com.azure.core.cryptography.KeyEncryptionKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-core Show documentation

This package contains core types for Azure Java clients.

There is a newer version: 1.54.1

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.cryptography;

/**
 * A key which is used to synchronously encrypt, or wrap, another key.
 */
public interface KeyEncryptionKey {

    /**
     * Retrieves the key identifier.
     *
     * @return The key identifier.
     */
    String getKeyId();
    
    /**
     * Encrypts the specified key using the specified algorithm.
     *
     * @param algorithm The key wrap algorithm used to encrypt the specified key.
     * @param key The key content to be encrypted.
     * @return The encrypted key bytes.
     */
    byte[] wrapKey(String algorithm, byte[] key);

    /**
     * Decrypts the specified encrypted key using the specified algorithm.
     *
     * @param algorithm The key wrap algorithm which was used to encrypt the specified encrypted key.
     * @param encryptedKey The encrypted key content to be decrypted.
     * @return The decrypted key bytes.
     */
    byte[] unwrapKey(String algorithm, byte[] encryptedKey);
}