com.fortanix.sdkms.v1.api

Class EncryptionAndDecryptionApi

java.lang.Object

com.fortanix.sdkms.v1.api.EncryptionAndDecryptionApi

public class EncryptionAndDecryptionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EncryptionAndDecryptionApi()
EncryptionAndDecryptionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BatchDecryptResponse	batchDecrypt(BatchDecryptRequest body) Batch decrypt with one or more keys The data to be decrypted and the key ids to be used are provided in the request body.
BatchEncryptResponse	batchEncrypt(BatchEncryptRequest body) Batch encrypt with one or more keys The data to be encrypted and the key ids to be used are provided in the request body.
DecryptResponse	decrypt(String keyId, DecryptRequest body) Decrypt data Decrypt data using a symmetric or asymmetric key.
DecryptResponse	decryptEx(DecryptRequestEx body) Decrypt data Decrypt data using a symmetric or asymmetric key.
DecryptFinalResponse	decryptFinal(String keyId, DecryptFinalRequest body) Conclude multi-part decryption Conclude a multi-part decryption operation.
DecryptFinalResponse	decryptFinalEx(DecryptFinalRequestEx body) Conclude multi-part decryption Conclude a multi-part decryption operation.
DecryptInitResponse	decryptInit(String keyId, DecryptInitRequest body) Begin multi-part decryption This API is used when decrypting more data than the client wishes to submit in a single request.
DecryptInitResponse	decryptInitEx(DecryptInitRequestEx body) Begin multi-part decryption This API is used when decrypting more data than the client wishes to submit in a single request.
DecryptUpdateResponse	decryptUpdate(String keyId, DecryptUpdateRequest body) Continue multi-part decryption Continue a multi-part decryption operation.
DecryptUpdateResponse	decryptUpdateEx(DecryptUpdateRequestEx body) Continue multi-part decryption Continue a multi-part decryption operation.
EncryptResponse	encrypt(String keyId, EncryptRequest body) Encrypt data Encrypt data using a symmetric or asymmetric key.
EncryptResponse	encryptEx(EncryptRequestEx body) Encrypt data Encrypt data using a symmetric or asymmetric key.
EncryptFinalResponse	encryptFinal(String keyId, EncryptFinalRequest body) Conclude multi-part encryption Conclude a multi-part encryption operation.
EncryptFinalResponse	encryptFinalEx(EncryptFinalRequestEx body) Conclude multi-part encryption Conclude a multi-part encryption operation.
EncryptInitResponse	encryptInit(String keyId, EncryptInitRequest body) Begin multi-part encryption This API is used when encrypting more data than the client wishes to submit in a single request.
EncryptInitResponse	encryptInitEx(EncryptInitRequestEx body) Begin multi-part encryption This API is used when encrypting more data than the client wishes to submit in a single request.
EncryptUpdateResponse	encryptUpdate(String keyId, EncryptUpdateRequest body) Continue multi-part encryption Continue a multi-part encryption operation.
EncryptUpdateResponse	encryptUpdateEx(EncryptUpdateRequestEx body) Continue multi-part encryption Continue a multi-part encryption operation.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
DecryptResponseFrame	streamDecrypt(DecryptRequestFrame body) Decrypt a stream of data Decrypt a stream of data.
EncryptResponseFrame	streamEncrypt(EncryptRequestFrame body) Encrypt a stream of data Encrypt a stream of data.

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptionAndDecryptionApi

public EncryptionAndDecryptionApi()

EncryptionAndDecryptionApi

public EncryptionAndDecryptionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

batchDecrypt

public BatchDecryptResponse batchDecrypt(BatchDecryptRequest body)
                                  throws ApiException

Batch decrypt with one or more keys The data to be decrypted and the key ids to be used are provided in the request body. The decrypted plain text is returned in the response body. The ordering of the body matches the ordering of the request. An individual status code is returned for each batch item. Maximum size of the entire batch request is 512 KB.

Parameters:

body - Batch decryption request (required)

Returns:

BatchDecryptResponse

Throws:

ApiException - if fails to make API call

batchEncrypt

public BatchEncryptResponse batchEncrypt(BatchEncryptRequest body)
                                  throws ApiException

Batch encrypt with one or more keys The data to be encrypted and the key ids to be used are provided in the request body. The encrypted cipher text is returned in the response body. The ordering of the body matches the ordering of the request. An individual status code is returned for each batch item. Maximum size of the entire batch request is 512 KB.

Parameters:

body - Batch Encryption request (required)

Returns:

BatchEncryptResponse

Throws:

ApiException - if fails to make API call

decrypt

public DecryptResponse decrypt(String keyId,
                               DecryptRequest body)
                        throws ApiException

Decrypt data Decrypt data using a symmetric or asymmetric key. For symmetric ciphers, mode (specifying the block cipher mode) is a required field. <br> For GCM and CCM modes, tag_len is a required field. <br> iv is required for symmetric ciphers and unused for asymmetric ciphers. It must contain the initialization value used when the object was encrypted. <br> Objects of type opaque, EC, or HMAC may not be used for encryption or decryption. <br>

Parameters:

keyId - kid of security object (required)

body - Decryption request (required)

Returns:

DecryptResponse

Throws:

ApiException - if fails to make API call

decryptEx

public DecryptResponse decryptEx(DecryptRequestEx body)
                          throws ApiException

Decrypt data Decrypt data using a symmetric or asymmetric key. For symmetric ciphers, mode (specifying the block cipher mode) is a required field. <br> For GCM and CCM modes, tag_len is a required field. <br> iv is required for symmetric ciphers and unused for asymmetric ciphers. It must contain the initialization value used when the object was encrypted. <br> Objects of type opaque, EC, or HMAC may not be used for encryption or decryption. <br>

Parameters:

body - Decryption request (required)

Returns:

DecryptResponse

Throws:

ApiException - if fails to make API call

decryptFinal

public DecryptFinalResponse decryptFinal(String keyId,
                                         DecryptFinalRequest body)
                                  throws ApiException

Conclude multi-part decryption Conclude a multi-part decryption operation. See `decrypt/init` for details.

Parameters:

keyId - kid of security object (required)

body - Finish multi-part decryption (required)

Returns:

DecryptFinalResponse

Throws:

ApiException - if fails to make API call

decryptFinalEx

public DecryptFinalResponse decryptFinalEx(DecryptFinalRequestEx body)
                                    throws ApiException

Conclude multi-part decryption Conclude a multi-part decryption operation. See `decrypt/init` for details.

Parameters:

body - Finish multi-part decryption (required)

Returns:

DecryptFinalResponse

Throws:

ApiException - if fails to make API call

decryptInit

public DecryptInitResponse decryptInit(String keyId,
                                       DecryptInitRequest body)
                                throws ApiException

Begin multi-part decryption This API is used when decrypting more data than the client wishes to submit in a single request. It supports only symmetric ciphers and CBC, CBCNOPAD, CTR, and GCM modes of operation. To perform multi-part decryption, the client makes one request to the `init` resource, zero or more requests to the `update` resource, followed by one request to the `final` resource. The response to init and update requests includes a `state` field. The `state` is an opaque data blob that must be supplied unmodified by the client with the subsequent request.

Parameters:

keyId - kid of security object (required)

body - Multi-part decryption initialization request (required)

Returns:

DecryptInitResponse

Throws:

ApiException - if fails to make API call

decryptInitEx

public DecryptInitResponse decryptInitEx(DecryptInitRequestEx body)
                                  throws ApiException

Begin multi-part decryption This API is used when decrypting more data than the client wishes to submit in a single request. It supports only symmetric ciphers and CBC, CBCNOPAD, CTR, and GCM modes of operation. To perform multi-part decryption, the client makes one request to the `init` resource, zero or more requests to the `update` resource, followed by one request to the `final` resource. The response to init and update requests includes a `state` field. The `state` is an opaque data blob that must be supplied unmodified by the client with the subsequent request.

Parameters:

body - Multi-part decryption initialization request (required)

Returns:

DecryptInitResponse

Throws:

ApiException - if fails to make API call

decryptUpdate

public DecryptUpdateResponse decryptUpdate(String keyId,
                                           DecryptUpdateRequest body)
                                    throws ApiException

Continue multi-part decryption Continue a multi-part decryption operation. See `decrypt/init` for details.

Parameters:

keyId - kid of security object (required)

body - Multi-part decryption (required)

Returns:

DecryptUpdateResponse

Throws:

ApiException - if fails to make API call

decryptUpdateEx

public DecryptUpdateResponse decryptUpdateEx(DecryptUpdateRequestEx body)
                                      throws ApiException

Continue multi-part decryption Continue a multi-part decryption operation. See `decrypt/init` for details.

Parameters:

body - Multi-part decryption (required)

Returns:

DecryptUpdateResponse

Throws:

ApiException - if fails to make API call

encrypt

public EncryptResponse encrypt(String keyId,
                               EncryptRequest body)
                        throws ApiException

Encrypt data Encrypt data using a symmetric or asymmetric key. <br> For symmetric ciphers, mode (specifying the block cipher mode) is a required field. <br> For GCM and CCM modes, tag_len is a required field. <br> iv is optional for symmetric ciphers and unused for asymmetric ciphers. If provided, it will be used as the cipher initialization value. Length of iv must match the initialization value size for the cipher and mode. If not provided, SDKMS will create a random iv of the correct length for the cipher and mode and return this value in the response. <br> Objects of type Opaque, EC, or HMAC may not be used for encryption or decryption. <br>

Parameters:

keyId - kid of security object (required)

body - Encryption request (required)

Returns:

EncryptResponse

Throws:

ApiException - if fails to make API call

encryptEx

public EncryptResponse encryptEx(EncryptRequestEx body)
                          throws ApiException

Encrypt data Encrypt data using a symmetric or asymmetric key. <br> For symmetric ciphers, mode (specifying the block cipher mode) is a required field. <br> For GCM and CCM modes, tag_len is a required field. <br> iv is optional for symmetric ciphers and unused for asymmetric ciphers. If provided, it will be used as the cipher initialization value. Length of iv must match the initialization value size for the cipher and mode. If not provided, SDKMS will create a random iv of the correct length for the cipher and mode and return this value in the response. <br> Objects of type Opaque, EC, or HMAC may not be used for encryption or decryption. <br>

Parameters:

body - Encryption request (required)

Returns:

EncryptResponse

Throws:

ApiException - if fails to make API call

encryptFinal

public EncryptFinalResponse encryptFinal(String keyId,
                                         EncryptFinalRequest body)
                                  throws ApiException

Conclude multi-part encryption Conclude a multi-part encryption operation. See `encrypt/init` for details.

Parameters:

keyId - kid of security object (required)

body - Finish multi-part encryption (required)

Returns:

EncryptFinalResponse

Throws:

ApiException - if fails to make API call

encryptFinalEx

public EncryptFinalResponse encryptFinalEx(EncryptFinalRequestEx body)
                                    throws ApiException

Conclude multi-part encryption Conclude a multi-part encryption operation. See `encrypt/init` for details.

Parameters:

body - Finish multi-part encryption (required)

Returns:

EncryptFinalResponse

Throws:

ApiException - if fails to make API call

encryptInit

public EncryptInitResponse encryptInit(String keyId,
                                       EncryptInitRequest body)
                                throws ApiException

Begin multi-part encryption This API is used when encrypting more data than the client wishes to submit in a single request. It supports only symmetric ciphers and CBC, CBCNOPAD, CTR, and GCM modes of operation. To perform multi-part encryption, the client makes one request to the `init` resource, zero or more requests to the `update` resource, followed by one request to the `final` resource. The response to init and update requests includes a `state` field. The `state` is an opaque data blob that must be supplied unmodified by the client with the subsequent request.

Parameters:

keyId - kid of security object (required)

body - Multi-part encryption initialization request (required)

Returns:

EncryptInitResponse

Throws:

ApiException - if fails to make API call

encryptInitEx

public EncryptInitResponse encryptInitEx(EncryptInitRequestEx body)
                                  throws ApiException

Begin multi-part encryption This API is used when encrypting more data than the client wishes to submit in a single request. It supports only symmetric ciphers and CBC, CBCNOPAD, CTR, and GCM modes of operation. To perform multi-part encryption, the client makes one request to the `init` resource, zero or more requests to the `update` resource, followed by one request to the `final` resource. The response to init and update requests includes a `state` field. The `state` is an opaque data blob that must be supplied unmodified by the client with the subsequent request.

Parameters:

body - Multi-part encryption initialization request (required)

Returns:

EncryptInitResponse

Throws:

ApiException - if fails to make API call

encryptUpdate

public EncryptUpdateResponse encryptUpdate(String keyId,
                                           EncryptUpdateRequest body)
                                    throws ApiException

Continue multi-part encryption Continue a multi-part encryption operation. See `encrypt/init` for details.

Parameters:

keyId - kid of security object (required)

body - Multi-part encryption (required)

Returns:

EncryptUpdateResponse

Throws:

ApiException - if fails to make API call

encryptUpdateEx

public EncryptUpdateResponse encryptUpdateEx(EncryptUpdateRequestEx body)
                                      throws ApiException

Continue multi-part encryption Continue a multi-part encryption operation. See `encrypt/init` for details.

Parameters:

body - Multi-part encryption (required)

Returns:

EncryptUpdateResponse

Throws:

ApiException - if fails to make API call

streamDecrypt

public DecryptResponseFrame streamDecrypt(DecryptRequestFrame body)
                                   throws ApiException

Decrypt a stream of data Decrypt a stream of data. Like the multi-part API, this API is used when the data to be encrypted is large (>512KiB), or the size of the data is not known ahead of time. It supports symmetric ciphers in the ECB, CBC, CBCNOPAD, CFB, OFB, CTR, and GCM modes of operation. Unlike the multi-part API, a single long-running request is used, where the request and response bodies are streamed simultaneously. <br> Both the request and response are a sequence of frames, each encoded in CBOR. The frames are concatenated into a CBOR sequence, following RFC 8742. The request consists of an \"init\" frame, zero or more \"ad\" frames, one or more \"cipher\" frames, and a \"final\" frame. A successful response consists of an \"init\" frame, one or more \"plain\" frames, and a \"final\" frame. <br> If an error occurs processing the \"init\" frame, the error is indicated as an HTTP status code and plain-text body, like all other APIs. If an error occurs later, it is reported as an \"error\" frame, and no further frames are sent.

Parameters:

body - Stream of decrypt request frames (required)

Returns:

DecryptResponseFrame

Throws:

ApiException - if fails to make API call

streamEncrypt

public EncryptResponseFrame streamEncrypt(EncryptRequestFrame body)
                                   throws ApiException

Encrypt a stream of data Encrypt a stream of data. Like the multi-part API, this API is used when the data to be encrypted is large (>512KiB), or the size of the data is not known ahead of time. It supports symmetric ciphers in the ECB, CBC, CBCNOPAD, CFB, OFB, CTR, and GCM modes of operation. Unlike the multi-part API, a single long-running request is used, where the request and response bodies are streamed simultaneously. <br> Both the request and response are a sequence of frames, each encoded in CBOR. The frames are concatenated into a CBOR sequence, following RFC 8742. The request consists of an \"init\" frame, zero or more \"ad\" frames, one or more \"plain\" frames, and a \"final\" frame. A successful response consists of an \"init\" frame, one or more \"cipher\" frames, and a \"final\" frame. <br> If an error occurs processing the \"init\" frame, the error is indicated as an HTTP status code and plain-text body, like all other APIs. If an error occurs later, it is reported as an \"error\" frame, and no further frames are sent.

Parameters:

body - Stream of encrypt request frames (required)

Returns:

EncryptResponseFrame

Throws:

ApiException - if fails to make API call