Web Crypto API
Node.js предоставляет реализацию стандартного Web Crypto API.
Для доступа к этому модулю используйте globalThis.crypto или require('node:crypto').webcrypto.
const { subtle } = globalThis.crypto;
(async function() {
const key = await subtle.generateKey({
name: 'HMAC',
hash: 'SHA-256',
length: 256,
}, true, ['sign', 'verify']);
const enc = new TextEncoder();
const message = enc.encode('I love cupcakes');
const digest = await subtle.sign({
name: 'HMAC',
}, key, message);
})(); copy Примеры
Создание ключей
Класс <SubtleCrypto> можно использовать для создания симметричных (секретных) ключей или асимметричных пар ключей (открытого и закрытого ключей).
Ключи AES
const { subtle } = globalThis.crypto;
async function generateAesKey(length = 256) {
const key = await subtle.generateKey({
name: 'AES-CBC',
length,
}, true, ['encrypt', 'decrypt']);
return key;
} copy Пары ключей ECDSA
const { subtle } = globalThis.crypto;
async function generateEcKey(namedCurve = 'P-521') {
const {
publicKey,
privateKey,
} = await subtle.generateKey({
name: 'ECDSA',
namedCurve,
}, true, ['sign', 'verify']);
return { publicKey, privateKey };
} copy Пары ключей Ed25519/X25519
const { subtle } = globalThis.crypto;
async function generateEd25519Key() {
return subtle.generateKey({
name: 'Ed25519',
}, true, ['sign', 'verify']);
}
async function generateX25519Key() {
return subtle.generateKey({
name: 'X25519',
}, true, ['deriveKey']);
} copy Ключи HMAC
const { subtle } = globalThis.crypto;
async function generateHmacKey(hash = 'SHA-256') {
const key = await subtle.generateKey({
name: 'HMAC',
hash,
}, true, ['sign', 'verify']);
return key;
} copy Пары ключей RSA
const { subtle } = globalThis.crypto;
const publicExponent = new Uint8Array([1, 0, 1]);
async function generateRsaKey(modulusLength = 2048, hash = 'SHA-256') {
const {
publicKey,
privateKey,
} = await subtle.generateKey({
name: 'RSASSA-PKCS1-v1_5',
modulusLength,
publicExponent,
hash,
}, true, ['sign', 'verify']);
return { publicKey, privateKey };
} copy Шифрование и расшифрование
const crypto = globalThis.crypto;
async function aesEncrypt(plaintext) {
const ec = new TextEncoder();
const key = await generateAesKey();
const iv = crypto.getRandomValues(new Uint8Array(16));
const ciphertext = await crypto.subtle.encrypt({
name: 'AES-CBC',
iv,
}, key, ec.encode(plaintext));
return {
key,
iv,
ciphertext,
};
}
async function aesDecrypt(ciphertext, key, iv) {
const dec = new TextDecoder();
const plaintext = await crypto.subtle.decrypt({
name: 'AES-CBC',
iv,
}, key, ciphertext);
return dec.decode(plaintext);
} copy Экспорт и импорт ключей
const { subtle } = globalThis.crypto;
async function generateAndExportHmacKey(format = 'jwk', hash = 'SHA-512') {
const key = await subtle.generateKey({
name: 'HMAC',
hash,
}, true, ['sign', 'verify']);
return subtle.exportKey(format, key);
}
async function importHmacKey(keyData, format = 'jwk', hash = 'SHA-512') {
const key = await subtle.importKey(format, keyData, {
name: 'HMAC',
hash,
}, true, ['sign', 'verify']);
return key;
} copy Упаковка и распаковка ключей
const { subtle } = globalThis.crypto;
async function generateAndWrapHmacKey(format = 'jwk', hash = 'SHA-512') {
const [
key,
wrappingKey,
] = await Promise.all([
subtle.generateKey({
name: 'HMAC', hash,
}, true, ['sign', 'verify']),
subtle.generateKey({
name: 'AES-KW',
length: 256,
}, true, ['wrapKey', 'unwrapKey']),
]);
const wrappedKey = await subtle.wrapKey(format, key, wrappingKey, 'AES-KW');
return { wrappedKey, wrappingKey };
}
async function unwrapHmacKey(
wrappedKey,
wrappingKey,
format = 'jwk',
hash = 'SHA-512') {
const key = await subtle.unwrapKey(
format,
wrappedKey,
wrappingKey,
'AES-KW',
{ name: 'HMAC', hash },
true,
['sign', 'verify']);
return key;
} copy Подписание и проверка
const { subtle } = globalThis.crypto;
async function sign(key, data) {
const ec = new TextEncoder();
const signature =
await subtle.sign('RSASSA-PKCS1-v1_5', key, ec.encode(data));
return signature;
}
async function verify(key, signature, data) {
const ec = new TextEncoder();
const verified =
await subtle.verify(
'RSASSA-PKCS1-v1_5',
key,
signature,
ec.encode(data));
return verified;
} copy Получение битов и ключей
const { subtle } = globalThis.crypto;
async function pbkdf2(pass, salt, iterations = 1000, length = 256) {
const ec = new TextEncoder();
const key = await subtle.importKey(
'raw',
ec.encode(pass),
'PBKDF2',
false,
['deriveBits']);
const bits = await subtle.deriveBits({
name: 'PBKDF2',
hash: 'SHA-512',
salt: ec.encode(salt),
iterations,
}, key, length);
return bits;
}
async function pbkdf2Key(pass, salt, iterations = 1000, length = 256) {
const ec = new TextEncoder();
const keyMaterial = await subtle.importKey(
'raw',
ec.encode(pass),
'PBKDF2',
false,
['deriveKey']);
const key = await subtle.deriveKey({
name: 'PBKDF2',
hash: 'SHA-512',
salt: ec.encode(salt),
iterations,
}, keyMaterial, {
name: 'AES-GCM',
length,
}, true, ['encrypt', 'decrypt']);
return key;
} copy Дайджест
const { subtle } = globalThis.crypto;
async function digest(data, algorithm = 'SHA-512') {
const ec = new TextEncoder();
const digest = await subtle.digest(algorithm, ec.encode(data));
return digest;
} copy Матрица алгоритмов
В таблице перечислены алгоритмы, поддерживаемые реализацией Web Crypto API в Node.js, и поддерживаемые для каждого из них API:
| Алгоритм | generateKey |
exportKey |
importKey |
encrypt |
decrypt |
wrapKey |
unwrapKey |
deriveBits |
deriveKey |
sign |
verify |
digest |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
'RSASSA-PKCS1-v1_5' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'RSA-PSS' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'RSA-OAEP' |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |||||
'ECDSA' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'Ed25519' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'Ed448' 1
|
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'ECDH' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'X25519' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'X448' 1
|
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'AES-CTR' |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |||||
'AES-CBC' |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |||||
'AES-GCM' |
✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | |||||
'AES-KW' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'HMAC' |
✔ | ✔ | ✔ | ✔ | ✔ | |||||||
'HKDF' |
✔ | ✔ | ✔ | ✔ | ||||||||
'PBKDF2' |
✔ | ✔ | ✔ | ✔ | ||||||||
'SHA-1' |
✔ | |||||||||||
'SHA-256' |
✔ | |||||||||||
'SHA-384' |
✔ | |||||||||||
'SHA-512' |
✔ |
Класс: Crypto
globalThis.crypto — это экземпляр класса Crypto. Crypto — это синглтон, предоставляющий доступ к остальной части API криптографии.
crypto.subtle
- Тип: <SubtleCrypto>
Предоставляет доступ к API SubtleCrypto.
crypto.getRandomValues(typedArray)
-
typedArray<Buffer> | <TypedArray> - Возвращает: <Buffer> | <TypedArray>
Генерирует криптографически стойкие случайные значения. Указанный typedArray заполняется случайными значениями, после чего возвращается ссылка на typedArray.
Указанный typedArray должен быть экземпляром <TypedArray> с целочисленными элементами; Float32Array и Float64Array не допускаются.
Если размер указанного typedArray превышает 65 536 байт, будет выброшена ошибка.
crypto.randomUUID()
- Возвращает: <string>
Генерирует случайный UUID версии 4 по RFC 4122. UUID генерируется с помощью криптографического генератора псевдослучайных чисел.
Класс: CryptoKey
cryptoKey.algorithm
Объект с описанием алгоритма, для которого можно использовать ключ, а также дополнительных параметров, специфичных для алгоритма.
Только для чтения.
cryptoKey.extractable
- Тип: <boolean>
Если значение true, <CryptoKey> можно извлечь с помощью subtleCrypto.exportKey() или subtleCrypto.wrapKey().
Только для чтения.
cryptoKey.type
- Тип: <string> Одно из значений:
'secret','private'или'public'.
Строка, указывающая, является ли ключ симметричным ('secret') или асимметричным ('private' или 'public').
cryptoKey.usages
- Тип: <string[]>
Массив строк, определяющих операции, для которых можно использовать ключ.
Допустимые варианты использования:
-
'encrypt'— ключ можно использовать для шифрования данных. -
'decrypt'— ключ можно использовать для расшифрования данных. -
'sign'— ключ можно использовать для создания цифровых подписей. -
'verify'— ключ можно использовать для проверки цифровых подписей. -
'deriveKey'— ключ можно использовать для получения нового ключа. -
'deriveBits'— ключ можно использовать для получения битов. -
'wrapKey'— ключ можно использовать для упаковки другого ключа. -
'unwrapKey'— ключ можно использовать для распаковки другого ключа.
Допустимые варианты использования ключа зависят от алгоритма ключа (определяется cryptokey.algorithm.name).
| Тип ключа | 'encrypt' |
'decrypt' |
'sign' |
'verify' |
'deriveKey' |
'deriveBits' |
'wrapKey' |
'unwrapKey' |
|---|---|---|---|---|---|---|---|---|
'AES-CBC' |
✔ | ✔ | ✔ | ✔ | ||||
'AES-CTR' |
✔ | ✔ | ✔ | ✔ | ||||
'AES-GCM' |
✔ | ✔ | ✔ | ✔ | ||||
'AES-KW' |
✔ | ✔ | ||||||
'ECDH' |
✔ | ✔ | ||||||
'X25519' |
✔ | ✔ | ||||||
'X448' 1
|
✔ | ✔ | ||||||
'ECDSA' |
✔ | ✔ | ||||||
'Ed25519' |
✔ | ✔ | ||||||
'Ed448' 1
|
✔ | ✔ | ||||||
'HDKF' |
✔ | ✔ | ||||||
'HMAC' |
✔ | ✔ | ||||||
'PBKDF2' |
✔ | ✔ | ||||||
'RSA-OAEP' |
✔ | ✔ | ✔ | ✔ | ||||
'RSA-PSS' |
✔ | ✔ | ||||||
'RSASSA-PKCS1-v1_5' |
✔ | ✔ |
Класс: CryptoKeyPair
CryptoKeyPair — это простой объект-словарь со свойствами publicKey и privateKey, представляющий асимметричную пару ключей.
cryptoKeyPair.privateKey
- Тип: <CryptoKey> Объект <CryptoKey>, свойство
typeкоторого будет иметь значение'private'.
cryptoKeyPair.publicKey
- Тип: <CryptoKey> Объект <CryptoKey>, свойство
typeкоторого будет иметь значение'public'.
Class: SubtleCrypto
subtle.decrypt(algorithm, key, data)
-
algorithm: <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams> -
key: <CryptoKey> -
data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> - Возвращает: <Promise> Выполняется с результатом <ArrayBuffer>
Используя метод и параметры, указанные в algorithm, и ключевой материал, предоставленный key, subtle.decrypt() пытается расшифровать предоставленные data. В случае успеха возвращённое обещание будет выполнено с <ArrayBuffer>, содержащим результат в открытом виде.
В настоящее время поддерживаются следующие алгоритмы:
'RSA-OAEP''AES-CTR''AES-CBC''AES-GCM'
subtle.deriveBits(algorithm, baseKey[, length])
-
algorithm: <AlgorithmIdentifier> | <EcdhKeyDeriveParams> | <HkdfParams> | <Pbkdf2Params> -
baseKey: <CryptoKey> -
length: <number> | <null> По умолчанию:null - Возвращает: <Promise> Выполняется с результатом <ArrayBuffer>
Используя метод и параметры, указанные в algorithm, и ключевой материал, предоставленный baseKey, subtle.deriveBits() пытается сгенерировать length бит.
Если length не задан или null, генерируется максимальное количество бит для данного алгоритма. Это допустимо для алгоритмов 'ECDH', 'X25519' и 'X448'; для остальных алгоритмов length должно быть числом.
В случае успеха возвращённое обещание будет выполнено с <ArrayBuffer>, содержащим сгенерированные данные.
В настоящее время поддерживаются следующие алгоритмы:
'ECDH''X25519'-
'X448'1 'HKDF''PBKDF2'
subtle.deriveKey(algorithm, baseKey, derivedKeyAlgorithm, extractable, keyUsages)
-
algorithm: <AlgorithmIdentifier> | <EcdhKeyDeriveParams> | <HkdfParams> | <Pbkdf2Params> -
baseKey: <CryptoKey> -
derivedKeyAlgorithm: <HmacKeyGenParams> | <AesKeyGenParams> -
extractable: <boolean> -
keyUsages: <string[]> См. Назначение ключа. - Возвращает: <Promise> Выполняется с результатом <CryptoKey>
Используя метод и параметры, указанные в algorithm, а также ключевой материал, предоставленный baseKey, subtle.deriveKey() пытается создать новый <CryptoKey> на основе метода и параметров из derivedKeyAlgorithm.
Вызов subtle.deriveKey() эквивалентен вызову subtle.deriveBits() для генерации необработанного ключевого материала с последующей передачей результата в метод subtle.importKey() с использованием параметров deriveKeyAlgorithm, extractable и keyUsages в качестве входных данных.
В настоящее время поддерживаются следующие алгоритмы:
'ECDH''X25519'-
'X448'1 'HKDF''PBKDF2'
subtle.digest(algorithm, data)
-
algorithm: <string> | <Object> -
data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> - Возвращает: <Promise> Выполняется с результатом <ArrayBuffer>
Используя метод, определённый algorithm, subtle.digest() пытается вычислить дайджест для data. В случае успеха возвращённое обещание выполняется с <ArrayBuffer>, содержащим вычисленный дайджест.
Если algorithm задан как <string>, он должен быть одним из следующих значений:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если algorithm задан как <Object>, он должен иметь свойство name, значением которого является одно из перечисленных выше.
subtle.encrypt(algorithm, key, data)
-
algorithm: <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams> -
key: <CryptoKey> -
data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> - Возвращает: <Promise> Выполняется с результатом <ArrayBuffer>
Используя метод и параметры, указанные в algorithm, и ключевой материал, предоставленный key, subtle.encrypt() пытается зашифровать data. В случае успеха возвращённое обещание выполняется с <ArrayBuffer>, содержащим результат шифрования.
В настоящее время поддерживаются следующие алгоритмы:
'RSA-OAEP''AES-CTR''AES-CBC''AES-GCM'
subtle.exportKey(format, key)
-
format: <string> Должно быть одним из значений'raw','pkcs8','spki'или'jwk'. -
key: <CryptoKey> - Возвращает: <Promise> Выполняется с результатом <ArrayBuffer> | <Object>.
Экспортирует указанный ключ в заданном формате, если он поддерживается.
Если <CryptoKey> не является извлекаемым, возвращённое обещание будет отклонено.
Если format имеет значение 'pkcs8' или 'spki' и экспорт выполнен успешно, возвращённое обещание будет выполнено с <ArrayBuffer>, содержащим экспортированные данные ключа.
Если format имеет значение 'jwk' и экспорт выполнен успешно, возвращённое обещание будет выполнено с объектом JavaScript, соответствующим спецификации JSON Web Key.
| Тип ключа | 'spki' |
'pkcs8' |
'jwk' |
'raw' |
|---|---|---|---|---|
'AES-CBC' |
✔ | ✔ | ||
'AES-CTR' |
✔ | ✔ | ||
'AES-GCM' |
✔ | ✔ | ||
'AES-KW' |
✔ | ✔ | ||
'ECDH' |
✔ | ✔ | ✔ | ✔ |
'ECDSA' |
✔ | ✔ | ✔ | ✔ |
'Ed25519' |
✔ | ✔ | ✔ | ✔ |
'Ed448' 1
|
✔ | ✔ | ✔ | ✔ |
'HDKF' |
||||
'HMAC' |
✔ | ✔ | ||
'PBKDF2' |
||||
'RSA-OAEP' |
✔ | ✔ | ✔ | |
'RSA-PSS' |
✔ | ✔ | ✔ | |
'RSASSA-PKCS1-v1_5' |
✔ | ✔ | ✔ |
subtle.generateKey(algorithm, extractable, keyUsages)
-
algorithm: <AlgorithmIdentifier> | <RsaHashedKeyGenParams> | <EcKeyGenParams> | <HmacKeyGenParams> | <AesKeyGenParams>
-
extractable: <boolean> -
keyUsages: <string[]> См. Назначение ключа. - Возвращает: <Promise> Выполняется с результатом <CryptoKey> | <CryptoKeyPair>
Используя метод и параметры, предоставленные в algorithm, subtle.generateKey() пытается сгенерировать новый ключевой материал. В зависимости от используемого метода может быть сгенерирован один <CryptoKey> или пара <CryptoKeyPair>.
Поддерживаются следующие алгоритмы генерации <CryptoKeyPair> (открытого и закрытого ключей):
Поддерживаются следующие алгоритмы генерации <CryptoKey> (секретного ключа):
'HMAC''AES-CTR''AES-CBC''AES-GCM''AES-KW'
subtle.importKey(format, keyData, algorithm, extractable, keyUsages)
-
format: <string> Должно быть одним из значений'raw','pkcs8','spki'или'jwk'. -
keyData: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> | <Object>
-
algorithm: <AlgorithmIdentifier> | <RsaHashedImportParams> | <EcKeyImportParams> | <HmacImportParams>
-
extractable: <boolean> -
keyUsages: <string[]> См. Назначение ключа. - Возвращает: <Promise> Выполняется с результатом <CryptoKey>
Метод subtle.importKey() пытается интерпретировать предоставленные keyData как указанный format, чтобы создать экземпляр <CryptoKey> с использованием аргументов algorithm, extractable и keyUsages. Если импорт выполнен успешно, возвращённое обещание будет выполнено с созданным <CryptoKey>.
При импорте ключа 'PBKDF2' значение extractable должно быть false.
В настоящее время поддерживаются следующие алгоритмы:
| Тип ключа | 'spki' |
'pkcs8' |
'jwk' |
'raw' |
|---|---|---|---|---|
'AES-CBC' |
✔ | ✔ | ||
'AES-CTR' |
✔ | ✔ | ||
'AES-GCM' |
✔ | ✔ | ||
'AES-KW' |
✔ | ✔ | ||
'ECDH' |
✔ | ✔ | ✔ | ✔ |
'X25519' |
✔ | ✔ | ✔ | ✔ |
'X448' 1
|
✔ | ✔ | ✔ | ✔ |
'ECDSA' |
✔ | ✔ | ✔ | ✔ |
'Ed25519' |
✔ | ✔ | ✔ | ✔ |
'Ed448' 1
|
✔ | ✔ | ✔ | ✔ |
'HDKF' |
✔ | |||
'HMAC' |
✔ | ✔ | ||
'PBKDF2' |
✔ | |||
'RSA-OAEP' |
✔ | ✔ | ✔ | |
'RSA-PSS' |
✔ | ✔ | ✔ | |
'RSASSA-PKCS1-v1_5' |
✔ | ✔ | ✔ |
subtle.sign(algorithm, key, data)
-
algorithm: <AlgorithmIdentifier> | <RsaPssParams> | <EcdsaParams> | <Ed448Params> -
key: <CryptoKey> -
data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> - Возвращает: <Promise> Выполняется с результатом <ArrayBuffer>
Используя метод и параметры, указанные в algorithm, и ключевой материал, предоставленный key, subtle.sign() пытается создать криптографическую подпись для data. В случае успеха возвращённое обещание выполняется с <ArrayBuffer>, содержащим созданную подпись.
В настоящее время поддерживаются следующие алгоритмы:
'RSASSA-PKCS1-v1_5''RSA-PSS''ECDSA''Ed25519'-
'Ed448'1 'HMAC'
subtle.unwrapKey(format, wrappedKey, unwrappingKey, unwrapAlgo, unwrappedKeyAlgo, extractable, keyUsages)
-
format: <string> Должно быть одним из значений'raw','pkcs8','spki'или'jwk'. -
wrappedKey: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> -
unwrappingKey: <CryptoKey>
-
unwrapAlgo: <AlgorithmIdentifier> | <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams> -
unwrappedKeyAlgo: <AlgorithmIdentifier> | <RsaHashedImportParams> | <EcKeyImportParams> | <HmacImportParams>
-
extractable: <boolean> -
keyUsages: <string[]> См. Назначение ключа. - Возвращает: <Promise> Выполняется с результатом <CryptoKey>
В криптографии «оборачивание ключа» означает его экспорт с последующим шифрованием ключевого материала. Метод subtle.unwrapKey() пытается расшифровать обёрнутый ключ и создать экземпляр <CryptoKey>. Он эквивалентен сначала вызову subtle.decrypt() для зашифрованных данных ключа (с использованием аргументов wrappedKey, unwrapAlgo и unwrappingKey в качестве входных данных), а затем передаче результатов методу subtle.importKey() с аргументами unwrappedKeyAlgo, extractable и keyUsages в качестве входных данных. В случае успеха возвращённое обещание выполняется с объектом <CryptoKey>.
В настоящее время поддерживаются следующие алгоритмы оборачивания:
'RSA-OAEP''AES-CTR''AES-CBC''AES-GCM''AES-KW'
Поддерживаются следующие алгоритмы развёрнутых ключей:
'RSASSA-PKCS1-v1_5''RSA-PSS''RSA-OAEP''ECDSA''Ed25519'-
'Ed448'1 'ECDH''X25519'-
'X448'1 'HMAC''AES-CTR''AES-CBC''AES-GCM''AES-KW'
subtle.verify(algorithm, key, signature, data)
-
algorithm: <AlgorithmIdentifier> | <RsaPssParams> | <EcdsaParams> | <Ed448Params> -
key: <CryptoKey> -
signature: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> -
data: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> - Возвращает: <Promise> Выполняется с результатом типа <boolean>
Используя метод и параметры, заданные в algorithm, а также ключевой материал, предоставленный key, subtle.verify() пытается проверить, что signature является действительной криптографической подписью data. Возвращённый промис разрешается со значением true или false.
В настоящее время поддерживаются следующие алгоритмы:
'RSASSA-PKCS1-v1_5''RSA-PSS''ECDSA''Ed25519'-
'Ed448'1 'HMAC'
subtle.wrapKey(format, key, wrappingKey, wrapAlgo)
-
format: <string> Должно иметь значение'raw','pkcs8','spki'или'jwk'. -
key: <CryptoKey> -
wrappingKey: <CryptoKey> -
wrapAlgo: <AlgorithmIdentifier> | <RsaOaepParams> | <AesCtrParams> | <AesCbcParams> | <AesGcmParams> - Возвращает: <Promise> Выполняется с результатом типа <ArrayBuffer>
В криптографии «обёртывание ключа» означает экспорт ключевого материала с последующим его шифрованием. Метод subtle.wrapKey() экспортирует ключевой материал в формате, определённом format, а затем шифрует его, используя метод и параметры, заданные в wrapAlgo, и ключевой материал, предоставленный wrappingKey. Это эквивалентно вызову subtle.exportKey() с аргументами format и key, а затем передаче результата методу subtle.encrypt() с входными данными wrappingKey и wrapAlgo. В случае успеха возвращённый промис будет разрешён объектом <ArrayBuffer>, содержащим зашифрованные данные ключа.
В настоящее время поддерживаются следующие алгоритмы обёртывания:
'RSA-OAEP''AES-CTR''AES-CBC''AES-GCM''AES-KW'
Параметры алгоритмов
Объекты параметров алгоритмов определяют методы и параметры, используемые различными методами <SubtleCrypto>. Хотя здесь они описаны как «классы», на самом деле это простые объекты-словари JavaScript.
Класс: AlgorithmIdentifier
algorithmIdentifier.name
- Тип: <string>
Класс: AesCbcParams
aesCbcParams.iv
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Задает вектор инициализации. Его длина должна составлять ровно 16 байт; он должен быть непредсказуемым и криптографически случайным.
aesCbcParams.name
- Тип: <string> Должно быть
'AES-CBC'.
Класс: AesCtrParams
aesCtrParams.counter
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Начальное значение блока счетчика. Его длина должна составлять ровно 16 байт.
Метод AES-CTR использует крайние правые length битов блока в качестве счетчика, а остальные биты — в качестве nonce.
aesCtrParams.length
- Тип: <number> Число битов в
aesCtrParams.counter, используемых в качестве счетчика.
aesCtrParams.name
- Тип: <string> Должно быть
'AES-CTR'.
Класс: AesGcmParams
aesGcmParams.additionalData
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> | <undefined>
В методе AES-GCM параметр additionalData представляет собой дополнительные входные данные, которые не шифруются, но участвуют в аутентификации данных. Использование additionalData необязательно.
aesGcmParams.iv
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Вектор инициализации должен быть уникальным для каждой операции шифрования с использованием данного ключа.
В идеале это детерминированное значение длиной 12 байт, вычисленное таким образом, чтобы гарантировать его уникальность во всех вызовах с одним и тем же ключом. В качестве альтернативы вектор инициализации может состоять как минимум из 12 криптографически случайных байт. Дополнительные сведения о формировании векторов инициализации для AES-GCM см. в разделе 8 документа NIST SP 800-38D.
aesGcmParams.name
- Тип: <string> Должно быть
'AES-GCM'.
aesGcmParams.tagLength
- Тип: <number> Размер создаваемого тега аутентификации в битах. Это значение должно быть одним из следующих:
32,64,96,104,112,120или128. По умолчанию:128.
Класс: AesKeyGenParams
aesKeyGenParams.length
- Тип: <number>
Длина создаваемого ключа AES. Она должна быть равна 128, 192 или 256.
aesKeyGenParams.name
- Тип: <string> Должно быть одним из следующих значений:
'AES-CBC','AES-CTR','AES-GCM'или'AES-KW'
Класс: EcdhKeyDeriveParams
ecdhKeyDeriveParams.name
- Тип: <string> Должно быть
'ECDH','X25519'или'X448'.
ecdhKeyDeriveParams.public
- Тип: <CryptoKey>
Получение ключа ECDH выполняется путем передачи в качестве входных данных закрытого ключа одной стороны и открытого ключа другой стороны — с их помощью создается общий общий секрет. Свойству ecdhKeyDeriveParams.public присваивается открытый ключ другой стороны.
Класс: EcdsaParams
ecdsaParams.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
ecdsaParams.name
- Тип: <string> Должно быть
'ECDSA'.
Класс: EcKeyGenParams
ecKeyGenParams.name
- Тип: <string> Должно быть
'ECDSA'или'ECDH'.
ecKeyGenParams.namedCurve
- Тип: <string> Должно быть
'P-256','P-384'или'P-521'.
Класс: EcKeyImportParams
ecKeyImportParams.name
- Тип: <string> Должно быть
'ECDSA'или'ECDH'.
ecKeyImportParams.namedCurve
- Тип: <string> Должно быть
'P-256','P-384'или'P-521'.
Класс: Ed448Params
ed448Params.name
- Тип: <string> Должно быть
'Ed448'.
ed448Params.context
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer> | <undefined>
Элемент context представляет собой необязательные контекстные данные, связываемые с сообщением. Реализация Web Crypto API в Node.js поддерживает только контекст нулевой длины, что равнозначно отсутствию контекста.
Класс: HkdfParams
hkdfParams.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
hkdfParams.info
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Предоставляет контекстные входные данные, специфичные для приложения, для алгоритма HKDF. Их длина может быть нулевой, но значение должно быть задано.
hkdfParams.name
- Тип: <string> Должно быть
'HKDF'.
hkdfParams.salt
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Значение соли значительно повышает стойкость алгоритма HKDF. Оно должно быть случайным или псевдослучайным и иметь ту же длину, что и результат хеш-функции (например, при использовании 'SHA-256' в качестве хеш-функции соль должна состоять из 256 случайных битов).
Класс: HmacImportParams
hmacImportParams.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
hmacImportParams.length
- Тип: <number>
Необязательное число битов в ключе HMAC. Обычно этот параметр не нужен и его следует опускать.
hmacImportParams.name
- Тип: <string> Должно быть
'HMAC'.
Класс: HmacKeyGenParams
hmacKeyGenParams.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
hmacKeyGenParams.length
- Тип: <number>
Число битов создаваемого ключа HMAC. Если не указано, длина определяется используемым алгоритмом хеширования. Обычно этот параметр не нужен и его следует опускать.
hmacKeyGenParams.name
- Тип: <string> Должно быть
'HMAC'.
Класс: Pbkdf2Params
pbkdb2Params.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
pbkdf2Params.iterations
- Тип: <number>
Число итераций, выполняемых алгоритмом PBKDF2 при получении битов.
pbkdf2Params.name
- Тип: <string> Должно быть
'PBKDF2'.
pbkdf2Params.salt
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Должно содержать не менее 16 случайных или псевдослучайных байтов.
Класс: RsaHashedImportParams
rsaHashedImportParams.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
rsaHashedImportParams.name
- Тип: <string> Должно быть
'RSASSA-PKCS1-v1_5','RSA-PSS'или'RSA-OAEP'.
Класс: RsaHashedKeyGenParams
rsaHashedKeyGenParams.hash
Если значение представлено в виде <string>, оно должно быть одним из следующих:
'SHA-1''SHA-256''SHA-384''SHA-512'
Если значение представлено в виде <Object>, объект должен иметь свойство name, значение которого должно совпадать с одним из перечисленных выше.
rsaHashedKeyGenParams.modulusLength
- Тип: <number>
Длина модуля RSA в битах. В соответствии с рекомендациями она должна составлять не менее 2048.
rsaHashedKeyGenParams.name
- Тип: <string> Должно быть
'RSASSA-PKCS1-v1_5','RSA-PSS'или'RSA-OAEP'.
rsaHashedKeyGenParams.publicExponent
- Тип: <Uint8Array>
Открытая экспонента RSA. Это должен быть <Uint8Array>, содержащий беззнаковое целое число в порядке от старшего байта к младшему, которое должно умещаться в 32 бита. <Uint8Array> может содержать произвольное число ведущих нулевых битов. Значение должно быть простым числом. Если нет причин использовать другое значение, задайте в качестве открытой экспоненты new Uint8Array([1, 0, 1]) (65537).
Класс: RsaOaepParams
rsaOaepParams.label
- Тип: <ArrayBuffer> | <TypedArray> | <DataView> | <Buffer>
Дополнительный набор байтов, который не шифруется, но связывается с созданным шифротекстом.
Параметр rsaOaepParams.label необязателен.
rsaOaepParams.name
- Тип: <string> Должно быть
'RSA-OAEP'.
Класс: RsaPssParams
rsaPssParams.name
- Тип: <string> Должно быть
'RSA-PSS'.
rsaPssParams.saltLength
- Тип: <number>
Длина (в байтах) используемой случайной соли.
Сноски
© Joyent, Inc. and other Node contributors
Licensed under the MIT License.
Node.js is a trademark of Joyent, Inc. and is used with its permission.
We are not endorsed by or affiliated with Joyent.
https://nodejs.org/dist/latest-v20.x/docs/api/webcrypto.html