@azure/keyvault-keys package

Az Azure Key Vault-kulcson vagy egy helyi JsonWebKeyvégzett titkosítási műveletekhez használt ügyfél.

A KeyClient metódusokat biztosít KeyVaultKey kezeléséhez az Azure Key Vaultban. Az ügyfél támogatja a KeyVaultKeys létrehozását, lekérését, frissítését, törlését, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél emellett támogatja a DeletedKey listázását a helyreállítható törlést engedélyező Azure Key Vaulthoz.

AES-CBC titkosítási algoritmusok visszafejtési paraméterei.

Titkosítási paraméterek AES-CBC titkosítási algoritmusokhoz.

AES-GCM titkosítási algoritmusok visszafejtési paraméterei.

Titkosítási paraméterek AES-GCM titkosítási algoritmusokhoz.

A backupKey(string, BackupKeyOptions)beállításai.

A beginDeleteKey(string, BeginDeleteKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A createEcKey(string, CreateEcKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A createKey(string, string, CreateKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A createOctKey(string, CreateOctKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A createRsaKey(string, CreateRsaKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A KeyVault CryptographyClient által elfogadott választható paraméterek

A titkosítási API-metódusok lehetőségeit képviselő felület további információért lépjen a CryptographyClient.

A decrypt(DecryptParameters, DecryptOptions)beállításai.

A decrypt(DecryptParameters, DecryptOptions) művelet eredménye.

Törölt Key Vault-kulcsot jelképező felület.

A encrypt(EncryptParameters, EncryptOptions)beállításai.

A encrypt(EncryptParameters, EncryptOptions) művelet eredménye.

A getCryptographyClientbeállításai.

A getDeletedKey(string, GetDeletedKeyOptions)beállításai.

A getKey(string, GetKeyOptions)beállításai.

A <xref:KeyClient.getRotationPolicy> beállításai

A getRandomBytes beállításai

A importKey(string, JsonWebKey, ImportKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

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

A KeyVault KeyClient által elfogadott választható paraméterek

A beginDeleteKey(string, BeginDeleteKeyOptions) és beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions) számára továbbítható opcionális paramétereket képviselő felület

A KeyVaultKey tulajdonságainak

Azok a szabályzatszabályok, amelyek alapján a kulcs exportálható.

Egy műveletet és annak megfelelő eseményindítóját, amelyet a Key Vault egy kulcs élettartama alatt hajt végre.

A kulcshoz tartozó teljes kulcsforgatási szabályzat.

Egy kulcsforgatási szabályzat tulajdonságai, amelyeket az ügyfél beállíthat egy adott kulcshoz.

A kulcsforgatási szabályzatot az alapértelmezett értékre is visszaállíthatja a lifetimeActions üres tömbre való beállításával.

Egy Key Vault-kulcsot jelképező felület, amelynek neve, értéke és KeyProperties.

A Key Vault kulcsazonosítóját alkotó szegmenseket jelöli.

Az listDeletedKeys(ListDeletedKeysOptions)átadott KeyClient-lapozott műveletek opcionális paramétereit képviselő felület.

Az listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions)átadott KeyClient-lapozott műveletek opcionális paramétereit képviselő felület.

Az listPropertiesOfKeys(ListPropertiesOfKeysOptions)átadott KeyClient-lapozott műveletek opcionális paramétereit képviselő felület.

Egy felület, amely nyomon követi a lapozott iteráció beállításait

Egy felület, amely lehetővé teszi az aszinkron iterálást mind a befejezésig, mind az oldal szerint.

A PollOperationState a hosszú ideig futó művelet pollerének meghatározásához szükséges legkisebb tulajdonságkészlet véleményezett listáját tartalmazza.

Bár a Poller osztály helyi vezérlő mechanizmusként működik egy hosszú ideig futó művelet elindításához, várakozásához és esetleges megszakításához, a PollOperationState dokumentálja a távoli, hosszú ideig futó művelet állapotát.

Legalább akkor kell frissíteni, amikor a művelet elkezdődik, amikor befejeződött, és ha a művelet megszakadt. Az implementációk azonban bármilyen más okból frissíthető tulajdonsággal rendelkezhetnek.

A poller absztrakt ábrázolása, amelynek célja, hogy a felhasználónak csak a minimális API-t tegye elérhetővé.

A purgeDeletedKey(string, PurgeDeletedKeyOptions)beállításai.

A releaseKey beállításai

A releaseKey művelet eredménye.

A restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions)beállításai.

Az forgatókulcs- beállításai

Az RSA titkosítási algoritmusok visszafejtési paraméterei.

Az RSA titkosítási algoritmusok titkosítási paraméterei.

A sign(string, Uint8Array, SignOptions)beállításai.

A sign(string, Uint8Array, SignOptions) művelet eredménye.

A unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)beállításai.

A <xref:unwrap> művelet eredménye.

A updateKeyProperties(string, string, UpdateKeyPropertiesOptions)beállításai.

Az updateKeyRotationPolicy beállításai

A verifyData(string, Uint8Array, Uint8Array, VerifyOptions) beállításai

A verify(string, Uint8Array, Uint8Array, VerifyOptions)beállításai.

A verify(string, Uint8Array, Uint8Array, VerifyOptions) művelet eredménye.

A wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)beállításai.

A <xref:wrap> művelet eredménye.

Az összes támogatott AES-CBC titkosítási algoritmust képviselő egyesítő típus.

Az összes támogatott AES-GCM titkosítási algoritmust képviselő egyesítő típus.

Az összes jelenleg támogatott visszafejtési paramétert képviselő típus, amely különböző titkosítási algoritmusokra vonatkozik.

A DeletionRecoveryLevel értékeit határozza meg.
KnownDeletionRecoveryLevel felcserélhető a DeletionRecoveryLeveltel, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a törlési műveletekkel szembeni védelemnek; az adatok helyrehozhatatlanul elvesznek, ha egy törlési műveletet az entitás szintjén vagy annál magasabb szinten fogadnak el (tároló, erőforráscsoport, előfizetés stb.)
Helyreállítható+Helyreállítható: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz törlésre) van lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak (90 nap) alatt, és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
Recoveryable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési idő (90 nap) alatt helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre
CustomizedRecoverable+Purgeable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (azaz 7<= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják.
CustomizedRecoverable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz 7<= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és amíg az előfizetés továbbra is elérhető.
CustomizedRecoverable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem mondható le véglegesen, amikor 7<= SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és azt is tükrözi, hogy maga az előfizetés nem törölhető.

Az összes jelenleg támogatott titkosítási paramétert képviselő típus, amely a különböző titkosítási algoritmusokra vonatkozik.

A JsonWebKeyEncryptionAlgorithm értékeit határozza meg.
<xref:KnownJsonWebKeyEncryptionAlgorithm> a JsonWebKeyEncryptionAlgorithm használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

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

A JsonWebKeyCurveName értékeit határozza meg.
<xref:KnownJsonWebKeyCurveName> a JsonWebKeyCurveName használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

P-256: A NIST P-256 háromliptikus görbe, AKA SECG-görbe SECP256R1.
P-384: Az NIST P-384 háromliptikus görbe, az AKA SECG-görbe SECP384R1.
P-521: A NIST P-521 háromliptikus görbe, AKA SECG-görbe SECP521R1.
P-256K: A SECG SECP256K1 háromliptikus görbe.

A KeyEncryptionAlgorithm értékeit határozza meg. KnownKeyExportEncryptionAlgorithm a KeyEncryptionAlgorithm használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

A JsonWebKeyOperation értékeit határozza meg.
<xref:KnownJsonWebKeyOperation> a JsonWebKeyOperation használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

titkosítási
visszafejtési
aláírási
ellenőrzése
wrapKey
unwrapKey
importálási
exportálási

A végrehajtandó művelet.

A JsonWebKeyType értékeit határozza meg.
<xref:KnownJsonWebKeyType> a JsonWebKeyType használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

EC: Elliptikus görbe.
EC-HSM: Elliptikus görbe a HSM-ben tárolt titkos kulccsal.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: A HSM-ben tárolt titkos kulccsal rendelkező RSA.
okt.: Oktet sorozat (szimmetrikus kulcsok ábrázolására szolgál)
okt-HSM: A HSM-ben tárolt oktett-sorozat (szimmetrikus kulcsok ábrázolására szolgál).

Támogatott algoritmusok kulcsburkoláshoz/törléshez

Az összes támogatott RSA-titkosítási algoritmust képviselő egyesítő típus.

A JsonWebKeySignatureAlgorithm értékeit határozza meg.
<xref:KnownJsonWebKeySignatureAlgorithm> a JsonWebKeySignatureAlgorithm használatával felcserélhető, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket.

A szolgáltatás által támogatott ismert értékek

PS256: RSASSA-PSS SHA-256 és MGF1 sha-256 használatával, a https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS SHA-384 és MGF1 sha-384 használatával, a https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS SHA-512 és MGF1 sha-512 használatával, a https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 SHA-256 használatával, a https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 SHA-384 használatával, a https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 SHA-512 használatával, a https://tools.ietf.org/html/rfc7518
RSNULL: Fenntartott
ES256: ECDSA p-256 és SHA-256 használatával, a https://tools.ietf.org/html/rfc7518.
ES384: ECDSA p-384 és SHA-384 használatával, a https://tools.ietf.org/html/rfc7518
ES512: ECDSA p-521 és SHA-512 használatával, a https://tools.ietf.org/html/rfc7518
ES256K: ECDSA p-256K és SHA-256 használatával, a https://tools.ietf.org/html/rfc7518

A szolgáltatás által elfogadott DeletionRecoveryLevel ismert értékei.

A szolgáltatás által elfogadott EncryptionAlgorithm ismert értékei.

A szolgáltatás által elfogadott <xref:JsonWebKeyCurveName> ismert értékei.

A KeyExportEncryptionAlgorithm ismert értékei, amelyeket a szolgáltatás elfogad.

A szolgáltatás által elfogadott KeyOperation ismert értékei.

A szolgáltatás által elfogadott <xref:JsonWebKeyType> ismert értékei.

A szolgáltatás által elfogadott <xref:JsonWebKeySignatureAlgorithm> ismert értékei.

Elemzi a megadott Key Vault-kulcsazonosítót. Ilyen például a következő:

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

A fenti azonosító elemzésekor a függvény a következőt adja vissza:

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