Class Encrypt.Request

    • Field Detail

      • ALGORITHM_AES_256_GCM

        public static final String ALGORITHM_AES_256_GCM
        Default encryption algorithm used by encryption/decryption is "AES_256_GCM".
        See Also:
        Constant Field Values
      • ALGORITHM_RSA_OAEP_SHA_1

        public static final String ALGORITHM_RSA_OAEP_SHA_1
        "RSA_OAEP_SHA_1" algorithm.
        See Also:
        Constant Field Values
      • ALGORITHM_RSA_OAEP_SHA_256

        public static final String ALGORITHM_RSA_OAEP_SHA_256
        "RSA_OAEP_SHA_256" algorithm.
        See Also:
        Constant Field Values
    • Method Detail

      • keyId

        public Encrypt.Request keyId​(String keyOcid)
        The OCID of the key to encrypt with. Required.
        Parameters:
        keyOcid - OCID of the key
        Returns:
        updated request
      • context

        public Encrypt.Request context​(String contextData)
        Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters. Optional.
        Parameters:
        contextData - context
        Returns:
        updated request
      • algorithm

        public Encrypt.Request algorithm​(String algorithm)
        The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. AES_256_GCM indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). RSA_OAEP_SHA_1 indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). RSA_OAEP_SHA_256 indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP. Optional, defaults to AES_256_GCM.
        Parameters:
        algorithm - algorithm to use
        Returns:
        updated request
      • keyVersionId

        public Encrypt.Request keyVersionId​(String versionOcid)
        The OCID of the key version used to encrypt the ciphertext. Optional.
        Parameters:
        versionOcid - OCID of the key version
        Returns:
        updated request