com.fortanix.sdkms.v1.api

Class SignAndVerifyApi

java.lang.Object

com.fortanix.sdkms.v1.api.SignAndVerifyApi

public class SignAndVerifyApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SignAndVerifyApi()
SignAndVerifyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BatchSignResponse	batchSign(BatchSignRequest body) Batch sign with one or more private keys The data to be signed and the key ids to be used are provided in the request body.
BatchVerifyResponse	batchVerify(BatchVerifyRequest body) Batch verify with one or more private keys The signature to be verified and the key ids to be used are provided in the request body.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
SignResponse	sign(String keyId, SignRequest body) Sign with a private key Sign data with a private key.
SignResponse	signEx(SignRequestEx body) Sign with a private key Sign data with a private key.
VerifyResponse	verify(String keyId, VerifyRequest body) Verify a signature with a key Verify a signature with a public key.
VerifyResponse	verifyEx(VerifyRequestEx body) Verify a signature with a key Verify a signature with a public key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignAndVerifyApi

public SignAndVerifyApi()

SignAndVerifyApi

public SignAndVerifyApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

batchSign

public BatchSignResponse batchSign(BatchSignRequest body)
                            throws ApiException

Batch sign with one or more private keys The data to be signed and the key ids to be used are provided in the request body. The signature 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 Sign request (required)

Returns:

BatchSignResponse

Throws:

ApiException - if fails to make API call

batchVerify

public BatchVerifyResponse batchVerify(BatchVerifyRequest body)
                                throws ApiException

Batch verify with one or more private keys The signature to be verified and the key ids to be used are provided in the request body. The result (true of false) 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 Verify request (required)

Returns:

BatchVerifyResponse

Throws:

ApiException - if fails to make API call

sign

public SignResponse sign(String keyId,
                         SignRequest body)
                  throws ApiException

Sign with a private key Sign data with a private key. The signing key must be an asymmetric key with the private part present. The sign operation must be enabled for this key. Symmetric keys may not be used to sign data. They can be used with the computeMac and verifyMac methods. <br> The data must be hashed with a SHA-1 or SHA-2 family hash algorithm.

Parameters:

keyId - kid of security object (required)

body - Signature request (required)

Returns:

SignResponse

Throws:

ApiException - if fails to make API call

signEx

public SignResponse signEx(SignRequestEx body)
                    throws ApiException

Sign with a private key Sign data with a private key. The signing key must be an asymmetric key with the private part present. The sign operation must be enabled for this key. Symmetric keys may not be used to sign data. They can be used with the computeMac and verifyMac methods. <br> The data must be hashed with a SHA-1 or SHA-2 family hash algorithm.

Parameters:

body - Signature request (required)

Returns:

SignResponse

Throws:

ApiException - if fails to make API call

verify

public VerifyResponse verify(String keyId,
                             VerifyRequest body)
                      throws ApiException

Verify a signature with a key Verify a signature with a public key. The verifying key must be an asymmetric key with the verify operation enabled. Symmetric keys may not be used to verify data. They can be used with the computeMac and verifyMac operations. <br> The signature must have been created with a SHA-1 or SHA-2 family hash algorithm.

Parameters:

keyId - kid of security object (required)

body - Verification request (required)

Returns:

VerifyResponse

Throws:

ApiException - if fails to make API call

verifyEx

public VerifyResponse verifyEx(VerifyRequestEx body)
                        throws ApiException

Verify a signature with a key Verify a signature with a public key. The verifying key must be an asymmetric key with the verify operation enabled. Symmetric keys may not be used to verify data. They can be used with the computeMac and verifyMac operations. <br> The signature must have been created with a SHA-1 or SHA-2 family hash algorithm.

Parameters:

body - Verification request (required)

Returns:

VerifyResponse

Throws:

ApiException - if fails to make API call