@azure/keyvault-keys package

Třídy

CryptographyClient	Klient používaný k provádění kryptografických operací s klíčem služby Azure Key Vault nebo místním JsonWebKey.
KeyClient	KeyClient poskytuje metody pro správu KeyVaultKey ve službě 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 DeletedKey pro obnovitelné odstranění s povoleným azure Key Vaultem.

Rozhraní

AesCbcDecryptParameters	Parametry dešifrování pro šifrovací algoritmy AES-CBC
AesCbcEncryptParameters	Parametry šifrování pro šifrovací algoritmy AES-CBC
AesGcmDecryptParameters	Parametry dešifrování pro šifrovací algoritmy AES-GCM
AesGcmEncryptParameters	Parametry šifrování pro šifrovací algoritmy AES-GCM
BackupKeyOptions	Možnosti pro backupKey(string, BackupKeyOptions).
BeginDeleteKeyOptions	Rozhraní představující volitelné parametry, které lze předat beginDeleteKey(string, BeginDeleteKeyOptions)
BeginRecoverDeletedKeyOptions	Rozhraní představující volitelné parametry, které lze předat beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
CreateEcKeyOptions	Rozhraní představující volitelné parametry, které lze předat createEcKey(string, CreateEcKeyOptions)
CreateKeyOptions	Rozhraní představující volitelné parametry, které lze předat createKey(string, string, CreateKeyOptions)
CreateOctKeyOptions	Rozhraní představující volitelné parametry, které lze předat createOctKey(string, CreateOctKeyOptions)
CreateRsaKeyOptions	Rozhraní představující volitelné parametry, které lze předat createRsaKey(string, CreateRsaKeyOptions)
CryptographyClientOptions	Volitelné parametry akceptované kryptografickým klientem služby KeyVault
CryptographyOptions	Rozhraní představující možnosti metod rozhraní API kryptografie, přejděte na KryptografickýClient další informace.
DecryptOptions	Možnosti pro decrypt(DecryptParameters, DecryptOptions).
DecryptResult	Výsledek operace decrypt(DecryptParameters, DecryptOptions)
DeletedKey	Rozhraní představující odstraněný klíč služby Key Vault.
EncryptOptions	Možnosti pro encrypt(EncryptParameters, EncryptOptions).
EncryptResult	Výsledek operace encrypt(EncryptParameters, EncryptOptions)
GetCryptographyClientOptions	Možnosti pro getCryptographyClient.
GetDeletedKeyOptions	Možnosti pro getDeletedKey(string, GetDeletedKeyOptions).
GetKeyAttestationOptions	Možnosti pro getKeyAttestation(string, GetKeyAttestationOptions).
GetKeyOptions	Možnosti pro getKey(string, GetKeyOptions).
GetKeyRotationPolicyOptions	Možnosti pro <xref:KeyClient.getRotationPolicy>
GetRandomBytesOptions	Možnosti pro getRandomBytes
ImportKeyOptions	Rozhraní představující volitelné parametry, které lze předat importKey(string, JsonWebKey, ImportKeyOptions)
JsonWebKey	Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
KeyAttestation	Rozhraní představující vlastnosti ověření identity klíče
KeyClientOptions	Volitelné parametry akceptované keyClient služby KeyClient služby KeyVault
KeyPollerOptions	Rozhraní představující volitelné parametry, které lze předat beginDeleteKey(string, BeginDeleteKeyOptions) a beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)
KeyProperties	Rozhraní představující vlastnosti keyVaultKey
KeyReleasePolicy	Pravidla zásad, pod kterými je možné klíč exportovat.
KeyRotationLifetimeAction	Akce a její odpovídající aktivační událost, kterou bude služba Key Vault provádět po celou dobu životnosti klíče.
KeyRotationPolicy	Úplná zásada obměny klíčů, která patří ke klíči.
KeyRotationPolicyProperties	Vlastnosti zásad obměně klíčů, které může klient nastavit pro daný klíč. Zásady obměny klíčů můžete také resetovat na výchozí hodnoty nastavením lifetimeActions na prázdné pole.
KeyVaultKey	Rozhraní představující klíč služby Key Vault s názvem, hodnotou a keyProperties.
KeyVaultKeyIdentifier	Představuje segmenty, které tvoří ID klíče služby Key Vault.
ListDeletedKeysOptions	Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané listDeletedKeys(ListDeletedKeysOptions).
ListPropertiesOfKeyVersionsOptions	Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).
ListPropertiesOfKeysOptions	Rozhraní představující volitelné parametry pro stránkované operace KeyClient předané listPropertiesOfKeys(ListPropertiesOfKeysOptions).
PageSettings	Rozhraní, které sleduje nastavení stránkované iterace
PagedAsyncIterableIterator	Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.
PollOperationState	PollOperationState obsahuje názorný seznam nejmenší sady vlastností potřebných k definování jakékoli dlouhotrvající operace poller. Zatímco Poller třída 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ěla by se aktualizovat aspoň po spuštění operace, po jeho dokončení a po zrušení. Implementace ale můžou mít jakýkoli jiný počet vlastností, které je možné aktualizovat z jiných důvodů.
PollerLike	Abstraktní reprezentace polleru, která má vystavit pouze minimální rozhraní API, se kterým musí uživatel pracovat.
PurgeDeletedKeyOptions	Možnosti pro purgeDeletedKey(string, PurgeDeletedKeyOptions).
ReleaseKeyOptions	Možnosti releaseKey
ReleaseKeyResult	Výsledek operace releaseKey.
RestoreKeyBackupOptions	Možnosti pro restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).
RotateKeyOptions	Možnosti pro rotateKey
RsaDecryptParameters	Dešifrovací parametry pro šifrovací algoritmy RSA.
RsaEncryptParameters	Parametry šifrování pro šifrovací algoritmy RSA
SignOptions	Možnosti pro sign(string, Uint8Array, SignOptions).
SignResult	Výsledek operace sign(string, Uint8Array, SignOptions)
UnwrapKeyOptions	Možnosti pro unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).
UnwrapResult	Výsledek operace <xref:unwrap>
UpdateKeyPropertiesOptions	Možnosti pro updateKeyProperties(string, string, UpdateKeyPropertiesOptions).
UpdateKeyRotationPolicyOptions	Možnosti updateKeyRotationPolicy
VerifyDataOptions	Možnosti pro verifyData(string, Uint8Array, Uint8Array, VerifyOptions)
VerifyOptions	Možnosti pro verify(string, Uint8Array, Uint8Array, VerifyOptions).
VerifyResult	Výsledek operace verify(string, Uint8Array, Uint8Array, VerifyOptions)
WrapKeyOptions	Možnosti pro wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).
WrapResult	Výsledek operace <xref:wrap>

Aliasy typu

AesCbcEncryptionAlgorithm	Typ sjednocení představující všechny podporované AES-CBC šifrovací algoritmy.
AesGcmEncryptionAlgorithm	Typ sjednocení představující všechny podporované AES-GCM šifrovací algoritmy.
DecryptParameters	Typ představující všechny aktuálně podporované parametry dešifrování, protože se vztahují na různé šifrovací algoritmy.
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která je aktuálně platná pro certifikáty v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát vyprázdnit pouze systém na konci intervalu uchovávání informací. PoleDeletionRecoveryLevel 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ázdnění: Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde ke ztrátě dat. Obnovitelné+vyprázdnitelné: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů), pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. Obnovitelné: Označuje stav trezoru, ve kterém je odstranění možné obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. Obnovitelné +ProtectedSubscription: Označuje trezor a stav předplatného, ve kterém je odstranění možné obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vyprázdnění) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. CustomizedRecoverable+Purgeable: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vymazání při 7 <= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Vlastní: Označuje stav trezoru, ve kterém se odstranění dá obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání, když 7 <= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a v době, kdy je předplatné stále dostupné. CustomizedRecoverable+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém se odstranění dá obnovit, okamžité a trvalé odstranění (tj. vyprázdnění) 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 také odráží skutečnost, že samotné předplatné nelze zrušit.
EncryptParameters	Typ představující všechny aktuálně podporované parametry šifrování, protože se vztahují na různé šifrovací algoritmy.
EncryptionAlgorithm	Algoritmus používaný k šifrování a dešifrování. <xref:KnownJsonWebKeyEncryptionAlgorithm> lze zaměnitelně s JsonWebKeyEncryptionAlgorithm, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou RSA-OAEP: [Nedoporučuje se] RSAES používající optimální asymetrické odsazení šifrování (OAEP), jak je popsáno v https://tools.ietf.org/html/rfc3447, s výchozími parametry zadanými rfC 3447 v oddílu A.2.1. Tyto výchozí parametry používají funkci hash SHA-1 a funkci generování masky MGF1 s SHA-1. Microsoft doporučuje používat RSA_OAEP_256 nebo silnější algoritmy pro lepší zabezpečení. Společnost Microsoft nedoporučuje RSA_OAEP, která je zahrnuta výhradně pro zpětnou kompatibilitu. RSA_OAEP využívá ALGORITMUS SHA1, který má známé problémy se kolizemi. RSA-OAEP-256: RSAES využívající optimální asymetrické odsazení šifrování s hashovou funkcí SHA-256 a funkcí generování masky MGF1 s SHA-256. RSA1_5: [Nedoporučuje se] šifrování klíčů RSAES-PKCS1-V1_5, jak je popsáno v https://tools.ietf.org/html/rfc3447. Microsoft doporučuje používat RSA_OAEP_256 nebo silnější algoritmy pro lepší zabezpečení. Společnost Microsoft nedoporučuje RSA_1_5, která je zahrnuta výhradně pro zpětnou kompatibilitu. Kryptografické standardy už nepovažují RSA za zabezpečené šifrování pomocí schématu odsazení PKCS#1 v1.5. A128GCM: 128bitová verze AES-GCM. A192GCM: 192bitová verze AES-GCM. A256GCM: 256bitová verze AES-GCM. A128KW: 128bitová sada klíčů AES. A192KW: 192bitová sada klíčů AES. A256KW: 256bitová sada klíčů AES. A128CBC: 128bitová verze AES-CBC. A192CBC: 192bitová verze AES-CBC. A256CBC: 256bitová verze AES-CBC. A128CBCPAD: 128bitová AES-CBC s odsazením PKCS. A192CBCPAD: 192bitová AES-CBC s odsazením PKCS. A256CBCPAD: 256bitová AES-CBC s odsazením PKCS. CKM_AES_KEY_WRAP: Zalamování klíčů AES CKM. CKM_AES_KEY_WRAP_PAD: Zalamování klíče AES CKM s odsazením.
KeyCurveName	Název tři tečky. Platné hodnoty najdete v tématu 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, křivka AKA SECG SECP256R1. P-384: elliptická křivka NIST P-384, křivka AKA SECG SECP384R1. P-521: elliptická křivka NIST P-521, křivka AKA SECG SECP521R1. P-256K: SECG SECP256K1 tři tečky.
KeyExportEncryptionAlgorithm	Definuje hodnoty pro KeyEncryptionAlgorithm. PoleKeyExportEncryptionAlgorithm 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
KeyOperation	Operace s webovými klíči JSON Další informace najdete v tématu JsonWebKeyOperation. <xref:KnownJsonWebKeyOperation> lze zaměnitelně s JsonWebKeyOperation, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou šifrování: Označuje, že klíč lze použít k šifrování. dešifrování: Označuje, že klíč lze použít k dešifrování. znaménko: Označuje, že klíč lze použít k podepsání. ověřit: Označuje, že klíč lze použít k ověření. wrapKey: Označuje, že klíč lze použít k zabalení jiného klíče. rozbalit klíč: Označuje, že klíč lze použít k rozbalení dalšího klíče. importu: Označuje, že klíč lze importovat během vytváření. exportu: Označuje, že je možné exportovat privátní komponentu klíče.
KeyRotationPolicyAction	Akce, která se spustí.
KeyType	JsonWebKey Key Type (kty), jak je definováno v https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. <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: elliptická křivka. EC-HSM: Tři tečky křivky 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 MODULU HARDWAROVÉHO ZABEZPEČENÍ. osmičkové: sekvence octetu (použitá k reprezentaci symetrických klíčů) oct-HSM: Sekvence octetu (použitá k reprezentaci symetrických klíčů), která je uložena HSM.
KeyWrapAlgorithm	Podporované algoritmy pro zabalení nebo rozbalení klíče
RsaEncryptionAlgorithm	Typ sjednocení představující všechny podporované šifrovací algoritmy RSA.
SignatureAlgorithm	Identifikátor podpisového nebo ověřovacího algoritmu. Další informace o možných typech algoritmů najdete v tématu 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 pomocí SHA-256 a MGF1 s SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518 PS384: RSASSA-PSS pomocí SHA-384 a MGF1 s SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518 PS512: RSASSA-PSS pomocí 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 HS256: HMAC používající SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518 HS384: HMAC používající SHA-384, jak je popsáno v https://tools.ietf.org/html/rfc7518 HS512: HMAC používající 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 s využitím P-256K a SHA-256, jak je popsáno v https://tools.ietf.org/html/rfc7518

Výčty

KnownDeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která je aktuálně platná pro certifikáty v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát vyprázdnit pouze systém na konci intervalu uchovávání informací.
KnownEncryptionAlgorithms	Algoritmus používaný k šifrování a dešifrování.
KnownKeyCurveNames	Název tři tečky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.
KnownKeyExportEncryptionAlgorithm	Šifrovací algoritmus, který se má použít k chráněnému materiálu exportovaného klíče
KnownKeyOperations	Známé hodnoty KeyOperation, které služba přijímá.
KnownKeyTypes	JsonWebKey Key Type (kty), jak je definováno v https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KnownSignatureAlgorithms	Identifikátor podpisového nebo ověřovacího algoritmu. Další informace o možných typech algoritmů najdete v tématu JsonWebKeySignatureAlgorithm.

Funkce

parseKeyVaultKeyIdentifier(string)

Analyzuje dané ID klíče služby Key Vault. Příkladem je: https://< název-trezoru>_klíčů.vault.azure.net/keys/< název-klíče/><id_jedinečné-verze-> Při analýze výše uvedeného ID vrátí tato funkce: { 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>" }

Podrobnosti funkce

parseKeyVaultKeyIdentifier(string)

Analyzuje dané ID klíče služby Key Vault. Příkladem je:

https://< název-trezoru>_klíčů.vault.azure.net/keys/< název-klíče/><id_jedinečné-verze->

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

  {
     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

Parametry

id

string

ID klíče služby Key Vault.

Návraty

KeyVaultKeyIdentifier