@azure/keyvault-keys package

Um cliente usado para executar operações criptográficas em uma chave do Azure Key Vault ou em um JsonWebKey local.

O KeyClient fornece métodos para gerenciar KeyVaultKey no Key Vault do Azure. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem de KeyVaultKeys. O cliente também dá suporte à listagem de DeletedKey para uma Key Vault do Azure habilitada para exclusão reversível.

Parâmetros de descriptografia para algoritmos de criptografia AES-CBC.

Parâmetros de criptografia para algoritmos de criptografia AES-CBC.

Parâmetros de descriptografia para algoritmos de criptografia AES-GCM.

Parâmetros de criptografia para algoritmos de criptografia AES-GCM.

Opções para backupKey(string, BackupKeyOptions).

Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteKey(string, BeginDeleteKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para createEcKey(string, CreateEcKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para createKey(string, string, CreateKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para createOctKey(string, CreateOctKeyOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para createRsaKey(string, CreateRsaKeyOptions)

Os parâmetros opcionais aceitos pela CryptographyClient do KeyVault

Uma interface que representa as opções dos métodos de API de criptografia, acesse CryptographyClient para obter mais informações.

Opções para decrypt(DecryptParameters, DecryptOptions).

Resultado da decrypt(DecryptParameters, DecryptOptions) operação.

Uma interface que representa uma chave de Key Vault excluída.

Opções para encrypt(EncryptParameters, EncryptOptions).

Resultado da encrypt(EncryptParameters, EncryptOptions) operação.

Opções para getCryptographyClient.

Opções para getDeletedKey(string, GetDeletedKeyOptions).

Opções para getKey(string, GetKeyOptions).

Opções para <xref:KeyClient.getRotationPolicy>

Opções para getRandomBytes

Uma interface que representa os parâmetros opcionais que podem ser passados para importKey(string, JsonWebKey_2, ImportKeyOptions)

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

Os parâmetros opcionais aceitos pelo KeyClient do KeyVault

Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteKey(string, BeginDeleteKeyOptions) e beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Uma interface que representa as propriedades de KeyVaultKey

As regras de política sob as quais uma chave pode ser exportada.

Uma ação e seu gatilho correspondente que serão executados por Key Vault ao longo do tempo de vida de uma chave.

A política de rotação de chave completa que pertence a uma chave.

As propriedades de uma política de rotação de chave que o cliente pode definir para uma determinada chave.

Você também pode redefinir a política de rotação de chaves para seus valores padrão definindo lifetimeActions como uma matriz vazia.

Uma interface que representa uma chave Key Vault, com seu nome, valor e KeyProperties.

Representa os segmentos que compõem uma ID de chave Key Vault.

Uma interface que representa parâmetros opcionais para operações paginadas keyClient passadas para listDeletedKeys(ListDeletedKeysOptions).

Uma interface que representa parâmetros opcionais para operações paginadas keyClient passadas para listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

Uma interface que representa parâmetros opcionais para operações paginadas keyClient passadas para listPropertiesOfKeys(ListPropertiesOfKeysOptions).

Uma interface que rastreia as configurações de iteração paginada

Uma interface que permite iteração iterável assíncrona para conclusão e por página.

PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessário para definir qualquer sondador de operação de execução prolongada.

Enquanto a classe Poller funciona como o mecanismo de controle local para começar a disparar, aguardar e potencialmente cancelar uma operação de execução longa, o PollOperationState documenta o status da operação de execução longa remota.

Ela deve ser atualizada pelo menos quando a operação for iniciada, quando for concluída e quando for cancelada. No entanto, as implementações podem ter qualquer outro número de propriedades que possam ser atualizadas por outros motivos.

Representação abstrata de um sondador, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.

Opções para purgeDeletedKey(string, PurgeDeletedKeyOptions).

Opções para releaseKey

Resultado da operação releaseKey .

Opções para restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Opções para rotateKey

Parâmetros de descriptografia para algoritmos de criptografia RSA.

Parâmetros de criptografia para algoritmos de criptografia RSA.

Opções para sign(string, Uint8Array, SignOptions).

Resultado da sign(string, Uint8Array, SignOptions) operação.

Opções para unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Resultado da <xref:unwrap> operação.

Opções para updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Opções para updateKeyRotationPolicy

Opções para verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Opções para verify(string, Uint8Array, Uint8Array, VerifyOptions).

Resultado da verify(string, Uint8Array, Uint8Array, VerifyOptions) operação.

Opções para wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Resultado da <xref:wrap> operação.

Um tipo de união que representa todos os algoritmos de criptografia AES-CBC com suporte.

Um tipo de união que representa todos os algoritmos de criptografia AES-GCM com suporte.

Um tipo que representa todos os parâmetros de descriptografia com suporte no momento conforme eles se aplicam a diferentes algoritmos de criptografia.

Define valores para DeletionRecoveryLevel.
KnownDeletionRecoveryLevel pode ser usado intercambiável com DeletionRecoveryLevel, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Purgável: indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação Delete no nível da entidade ou superior (cofre, grupo de recursos, assinatura etc.)
Recuperável+Purgável: indica um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recuperável: indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription: indica um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable: indica um estado de cofre no qual a exclusão é recuperável e que também permite exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada.
CustomizedRecoverable: indica um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7<= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda está disponível.
CustomizedRecoverable+ProtectedSubscription: indica um cofre e um estado de assinatura no qual a exclusão é recuperável, exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a própria assinatura não pode ser cancelada.

Um tipo que representa todos os parâmetros de criptografia com suporte no momento conforme eles se aplicam a algoritmos de criptografia diferentes.

Define valores para JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> pode ser usado intercambiável com JsonWebKeyEncryptionAlgorithm, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

Define valores para JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> pode ser usado de forma intercambiável com JsonWebKeyCurveName, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

P-256: a curva elíptica NIST P-256, também conhecida como curva SECG SECP256R1.
P-384: a curva elíptica NIST P-384, também conhecida como curva SECG SECP384R1.
P-521: a curva elíptica NIST P-521, também conhecida como curva SECG SECP521R1.
P-256K: a curva elíptica SECP256K1 secg.

Define valores para KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm pode ser usado de forma intercambiável com KeyEncryptionAlgorithm, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Define valores para JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> pode ser usado intercambiável com JsonWebKeyOperation, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

encrypt
decrypt
sign
verify
wrapKey
unwrapKey
import
export

A ação que será executada.

Define valores para JsonWebKeyType.
<xref:KnownJsonWebKeyType> pode ser usado de forma intercambiável com JsonWebKeyType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

EC: curva elíptica.
EC-HSM: curva elíptica com uma chave privada armazenada no HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA com uma chave privada que é armazenada no HSM.
oct: Sequência de octeto (usada para representar chaves simétricas)
oct-HSM: sequência de octeto (usada para representar chaves simétricas) que é armazenada no HSM.

Algoritmos com suporte para encapsulamento/desembrulhamento de chaves

Um tipo de união que representa todos os algoritmos de criptografia RSA com suporte.

Define valores para JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> pode ser usado intercambiável com JsonWebKeySignatureAlgorithm, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

PS256: RSASSA-PSS usando SHA-256 e MGF1 com SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS usando SHA-384 e MGF1 com SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS usando SHA-512 e MGF1 com SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 usando SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 usando SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 usando SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
RSNULL: Reservado
ES256: ECDSA usando P-256 e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518.
ES384: ECDSA usando P-384 e SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
ES512: ECDSA usando P-521 e SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
ES256K: ECDSA usando P-256K e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518

Valores conhecidos de DeletionRecoveryLevel que o serviço aceita.

Valores conhecidos de EncryptionAlgorithm que o serviço aceita.

Valores conhecidos do <xref:JsonWebKeyCurveName> que o serviço aceita.

Valores conhecidos de KeyExportEncryptionAlgorithm que o serviço aceita.

Valores conhecidos de KeyOperation que o serviço aceita.

Valores conhecidos do <xref:JsonWebKeyType> que o serviço aceita.

Valores conhecidos do <xref:JsonWebKeySignatureAlgorithm> que o serviço aceita.

Analisa a ID da chave de Key Vault fornecida. Um exemplo é:

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

Ao analisar a ID acima, essa função retorna:

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