@azure/keyvault-keys package

A client used to perform cryptographic operations on an Azure Key vault key or a local JsonWebKey.

The KeyClient provides methods to manage KeyVaultKey in the Azure Key Vault. The client supports creating, retrieving, updating, deleting, purging, backing up, restoring and listing KeyVaultKeys. The client also supports listing DeletedKey for a soft-delete enabled Azure Key Vault.

Decryption parameters for AES-CBC encryption algorithms.

Encryption parameters for AES-CBC encryption algorithms.

Decryption parameters for AES-GCM encryption algorithms.

Encryption parameters for AES-GCM encryption algorithms.

Options for backupKey(string, BackupKeyOptions).

An interface representing the optional parameters that can be passed to beginDeleteKey(string, BeginDeleteKeyOptions)

An interface representing the optional parameters that can be passed to beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

An interface representing the optional parameters that can be passed to createEcKey(string, CreateEcKeyOptions)

An interface representing the optional parameters that can be passed to createKey(string, string, CreateKeyOptions)

An interface representing the optional parameters that can be passed to createOctKey(string, CreateOctKeyOptions)

An interface representing the optional parameters that can be passed to createRsaKey(string, CreateRsaKeyOptions)

The optional parameters accepted by the KeyVault's CryptographyClient

An interface representing the options of the cryptography API methods, go to the CryptographyClient for more information.

Options for decrypt(DecryptParameters, DecryptOptions).

Result of the decrypt(DecryptParameters, DecryptOptions) operation.

An interface representing a deleted Key Vault Key.

Options for encrypt(EncryptParameters, EncryptOptions).

Result of the encrypt(EncryptParameters, EncryptOptions) operation.

Options for getCryptographyClient.

Options for getDeletedKey(string, GetDeletedKeyOptions).

Options for getKey(string, GetKeyOptions).

Options for <xref:KeyClient.getRotationPolicy>

Options for getRandomBytes

An interface representing the optional parameters that can be passed to importKey(string, JsonWebKey, ImportKeyOptions)

As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

The optional parameters accepted by the KeyVault's KeyClient

An interface representing the optional parameters that can be passed to beginDeleteKey(string, BeginDeleteKeyOptions) and beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

An interface representing the Properties of KeyVaultKey

The policy rules under which a key can be exported.

An action and its corresponding trigger that will be performed by Key Vault over the lifetime of a key.

The complete key rotation policy that belongs to a key.

The properties of a key rotation policy that the client can set for a given key.

You may also reset the key rotation policy to its default values by setting lifetimeActions to an empty array.

An interface representing a Key Vault Key, with its name, value and KeyProperties.

Represents the segments that compose a Key Vault Key Id.

An interface representing optional parameters for KeyClient paged operations passed to listDeletedKeys(ListDeletedKeysOptions).

An interface representing optional parameters for KeyClient paged operations passed to listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

An interface representing optional parameters for KeyClient paged operations passed to listPropertiesOfKeys(ListPropertiesOfKeysOptions).

An interface that tracks the settings for paged iteration

An interface that allows async iterable iteration both to completion and by page.

PollOperationState contains an opinionated list of the smallest set of properties needed to define any long running operation poller.

While the Poller class works as the local control mechanism to start triggering, wait for, and potentially cancel a long running operation, the PollOperationState documents the status of the remote long running operation.

It should be updated at least when the operation starts, when it's finished, and when it's cancelled. Though, implementations can have any other number of properties that can be updated by other reasons.

Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.

Options for purgeDeletedKey(string, PurgeDeletedKeyOptions).

Options for releaseKey

Result of the releaseKey operation.

Options for restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Options for rotateKey

Decryption parameters for RSA encryption algorithms.

Encryption parameters for RSA encryption algorithms.

Options for sign(string, Uint8Array, SignOptions).

Result of the sign(string, Uint8Array, SignOptions) operation.

Options for unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Result of the <xref:unwrap> operation.

Options for updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Options for updateKeyRotationPolicy

Options for verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Options for verify(string, Uint8Array, Uint8Array, VerifyOptions).

Result of the verify(string, Uint8Array, Uint8Array, VerifyOptions) operation.

Options for wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Result of the <xref:wrap> operation.

A union type representing all supported AES-CBC encryption algorithms.

A union type representing all supported AES-GCM encryption algorithms.

A type representing all currently supported decryption parameters as they apply to different encryption algorithms.

Defines values for DeletionRecoveryLevel.
KnownDeletionRecoveryLevel can be used interchangeably with DeletionRecoveryLevel, this enum contains the known values that the service supports.

Known values supported by the service

Purgeable: Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)
Recoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered
Recoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered
Recoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered
CustomizedRecoverable+Purgeable: Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.
CustomizedRecoverable: Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.
CustomizedRecoverable+ProtectedSubscription: Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.

A type representing all currently supported encryption parameters as they apply to different encryption algorithms.

Defines values for JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> can be used interchangeably with JsonWebKeyEncryptionAlgorithm, this enum contains the known values that the service supports.

Known values supported by the service

RSA-OAEP
RSA-OAEP-256
RSA1_5
A128GCM
A192GCM
A256GCM
A128KW
A192KW
A256KW
A128CBC
A192CBC
A256CBC
A128CBCPAD
A192CBCPAD
A256CBCPAD

Defines values for JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> can be used interchangeably with JsonWebKeyCurveName, this enum contains the known values that the service supports.

Known values supported by the service

P-256: The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.
P-384: The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
P-521: The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.
P-256K: The SECG SECP256K1 elliptic curve.

Defines values for KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm can be used interchangeably with KeyEncryptionAlgorithm, this enum contains the known values that the service supports.

Known values supported by the service

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Defines values for JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> can be used interchangeably with JsonWebKeyOperation, this enum contains the known values that the service supports.

Known values supported by the service

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export

The action that will be executed.

Defines values for JsonWebKeyType.
<xref:KnownJsonWebKeyType> can be used interchangeably with JsonWebKeyType, this enum contains the known values that the service supports.

Known values supported by the service

EC: Elliptic Curve.
EC-HSM: Elliptic Curve with a private key which is stored in the HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA with a private key which is stored in the HSM.
oct: Octet sequence (used to represent symmetric keys)
oct-HSM: Octet sequence (used to represent symmetric keys) which is stored the HSM.

Supported algorithms for key wrapping/unwrapping

A union type representing all supported RSA encryption algorithms.

Defines values for JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> can be used interchangeably with JsonWebKeySignatureAlgorithm, this enum contains the known values that the service supports.

Known values supported by the service

PS256: RSASSA-PSS using SHA-256 and MGF1 with SHA-256, as described in https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS using SHA-384 and MGF1 with SHA-384, as described in https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS using SHA-512 and MGF1 with SHA-512, as described in https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 using SHA-256, as described in https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 using SHA-384, as described in https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 using SHA-512, as described in https://tools.ietf.org/html/rfc7518
RSNULL: Reserved
ES256: ECDSA using P-256 and SHA-256, as described in https://tools.ietf.org/html/rfc7518.
ES384: ECDSA using P-384 and SHA-384, as described in https://tools.ietf.org/html/rfc7518
ES512: ECDSA using P-521 and SHA-512, as described in https://tools.ietf.org/html/rfc7518
ES256K: ECDSA using P-256K and SHA-256, as described in https://tools.ietf.org/html/rfc7518

Known values of DeletionRecoveryLevel that the service accepts.

Known values of EncryptionAlgorithm that the service accepts.

Known values of <xref:JsonWebKeyCurveName> that the service accepts.

Known values of KeyExportEncryptionAlgorithm that the service accepts.

Known values of KeyOperation that the service accepts.

Known values of <xref:JsonWebKeyType> that the service accepts.

Known values of <xref:JsonWebKeySignatureAlgorithm> that the service accepts.

Parses the given Key Vault Key Id. An example is:

https://.vault.azure.net/keys//

On parsing the above Id, this function returns:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/keys/<key-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<key-name>"
  }