CryptoKey

A interface CryptoKey do Azion Runtime: o objeto de chave que os métodos SubtleCrypto retornam, como uma function obtém um e as suas propriedades.

Última atualização

Ver como Markdown Configurar agente

A interface CryptoKey representa uma chave criptográfica que um dos métodos do SubtleCrypto retorna. Em uma function da Azion, uma CryptoKey é o objeto que você passa para o SubtleCrypto ao criptografar, descriptografar, assinar ou verificar dados. Para mais informações, consulte CryptoKey na MDN Web Docs.

Use uma CryptoKey para guardar uma chave secreta importada que verifica tokens assinados ou assinaturas HMAC. Um par de chaves gerado pode assinar ou criptografar payloads antes que eles saiam da function. As suas usages restringem como a chave é aplicada, de modo que uma chave pode assinar, mas não descriptografar, por exemplo. A function trata a chave como um objeto opaco: o material bruto da chave fica fora do código, a menos que a chave seja extraível e você a exporte.

Construtor

CryptoKey não tem construtor público: new CryptoKey() lança TypeError: Illegal constructor. Uma function obtém uma chave por meio destes métodos do SubtleCrypto:

MétodoRetorna
crypto.subtle.generateKey()Uma nova CryptoKey para um algoritmo simétrico, como AES-GCM ou AES-KW. Para um algoritmo assimétrico, como ECDSA, um objeto com uma privateKey e uma publicKey.
crypto.subtle.importKey()Uma CryptoKey construída a partir dos dados de chave que você fornece, como os bytes brutos de um segredo.
crypto.subtle.deriveKey()Uma CryptoKey derivada de uma chave base, como uma chave AES-GCM derivada com PBKDF2.
crypto.subtle.unwrapKey()Uma CryptoKey descriptografada a partir de uma chave encapsulada, como uma chave encapsulada com AES-KW.

Propriedades

As propriedades são somente leitura. Elas descrevem o que a chave é e a quais operações ela pode ser aplicada, para que o runtime aplique uma chave apenas às operações para as quais ela foi criada:

PropriedadeTipoDescrição
typeStringTipo de chave: secret para uma chave simétrica, private ou public para uma das metades de um par de chaves.
extractableBooleantrue quando crypto.subtle.exportKey() ou crypto.subtle.wrapKey() pode exportar a chave. O método que cria a chave define esse valor. A exportação de uma chave cujo valor é false é rejeitada com InvalidAccessError: Key is not extractable.
algorithmObjectAlgoritmo com o qual a chave é usada, em name, e os seus parâmetros, como length e hash.
usagesArray de stringsOperações que a chave pode executar: encrypt, decrypt, sign, verify, deriveKey, deriveBits, wrapKey e unwrapKey. O método que cria a chave as define.

Exemplo

Este handler importa um segredo como uma chave HMAC e assina uma mensagem. Ele verifica a assinatura contra a mensagem e contra uma versão adulterada dela, depois retorna os resultados e as propriedades da chave:

JavaScript
01const enc = new TextEncoder();
02const hex = (buf) => Array.from(new Uint8Array(buf), (b) => b.toString(16).padStart(2, '0')).join('');
03
04export default {
05 async fetch(request, env, ctx) {
06 const key = await crypto.subtle.importKey('raw', enc.encode('a secret'), { name: 'HMAC', hash: 'SHA-256' }, false, ['sign', 'verify']);
07 const sig = await crypto.subtle.sign('HMAC', key, enc.encode('Azion Functions'));
08 const ok = await crypto.subtle.verify('HMAC', key, sig, enc.encode('Azion Functions'));
09 const bad = await crypto.subtle.verify('HMAC', key, sig, enc.encode('tampered'));
10 return Response.json({
11 signatureHex: hex(sig),
12 verifies: ok,
13 rejectsTampered: !bad,
14 key: { type: key.type, extractable: key.extractable, algorithm: key.algorithm, usages: key.usages, ctor: key.constructor.name },
15 });
16 },
17};

A function retorna estes valores. A chave é uma CryptoKey do tipo secret e não é extraível porque importKey() recebeu false:

JSON
01{
02 "signatureHex": "86fec9e22ad82998c7007d637f61a5206e2b64ee2a8ac2ed12f1f359e3d14bc6",
03 "verifies": true,
04 "rejectsTampered": true,
05 "key": {
06 "type": "secret",
07 "extractable": false,
08 "algorithm": {
09 "name": "HMAC",
10 "length": 64,
11 "hash": {
12 "name": "SHA-256"
13 }
14 },
15 "usages": [
16 "sign",
17 "verify"
18 ],
19 "ctor": "CryptoKey"
20 }
21}

Recursos relacionados

SubtleCrypto

Os métodos que criam uma CryptoKey e as operações que a usam.

Crypto

O objeto global crypto, que dá acesso ao SubtleCrypto.

node:crypto

O módulo crypto do Node.js, para código escrito para o Node.js.

Web APIs

As outras Web APIs que o Azion Runtime suporta.