Interface KeyProvider


public interface KeyProvider
General interface for all key encryption key providers.
  • Method Details

    • encryptKey

      byte[] encryptKey(DataEncryptionKey key)
      Encrypts a data encryption key with the active key encryption key.
      Parameters:
      key - Data encryption key to encrypt.
      Returns:
      Encrypted key.
    • decryptKey

      DataEncryptionKey decryptKey(byte[] data, @Nullable @Nullable String keyIdentifier)
      Decrypts data encryption key and checks its integrity using the key encryption key specified by name.
      Parameters:
      data - Data encryption key to decrypt.
      keyIdentifier - Key encryption key identifier or null to use active key encryption key.
      Returns:
      Decrypted data encryption key.
    • getProviderIdentifier

      String getProviderIdentifier()
      Gets the key provider identifier.
      Returns:
      Key provider identifier.
    • getActiveKeyIdentifier

      String getActiveKeyIdentifier()
      Gets the active key encryption key identifier.
      Returns:
      Active key encryption key identifier.