Package com.azure.core.cryptography

Interface KeyEncryptionKey

public interface KeyEncryptionKey
A KeyEncryptionKey defines synchronous methods for encrypting and decrypting keys, also known as key wrapping and unwrapping. It also supports signing and verifying data using the configured key.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKeyId()
    Retrieves the key identifier.
    byte[]
    unwrapKey(String algorithm, byte[] encryptedKey)
    Decrypts the specified encrypted key using the specified algorithm.
    byte[]
    wrapKey(String algorithm, byte[] key)
    Encrypts the specified key using the specified algorithm.

  • Method Details

    • getKeyId

      String getKeyId()
      Retrieves the key identifier.
      Returns:
      The key identifier.

    • wrapKey

      byte[] wrapKey(String algorithm, byte[] key)
      Encrypts the specified key using the specified algorithm.
      Parameters:
      algorithm - The key wrap algorithm used to encrypt the specified key.
      key - The key content to be encrypted.
      Returns:
      The encrypted key bytes.

    • unwrapKey

      byte[] unwrapKey(String algorithm, byte[] encryptedKey)
      Decrypts the specified encrypted key using the specified algorithm.
      Parameters:
      algorithm - The key wrap algorithm which was used to encrypt the specified encrypted key.
      encryptedKey - The encrypted key content to be decrypted.
      Returns:
      The decrypted key bytes.