@Generated(value="OracleSDKGenerator", comments="API Version: release") public interface KmsCrypto extends AutoCloseable
API for managing and performing operations with keys and vaults. (For the API for managing secrets, see the Vault Service Secret Management API. For the API for retrieving secrets, see the Vault Service Secret Retrieval API.)
Modifier and Type | Method and Description |
---|---|
DecryptResponse |
decrypt(DecryptRequest request)
Decrypts data using the given DecryptDataDetails resource.
|
EncryptResponse |
encrypt(EncryptRequest request)
Encrypts data using the given EncryptDataDetails resource.
|
ExportKeyResponse |
exportKey(ExportKeyRequest request)
Exports a specific version of a master encryption key according to the details of the request.
|
GenerateDataEncryptionKeyResponse |
generateDataEncryptionKey(GenerateDataEncryptionKeyRequest request)
Generates a key that you can use to encrypt or decrypt data.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
SignResponse |
sign(SignRequest request)
Creates a digital signature for a message or message digest by using the private key in an asymmetric key.
|
VerifyResponse |
verify(VerifyRequest request)
Verifies a digital signature that was generated by the Sign operation using the public key in the same asymmetric key.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
DecryptResponse decrypt(DecryptRequest request)
Decrypts data using the given DecryptDataDetails resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use Decrypt API.
EncryptResponse encrypt(EncryptRequest request)
Encrypts data using the given EncryptDataDetails resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use Encrypt API.
ExportKeyResponse exportKey(ExportKeyRequest request)
Exports a specific version of a master encryption key according to the details of the request. For their protection, keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys stored on the server. For export, the key version is encrypted by an RSA public key that you provide.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ExportKey API.
GenerateDataEncryptionKeyResponse generateDataEncryptionKey(GenerateDataEncryptionKeyRequest request)
Generates a key that you can use to encrypt or decrypt data.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GenerateDataEncryptionKey API.
SignResponse sign(SignRequest request)
Creates a digital signature for a message or message digest by using the private key in an asymmetric key. To verify the generated signature, you can use the Verify operation or use the public key in the same asymmetric key outside of KMS
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use Sign API.
VerifyResponse verify(VerifyRequest request)
Verifies a digital signature that was generated by the Sign operation using the public key in the same asymmetric key. You can also verify the digital signature by using the public key in the asymmetric key outside of KMS
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use Verify API.
Copyright © 2016–2021. All rights reserved.