Поделиться через


@azure/keyvault-keys package

Классы

CryptographyClient

Клиент, используемый для выполнения криптографических операций с ключом хранилища ключей Azure или локальным JsonWebKey.

KeyClient

KeyClient предоставляет методы управления KeyVaultKey в Azure Key Vault. Клиент поддерживает создание, извлечение, обновление, удаление, очистку, резервное копирование, восстановление и перечисление KeyVaultKeys. Клиент также поддерживает перечисление DeletedKey для обратимого удаления Azure Key Vault.

Интерфейсы

AesCbcDecryptParameters

Параметры расшифровки для алгоритмов шифрования AES-CBC.

AesCbcEncryptParameters

Параметры шифрования для алгоритмов шифрования AES-CBC.

AesGcmDecryptParameters

Параметры расшифровки для алгоритмов шифрования AES-GCM.

AesGcmEncryptParameters

Параметры шифрования для алгоритмов шифрования AES-GCM.

BackupKeyOptions

Параметры backupKey(string, BackupKeyOptions).

BeginDeleteKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteKey(string, BeginDeleteKeyOptions)

BeginRecoverDeletedKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

CreateEcKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в createEcKey(string, CreateEcKeyOptions)

CreateKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в createKey(string, string, CreateKeyOptions)

CreateOctKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в createOctKey(string, CreateOctKeyOptions)

CreateRsaKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в createRsaKey(string, CreateRsaKeyOptions)

CryptographyClientOptions

Необязательные параметры, принятые криптографией KeyVault.

CryptographyOptions

Интерфейс, представляющий параметры методов API шифрования, перейдите к CryptographyClient.

DecryptOptions

Параметры decrypt(DecryptParameters, DecryptOptions).

DecryptResult

Результат операции decrypt(DecryptParameters, DecryptOptions).

DeletedKey

Интерфейс, представляющий удаленный ключ Key Vault.

EncryptOptions

Параметры encrypt(EncryptParameters, EncryptOptions).

EncryptResult

Результат операции encrypt(EncryptParameters, EncryptOptions).

GetCryptographyClientOptions

Параметры getCryptographyClient.

GetDeletedKeyOptions

Параметры getDeletedKey(string, GetDeletedKeyOptions).

GetKeyOptions

Параметры getKey(string, GetKeyOptions).

GetKeyRotationPolicyOptions

Параметры <xref:KeyClient.getRotationPolicy>

GetRandomBytesOptions

Параметры getRandomBytes

ImportKeyOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в importKey(string, JsonWebKey, ImportKeyOptions)

JsonWebKey

По состоянию на http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

KeyClientOptions

Необязательные параметры, принятые keyVault KeyClient

KeyPollerOptions

Интерфейс, представляющий необязательные параметры, которые можно передать в beginDeleteKey(string, BeginDeleteKeyOptions) и beginRecoverDeletedKey(string, BeginRecoverDeletedKeyOptions)

KeyProperties

Интерфейс, представляющий свойства KeyVaultKey

KeyReleasePolicy

Правила политики, в которых можно экспортировать ключ.

KeyRotationLifetimeAction

Действие и соответствующий триггер, который будет выполняться Key Vault в течение всего времени существования ключа.

KeyRotationPolicy

Полная политика смены ключей, принадлежающая ключу.

KeyRotationPolicyProperties

Свойства политики смены ключей, которую клиент может задать для заданного ключа.

Вы также можете сбросить политику смены ключей в значения по умолчанию, задав lifetimeActions пустому массиву.

KeyVaultKey

Интерфейс, представляющий ключ Key Vault с его именем, значением и KeyProperties.

KeyVaultKeyIdentifier

Представляет сегменты, составляющие идентификатор ключа Key Vault.

ListDeletedKeysOptions

Интерфейс, представляющий необязательные параметры для операций с страницами KeyClient, передаваемых в listDeletedKeys(ListDeletedKeysOptions).

ListPropertiesOfKeyVersionsOptions

Интерфейс, представляющий необязательные параметры для операций с страницами KeyClient, передаваемых в listPropertiesOfKeyVersions(string, ListPropertiesOfKeyVersionsOptions).

ListPropertiesOfKeysOptions

Интерфейс, представляющий необязательные параметры для операций с страницами KeyClient, передаваемых в listPropertiesOfKeys(ListPropertiesOfKeysOptions).

PageSettings

Интерфейс, отслеживающий параметры для итерации страниц

PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.

PollOperationState

PollOperationState содержит список с мнением наименьшего набора свойств, необходимых для определения любого длительного опроса операций.

Хотя класс Poller работает в качестве локального механизма управления для запуска, ожидания и потенциальной отмены длительной операции, pollOperationState документирует состояние удаленной длительной операции.

Он должен обновляться по крайней мере после запуска операции, когда она завершится и когда она отменена. Хотя реализации могут иметь любое другое количество свойств, которые могут быть обновлены другими причинами.

PollerLike

Абстрактное представление опроса, предназначенное для предоставления только минимального API, с которым должен работать пользователь.

PurgeDeletedKeyOptions

Параметры purgeDeletedKey(string, PurgeDeletedKeyOptions).

ReleaseKeyOptions

Параметры releaseKey

ReleaseKeyResult

Результат операции releaseKey.

RestoreKeyBackupOptions

Параметры restoreKeyBackup(Uint8Array, RestoreKeyBackupOptions).

RotateKeyOptions

Параметры поворота Key

RsaDecryptParameters

Параметры расшифровки для алгоритмов шифрования RSA.

RsaEncryptParameters

Параметры шифрования для алгоритмов шифрования RSA.

SignOptions

Параметры sign(string, Uint8Array, SignOptions).

SignResult

Результат операции sign(string, Uint8Array, SignOptions).

UnwrapKeyOptions

Параметры unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions).

UnwrapResult

Результат операции <xref:unwrap>.

UpdateKeyPropertiesOptions

Параметры updateKeyProperties(string, string, UpdateKeyPropertiesOptions).

UpdateKeyRotationPolicyOptions

Параметры updateKeyRotationPolicy

VerifyDataOptions

Параметры verifyData(string, Uint8Array, Uint8Array, VerifyOptions)

VerifyOptions

Параметры verify(string, Uint8Array, Uint8Array, VerifyOptions).

VerifyResult

Результат операции verify(string, Uint8Array, Uint8Array, VerifyOptions).

WrapKeyOptions

Параметры wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions).

WrapResult

Результат операции <xref:wrap>.

Псевдонимы типа

AesCbcEncryptionAlgorithm

Тип объединения, представляющий все поддерживаемые алгоритмы шифрования AES-CBC.

AesGcmEncryptionAlgorithm

Тип объединения, представляющий все поддерживаемые алгоритмы шифрования AES-GCM.

DecryptParameters

Тип, представляющий все поддерживаемые в настоящее время параметры расшифровки при применении к разным алгоритмам шифрования.

DeletionRecoveryLevel

Определяет значения для УдаленияRecoveryLevel.
KnownDeletionRecoveryLevel можно использовать взаимозаменяемо с удалениемRecoveryLevel, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

очистка: обозначает состояние хранилища, в котором удаление является необратимой операцией без возможности восстановления. Этот уровень не соответствует защите от операции delete; данные безвозвратно теряются при принятии операции удаления на уровне сущности или выше (хранилище, группа ресурсов, подписка и т. д.).
Восстановление и очистка: обозначает состояние хранилища, в котором можно восстановить, а также разрешает немедленное и постоянное удаление (т. е. очистка). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней), если операция очистки не запрашивается или подписка отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
можно восстановить: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистки). Этот уровень гарантирует возможность восстановления удаленной сущности в течение интервала хранения (90 дней) и пока подписка по-прежнему доступна. Система будет окончательно удалять ее через 90 дней, если не восстановлена
recoveryable+ProtectedSubscription: обозначает хранилище и состояние подписки, в котором удаление можно восстановить в течение интервала хранения (90 дней), немедленное и постоянное удаление (т. е. очистка) не допускается, и при этом сама подписка не может быть окончательно отменена. Система будет окончательно удалять ее через 90 дней, если не восстановлена
Настраиваемыйrecoverable+Purgeable: обозначает состояние хранилища, в котором можно восстановить удаление, а также разрешает немедленное и постоянное удаление (т. е. очистка при 7<= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, если не запрашивается операция очистки или подписка отменена.
Настраиваемый: обозначает состояние хранилища, в котором удаление можно восстановить без возможности немедленного и постоянного удаления (т. е. очистка при 7<= SoftDeleteRetentionInDays < 90). Этот уровень гарантирует возможность восстановления удаленной сущности во время периода хранения и пока подписка по-прежнему доступна.
Настраиваемая настройкаRecoverable+ProtectedSubscription: обозначает состояние хранилища и подписки, в котором удаление можно восстановить, немедленное и постоянное удаление (т. е. очистка) запрещено, и при этом сама подписка не может быть окончательно отменена, когда 7<= SoftDeleteRetentionInDays < 90. Этот уровень гарантирует возможность восстановления удаленной сущности во время интервала хранения, а также отражает тот факт, что сама подписка не может быть отменена.

EncryptParameters

Тип, представляющий все поддерживаемые в настоящее время параметры шифрования при применении к разным алгоритмам шифрования.

EncryptionAlgorithm

Определяет значения jsonWebKeyEncryptionAlgorithm.
<xref:KnownJsonWebKeyEncryptionAlgorithm> можно использовать взаимозаменяемо с JsonWebKeyEncryptionAlgorithm, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

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

KeyCurveName

Определяет значения для JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> можно использовать взаимозаменяемо с JsonWebKeyCurveName, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

P-256: NIST P-256 многоточие кривой, AKA SECG кривая SECP256R1.
P-384: кривая NIST P-384 с многоточием, кривая AKA SECG SECP384R1.
P-521: кривая NIST P-521 с многоточием, кривая AKA SECG SECP521R1.
P-256K: SECP256K1 эллиптической кривой SECG.

KeyExportEncryptionAlgorithm

Определяет значения для KeyEncryptionAlgorithm. KnownKeyExportEncryptionAlgorithm можно использовать взаимозаменяемо с KeyEncryptionAlgorithm, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

CKM_RSA_AES_KEY_WRAP
RSA_AES_KEY_WRAP_256
RSA_AES_KEY_WRAP_384

KeyOperation

Определяет значения для JsonWebKeyOperation.
<xref:KnownJsonWebKeyOperation> можно использовать взаимозаменяемо с JsonWebKeyOperation, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

шифрования
расшифровка
знак
проверить
wrapKey
unwrapKey
импорт
экспорта

KeyRotationPolicyAction

Действие, которое будет выполняться.

KeyType

Определяет значения для JsonWebKeyType.
<xref:KnownJsonWebKeyType> можно использовать взаимозаменяемо с JsonWebKeyType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

EC: эллиптическая кривая.
EC-HSM: эллиптическая кривая с закрытым ключом, хранящимся в HSM.
RSA: RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM: RSA с закрытым ключом, хранящимся в HSM.
окт: последовательность октетов (используется для представления симметричные ключи)
окт-HSM: последовательность октетов (используется для представления симметричные ключи), которая хранится в HSM.

KeyWrapAlgorithm

Поддерживаемые алгоритмы для упаковки ключей и распаки

RsaEncryptionAlgorithm

Тип объединения, представляющий все поддерживаемые алгоритмы шифрования RSA.

SignatureAlgorithm

Определяет значения jsonWebKeySignatureAlgorithm.
<xref:KnownJsonWebKeySignatureAlgorithm> можно использовать взаимозаменяемо с JsonWebKeySignatureAlgorithm, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

PS256: RSASSA-PSS с SHA-256 и MGF1 с SHA-256, как описано в https://tools.ietf.org/html/rfc7518
PS384: RSASSA-PSS с помощью SHA-384 и MGF1 с SHA-384, как описано в https://tools.ietf.org/html/rfc7518
PS512: RSASSA-PSS использование SHA-512 и MGF1 с SHA-512, как описано в https://tools.ietf.org/html/rfc7518
RS256: RSASSA-PKCS1-v1_5 с помощью SHA-256, как описано в https://tools.ietf.org/html/rfc7518
RS384: RSASSA-PKCS1-v1_5 с помощью SHA-384, как описано в https://tools.ietf.org/html/rfc7518
RS512: RSASSA-PKCS1-v1_5 с помощью SHA-512, как описано в https://tools.ietf.org/html/rfc7518
RSNULL: зарезервировано
ES256: ECDSA с помощью P-256 и SHA-256, как описано в https://tools.ietf.org/html/rfc7518.
ES384: ECDSA с помощью P-384 и SHA-384, как описано в https://tools.ietf.org/html/rfc7518
ES512: ECDSA с помощью P-521 и SHA-512, как описано в https://tools.ietf.org/html/rfc7518
ES256K: ECDSA с помощью P-256K и SHA-256, как описано в https://tools.ietf.org/html/rfc7518

Перечисления

KnownDeletionRecoveryLevel

Известные значения DeletionRecoveryLevel, которые служба принимает.

KnownEncryptionAlgorithms

Известные значения EncryptionAlgorithm, которые служба принимает.

KnownKeyCurveNames

Известные значения <xref:JsonWebKeyCurveName>, которые принимает служба.

KnownKeyExportEncryptionAlgorithm

Известные значения KeyExportEncryptionAlgorithm, которые служба принимает.

KnownKeyOperations

Известные значения KeyOperation, которые служба принимает.

KnownKeyTypes

Известные значения <xref:JsonWebKeyType>, которые принимает служба.

KnownSignatureAlgorithms

Известные значения <xref:JsonWebKeySignatureAlgorithm>, которые принимает служба.

Функции

parseKeyVaultKeyIdentifier(string)

Анализирует указанный идентификатор ключа Key Vault. Пример:

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

При анализе приведенного выше идентификатора эта функция возвращает следующее:

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

Сведения о функции

parseKeyVaultKeyIdentifier(string)

Анализирует указанный идентификатор ключа Key Vault. Пример:

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

При анализе приведенного выше идентификатора эта функция возвращает следующее:

  {
     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

Параметры

id

string

Идентификатор ключа Key Vault.

Возвращаемое значение