@azure/keyvault-keys package

Un client utilisé pour effectuer des opérations de chiffrement sur une clé Azure Key Vault ou une JsonWebKey locale.

KeyClient fournit des méthodes pour gérer KeyVaultKey dans Azure Key Vault. 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 des DeletedKey pour une suppression réversible d’Azure Key Vault.

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

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

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

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

Options de backupKey(string, BackupKeyOptions).

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

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

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

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

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

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

Paramètres facultatifs acceptés par le CryptographyClient du Coffre de clés

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

Options de decrypt(DecryptParameters, DecryptOptions).

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

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

Options de encrypt(EncryptParameters, EncryptOptions).

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

Options pour getCryptographyClient.

Options de getDeletedKey(string, GetDeletedKeyOptions).

Options de getKeyAttestation(string, GetKeyAttestationOptions).

Options de getKey(string, GetKeyOptions).

Options de <xref:KeyClient.getRotationPolicy>

Options pour getRandomBytes

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

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

Interface représentant les propriétés de l’attestation d’une clé

Paramètres facultatifs acceptés par keyClient de KeyVault

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

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

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

Action et son déclencheur correspondant qui seront effectués par Key Vault au cours de la durée de vie d’une clé.

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

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éinitialiser la stratégie de rotation de clé à ses valeurs par défaut en définissant lifetimeActions sur un tableau vide.

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

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

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

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

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

Interface qui suit les paramètres de l’itération paginée

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

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

Bien 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, PollOperationState documente l’état de l’opération de longue durée distante.

Elle doit être mise à jour au moins au démarrage de l’opération, quand elle est terminée et quand elle est annulée. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour par d’autres raisons.

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

Options de purgeDeletedKey(string, PurgeDeletedKeyOptions).

Options pour releaseKey

Résultat de l’opération releaseKey .

Options de restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Options pour rotationKey

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

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

Options de sign(string, Uint8Array, SignOptions).

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

Options de unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

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

Options de updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Options de updateKeyRotationPolicy

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

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

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

Options de wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

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

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

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

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

Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à la fin de l’intervalle de rétention.
KnownDeletionRecoveryLevel pouvez être utilisé de manière interchangeable 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 irréversible, sans possibilité de récupération. Ce niveau correspond à aucune protection disponible contre une opération De suppression ; les données sont irrécupérablement perdues lors de l’acceptation d’une opération Delete au niveau de l’entité ou supérieure (coffre, groupe de ressources, abonnement, etc.)
récupérable+purgeable: indique 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). 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 vidage est demandée ou si l’abonnement est annulé. Le système le supprime 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 purger). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention (90 jours) et pendant que l’abonnement est toujours disponible. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré
récupérable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable dans l’intervalle de rétention (90 jours), la suppression immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée, et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement. Le système le supprime définitivement après 90 jours, s’il n’est pas récupéré
CustomRecoverable+Purgeable: indique 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 lorsque 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 vidage est demandée ou si l’abonnement est annulé.
CustomRecoverable: indique un état de coffre dans lequel la suppression est récupérable sans possibilité de suppression immédiate et définitive (c’est-à-dire purger lorsque 7 <= SoftDeleteRetentionInDays < 90). Ce niveau garantit la récupération de l’entité supprimée pendant l’intervalle de rétention et pendant la disponibilité de l’abonnement.
CustomRecoverable+ProtectedSubscription: indique un coffre et un état d’abonnement dans lequel la suppression est récupérable, immédiate et définitive (c’est-à-dire la suppression définitive) n’est pas autorisée et dans laquelle l’abonnement lui-même ne peut pas être annulé définitivement lorsque 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é.

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

Algorithme utilisé pour le chiffrement et le déchiffrement.
<xref:KnownJsonWebKeyEncryptionAlgorithm> pouvez être utilisé de manière interchangeable 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: [Non recommandé] RSAES à l’aide du remplissage de chiffrement asymétrique optimal (OAEP), comme décrit dans https://tools.ietf.org/html/rfc3447, avec les paramètres par défaut spécifiés par RFC 3447 dans la section A.2.1. Ces paramètres par défaut utilisent une fonction de hachage de SHA-1 et une fonction de génération de masque de MGF1 avec SHA-1. Microsoft recommande d’utiliser des algorithmes RSA_OAEP_256 ou plus forts pour une sécurité renforcée. Microsoft ne pas recommander RSA_OAEP, qui est inclus uniquement pour la compatibilité descendante. RSA_OAEP utilise SHA1, qui présente des problèmes de collision connus.
RSA-OAEP-256: RSAES à l’aide d’un remplissage de chiffrement asymétrique optimal avec une fonction de hachage SHA-256 et une fonction de génération de masque de MGF1 avec SHA-256.
RSA1_5: [Non recommandé] RSAES - chiffrement de cléPKCS1-V1_5, comme décrit dans https://tools.ietf.org/html/rfc3447. Microsoft recommande d’utiliser des algorithmes RSA_OAEP_256 ou plus forts pour une sécurité renforcée. Microsoft ne pas recommander RSA_1_5, qui est inclus uniquement pour la compatibilité descendante. Les normes de chiffrement ne prennent plus en compte RSA avec le schéma de remplissage PKCS#1 v1.5 sécurisé pour le chiffrement.
A128GCM: AES-GCM 128 bits.
A192GCM: AES-GCM 192 bits.
A256GCM: AES-GCM 256 bits.
A128KW: 128 bits AES clé wrap.
A192KW: 192 bits AES clé wrap.
A256KW: 256 bits de clé AES wrap.
A128CBC: AES-CBC 128 bits.
A192CBC: AES-CBC 192 bits.
A256CBC: AES-CBC 256 bits.
A128CBCPAD: AES-CBC 128 bits avec remplissage PKCS.
A192CBCPAD: AES-CBC 192 bits avec remplissage PKCS.
A256CBCPAD: AES-CBC 256 bits avec remplissage PKCS.
CKM_AES_KEY_WRAP: habillage de clé AES CKM.
CKM_AES_KEY_WRAP_PAD: habillage de touche AES CKM avec remplissage.

Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> pouvez être utilisé de manière interchangeable 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, courbe AKA SCG SECP256R1.
P-384: courbe elliptique NIST P-384, courbe AKA SCG SECP384R1.
P-521: courbe elliptique NIST P-521, courbe AKA SCG SECP521R1.
P-256K : la courbe elliptique SECP256K1 SCG.

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

Opérations de clé web JSON. Pour plus d’informations, consultez JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> pouvez être utilisé de manière interchangeable avec JsonWebKeyOperation, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

chiffrer: indique que la clé peut être utilisée pour chiffrer.
déchiffrer: indique que la clé peut être utilisée pour déchiffrer.
signe: indique que la clé peut être utilisée pour signer.
vérifier: indique que la clé peut être utilisée pour vérifier.
wrapKey: indique que la clé peut être utilisée pour encapsuler une autre clé.
unwrapKey: indique que la clé peut être utilisée pour décompresser une autre clé.
importer: indique que la clé peut être importée lors de la création.
exporter: indique que le composant privé de la clé peut être exporté.

Action qui sera exécutée.

Type de clé JsonWebKey (kty), tel que défini dans https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
<xref:KnownJsonWebKeyType> pouvez être utilisé de manière interchangeable 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.

Algorithmes pris en charge pour le wrapping/unwrapping de clé

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

Identificateur de l’algorithme de signature/vérification. Pour plus d’informations sur les types d’algorithmes possibles, consultez JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> pouvez être utilisé de manière interchangeable 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 à l’aide de SHA-256 et MGF1 avec SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
PS384 : RSASSA-PSS à l’aide de SHA-384 et MGF1 avec SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
PS512 : RSASSA-PSS à l’aide de 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
HS256 : HMAC à l’aide de SHA-256, comme décrit dans https://tools.ietf.org/html/rfc7518
HS384 : HMAC à l’aide de SHA-384, comme décrit dans https://tools.ietf.org/html/rfc7518
HS512 : HMAC à 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

Reflète le niveau de récupération de suppression actuellement en vigueur pour les certificats dans le coffre actuel. S’il contient « Purgeable », le certificat peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut vider le certificat, à la fin de l’intervalle de rétention.

Algorithme utilisé pour le chiffrement et le déchiffrement.

Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName.

Algorithme de chiffrement à utiliser pour protéger le matériel de clé exporté

Valeurs connues de KeyOperation que le service accepte.

Type de clé JsonWebKey (kty), tel que défini dans https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Identificateur de l’algorithme de signature/vérification. Pour plus d’informations sur les types d’algorithmes possibles, consultez JsonWebKeySignatureAlgorithm.

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

https://< nom-keyvault.vault.azure.net/keys/<> nom-clé>/<id-version-unique>

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