Barbican client object used to interact with barbican service.
Parameters: |
|
---|
Entity Manager for Secret entities
Factory method for creating new Secret objects
Secrets returned by this method have not yet been stored in the Barbican service.
Parameters: |
|
---|---|
Returns: | A new Secret object |
Return type: |
Delete a Secret from Barbican
Parameters: | secret_ref – The href for the secret to be deleted |
---|
Retrieve an existing Secret from Barbican
Parameters: |
|
---|---|
Returns: | Secret object retrieved from Barbican |
Return type: |
List Secrets for the project
This method uses the limit and offset parameters for paging, and also supports filtering.
Parameters: |
|
---|---|
Returns: | list of Secret objects that satisfy the provided filter criteria. |
Return type: | list |
Secrets represent keys, credentials, and other sensitive data that is stored by the Barbican service.
Secret objects should not be instantiated directly. You should use the create or get methods of the barbicanclient.secrets.SecretManager instead.
Deletes the Secret from Barbican
Lazy-loaded property that holds the unencrypted data
Stores the Secret in Barbican. New Secret objects are not persisted in Barbican until this method is called.
Raises: | PayloadException |
---|
Entity Manager for Order entitites
Factory method for AsymmetricOrder objects
AsymmetricOrder objects returned by this method have not yet been submitted to the Barbican service.
Parameters: |
|
---|---|
Returns: | AsymmetricOrder |
Return type: |
Factory method for KeyOrder objects
KeyOrder objects returned by this method have not yet been submitted to the Barbican service.
Parameters: |
|
---|---|
Returns: | KeyOrder |
Return type: |
Delete an Order from Barbican
Parameters: | order_ref – The href for the order |
---|
Retrieve an existing Order from Barbican
Parameters: | order_ref – Full HATEOAS reference to an Order |
---|---|
Returns: | An instance of the appropriate subtype of Order |
List Orders for the project
This method uses the limit and offset parameters for paging.
Parameters: |
|
---|---|
Returns: | list of Order objects |
Base order object to hold common functionality
This should be considered an abstract class that should not be instantiated directly.
Deletes the Order from Barbican
Submit the Order to Barbican. New Order objects are not persisted in Barbican until this method is called.
KeyOrders can be used to request random key material from Barbican
Encryption mode being used with this key
The mode could be set to “CBC” for example, when requesting a key that will be used for AES encryption in CBC mode.
Passphrase to be used for passphrase protected asymmetric keys
EntityManager for Container entities
You should use the ContainerManager exposed by the Client and should not need to instantiate your own.
Factory method for Container objects
Container objects returned by this method have not yet been stored in Barbican.
Parameters: |
|
---|---|
Returns: | Container |
Return type: |
Factory method for CertificateContainer objects
CertificateContainer objects returned by this method have not yet been stored in Barbican.
Parameters: |
|
---|---|
Returns: | CertificateContainer |
Return type: |
Factory method for RSAContainer objects
RSAContainer objects returned by this method have not yet been stored in Barbican.
Parameters: |
|
---|---|
Returns: | RSAContainer |
Return type: |
Delete a Container from Barbican
Parameters: | container_ref – Full HATEOAS reference to a Container |
---|
Retrieve an existing Container from Barbican
Parameters: | container_ref (str) – Full HATEOAS reference to a Container |
---|---|
Returns: | Container object or a subclass of the appropriate type |
List containers for the project. This method uses the limit and offset parameters for paging.
Parameters: |
|
---|---|
Returns: | list of Container metadata objects |
Add a consumer to the container
Parameters: |
|
---|---|
Returns: | A container object per the get() method |
Remove a consumer from the container
Parameters: |
|
---|
Container is a generic grouping of Secrets
Delete container from Barbican
List of Secrets in Containers
Store Container in Barbican
Secret containing the Private Key
Secret containing the Passphrase
Secret containing the Public Key
Secret containing the certificate
Secret containing intermediate certificates
Secret containing the private key
Secret containing the passphrase