com.fortanix.sdkms.v1.api

Class DigestApi

java.lang.Object

com.fortanix.sdkms.v1.api.DigestApi

public class DigestApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DigestApi()
DigestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BatchMacResponse	batchMac(BatchMacRequest body) Batch MAC with one or more keys Message to compute a cryptographic Message Authentication Code and the key ids to be used are provided in the request body.
BatchVerifyResponse	batchMacVerify(BatchMacVerifyRequest body) Batch MAC Verify with one or more keys The data to be MACed, the algorithm, a pre-computed MAC are provided in the request body, and the key id to be used are provided in the request body.
DigestResponse	computeDigest(DigestRequest body) Compute a message digest of data This returns the digest of data provided in request body using the algorithm specified in request body.
MacGenerateResponse	computeMac(String keyId, MacGenerateRequest body) Compute MAC using a key Compute a cryptographic Message Authentication Code on a message using a symmetric key.
MacGenerateResponse	computeMacEx(MacGenerateRequestEx body) Compute MAC using a key Compute a cryptographic Message Authentication Code on a message using a symmetric key.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
MacVerifyResponse	verifyMac(String keyId, MacVerifyRequest body) Verify MAC using a key The data to be MACed, the algorithm, and a pre-computed MAC are provided in the request body, and the key id is provided in the URL.
MacVerifyResponse	verifyMacEx(MacVerifyRequestEx body) Verify MAC using a key The data to be MACed, the algorithm, and a pre-computed MAC are provided in the request body, and the key id is provided in the URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

DigestApi

public DigestApi()

DigestApi

public DigestApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

batchMac

public BatchMacResponse batchMac(BatchMacRequest body)
                          throws ApiException

Batch MAC with one or more keys Message to compute a cryptographic Message Authentication Code and the key ids to be used are provided in the request body. The MAC 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 MAC request (required)

Returns:

BatchMacResponse

Throws:

ApiException - if fails to make API call

batchMacVerify

public BatchVerifyResponse batchMacVerify(BatchMacVerifyRequest body)
                                   throws ApiException

Batch MAC Verify with one or more keys The data to be MACed, the algorithm, a pre-computed MAC are provided in the request body, and the key id to be used are provided in the request body. The MAC 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 MAC verify request (required)

Returns:

BatchVerifyResponse

Throws:

ApiException - if fails to make API call

computeDigest

public DigestResponse computeDigest(DigestRequest body)
                             throws ApiException

Compute a message digest of data This returns the digest of data provided in request body using the algorithm specified in request body. Maximum size of request body supported is 512KB.

Parameters:

body - Digest request (required)

Returns:

DigestResponse

Throws:

ApiException - if fails to make API call

computeMac

public MacGenerateResponse computeMac(String keyId,
                                      MacGenerateRequest body)
                               throws ApiException

Compute MAC using a key Compute a cryptographic Message Authentication Code on a message using a symmetric key. The key must have the MACGenerate operation enabled. Asymmetric keys may not be used to generate MACs. They can be used with the sign and verify operations.

Parameters:

keyId - kid of security object (required)

body - MAC generation request (required)

Returns:

MacGenerateResponse

Throws:

ApiException - if fails to make API call

computeMacEx

public MacGenerateResponse computeMacEx(MacGenerateRequestEx body)
                                 throws ApiException

Compute MAC using a key Compute a cryptographic Message Authentication Code on a message using a symmetric key. The key must have the MACGenerate operation enabled. Asymmetric keys may not be used to generate MACs. They can be used with the sign and verify operations.

Parameters:

body - MAC generation request (required)

Returns:

MacGenerateResponse

Throws:

ApiException - if fails to make API call

verifyMac

public MacVerifyResponse verifyMac(String keyId,
                                   MacVerifyRequest body)
                            throws ApiException

Verify MAC using a key The data to be MACed, the algorithm, and a pre-computed MAC are provided in the request body, and the key id is provided in the URL. SDKMS computes the MAC of the data and compares it with the specified MAC, and returns the outcome of the MAC verification in the response body. Maximum size of request body supported is 512KB. Supported digest algorithms are - SHA1, SHA256, SHA384, and SHA512.

Parameters:

keyId - kid of security object (required)

body - MAC Verify request (required)

Returns:

MacVerifyResponse

Throws:

ApiException - if fails to make API call

verifyMacEx

public MacVerifyResponse verifyMacEx(MacVerifyRequestEx body)
                              throws ApiException

Verify MAC using a key The data to be MACed, the algorithm, and a pre-computed MAC are provided in the request body, and the key id is provided in the URL. SDKMS computes the MAC of the data and compares it with the specified MAC, and returns the outcome of the MAC verification in the response body. Maximum size of request body supported is 512KB. Supported digest algorithms are - SHA1, SHA256, SHA384, and SHA512.

Parameters:

body - MAC Verify request (required)

Returns:

MacVerifyResponse

Throws:

ApiException - if fails to make API call