Partager via

@azure/keyvault-keys package

  • Référence

Classes

CryptographyClient

Client utilisé pour effectuer des opérations de chiffrement sur une clé Azure Key Vault ou un JsonWebKey local.
KeyClient

KeyClient fournit des méthodes pour gérer KeyVaultKey dans le Key Vault Azure. Le client prend en charge la création, la récupération, la mise à jour, la suppression, la purge, la sauvegarde, la restauration et la liste des KeyVaultKeys. Le client prend également en charge la liste DeletedKey pour une Key Vault Azure avec suppression réversible.

Interfaces

AesCbcDecryptParameters

Paramètres de déchiffrement pour les algorithmes de chiffrement AES-CBC.
AesCbcEncryptParameters

Paramètres de chiffrement pour les algorithmes de chiffrement AES-CBC.
AesGcmDecryptParameters

Paramètres de déchiffrement pour les algorithmes de chiffrement AES-GCM.
AesGcmEncryptParameters

Paramètres de chiffrement pour les algorithmes de chiffrement AES-GCM.
BackupKeyOptions

Options pour backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions

Paramètres facultatifs acceptés par le chiffrementClient de KeyVault
CryptographyOptions

Interface représentant les options des méthodes d’API de chiffrement, accédez à CryptographyClient pour plus d’informations.
DecryptOptions

Options pour decrypt(DecryptParameters, DecryptOptions).
DecryptResult

Résultat de l’opération decrypt(DecryptParameters, DecryptOptions) .
DeletedKey

Interface représentant une clé de Key Vault supprimée.
EncryptOptions

Options pour encrypt(EncryptParameters, EncryptOptions).
EncryptResult

Résultat de l’opération encrypt(EncryptParameters, EncryptOptions) .
GetCryptographyClientOptions

Options pour getCryptographyClient.
GetDeletedKeyOptions

Options pour getDeletedKey(string, GetDeletedKeyOptions).
GetKeyOptions

Options pour getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions

Options pour <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions

Options pour getRandomBytes
ImportKeyOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à importKey(string, JsonWebKey_2, ImportKeyOptions)
JsonWebKey

À partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyClientOptions

Paramètres facultatifs acceptés par le KeyClient de KeyVault
KeyPollerOptions

Interface représentant les paramètres facultatifs qui peuvent être passés à beginDeleteKey(string, BeginDeleteKeyOptions) et beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties

Interface représentant les propriétés de KeyVaultKey
KeyReleasePolicy

Règles de stratégie selon lesquelles une clé peut être exportée.
KeyRotationLifetimeAction

Une action et son déclencheur correspondant qui seront exécutés par Key Vault sur la durée de vie d’une clé.
KeyRotationPolicy

Stratégie de rotation de clé complète qui appartient à une clé.
KeyRotationPolicyProperties

Propriétés d’une stratégie de rotation de clé que le client peut définir pour une clé donnée.

Vous pouvez également rétablir les valeurs par défaut de la stratégie de rotation des clés en définissant lifetimeActions sur un tableau vide.
KeyVaultKey

Interface représentant une clé Key Vault, avec son nom, sa valeur et keyproperties.
KeyVaultKeyIdentifier

Représente les segments qui composent un ID de clé Key Vault.
ListDeletedKeysOptions

Interface représentant des paramètres facultatifs pour les opérations paginées KeyClient passées à listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions

Interface représentant des paramètres facultatifs pour les opérations paginées KeyClient passées à listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions

Interface représentant des paramètres facultatifs pour les opérations paginées KeyClient passées à listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings

Interface qui effectue le suivi des paramètres de l’itération paginée
PagedAsyncIterableIterator

Interface qui permet l’itération asynchrone itérable à la fois à l’achèvement et par page.
PollOperationState

PollOperationState contient une liste avisée du plus petit ensemble de propriétés nécessaire pour définir un pollueur d’opérations de longue durée.

Alors que la classe Poller fonctionne comme mécanisme de contrôle local pour démarrer le déclenchement, attendre et éventuellement annuler une opération de longue durée, l’état PollOperationState documente l’état de l’opération distante de longue durée.

Elle doit être mise à jour au moins au démarrage de l’opération, à sa fin et à son annulation. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour pour d’autres raisons.
PollerLike

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.
PurgeDeletedKeyOptions

Options pour purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions

Options de releaseKey
ReleaseKeyResult

Résultat de l’opération releaseKey .
RestoreKeyBackupOptions

Options pour restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions

Options de rotateKey
RsaDecryptParameters

Paramètres de déchiffrement pour les algorithmes de chiffrement RSA.
RsaEncryptParameters

Paramètres de chiffrement pour les algorithmes de chiffrement RSA.
SignOptions

Options pour sign(string, Uint8Array, SignOptions).
SignResult

Résultat de l’opération sign(string, Uint8Array, SignOptions) .
UnwrapKeyOptions

Options pour unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult

Résultat de l’opération <xref:unwrap> .
UpdateKeyPropertiesOptions

Options pour updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions

Options de updateKeyRotationPolicy
VerifyDataOptions

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

Options pour verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult

Résultat de l’opération verify(string, Uint8Array, Uint8Array, VerifyOptions) .
WrapKeyOptions

Options pour wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult

Résultat de l’opération <xref:wrap> .

Alias de type

AesCbcEncryptionAlgorithm

Type d’union représentant tous les algorithmes de chiffrement AES-CBC pris en charge.
AesGcmEncryptionAlgorithm

Type d’union représentant tous les algorithmes de chiffrement AES-GCM pris en charge.
DecryptParameters

Type représentant tous les paramètres de déchiffrement actuellement pris en charge, car ils s’appliquent à différents algorithmes de chiffrement.
DeletionRecoveryLevel

Définit des valeurs pour DeletionRecoveryLevel.
KnownDeletionRecoveryLevel peut être utilisé indifféremment avec DeleteRecoveryLevel. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Purgeable : désigne un état de coffre dans lequel la suppression est une opération irréversible, sans possibilité de récupération. Ce niveau correspond à l’absence de protection disponible contre une opération de suppression ; les données sont irrémédiablement perdues lors de l’acceptation d’une opération de suppression au niveau de l’entité ou au niveau supérieur (coffre, groupe de ressources, abonnement, etc.)
Récupérable+Purgeable : désigne un état de coffre dans lequel la suppression est récupérable et qui permet également une suppression immédiate et définitive (par exemple, purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours), sauf si une opération de purge est demandée ou si l’abonnement est annulé. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Récupérable : désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire une purge). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et tant que l’abonnement est toujours disponible. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
Récupérable+ProtectedSubscription : désigne un état de coffre et d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et permanente (c’est-à-dire la purge) n’est pas autorisée et dans lequel l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprimera définitivement après 90 jours, s’il n’est pas récupéré
CustomizedRecoverable+Purgeable : désigne un état de coffre dans lequel la suppression est récupérable et qui permet également une suppression immédiate et définitive (c’est-à-dire, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention, sauf si une opération de purge est demandée ou si l’abonnement est annulé.
CustomRecoverable : désigne un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (par exemple, purger quand 7<= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et tant que l’abonnement est toujours disponible.
CustomizedRecoverable+ProtectedSubscription : désigne un coffre et un état d’abonnement dans lequel la suppression est récupérable, la suppression immédiate et permanente (c’est-à-dire la purge) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement quand 7<= SoftDeleteRetentionInDays < 90. Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et reflète également le fait que l’abonnement lui-même ne peut pas être annulé.
EncryptParameters

Type représentant tous les paramètres de chiffrement actuellement pris en charge, car ils s’appliquent à différents algorithmes de chiffrement.
EncryptionAlgorithm

Définit des valeurs pour JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> peut être utilisé indifféremment avec JsonWebKeyEncryptionAlgorithm, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

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

Définit des valeurs pour JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> peut être utilisé indifféremment avec JsonWebKeyCurveName, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

P-256 : courbe elliptique NIST P-256, AKA courbe SECG SECP256R1.
P-384 : courbe elliptique NIST P-384, AKA courbe SECG SECP384R1.
P-521 : courbe elliptique NIST P-521, AKA courbe SECG SECP521R1.
P-256K : courbe elliptique SECG SECP256K1.
KeyExportEncryptionAlgorithm

Définit des valeurs pour KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm peut être utilisé de manière interchangeable avec KeyEncryptionAlgorithm. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384
KeyOperation

Définit des valeurs pour JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> peut être utilisé indifféremment avec JsonWebKeyOperation. Cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export
KeyRotationPolicyAction

Action qui sera exécutée.
KeyType

Définit des valeurs pour JsonWebKeyType.
<xref:KnownJsonWebKeyType> peut être utilisé indifféremment avec JsonWebKeyType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

EC : courbe elliptique.
EC-HSM : courbe elliptique avec une clé privée stockée dans le HSM.
RSA : RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM : RSA avec une clé privée stockée dans le HSM.
oct : séquence d’octets (utilisée pour représenter des clés symétriques)
oct-HSM : séquence d’octets (utilisée pour représenter des clés symétriques) qui est stockée le HSM.
KeyWrapAlgorithm

Algorithmes pris en charge pour l’habillage/désencapsulation de clé
RsaEncryptionAlgorithm

Type d’union représentant tous les algorithmes de chiffrement RSA pris en charge.
SignatureAlgorithm

Définit des valeurs pour JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> peut être utilisé indifféremment avec JsonWebKeySignatureAlgorithm, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

PS256 : RSASSA-PSS utilisant SHA-256 et MGF1 avec SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
PS384 : RSASSA-PSS utilisant SHA-384 et MGF1 avec SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
PS512 : RSASSA-PSS utilisant SHA-512 et MGF1 avec SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518
RS256 : RSASSA-PKCS1-v1_5 à l’aide de SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
RS384 : RSASSA-PKCS1-v1_5 à l’aide de SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
RS512 : RSASSA-PKCS1-v1_5 à l’aide de SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518
RSNULL : Réservé
ES256 : ECDSA utilisant P-256 et SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518.
ES384 : ECDSA utilisant P-384 et SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
ES512 : ECDSA utilisant P-521 et SHA-512, comme décrit dans https://tools.ietf.org/html/rfc7518
ES256K : ECDSA utilisant P-256K et SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518

Énumérations

KnownDeletionRecoveryLevel

Valeurs connues de DeletionRecoveryLevel que le service accepte.
KnownEncryptionAlgorithms

Valeurs connues de EncryptionAlgorithm que le service accepte.
KnownKeyCurveNames

Valeurs connues que <xref:JsonWebKeyCurveName> le service accepte.
KnownKeyExportEncryptionAlgorithm

Valeurs connues de KeyExportEncryptionAlgorithm que le service accepte.
KnownKeyOperations

Valeurs connues de KeyOperation que le service accepte.
KnownKeyTypes

Valeurs connues que <xref:JsonWebKeyType> le service accepte.
KnownSignatureAlgorithms

Valeurs connues que <xref:JsonWebKeySignatureAlgorithm> le service accepte.

Functions

parseKeyVaultKeyIdentifier(string)

Analyse l’ID de clé de Key Vault donné. Voici un exemple :

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

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

  {
     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>"
  }

Informations relatives à la fonction

parseKeyVaultKeyIdentifier(string)

Analyse l’ID de clé de Key Vault donné. Voici un exemple :

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

Lors de l’analyse de l’ID ci-dessus, cette fonction retourne :

  {
     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>"
  }

function parseKeyVaultKeyIdentifier(id: string): KeyVaultKeyIdentifier

Paramètres

id

string

ID de la clé Key Vault.

Retours

KeyVaultKeyIdentifier