@azure/keyvault-keys package

Un cliente que se usa para realizar operaciones criptográficas en una clave de Azure Key Vault o en una JsonWebKey local.

KeyClient proporciona métodos para administrar keyVaultKey en Azure Key Vault. El cliente admite la creación, recuperación, actualización, eliminación, purga, copia de seguridad, restauración y enumeración de KeyVaultKeys. El cliente también admite la enumeración de DeletedKey para una instancia de Azure Key Vault habilitada para eliminación temporal.

Parámetros de descifrado para AES-CBC algoritmos de cifrado.

Parámetros de cifrado para AES-CBC algoritmos de cifrado.

Parámetros de descifrado para AES-GCM algoritmos de cifrado.

Parámetros de cifrado para AES-GCM algoritmos de cifrado.

Opciones de backupKey(string, BackupKeyOptions).

Interfaz que representa los parámetros opcionales que se pueden pasar a beginDeleteKey(string, BeginDeleteKeyOptions)

Interfaz que representa los parámetros opcionales que se pueden pasar a beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Interfaz que representa los parámetros opcionales que se pueden pasar a createEcKey(string, CreateEcKeyOptions)

Interfaz que representa los parámetros opcionales que se pueden pasar a createKey(string, string, CreateKeyOptions)

Interfaz que representa los parámetros opcionales que se pueden pasar a createOctKey(string, CreateOctKeyOptions)

Interfaz que representa los parámetros opcionales que se pueden pasar a createRsaKey(string, CreateRsaKeyOptions)

Los parámetros opcionales aceptados por el CryptographyClient de KeyVault

Una interfaz que representa las opciones de los métodos de la API de criptografía, vaya al cryptographyClient de para obtener más información.

Opciones de decrypt(DecryptParameters, DecryptOptions).

Resultado de la operación de decrypt(DecryptParameters, DecryptOptions).

Interfaz que representa una clave de Key Vault eliminada.

Opciones de encrypt(EncryptParameters, EncryptOptions).

Resultado de la operación de encrypt(EncryptParameters, EncryptOptions).

Opciones de getCryptographyClient.

Opciones de getDeletedKey(string, GetDeletedKeyOptions).

Opciones de getKeyAttestation(string, GetKeyAttestationOptions).

Opciones de getKey(string, GetKeyOptions).

Opciones de <xref:KeyClient.getRotationPolicy>

Opciones para getRandomBytes

Interfaz que representa los parámetros opcionales que se pueden pasar a importKey(string, JsonWebKey, ImportKeyOptions)

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

Interfaz que representa las propiedades de la atestación de una clave

Los parámetros opcionales aceptados por KeyVault KeyClient

Interfaz que representa los parámetros opcionales que se pueden pasar a beginDeleteKey(string, BeginDeleteKeyOptions) y beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Interfaz que representa las propiedades de keyVaultKey

Reglas de directiva en las que se puede exportar una clave.

Una acción y su desencadenador correspondiente que realizará Key Vault durante la vigencia de una clave.

Directiva de rotación de claves completa que pertenece a una clave.

Propiedades de una directiva de rotación de claves que el cliente puede establecer para una clave determinada.

También puede restablecer la directiva de rotación de claves a sus valores predeterminados estableciendo lifetimeActions en una matriz vacía.

Interfaz que representa una clave de Key Vault, con su nombre, valor y KeyProperties.

Representa los segmentos que componen un identificador de clave de Key Vault.

Interfaz que representa parámetros opcionales para las operaciones paginadas keyClient pasadas a listDeletedKeys(ListDeletedKeysOptions).

Interfaz que representa parámetros opcionales para las operaciones paginadas keyClient pasadas a listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

Interfaz que representa parámetros opcionales para las operaciones paginadas keyClient pasadas a listPropertiesOfKeys(ListPropertiesOfKeysOptions).

Interfaz que realiza un seguimiento de la configuración de la iteración paginada

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

PollOperationState contiene una lista con opiniones del conjunto más pequeño de propiedades necesarias para definir cualquier sondeo de operación de larga duración.

Aunque la clase Poller funciona como mecanismo de control local para iniciar el desencadenamiento, esperar y cancelar potencialmente una operación de larga duración, PollOperationState documenta el estado de la operación remota de larga duración.

Debe actualizarse al menos cuando se inicia la operación, cuando termine y cuando se cancele. Sin embargo, las implementaciones pueden tener cualquier otro número de propiedades que se puedan actualizar por otros motivos.

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.

Opciones de purgeDeletedKey(string, PurgeDeletedKeyOptions).

Opciones de releaseKey

Resultado de la operación de releaseKey.

Opciones de restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Opciones para rotateKey

Parámetros de descifrado para algoritmos de cifrado RSA.

Parámetros de cifrado para algoritmos de cifrado RSA.

Opciones de sign(string, Uint8Array, SignOptions).

Resultado de la operación de sign(string, Uint8Array, SignOptions).

Opciones de unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Resultado de la operación de <xref:unwrap>.

Opciones de updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Opciones de updateKeyRotationPolicy

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

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

Resultado de la operación de verify(string, Uint8Array, Uint8Array, VerifyOptions).

Opciones de wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Resultado de la operación de <xref:wrap>.

Tipo de unión que representa todos los algoritmos de cifrado de AES-CBC admitidos.

Tipo de unión que representa todos los algoritmos de cifrado de AES-GCM admitidos.

Tipo que representa todos los parámetros de descifrado admitidos actualmente a medida que se aplican a diferentes algoritmos de cifrado.

Refleja el nivel de recuperación de eliminación actualmente en vigor para los certificados del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el certificado; De lo contrario, solo el sistema puede purgar el certificado al final del intervalo de retención.
KnownDeletionRecoveryLevel se puede usar indistintamente con DeletionRecoveryLevel, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

purgable: denota un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; los datos se pierden irrecuperablemente al aceptar una operación De eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.).
recuperable+Purgable: denota un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
recuperables: denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
recuperable+ProtectedSubscription: indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar en el intervalo de retención (90 días), no se permite la eliminación inmediata y permanente (es decir, purga) y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
CustomizedRecoverable+Purgeable: denota un estado de almacén en el que se puede recuperar la eliminación y, además, permite la eliminación inmediata y permanente (es decir, purgar cuando 7 <= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción.
CustomdRecoverable: denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purgar cuando 7 <= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible.
CustomizedRecoverable+ProtectedSubscription: indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, purga) no se permite y en la que la propia suscripción no se puede cancelar permanentemente cuando 7 <= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción.

Tipo que representa todos los parámetros de cifrado admitidos actualmente a medida que se aplican a diferentes algoritmos de cifrado.

Algoritmo usado para el cifrado y el descifrado.
<xref:KnownJsonWebKeyEncryptionAlgorithm> se puede usar indistintamente con JsonWebKeyEncryptionAlgorithm, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

RSA-OAEP: RSAES [No recomendado] mediante relleno óptimo de cifrado asimétrico (OAEP), como se describe en https://tools.ietf.org/html/rfc3447, con los parámetros predeterminados especificados por RFC 3447 en la sección A.2.1. Estos parámetros predeterminados utilizan una función hash de SHA-1 y una función de generación de máscara de MGF1 con SHA-1. Microsoft recomienda usar RSA_OAEP_256 o algoritmos más seguros para mejorar la seguridad. Microsoft no recomienda RSA_OAEP, que se incluye únicamente para la compatibilidad con versiones anteriores. RSA_OAEP utiliza SHA1, que tiene problemas de colisión conocidos.
RSA-OAEP-256: RSAES mediante el relleno óptimo de cifrado asimétrico con una función hash de SHA-256 y una función de generación de máscaras de MGF1 con SHA-256.
RSA1_5: [No recomendado] RSAES-PKCS1-V1_5 cifrado de claves, como se describe en https://tools.ietf.org/html/rfc3447. Microsoft recomienda usar RSA_OAEP_256 o algoritmos más seguros para mejorar la seguridad. Microsoft no recomienda RSA_1_5, que se incluye únicamente para la compatibilidad con versiones anteriores. Los estándares criptográficos ya no consideran RSA con el esquema de relleno PKCS#1 v1.5 seguro para el cifrado.
A128GCM: AES-GCM de 128 bits.
A192GCM: AES-GCM de 192 bits.
A256GCM: AES-GCM de 256 bits.
A128KW: encapsulado de teclas AES de 128 bits.
A192KW: encapsulado de teclas AES de 192 bits.
A256KW: encapsulado de teclas AES de 256 bits.
A128CBC: AES-CBC de 128 bits.
A192CBC: AES-CBC de 192 bits.
A256CBC: AES-CBC de 256 bits.
A128CBCPAD: AES-CBC de 128 bits con relleno PKCS.
A192CBCPAD: AES-CBC de 192 bits con relleno PKCS.
A256CBCPAD: AES-CBC de 256 bits con relleno PKCS.
CKM_AES_KEY_WRAP: encapsulado de teclas AES de CKM.
CKM_AES_KEY_WRAP_PAD: encapsulado de teclas AES CKM con relleno.

Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> se puede usar indistintamente con JsonWebKeyCurveName, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

P-256: la curva elíptica NIST P-256, la curva AKA SECG SECP256R1.
P-384: curva elíptica NIST P-384, curva AKA SECG SECP384R1.
P-521: curva elíptica NIST P-521, curva AKA SECG SECP521R1.
P-256K: curva elíptica SECG SECP256K1.

Define valores para KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm se puede usar indistintamente con KeyEncryptionAlgorithm, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Operaciones de clave web JSON. Para más información, consulte JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> se puede usar indistintamente con JsonWebKeyOperation, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

cifrar: indica que la clave se puede usar para cifrar.
descifrar: indica que se puede usar la clave para descifrar.
signo: indica que se puede usar la clave para firmar.
comprobar: indica que se puede usar la clave para comprobar.
wrapKey: indica que la clave se puede usar para encapsular otra clave.
unwrapKey: indica que la clave se puede usar para desencapsular otra clave.
importar: indica que la clave se puede importar durante la creación.
exportación: indica que se puede exportar el componente privado de la clave.

Acción que se ejecutará.

Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
<xref:KnownJsonWebKeyType> se puede usar indistintamente con JsonWebKeyType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

EC: Curva elíptica.
EC-HSM: Curva elíptica con una clave privada que se almacena en el HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA con una clave privada que se almacena en el HSM.
oct: secuencia octeto (usada para representar claves simétricas)
oct-HSM: secuencia octeto (usada para representar claves simétricas) que se almacena el HSM.

Algoritmos admitidos para el ajuste o desencapsulado de claves

Tipo de unión que representa todos los algoritmos de cifrado RSA admitidos.

Identificador del algoritmo de firma y comprobación. Para obtener más información sobre los posibles tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> se puede usar indistintamente con JsonWebKeySignatureAlgorithm, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

PS256: RSASSA-PSS usando SHA-256 y MGF1 con SHA-256, tal como se describe en https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS usando SHA-384 y MGF1 con SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS usando SHA-512 y MGF1 con SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 mediante SHA-256, como se describe en https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 mediante SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 mediante SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
HS256: HMAC con SHA-256, como se describe en https://tools.ietf.org/html/rfc7518
HS384: HMAC con SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
HS512: HMAC con SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
RSNULL: Reservado
ES256: ECDSA con P-256 y SHA-256, tal como se describe en https://tools.ietf.org/html/rfc7518.
ES384: ECDSA con P-384 y SHA-384, como se describe en https://tools.ietf.org/html/rfc7518
ES512: ECDSA con P-521 y SHA-512, como se describe en https://tools.ietf.org/html/rfc7518
ES256K : ECDSA con P-256K y SHA-256, tal como se describe en https://tools.ietf.org/html/rfc7518

Refleja el nivel de recuperación de eliminación actualmente en vigor para los certificados del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el certificado; De lo contrario, solo el sistema puede purgar el certificado al final del intervalo de retención.

Algoritmo usado para el cifrado y el descifrado.

Nombre de la curva elíptica. Para obtener valores válidos, consulte JsonWebKeyCurveName.

Algoritmo de cifrado que se va a usar para proteger el material de clave exportado

Los valores conocidos de KeyOperation que acepta el servicio.

Tipo de clave JsonWebKey (kty), tal como se define en https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Identificador del algoritmo de firma y comprobación. Para obtener más información sobre los posibles tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.

Analiza el identificador de clave de Key Vault especificado. Un ejemplo es:

https://< nombre-de-almacén-de-clave.vault.azure.net/keys/>< nombre-de-clave>/<id-de-versión-única>

Al analizar el identificador anterior, esta función devuelve:

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