@azure/keyvault-keys package

Klient používaný k provádění kryptografických operací s klíčem služby Azure Key Vault nebo místním klíčem JsonWebKey.

KeyClient poskytuje metody pro správu klíče KeyVaultKey v azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultKeys. Klient také podporuje výpis odstraněného klíče pro Key Vault Azure s povoleným obnovitelném odstraněním.

Parametry dešifrování pro šifrovací algoritmy AES-CBC.

Parametry šifrování pro šifrovací algoritmy AES-CBC.

Parametry dešifrování pro šifrovací algoritmy AES-GCM.

Parametry šifrování pro šifrovací algoritmy AES-GCM.

Možnosti pro backupKey(string, BackupKeyOptions).

Rozhraní představující volitelné parametry, které lze předat do beginDeleteKey(string, BeginDeleteKeyOptions)

Rozhraní představující volitelné parametry, které lze předat do beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Rozhraní představující volitelné parametry, které lze předat do createEcKey(string, CreateEcKeyOptions)

Rozhraní představující volitelné parametry, které lze předat do createKey(string, string, CreateKeyOptions)

Rozhraní představující volitelné parametry, které lze předat do createOctKey(string, CreateOctKeyOptions)

Rozhraní představující volitelné parametry, které lze předat do createRsaKey(string, CreateRsaKeyOptions)

Volitelné parametry akceptované kryptografickým klientem služby KeyVault

Rozhraní představující možnosti metod rozhraní API kryptografie, přejděte na CryptographyClient , kde najdete další informace.

Možnosti pro decrypt(DecryptParameters, DecryptOptions).

Výsledek decrypt(DecryptParameters, DecryptOptions) operace.

Rozhraní představující odstraněný klíč Key Vault.

Možnosti pro encrypt(EncryptParameters, EncryptOptions).

Výsledek encrypt(EncryptParameters, EncryptOptions) operace.

Možnosti pro getCryptographyClient.

Možnosti pro getDeletedKey(string, GetDeletedKeyOptions).

Možnosti pro getKey(string, GetKeyOptions).

Možnosti pro <xref:KeyClient.getRotationPolicy>

Možnosti pro getRandomBytes

Rozhraní představující volitelné parametry, které lze předat do importKey(string, JsonWebKey_2, ImportKeyOptions)

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

Volitelné parametry akceptované klientem KeyClient služby KeyVault

Rozhraní představující volitelné parametry, které lze předat do beginDeleteKey(string, BeginDeleteKeyOptions) a beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

Rozhraní představující vlastnosti KeyVaultKey

Pravidla zásad, podle kterých se dá klíč exportovat.

Akce a její odpovídající aktivační událost, kterou bude provádět Key Vault po celou dobu životnosti klíče.

Úplná zásada obměny klíčů, která patří ke klíči.

Vlastnosti zásad obměně klíčů, které může klient nastavit pro daný klíč.

Zásady obměny klíčů můžete také obnovit na výchozí hodnoty nastavením lifetimeActions na prázdné pole.

Rozhraní představující Key Vault Klíč s jeho názvem, hodnotou a vlastnostmi klíče.

Představuje segmenty, které tvoří ID klíče Key Vault.

Rozhraní představující volitelné parametry stránkovaných operací KeyClient předaných do listDeletedKeys(ListDeletedKeysOptions).

Rozhraní představující volitelné parametry stránkovaných operací KeyClient předaných do listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

Rozhraní představující volitelné parametry stránkovaných operací KeyClient předaných do listPropertiesOfKeys(ListPropertiesOfKeysOptions).

Rozhraní, které sleduje nastavení stránkované iterace

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

PollOperationState obsahuje seznam nejmenší sady vlastností potřebných k definování jakékoli dlouho běžící operace poller.

Zatímco třída Poller funguje jako místní řídicí mechanismus pro spuštění aktivace, čekání a potenciálně zrušení dlouhotrvající operace, PollOperationState dokumentuje stav vzdálené dlouhotrvající operace.

Měl by se aktualizovat alespoň při spuštění operace, po dokončení a při jejím zrušení. Implementace ale můžou mít libovolný další počet vlastností, které se dají aktualizovat z jiných důvodů.

Abstraktní reprezentace polleru, která má zveřejnit pouze minimální rozhraní API, se kterým uživatel potřebuje pracovat.

Možnosti pro purgeDeletedKey(string, PurgeDeletedKeyOptions).

Možnosti pro releaseKey

Výsledek operace releaseKey .

Možnosti pro restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

Možnosti pro rotateKey

Parametry dešifrování pro šifrovací algoritmy RSA

Parametry šifrování pro šifrovací algoritmy RSA.

Možnosti pro sign(string, Uint8Array, SignOptions).

Výsledek sign(string, Uint8Array, SignOptions) operace.

Možnosti pro unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

Výsledek <xref:unwrap> operace.

Možnosti pro updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

Možnosti pro updateKeyRotationPolicy

Možnosti pro verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

Možnosti pro verify(string, Uint8Array, Uint8Array, VerifyOptions).

Výsledek verify(string, Uint8Array, Uint8Array, VerifyOptions) operace.

Možnosti pro wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

Výsledek <xref:wrap> operace.

Typ sjednocení představující všechny podporované šifrovací algoritmy AES-CBC.

Typ sjednocení představující všechny podporované šifrovací algoritmy AES-GCM.

Typ představující všechny aktuálně podporované parametry dešifrování, protože se vztahují na různé šifrovací algoritmy.

Definuje hodnoty pro DeletionRecoveryLevel.
Pole KnownDeletionRecoveryLevel lze použít zaměnitelně s DeletionRecoveryLevel, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Vyprázdnitelné: Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá žádné ochraně není k dispozici proti operaci Odstranění; dojde k nenahraditelné ztrátě dat při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.)
Obnovitelné+vyprázdnitelné: Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud se nevyžádá operace vyprázdnění nebo nezruší předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Obnovitelné: Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a po dobu, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Obnovitelné+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
CustomizedRecoverable+Purgeable: Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnit, když 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není požadována operace vyprázdnění nebo se nezruší předplatné.
CustomizedRecoverable: Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnit, když 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, když 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.

Typ představující všechny aktuálně podporované parametry šifrování, protože se vztahují na různé šifrovací algoritmy.

Definuje hodnoty pro JsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> Lze použít zaměnitelně s JsonWebKeyEncryptionAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

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

Definuje hodnoty pro JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> Lze použít zaměnitelně s JsonWebKeyCurveName, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

P-256: Elliptická křivka NIST P-256, AKA SECG křivka SECP256R1.
P-384: Elliptická křivka NIST P-384, AKA SECG křivka SECP384R1.
P-521: Elliptická křivka NIST P-521, AKA SECG křivka SECP521R1.
P-256K: Eliptická křivka SECG SECP256K1.

Definuje hodnoty pro KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm lze použít zaměnitelně s KeyEncryptionAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

Definuje hodnoty pro JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> Lze použít zaměnitelně s JsonWebKeyOperation, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Šifrování
Dešifrování
sign
verify
wrapKey
unwrapKey
Import
Vývozní

Akce, která se provede.

Definuje hodnoty pro JsonWebKeyType.
<xref:KnownJsonWebKeyType> Lze použít zaměnitelně s JsonWebKeyType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

EC: Eliptická křivka.
EC-HSM: Eliptická křivka s privátním klíčem, který je uložený v HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA s privátním klíčem, který je uložený v HSM.
oct: Oktetová sekvence (používá se k reprezentaci symetrických klíčů)
oct-HSM: Sekvence octetů (používaná k reprezentaci symetrických klíčů), která je uložena v modulu HSM.

Podporované algoritmy pro zabalení/rozbalování klíčů

Typ sjednocení představující všechny podporované šifrovací algoritmy RSA.

Definuje hodnoty pro JsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> Lze použít zaměnitelně s JsonWebKeySignatureAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

PS256: RSASSA-PSS používající SHA-256 a MGF1 s SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS používající SHA-384 a MGF1 s SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS používající SHA-512 a MGF1 s SHA-512, jak je popsáno v https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 pomocí SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 pomocí SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 pomocí SHA-512, jak je popsáno v https://tools.ietf.org/html/rfc7518
RSNULL: Vyhrazeno
ES256: ECDSA používající P-256 a SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518.
ES384: ECDSA používající P-384 a SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518
ES512: ECDSA používající P-521 a SHA-512, jak je popsáno v https://tools.ietf.org/html/rfc7518
ES256K: ECDSA používající P-256K a SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518

Známé hodnoty DeletionRecoveryLevel , které služba přijímá.

Známé hodnoty EncryptionAlgorithm , které služba přijímá.

Známé hodnoty <xref:JsonWebKeyCurveName> , které služba přijímá.

Známé hodnoty KeyExportEncryptionAlgorithm , které služba přijímá.

Známé hodnoty KeyOperation , které služba přijímá.

Známé hodnoty <xref:JsonWebKeyType> , které služba přijímá.

Známé hodnoty <xref:JsonWebKeySignatureAlgorithm> , které služba přijímá.

Analyzuje dané ID klíče Key Vault. Příklad:

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

Při parsování výše uvedeného ID tato funkce vrátí:

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