SubtleCrypto: deriveKey() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die deriveKey() Methode des SubtleCrypto Interfaces kann verwendet werden, um einen geheimen Schlüssel aus einem Master-Schlüssel abzuleiten.

Sie nimmt als Argumente ein anfängliches Schlüsselmateriel, den zu verwendenden Ableitungsalgorithmus und die gewünschten Eigenschaften des abzuleitenden Schlüssels. Sie gibt ein Promise zurück, das mit einem CryptoKey Objekt erfüllt wird, das den neuen Schlüssel repräsentiert.

Es ist erwähnenswert, dass die unterstützten Schlüsselableitungsalgorithmen sehr unterschiedliche Eigenschaften haben und für sehr unterschiedliche Situationen geeignet sind. Siehe Unterstützte Algorithmen für weitere Details hierzu.

Syntax

js
deriveKey(algorithm, baseKey, derivedKeyAlgorithm, extractable, keyUsages)

Parameter

algorithm

Ein Objekt, das den zu verwendenden Ableitungsalgorithmus definiert.

baseKey

Ein CryptoKey, der die Eingabe für den Ableitungsalgorithmus darstellt. Wenn algorithm ECDH oder X25519 ist, dann wird dies der ECDH oder X25519 private Schlüssel sein. Andernfalls wird es das anfängliche Schlüsselmateriel für die Ableitungsfunktion sein: zum Beispiel könnte es bei PBKDF2 ein Passwort sein, das als CryptoKey importiert wurde, unter Verwendung von SubtleCrypto.importKey().

derivedKeyAlgorithm

Ein Objekt, das den Algorithmus definiert, für den der abgeleitete Schlüssel verwendet werden soll:

extractable

Ein boolescher Wert, der angibt, ob es möglich sein wird, den Schlüssel mit SubtleCrypto.exportKey() oder SubtleCrypto.wrapKey() zu exportieren.

keyUsages

Ein Array, das angibt, was mit dem abgeleiteten Schlüssel getan werden kann. Beachten Sie, dass die Schlüsselverwendungen durch den im derivedKeyAlgorithm festgelegten Algorithmus erlaubt sein müssen. Mögliche Werte des Arrays sind:

  • encrypt: Der Schlüssel kann verwendet werden, um Nachrichten zu verschlüsseln.
  • decrypt: Der Schlüssel kann verwendet werden, um Nachrichten zu entschlüsseln.
  • sign: Der Schlüssel kann verwendet werden, um Nachrichten zu signieren.
  • verify: Der Schlüssel kann verwendet werden, um Signaturen zu überprüfen.
  • deriveKey: Der Schlüssel kann verwendet werden, um einen neuen Schlüssel abzuleiten.
  • deriveBits: Der Schlüssel kann verwendet werden, um Bits abzuleiten.
  • wrapKey: Der Schlüssel kann verwendet werden, um einen Schlüssel zu verpacken.
  • unwrapKey: Der Schlüssel kann verwendet werden, um einen Schlüssel zu entpacken.

Rückgabewert

Ein Promise, das mit einem CryptoKey erfüllt wird.

Ausnahmen

Das Promise wird abgelehnt, wenn eine der folgenden Ausnahmen auftritt:

InvalidAccessError DOMException

Wird ausgelöst, wenn der Master-Schlüssel kein Schlüssel für den angeforderten Ableitungsalgorithmus ist oder wenn der keyUsages Wert dieses Schlüssels nicht deriveKey enthält.

NotSupported DOMException

Wird ausgelöst, wenn versucht wird, einen Algorithmus zu verwenden, der entweder unbekannt oder nicht für die Ableitung geeignet ist, oder wenn der angeforderte Algorithmus für den abgeleiteten Schlüssel keine Schlüssellänge definiert.

SyntaxError DOMException

Wird ausgelöst, wenn keyUsages leer ist, aber der entpackte Schlüssel vom Typ secret oder private ist.

Unterstützte Algorithmen

Die von deriveKey() unterstützten Algorithmen haben sehr unterschiedliche Eigenschaften und sind für unterschiedliche Situationen geeignet.

Schlüsselableitungsalgorithmen

HKDF

HKDF ist eine Schlüsselableitungsfunktion. Es ist dazu ausgelegt, Schlüsselmateriel aus einer hochentropischen Eingabe abzuleiten, wie z.B. dem Output eines ECDH-Schlüsselaustauschvorgangs.

Es ist nicht dazu ausgelegt, Schlüssel aus relativ niedriegen Entropie-Eingaben wie Passwörtern abzuleiten. Dafür sollte PBKDF2 verwendet werden.

HKDF ist in RFC 5869 spezifiziert.

PBKDF2

PBKDF2 ist ebenfalls eine Schlüsselableitungsfunktion. Es ist dazu ausgelegt, Schlüsselmateriel aus einer relativ niedriegen Entropiequelle wie einem Passwort abzuleiten. Es leitet Schlüsselmateriel ab, indem es eine Funktion wie HMAC auf das Eingabepasswort zusammen mit etwas Salz anwendet und diesen Prozess viele Male wiederholt. Je häufiger der Prozess wiederholt wird, desto rechenaufwändiger ist die Schlüsselerstellung: dies erschwert es einem Angreifer, den Schlüssel mit einer Brute-Force-Attacke durch eine Wörterbuchattacke zu entdecken.

PBKDF2 ist in RFC 2898 spezifiziert.

Schlüsselvereinbarungsalgorithmen

ECDH

ECDH (Elliptic Curve Diffie-Hellman) ist ein Schlüsselvereinbarungsalgorithmus. Er ermöglicht es zwei Personen, die jeweils ein ECDH-Öffentlich/Privat-Schlüsselpaar haben, ein gemeinsames Geheimnis zu erzeugen: das heißt, ein Geheimnis, das sie - und niemand sonst - teilen können. Sie können dann dieses gemeinsame Geheimnis als symmetrischen Schlüssel verwenden, um ihre Kommunikation zu sichern, oder das Geheimnis verwenden, um einen solchen Schlüssel abzuleiten (zum Beispiel unter Verwendung des HKDF-Algorithmus).

ECDH ist in RFC 6090 spezifiziert.

X25519

X25519 ist ein Schlüsselvereinbarungsalgorithmus wie ECDH, basiert jedoch auf der Curve25519 elliptischen Kurve, die zur Familie der Edwards-Curve Digital Signature Algorithm (EdDSA) Algorithmen gehört, die in RFC 8032 definiert sind.

Die Curve25519 Algorithmen sind weit verbreitet in der Kryptographie und gelten als einige der effizientesten/schnellsten verfügbaren. Im Vergleich zu den von ECDH verwendeten NIST (National Institute of Standards and Technology) Kurven-Schlüsselaustauschalgorithmen ist Curve25519 einfacher zu implementieren, und sein nicht-staatlicher Ursprung bedeutet, dass die Entscheidungen hinter seinen Designwahlen transparent und offen sind.

X25519 ist in RFC 7748 spezifiziert.

Beispiele

Hinweis: Sie können die funktionierenden Beispiele hier ausprobieren auf GitHub.

ECDH: Abgeleiteten gemeinsamen geheimen Schlüssel

In diesem Beispiel generieren Alice und Bob jeweils ein ECDH-Schlüsselpaar und tauschen dann öffentliche Schlüssel aus. Sie verwenden dann deriveKey(), um einen gemeinsamen AES-Schlüssel abzuleiten, den sie zum Verschlüsseln von Nachrichten verwenden könnten. Sehen Sie den vollständigen Code auf GitHub.

js
/*
Derive an AES key, given:
- our ECDH private key
- their ECDH public key
*/
function deriveSecretKey(privateKey, publicKey) {
  return window.crypto.subtle.deriveKey(
    {
      name: "ECDH",
      public: publicKey,
    },
    privateKey,
    {
      name: "AES-GCM",
      length: 256,
    },
    false,
    ["encrypt", "decrypt"],
  );
}

async function agreeSharedSecretKey() {
  // Generate 2 ECDH key pairs: one for Alice and one for Bob
  // In more normal usage, they would generate their key pairs
  // separately and exchange public keys securely
  let aliceKeyPair = await window.crypto.subtle.generateKey(
    {
      name: "ECDH",
      namedCurve: "P-384",
    },
    false,
    ["deriveKey"],
  );

  let bobKeyPair = await window.crypto.subtle.generateKey(
    {
      name: "ECDH",
      namedCurve: "P-384",
    },
    false,
    ["deriveKey"],
  );

  // Alice then generates a secret key using her private key and Bob's public key.
  let aliceSecretKey = await deriveSecretKey(
    aliceKeyPair.privateKey,
    bobKeyPair.publicKey,
  );

  // Bob generates the same secret key using his private key and Alice's public key.
  let bobSecretKey = await deriveSecretKey(
    bobKeyPair.privateKey,
    aliceKeyPair.publicKey,
  );

  // Alice can then use her copy of the secret key to encrypt a message to Bob.
  let encryptButton = document.querySelector(".ecdh .encrypt-button");
  encryptButton.addEventListener("click", () => {
    encrypt(aliceSecretKey);
  });

  // Bob can use his copy to decrypt the message.
  let decryptButton = document.querySelector(".ecdh .decrypt-button");
  decryptButton.addEventListener("click", () => {
    decrypt(bobSecretKey);
  });
}

X25519: Abgeleiteten gemeinsamen geheimen Schlüssel

In diesem Beispiel generieren Alice und Bob jeweils ein X25519-Schlüsselpaar und tauschen dann öffentliche Schlüssel aus. Sie verwenden dann jeweils deriveKey(), um aus ihrem eigenen privaten Schlüssel und dem öffentlichen Schlüssel des anderen einen gemeinsamen AES-Schlüssel abzuleiten. Sie können diesen gemeinsamen Schlüssel verwenden, um Nachrichten, die sie austauschen, zu verschlüsseln und zu entschlüsseln.

HTML

Zuerst definieren wir ein HTML <input>, das Sie verwenden, um die Klartextnachricht einzugeben, die "Alice" senden wird, und einen Button, den Sie anklicken können, um den Verschlüsselungsprozess zu starten.

html
<label for="message">Plaintext message from Alice (Enter):</label>
<input
  type="text"
  id="message"
  name="message"
  size="50"
  value="The lion roars near dawn" />
<input id="encrypt-button" type="button" value="Encrypt" />

Es folgen zwei weitere Elemente zum Anzeigen des Chiffriertexts, nachdem Alice den Klartext mit ihrer Kopie des geheimen Schlüssels verschlüsselt hat, und zum Anzeigen des Textes, nachdem Bob ihn mit seiner Kopie des geheimen Schlüssels entschlüsselt hat.

html
<div id="results">
  <label for="encrypted">Encrypted (Alice)</label>
  <input
    type="text"
    id="encrypted"
    name="encrypted"
    size="30"
    value=""
    readonly />

  <label for="results">Decrypted (Bob)</label>
  <input
    type="text"
    id="decrypted"
    name="decrypted"
    size="50"
    value=""
    readonly />
</div>

JavaScript

Der folgende Code zeigt, wie wir deriveKey() verwenden. Wir übergeben den öffentlichen X25519-Schlüssel der entfernten Partei, den privaten X25519-Schlüssel der lokalen Partei und spezifizieren, dass der abgeleitete Schlüssel ein AES-GCM-Schlüssel sein soll. Wir setzen den abgeleiteten Schlüssel auch als nicht extrahierbar und geeignet für Verschlüsselung und Entschlüsselung.

Wir verwenden diese Funktion weiter unten im Code, um gemeinsame Schlüssel für Bob und Alice zu erstellen.

js
/*
Derive an AES-GCM key, given:
- our X25519 private key
- their X25519 public key
*/
function deriveSecretKey(privateKey, publicKey) {
  return window.crypto.subtle.deriveKey(
    {
      name: "X25519",
      public: publicKey,
    },
    privateKey,
    {
      name: "AES-GCM",
      length: 256,
    },
    false,
    ["encrypt", "decrypt"],
  );
}

Als nächstes definieren wir die Funktionen, die Alice verwenden wird, um ihre Klartextnachricht in UTF-8 zu kodieren und dann zu verschlüsseln, und die Bob verwenden wird, um die Nachricht zu entschlüsseln und dann zu dekodieren. Sie nehmen beide den gemeinsamen AES-Schlüssel, einen Initialisierungsvektor und den zu verschlüsselnden oder entschlüsselnden Text als Argumente.

Der gleiche Initialisierungsvektor muss für die Verschlüsselung und Entschlüsselung verwendet werden, aber er muss nicht geheim sein, daher wird er normalerweise zusammen mit der verschlüsselten Nachricht gesendet. In diesem Fall machen wir ihn jedoch direkt verfügbar, da wir keine Nachricht tatsächlich senden.

js
async function encryptMessage(key, initializationVector, message) {
  try {
    const encoder = new TextEncoder();
    encodedMessage = encoder.encode(message);
    // iv will be needed for decryption
    return await window.crypto.subtle.encrypt(
      { name: "AES-GCM", iv: initializationVector },
      key,
      encodedMessage,
    );
  } catch (e) {
    console.log(e);
    return `Encoding error`;
  }
}

async function decryptMessage(key, initializationVector, ciphertext) {
  try {
    const decryptedText = await window.crypto.subtle.decrypt(
      // The iv value must be the same as that used for encryption
      { name: "AES-GCM", iv: initializationVector },
      key,
      ciphertext,
    );

    const utf8Decoder = new TextDecoder();
    return utf8Decoder.decode(decryptedText);
  } catch (e) {
    console.log(e);
    return "Decryption error";
  }
}

Die Funktion agreeSharedSecretKey() unten wird beim Laden aufgerufen, um Paare und gemeinsame Schlüssel für Alice und Bob zu generieren. Sie fügt auch einen Klick-Handler für den "Verschlüsseln"-Button hinzu, der die Verschlüsselung und anschließend die Entschlüsselung des Textes aus dem ersten <input> auslöst. Beachten Sie, dass der gesamte Code in einem try...catch Handler ist, um sicherzustellen, dass wir den Fall protokollieren können, in dem die Schlüsselgenerierung fehlschlägt, weil der X25519-Algorithmus nicht unterstützt wird.

js
async function agreeSharedSecretKey() {
  try {
    // Generate 2 X25519 key pairs: one for Alice and one for Bob
    // In more normal usage, they would generate their key pairs
    // separately and exchange public keys securely
    const aliceKeyPair = await window.crypto.subtle.generateKey(
      {
        name: "X25519",
      },
      false,
      ["deriveKey"],
    );

    log(
      `Created Alice's key pair: (algorithm: ${JSON.stringify(
        aliceKeyPair.privateKey.algorithm,
      )}, usages: ${aliceKeyPair.privateKey.usages})`,
    );

    const bobKeyPair = await window.crypto.subtle.generateKey(
      {
        name: "X25519",
      },
      false,
      ["deriveKey"],
    );

    log(
      `Created Bob's key pair: (algorithm: ${JSON.stringify(
        bobKeyPair.privateKey.algorithm,
      )}, usages: ${bobKeyPair.privateKey.usages})`,
    );

    // Alice then generates a secret key using her private key and Bob's public key.
    const aliceSecretKey = await deriveSecretKey(
      aliceKeyPair.privateKey,
      bobKeyPair.publicKey,
    );

    log(
      `aliceSecretKey: ${aliceSecretKey.type} (algorithm: ${JSON.stringify(
        aliceSecretKey.algorithm,
      )}, usages: ${aliceSecretKey.usages}), `,
    );

    // Bob generates the same secret key using his private key and Alice's public key.
    const bobSecretKey = await deriveSecretKey(
      bobKeyPair.privateKey,
      aliceKeyPair.publicKey,
    );

    log(
      `bobSecretKey: ${bobSecretKey.type} (algorithm: ${JSON.stringify(
        bobSecretKey.algorithm,
      )}, usages: ${bobSecretKey.usages}), \n`,
    );

    // Get access for the encrypt button and the three inputs
    const encryptButton = document.querySelector("#encrypt-button");
    const messageInput = document.querySelector("#message");
    const encryptedInput = document.querySelector("#encrypted");
    const decryptedInput = document.querySelector("#decrypted");

    encryptButton.addEventListener("click", async () => {
      log(`Plaintext: ${messageInput.value}`);

      // Define the initialization vector used when encrypting and decrypting.
      // This must be regenerated for every message!
      const initializationVector = window.crypto.getRandomValues(
        new Uint8Array(8),
      );

      // Alice can use her copy of the shared key to encrypt the message.
      const encryptedMessage = await encryptMessage(
        aliceSecretKey,
        initializationVector,
        messageInput.value,
      );

      // We then display part of the encrypted buffer and log the encrypted message
      let buffer = new Uint8Array(encryptedMessage, 0, 5);
      encryptedInput.value = `${buffer}...[${encryptedMessage.byteLength} bytes total]`;

      log(
        `encryptedMessage: ${buffer}...[${encryptedMessage.byteLength} bytes total]`,
      );

      // Bob uses his shared secret key to decrypt the message.
      const decryptedCiphertext = await decryptMessage(
        bobSecretKey,
        initializationVector,
        encryptedMessage,
      );

      decryptedInput.value = decryptedCiphertext;
      log(`decryptedCiphertext: ${decryptedCiphertext}\n`);
    });
  } catch (e) {
    log(e);
  }
}

// Finally we call the method to set the example running.
agreeSharedSecretKey();

Ergebnis

Drücken Sie die Schaltfläche Verschlüsseln, um den Text im oberen <input>-Element zu verschlüsseln. Der verschlüsselte Chiffrier- und der entschlüsselte Chiffriertext werden in den folgenden beiden Elementen angezeigt. Der Logbereich am unteren Rand liefert Informationen über die von dem Code generierten Schlüssel.

PBKDF2: Ableiten eines AES-Schlüssels aus einem Passwort

In diesem Beispiel fragen wir den Benutzer nach einem Passwort, verwenden es dann, um einen AES-Schlüssel unter Verwendung von PBKDF2 abzuleiten, und verwenden dann den AES-Schlüssel, um eine Nachricht zu verschlüsseln. Sehen Sie den vollständigen Code auf GitHub.

js
/*
Get some key material to use as input to the deriveKey method.
The key material is a password supplied by the user.
*/
function getKeyMaterial() {
  const password = window.prompt("Enter your password");
  const enc = new TextEncoder();
  return window.crypto.subtle.importKey(
    "raw",
    enc.encode(password),
    "PBKDF2",
    false,
    ["deriveBits", "deriveKey"],
  );
}

async function encrypt(plaintext, salt, iv) {
  const keyMaterial = await getKeyMaterial();
  const key = await window.crypto.subtle.deriveKey(
    {
      name: "PBKDF2",
      salt,
      iterations: 100000,
      hash: "SHA-256",
    },
    keyMaterial,
    { name: "AES-GCM", length: 256 },
    true,
    ["encrypt", "decrypt"],
  );

  return window.crypto.subtle.encrypt({ name: "AES-GCM", iv }, key, plaintext);
}

HKDF: Ableiten eines AES-Schlüssels aus einem gemeinsamen Geheimnis

In diesem Beispiel verschlüsseln wir eine Nachricht plainText mithilfe eines gemeinsamen Geheimnisses secret, das selbst mit einem Algorithmus wie ECDH abgeleitet worden sein könnte. Anstatt das gemeinsame Geheimnis direkt zu verwenden, verwenden wir es als Schlüsselmateriel für die HKDF-Funktion, um einen AES-GCM-Verschlüsselungsschlüssel abzuleiten, den wir dann verwenden, um die Nachricht zu verschlüsseln. Sehen Sie den vollständigen Code auf GitHub.

js
/*
  Given some key material and some random salt,
  derive an AES-GCM key using HKDF.
  */
function getKey(keyMaterial, salt) {
  return window.crypto.subtle.deriveKey(
    {
      name: "HKDF",
      salt: salt,
      info: new TextEncoder().encode("Encryption example"),
      hash: "SHA-256",
    },
    keyMaterial,
    { name: "AES-GCM", length: 256 },
    true,
    ["encrypt", "decrypt"],
  );
}

async function encrypt(secret, plainText) {
  const message = {
    salt: window.crypto.getRandomValues(new Uint8Array(16)),
    iv: window.crypto.getRandomValues(new Uint8Array(12)),
  };

  const key = await getKey(secret, message.salt);

  message.ciphertext = await window.crypto.subtle.encrypt(
    {
      name: "AES-GCM",
      iv: message.iv,
    },
    key,
    plainText,
  );

  return message;
}

Spezifikationen

Specification
Web Cryptography API
# SubtleCrypto-method-deriveKey

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch