com.fortanix.sdkms.v1.api

Class SecurityObjectsApi

java.lang.Object

com.fortanix.sdkms.v1.api.SecurityObjectsApi

public class SecurityObjectsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SecurityObjectsApi()
SecurityObjectsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	activateSecurityObject(String keyId) Transitions immediately a security object to Active state Trigger the transition of a security object to Active state.
KeyObject	agreeKey(AgreeKeyRequest body) Agree on a key from two other keys This does a cryptographic key agreement operation between a public and private key.
void	deletePrivateKey(String keyId) Remove / Destroy private half of the asymmetric key Removes the private portion of an asymmetric key from SDKMS.
void	deleteSecurityObject(String keyId) Delete a security object Delete a specified security object.
KeyObject	deriveKey(String keyId, DeriveKeyRequest body) Derive a key from another key This derives a key from an existing key and returns the properties of the new key.
KeyObject	deriveKeyEx(DeriveKeyRequestEx body) Derive a key from another key This derives a key from an existing key and returns the properties of the new key.
void	destroySecurityObject(String keyId) Destroys a security object, leaving its metadata in place Destroys a security object.
ExportComponentsResponse	exportSobjectComponents(ExportSobjectComponentsRequest body) export key components
KeyObject	generateSecurityObject(SobjectRequest body) Generate a new security object Generate a new security object (such as an RSA key pair or an AES key) of the requested size or elliptic curve.
ApiClient	getApiClient()
KeyObject	getSecurityObject(String keyId, String view, Boolean showDestroyed, Boolean showDeleted) Get a specific security object Get the details of a particular security object.
DigestResponse	getSecurityObjectDigest(ObjectDigestRequest body) Retrieve the digest (hash) of the value of an exportable security object
KeyObject	getSecurityObjectEx(SobjectDescriptor body, String view, Boolean showDestroyed, Boolean showDeleted) Get a specific security object by id or name Get the details of a particular security object.
KeyCheckValueResponse	getSecurityObjectKcv(SobjectDescriptor body) Get the key check value (KCV) of a symmetric key Get the key check value (KCV) of a symmetric key
List<KeyObject>	getSecurityObjects(String name, String groupId, String creator) Get all security objects Return detailed information about the security objects stored in Fortanix SDKMS.
List<KeyObject>	getSecurityObjects(String name, String groupId, String creator, String sort, Boolean compliantWithPolicies, String start, Integer limit, Integer offset, Boolean showDestroyed, Boolean showDeleted) Get all security objects Return detailed information about the security objects stored in Fortanix SDKMS.
KeyObject	getSecurityObjectValue(String keyId) Retrieve the value of an exportable security object Get the details and value of a particular exportable security object.
KeyObject	getSecurityObjectValueEx(SobjectDescriptor body) Retrieve the value of an exportable security object Get the details and value of a particular exportable security object.
KeyObject	importSecurityObject(SobjectRequest body) Import a security object Import a security object into SDKMS.
KeyObject	importSobjectComponents(ImportSobjectComponentsRequest body) import key components
KeyObject	persistSecurityObject(PersistTransientKeyRequest body) Persist a transient key.
void	revertHistoryItem(String keyId, SobjectRequest body) Reverts a security object to a previous state When a Key Undo Policy is in place, security objects maintain a list of history items.
void	revokeSecurityObject(String keyId, RevocationReason body) Transitions immediately a security object to Deactivated or Compromised state Trigger the transition of a security object to Deactivated or Compromised state depending on the RevocationReason Code.
KeyObject	rotateSecurityObject(SobjectRequest body) Rotate a key.
void	setApiClient(ApiClient apiClient)
KeyObject	updateSecurityObject(String keyId, SobjectRequest body) Update a security object Update the properties of a security object.
VerifyKcvResponse	verifyKcv(VerifyKcvRequest body) Verify that the KCV of the provided key material matches the provided KCV

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityObjectsApi

public SecurityObjectsApi()

SecurityObjectsApi

public SecurityObjectsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateSecurityObject

public void activateSecurityObject(String keyId)
                            throws ApiException

Transitions immediately a security object to Active state Trigger the transition of a security object to Active state.

Parameters:

keyId - kid of security object (required)

Throws:

ApiException - if fails to make API call

agreeKey

public KeyObject agreeKey(AgreeKeyRequest body)
                   throws ApiException

Agree on a key from two other keys This does a cryptographic key agreement operation between a public and private key. Both keys must have been generated from the same parameters (e.g. the same elliptic curve). Both keys must allow the AGREEKEY operation. The request body contains the requested properties for the new key as well as the mechanism (e.g. Diffie-Hellman) to be used to produce the key material for the new key. The output of this API should not be used directly as a cryptographic key. The target object type should be HMAC or Secret, and a key derivation procedure should be used to derive the actual key material.

Parameters:

body - Template of the agreed-upon security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

deletePrivateKey

public void deletePrivateKey(String keyId)
                      throws ApiException

Remove / Destroy private half of the asymmetric key Removes the private portion of an asymmetric key from SDKMS. After this operation is performed, operations that require the private key, such as encryption and generating signatures, may no longer be performed.

Parameters:

keyId - kid of security object (required)

Throws:

ApiException - if fails to make API call

deleteSecurityObject

public void deleteSecurityObject(String keyId)
                          throws ApiException

Delete a security object Delete a specified security object.

Parameters:

keyId - kid of security object (required)

Throws:

ApiException - if fails to make API call

deriveKey

public KeyObject deriveKey(String keyId,
                           DeriveKeyRequest body)
                    throws ApiException

Derive a key from another key This derives a key from an existing key and returns the properties of the new key. The request body contains the requested properties for the new as well as the mechanism to be used to produce the key material for the new key.

Parameters:

keyId - kid of security object (required)

body - Name of security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

deriveKeyEx

public KeyObject deriveKeyEx(DeriveKeyRequestEx body)
                      throws ApiException

Derive a key from another key This derives a key from an existing key and returns the properties of the new key. The request body contains the requested properties for the new as well as the mechanism to be used to produce the key material for the new key.

Parameters:

body - Name of security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

destroySecurityObject

public void destroySecurityObject(String keyId)
                           throws ApiException

Destroys a security object, leaving its metadata in place Destroys a security object. Objects in the `Destroyed` state cannot be used in any cryptographic operation. Their metadata however, remains present.

Parameters:

keyId - kid of security object (required)

Throws:

ApiException - if fails to make API call

exportSobjectComponents

public ExportComponentsResponse exportSobjectComponents(ExportSobjectComponentsRequest body)
                                                 throws ApiException

export key components

Parameters:

body - Request to export a security object components (required)

Returns:

ExportComponentsResponse

Throws:

ApiException - if fails to make API call

generateSecurityObject

public KeyObject generateSecurityObject(SobjectRequest body)
                                 throws ApiException

Generate a new security object Generate a new security object (such as an RSA key pair or an AES key) of the requested size or elliptic curve. <br> By default, all key operations except for Export that are implemented for that type of key will be enabled. These may be overridden by requesting specific operations in the key creation request. <br> Objects of type Opaque may not be generated with this API. They must be imported via the importSecurityObject API.

Parameters:

body - Request to create, update, or import security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

getSecurityObject

public KeyObject getSecurityObject(String keyId,
                                   String view,
                                   Boolean showDestroyed,
                                   Boolean showDeleted)
                            throws ApiException

Get a specific security object Get the details of a particular security object.

Parameters:

keyId - kid of security object (required)

view - The encoding the value of an opaque object or certificate (optional, default to json)

showDestroyed - Whether security objects in the `Destroyed` state should be returned (optional, default to false)

showDeleted - Whether security objects in the `Deleted` state should be returned (optional)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

getSecurityObjectDigest

public DigestResponse getSecurityObjectDigest(ObjectDigestRequest body)
                                       throws ApiException

Retrieve the digest (hash) of the value of an exportable security object

Parameters:

body - Object digest request (required)

Returns:

DigestResponse

Throws:

ApiException - if fails to make API call

getSecurityObjectEx

public KeyObject getSecurityObjectEx(SobjectDescriptor body,
                                     String view,
                                     Boolean showDestroyed,
                                     Boolean showDeleted)
                              throws ApiException

Get a specific security object by id or name Get the details of a particular security object.

Parameters:

body - Request to get a security object (required)

view - The encoding the value of an opaque object or certificate (optional, default to json)

showDestroyed - Whether security objects in the `Destroyed` state should be returned (optional, default to false)

showDeleted - Whether security objects in the `Deleted` state should be returned (optional)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

getSecurityObjectKcv

public KeyCheckValueResponse getSecurityObjectKcv(SobjectDescriptor body)
                                           throws ApiException

Get the key check value (KCV) of a symmetric key Get the key check value (KCV) of a symmetric key

Parameters:

body - Request to export a security object (required)

Returns:

KeyCheckValueResponse

Throws:

ApiException - if fails to make API call

getSecurityObjectValue

public KeyObject getSecurityObjectValue(String keyId)
                                 throws ApiException

Retrieve the value of an exportable security object Get the details and value of a particular exportable security object.

Parameters:

keyId - kid of security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

getSecurityObjectValueEx

public KeyObject getSecurityObjectValueEx(SobjectDescriptor body)
                                   throws ApiException

Retrieve the value of an exportable security object Get the details and value of a particular exportable security object.

Parameters:

body - Request to export a security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

getSecurityObjects

public List<KeyObject> getSecurityObjects(String name,
                                          String groupId,
                                          String creator,
                                          String sort,
                                          Boolean compliantWithPolicies,
                                          String start,
                                          Integer limit,
                                          Integer offset,
                                          Boolean showDestroyed,
                                          Boolean showDeleted)
                                   throws ApiException

Get all security objects Return detailed information about the security objects stored in Fortanix SDKMS.

Parameters:

name - Only retrieve the security object with this name. (optional)

groupId - Only retrieve security objects in the specified group. (optional)

creator - Only retrieve security objects created by the user or application with the specified id. (optional)

sort - This specifies the property (`kid` or `name`) and order (ascending or descending) with which to sort the security objects. By default, security objects are sorted by `kid` in ascending order. The syntax is \"<property>:[asc|desc]\" (e.g. \"kid:desc\") or just \"<property>\" (ascending order by default). (optional)

compliantWithPolicies - Whether this security object is compliant with cryptographic policies or not. (optional)

start - If provided, this must be a value of the property specified in `sort`. Returned security objects will begin just above or just below this value (for asc/desc order resp.). (optional)

limit - Maximum number of security objects to return. If not provided, the limit is 100. (optional)

offset - Number of security objects past `start` to skip. (optional)

showDestroyed - Whether security objects in the `Destroyed` state should be returned (optional)

showDeleted - Whether security objects in the `Deleted` state should be returned (optional)

Returns:

List<KeyObject>

Throws:

ApiException - if fails to make API call

getSecurityObjects

public List<KeyObject> getSecurityObjects(String name,
                                          String groupId,
                                          String creator)
                                   throws ApiException

Get all security objects Return detailed information about the security objects stored in Fortanix SDKMS.

Parameters:

name - Only retrieve the security object with this name. (optional)

groupId - Only retrieve security objects in the specified group. (optional)

creator - Only retrieve security objects created by the user or application with the specified id. (optional)

Returns:

List<KeyObject>

Throws:

ApiException - if fails to make API call

importSecurityObject

public KeyObject importSecurityObject(SobjectRequest body)
                               throws ApiException

Import a security object Import a security object into SDKMS. <br> By default, all key operations except that are implemented for that type of key will be enabled. These may be overridden by requesting specific operations in the key import request. <br> For symmetric and asymmetric keys, value is base64-encoding of the key material in DER format.

Parameters:

body - Request to create, update, or import security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

importSobjectComponents

public KeyObject importSobjectComponents(ImportSobjectComponentsRequest body)
                                  throws ApiException

import key components

Parameters:

body - Request to import a security object components (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

persistSecurityObject

public KeyObject persistSecurityObject(PersistTransientKeyRequest body)
                                throws ApiException

Persist a transient key. This API copies a transient key into a persisted security object in SDKMS. If the transient key's origin is \"FortanixHSM\", the origin of the persisted key will be \"Transient\". If the transient key's origin is \"External\", the origin of the persisted key will be \"External\".

Parameters:

body - Persist transient key request (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

revertHistoryItem

public void revertHistoryItem(String keyId,
                              SobjectRequest body)
                       throws ApiException

Reverts a security object to a previous state When a Key Undo Policy is in place, security objects maintain a list of history items. Using this API endpoint, clients may revert the security object to a previous (non-expired) history item.

Parameters:

keyId - kid of security object (required)

body - Request to create, update, or import security object (required)

Throws:

ApiException - if fails to make API call

revokeSecurityObject

public void revokeSecurityObject(String keyId,
                                 RevocationReason body)
                          throws ApiException

Transitions immediately a security object to Deactivated or Compromised state Trigger the transition of a security object to Deactivated or Compromised state depending on the RevocationReason Code.

Parameters:

keyId - kid of security object (required)

body - Reason to revoke a security object (required)

Throws:

ApiException - if fails to make API call

rotateSecurityObject

public KeyObject rotateSecurityObject(SobjectRequest body)
                               throws ApiException

Rotate a key. Rotate an existing security object.

Parameters:

body - Request to create, update, or import security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

updateSecurityObject

public KeyObject updateSecurityObject(String keyId,
                                      SobjectRequest body)
                               throws ApiException

Update a security object Update the properties of a security object.

Parameters:

keyId - kid of security object (required)

body - Request to create, update, or import security object (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

verifyKcv

public VerifyKcvResponse verifyKcv(VerifyKcvRequest body)
                            throws ApiException

Verify that the KCV of the provided key material matches the provided KCV

Parameters:

body - Verify KCV request (required)

Returns:

VerifyKcvResponse

Throws:

ApiException - if fails to make API call