SubtleCrypto: deriveBits() method
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
* Some parts of this feature may have varying levels of support.
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inWeb Workers.
ThederiveBits() method of theSubtleCrypto interface can be used to derive an array of bits from a basekey.
It takes as its arguments the base key, the derivation algorithm to use, and the lengthof the bits to derive. It returns aPromisewhich will be fulfilled with anArrayBuffercontaining the derived bits.
This method is very similar toSubtleCrypto.deriveKey(),except thatderiveKey() returns aCryptoKey object rather than anArrayBuffer. EssentiallyderiveKey() is composed ofderiveBits() followed byimportKey().
This function supports the same derivation algorithms asderiveKey(): ECDH, HKDF, PBKDF2, and X25519.SeeSupported algorithms for some more detail on these algorithms.
In this article
Syntax
deriveBits(algorithm, baseKey, length)Parameters
algorithmAn object defining thederivation algorithm to use.
- To useECDH, pass an
EcdhKeyDeriveParamsobject, specifying the stringECDHas thenameproperty. - To useHKDF, pass an
HkdfParamsobject. - To usePBKDF2, pass a
Pbkdf2Paramsobject. - To useX25519, pass an
EcdhKeyDeriveParamsobject, specifying the stringX25519as thenameproperty.
- To useECDH, pass an
baseKeyA
CryptoKeyrepresenting the inputto the derivation algorithm. Ifalgorithmis ECDH, this will be the ECDHprivate key. Otherwise it will be the initial key material for the derivationfunction: for example, for PBKDF2 it might be a password, imported as aCryptoKeyusingSubtleCrypto.importKey().lengthA number representing the number of bits to derive. To be compatible with all browsers, the number should be a multiple of 8.
Return value
APromisethat fulfills with anArrayBuffercontaining the derived bits.
Exceptions
The promise is rejected when one of the following exceptions are encountered:
OperationErrorDOMExceptionRaised if thelength parameter of the
deriveBits()call is null, and also in some cases if thelength parameter is not a multiple of 8.InvalidAccessErrorDOMExceptionRaised when the base key is not a key for the requested derivation algorithm or ifthe
CryptoKey.usagesvalue of that key doesn't containderiveBits.NotSupportedDOMExceptionRaised when trying to use an algorithm that is either unknown or isn't suitable forderivation.
Supported algorithms
See theSupported algorithms section of thederiveKey() documentation.
Examples
Note:You cantry the working examples on GitHub.
ECDH
In this example Alice and Bob each generate an ECDH key pair.
We then use Alice's private key and Bob's public key to derive a shared secret.See the complete code on GitHub.
async function deriveSharedSecret(privateKey, publicKey) { const sharedSecret = await window.crypto.subtle.deriveBits( { name: "ECDH", namedCurve: "P-384", public: publicKey, }, privateKey, 128, ); const buffer = new Uint8Array(sharedSecret, 0, 5); const sharedSecretValue = document.querySelector(".ecdh .derived-bits-value"); sharedSecretValue.classList.add("fade-in"); sharedSecretValue.addEventListener("animationend", () => { sharedSecretValue.classList.remove("fade-in"); }); sharedSecretValue.textContent = `${buffer}…[${sharedSecret.byteLength} bytes total]`;}// 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 securelyconst generateAliceKeyPair = window.crypto.subtle.generateKey( { name: "ECDH", namedCurve: "P-384", }, false, ["deriveBits"],);const generateBobKeyPair = window.crypto.subtle.generateKey( { name: "ECDH", namedCurve: "P-384", }, false, ["deriveBits"],);Promise.all([generateAliceKeyPair, generateBobKeyPair]).then((values) => { const aliceKeyPair = values[0]; const bobKeyPair = values[1]; const deriveBitsButton = document.querySelector(".ecdh .derive-bits-button"); deriveBitsButton.addEventListener("click", () => { // Alice then generates a secret using her private key and Bob's public key. // Bob could generate the same secret using his private key and Alice's public key. deriveSharedSecret(aliceKeyPair.privateKey, bobKeyPair.publicKey); });});X25519
In this example Alice and Bob each generate an X25519 key pair.We then use Alice's private key and Bob's public key to derive a secret, and compare that with the secret generated using Bob's private key and Alice's public key to show that they are shared/identical.
HTML
The HTML defines two buttons.The "Change keys" button is pressed to generate new key pairs for Alice and Bob.The "Derive bits" button is pressed to derive a shared secret with the current set of key pairs.
<input type="button" value="Derive bits" /><input type="button" value="Change keys" /><pre></pre>#log { height: 150px; width: 90%; white-space: pre-wrap; /* wrap pre blocks */ overflow-wrap: break-word; /* break on words */ overflow-y: auto; padding: 0.5rem; border: 1px solid black;}JavaScript
const logElement = document.querySelector("#log");function log(text) { logElement.innerText = `${logElement.innerText}${text}\n`; logElement.scrollTop = logElement.scrollHeight;}The function to generate a shared secret using the X25519 algorithm is shown below.This takes a private key from one party and the public key from another.
async function deriveSharedSecret(privateKey, publicKey) { return await window.crypto.subtle.deriveBits( { name: "X25519", public: publicKey, }, privateKey, 128, );}The code below adds a function to generate new keys for Alice and Bob.This is done the first time the JavaScript is loaded, and repeated whenever the "Change keys" button is pressed (this allows us to see the effect of changing the keys on the shared secret).
let aliceKeyPair;let bobKeyPair;async function changeKeys() { try { aliceKeyPair = await window.crypto.subtle.generateKey( { name: "X25519", }, false, ["deriveBits"], ); bobKeyPair = await window.crypto.subtle.generateKey( { name: "X25519", }, false, ["deriveBits"], ); log("Keys changed"); } catch (e) { log(e); }}changeKeys();const changeKeysButton = document.querySelector("#buttonChangeKeys");// 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 securelychangeKeysButton.addEventListener("click", changeKeys);The code below adds a handler function that is invoked every time the "Derive bits" button is pressed.The handler generates the shared secrets for Alice and Bob using thederiveSharedSecret() method defined above, and logs them for easy comparison.
const deriveBitsButton = document.querySelector("#buttonDeriveKeys");deriveBitsButton.addEventListener("click", async () => { // 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 // Alice then generates a secret using her private key and Bob's public key. // Bob could generate the same secret using his private key and Alice's public key. const sharedSecretAlice = await deriveSharedSecret( aliceKeyPair.privateKey, bobKeyPair.publicKey, ); let buffer = new Uint8Array(sharedSecretAlice, 0, 10); log(`${buffer}…[${sharedSecretAlice.byteLength} bytes total] (Alice secret)`); const sharedSecretBob = await deriveSharedSecret( bobKeyPair.privateKey, aliceKeyPair.publicKey, ); buffer = new Uint8Array(sharedSecretBob, 0, 10); log(`${buffer}…[${sharedSecretAlice.byteLength} bytes total] (Bob secret)`);});Result
Press the "Derive bits" button to generate and log a shared secret from Bob and Alice's keys.Press the "Change keys" button to change the X25519 keys used by both parties.
PBKDF2
In this example we ask the user for a password, then use it to derive some bits usingPBKDF2.See the complete code on GitHub.
let salt;/*Get some key material to use as input to the deriveBits 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), { name: "PBKDF2" }, false, ["deriveBits", "deriveKey"], );}/*Derive some bits from a password supplied by the user.*/async function getDerivedBits() { const keyMaterial = await getKeyMaterial(); salt = window.crypto.getRandomValues(new Uint8Array(16)); const derivedBits = await window.crypto.subtle.deriveBits( { name: "PBKDF2", salt, iterations: 100000, hash: "SHA-256", }, keyMaterial, 256, ); const buffer = new Uint8Array(derivedBits, 0, 5); const derivedBitsValue = document.querySelector( ".pbkdf2 .derived-bits-value", ); derivedBitsValue.classList.add("fade-in"); derivedBitsValue.addEventListener("animationend", () => { derivedBitsValue.classList.remove("fade-in"); }); derivedBitsValue.textContent = `${buffer}…[${derivedBits.byteLength} bytes total]`;}const deriveBitsButton = document.querySelector(".pbkdf2 .derive-bits-button");deriveBitsButton.addEventListener("click", () => { getDerivedBits();});Specifications
| Specification |
|---|
| Web Cryptography Level 2> # SubtleCrypto-method-deriveBits> |