com.fortanix.sdkms.v1.api

Class WrappingAndUnwrappingApi

java.lang.Object

com.fortanix.sdkms.v1.api.WrappingAndUnwrappingApi

public class WrappingAndUnwrappingApi
extends Object

Constructor Summary

Constructors

Constructor and Description
WrappingAndUnwrappingApi()
WrappingAndUnwrappingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
KeyObject	unwrapKey(String keyId, UnwrapKeyRequest body) Unwrap a security object with a key Unwrap (decrypt) a wrapped key and import it into SDKMS.
KeyObject	unwrapKeyEx(UnwrapKeyRequestEx body) Unwrap a security object with a key Unwrap (decrypt) a wrapped key and import it into SDKMS.
WrapKeyResponse	wrapKey(String keyId, WrapKeyRequest body) Wrap a security object with a key Wrap (encrypt) an existing security object with a key.
WrapKeyResponse	wrapKeyEx(WrapKeyRequestEx body) Wrap a security object with a key Wrap (encrypt) an existing security object with a key.

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappingAndUnwrappingApi

public WrappingAndUnwrappingApi()

WrappingAndUnwrappingApi

public WrappingAndUnwrappingApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

unwrapKey

public KeyObject unwrapKey(String keyId,
                           UnwrapKeyRequest body)
                    throws ApiException

Unwrap a security object with a key Unwrap (decrypt) a wrapped key and import it into SDKMS. This allows securely importing into SDKMS security objects that were previously wrapped by SDKMS or another key management system. A new security object will be created in SDKMS with the unwrapped data. <br> The key-id parameter in the URL specifies the key that will be used to unwrap the other security object. This key must have the unwrapkey operation enabled. <br> The alg and mode parameters specify the encryption algorithm and cipher mode being used by the unwrapping key. The obj_type parameter specifies the object type of the security object being unwrapped. The size or elliptic curve of the object being unwrapped does not need to be specified.

Parameters:

keyId - kid of security object (required)

body - Unwrap key request (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

unwrapKeyEx

public KeyObject unwrapKeyEx(UnwrapKeyRequestEx body)
                      throws ApiException

Unwrap a security object with a key Unwrap (decrypt) a wrapped key and import it into SDKMS. This allows securely importing into SDKMS security objects that were previously wrapped by SDKMS or another key management system. A new security object will be created in SDKMS with the unwrapped data. <br> The key-id parameter in the URL specifies the key that will be used to unwrap the other security object. This key must have the unwrapkey operation enabled. <br> The alg and mode parameters specify the encryption algorithm and cipher mode being used by the unwrapping key. The obj_type parameter specifies the object type of the security object being unwrapped. The size or elliptic curve of the object being unwrapped does not need to be specified.

Parameters:

body - Unwrap key request (required)

Returns:

KeyObject

Throws:

ApiException - if fails to make API call

wrapKey

public WrapKeyResponse wrapKey(String keyId,
                               WrapKeyRequest body)
                        throws ApiException

Wrap a security object with a key Wrap (encrypt) an existing security object with a key. This allows keys to be securely exported from SDKMS so they can be later imported into SDKMS or another key management system. <br> The key-id parameter in the URL specifies the key that will be used to wrap the other security object. The security object being wrapped is specified inside of the request body. <br> The alg and mode parameters specify the encryption algorithm and cipher mode being used for the wrapping key. The algorithm of the key being wrapped is not provided to this API call. <br> The key being wrapped must have the export operation enabled. The wrapping key must have the wrapkey operation enabled. <br> The following wrapping operations are supported: * Symmetric keys, HMAC keys, opaque objects, and secret objects may be wrapped with symmetric or asymmetric keys. * Asymmetric keys may be wrapped with symmetric keys. Wrapping an asymmetric key with an asymmetric key is not supported. When wrapping with an asymmetric key, the wrapped object size must fit as plaintext for the wrapping key size and algorithm.

Parameters:

keyId - kid of security object (required)

body - Wrap key request (required)

Returns:

WrapKeyResponse

Throws:

ApiException - if fails to make API call

wrapKeyEx

public WrapKeyResponse wrapKeyEx(WrapKeyRequestEx body)
                          throws ApiException

Wrap a security object with a key Wrap (encrypt) an existing security object with a key. This allows keys to be securely exported from SDKMS so they can be later imported into SDKMS or another key management system. <br> The key-id parameter in the URL specifies the key that will be used to wrap the other security object. The security object being wrapped is specified inside of the request body. <br> The alg and mode parameters specify the encryption algorithm and cipher mode being used for the wrapping key. The algorithm of the key being wrapped is not provided to this API call. <br> The key being wrapped must have the export operation enabled. The wrapping key must have the wrapkey operation enabled. <br> The following wrapping operations are supported: * Symmetric keys, HMAC keys, opaque objects, and secret objects may be wrapped with symmetric or asymmetric keys. * Asymmetric keys may be wrapped with symmetric keys. Wrapping an asymmetric key with an asymmetric key is not supported. When wrapping with an asymmetric key, the wrapped object size must fit as plaintext for the wrapping key size and algorithm.

Parameters:

body - Wrap key request (required)

Returns:

WrapKeyResponse

Throws:

ApiException - if fails to make API call