Cert manager implementation for Barbican using a single PKCS12 secret
Bases: octavia.certificates.manager.cert_mgr.CertManager
Certificate Manager that wraps the Barbican client API.
Deregister as a consumer for the specified cert.
context – Oslo context of the request
cert_ref – the UUID of the cert to retrieve
resource_ref – Full HATEOAS reference to the consuming resource
service_name – Friendly name for the consuming service
Exception – if deregistration fails
Retrieves the specified cert and registers as a consumer.
context – Oslo context of the request
cert_ref – the UUID of the cert to retrieve
resource_ref – Full HATEOAS reference to the consuming resource
check_only – Read Certificate data without registering
service_name – Friendly name for the consuming service
octavia.certificates.common.Cert representation of the certificate data
Exception – if certificate retrieval fails
Retrieves a secret payload by reference.
context – Oslo context of the request
secret_ref – The secret reference ID
The secret payload
CertificateStorageException – if retrieval fails
Adds ACLs so Octavia can access the cert objects.
If the specified cert does not exist or the addition of ACLs fails for any reason, a CertificateStorageException should be raised.
Stores a certificate in the certificate manager.
context – Oslo context of the request
certificate – PEM encoded TLS certificate
private_key – private key for the supplied certificate
intermediates – ordered and concatenated intermediate certs
private_key_passphrase – optional passphrase for the supplied key
expiration – the expiration time of the cert in ISO 8601 format
name – a friendly name for the cert
the container_ref of the stored cert
Exception – if certificate storage fails
Legacy cert manager implementation for Barbican (container+secrets)
Bases: octavia.certificates.manager.cert_mgr.CertManager
Certificate Manager that wraps the Barbican client API.
Deregister as a consumer for the specified cert.
context – Oslo context of the request
cert_ref – the UUID of the cert to retrieve
resource_ref – Full HATEOAS reference to the consuming resource
service_name – Friendly name for the consuming service
Exception – if deregistration fails
Retrieves the specified cert and registers as a consumer.
context – Oslo context of the request
cert_ref – the UUID of the cert to retrieve
resource_ref – Full HATEOAS reference to the consuming resource
check_only – Read Certificate data without registering
service_name – Friendly name for the consuming service
octavia.certificates.common.Cert representation of the certificate data
Exception – if certificate retrieval fails
Retrieves a secret payload by reference.
If the specified secret does not exist, a CertificateStorageException should be raised.
Adds ACLs so Octavia can access the cert objects.
If the specified cert does not exist or the addition of ACLs fails for any reason, a CertificateStorageException should be raised.
Stores a certificate in the certificate manager.
context – Oslo context of the request
certificate – PEM encoded TLS certificate
private_key – private key for the supplied certificate
intermediates – ordered and concatenated intermediate certs
private_key_passphrase – optional passphrase for the supplied key
expiration – the expiration time of the cert in ISO 8601 format
name – a friendly name for the cert
the container_ref of the stored cert
Exception – if certificate storage fails
Cert manager implementation for Castellan
Bases: octavia.certificates.manager.cert_mgr.CertManager
Certificate Manager for the Castellan library.
Deletes the specified cert.
If the specified cert does not exist, a CertificateStorageException should be raised.
Retrieves the specified cert.
If check_only is True, don’t perform any sort of registration. If the specified cert does not exist, a CertificateStorageException should be raised.
Retrieves a secret payload by reference.
If the specified secret does not exist, a CertificateStorageException should be raised.
Adds ACLs so Octavia can access the cert objects.
If the specified cert does not exist or the addition of ACLs fails for any reason, a CertificateStorageException should be raised.
Stores (i.e., registers) a cert with the cert manager.
This method stores the specified cert and returns its UUID that identifies it within the cert manager. If storage of the certificate data fails, a CertificateStorageException should be raised.
Certificate manager API
Bases: object
Base Cert Manager Interface
A Cert Manager is responsible for managing certificates for TLS.
Deletes the specified cert.
If the specified cert does not exist, a CertificateStorageException should be raised.
Retrieves the specified cert.
If check_only is True, don’t perform any sort of registration. If the specified cert does not exist, a CertificateStorageException should be raised.
Retrieves a secret payload by reference.
If the specified secret does not exist, a CertificateStorageException should be raised.
Adds ACLs so Octavia can access the cert objects.
If the specified cert does not exist or the addition of ACLs fails for any reason, a CertificateStorageException should be raised.
Stores (i.e., registers) a cert with the cert manager.
This method stores the specified cert and returns its UUID that identifies it within the cert manager. If storage of the certificate data fails, a CertificateStorageException should be raised.
Bases: octavia.certificates.manager.cert_mgr.CertManager
Cert Manager Interface that stores data locally.
Deletes the specified cert.
context – Ignored in this implementation
cert_ref – the UUID of the cert to delete
CertificateStorageException – if certificate deletion fails
Retrieves the specified cert.
context – Ignored in this implementation
cert_ref – the UUID of the cert to retrieve
octavia.certificates.common.Cert representation of the certificate data
CertificateStorageException – if certificate retrieval fails
Retrieves a secret payload by reference.
context – Ignored in this implementation
secret_ref – The secret reference ID
The secret payload
CertificateStorageException – if secret retrieval fails
Adds ACLs so Octavia can access the cert objects.
If the specified cert does not exist or the addition of ACLs fails for any reason, a CertificateStorageException should be raised.
Stores (i.e., registers) a cert with the cert manager.
This method stores the specified cert to the filesystem and returns a UUID that can be used to retrieve it.
context – Ignored in this implementation
certificate – PEM encoded TLS certificate
private_key – private key for the supplied certificate
intermediates – ordered and concatenated intermediate certs
private_key_passphrase – optional passphrase for the supplied key
the UUID of the stored cert
CertificateStorageException – if certificate storage fails
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.