363 lines
16 KiB
JavaScript
363 lines
16 KiB
JavaScript
/** Raw type */
|
|
const TYPE_RAW = 'raw';
|
|
const TYPE_JWK = 'jwk';
|
|
const TYPE_SPKI = 'spki';
|
|
const TYPE_PKCS = 'pkcs8';
|
|
// default formats
|
|
const dfsec = TYPE_PKCS;
|
|
const dfpub = TYPE_SPKI;
|
|
function getSubtle() {
|
|
const s = globalThis?.crypto?.subtle;
|
|
if (typeof s === 'object' && s != null)
|
|
return s;
|
|
throw new Error('crypto.subtle must be defined');
|
|
}
|
|
function createKeygenA(randomSecretKey, getPublicKey) {
|
|
// Runtime accepts an accidental `keygen(seed)` argument for parity with other wrappers, but the
|
|
// seed is intentionally ignored because WebCrypto keygen here always goes through fresh keygen.
|
|
return async function keygenA(_seed) {
|
|
const secretKey = (await randomSecretKey());
|
|
return { secretKey, publicKey: (await getPublicKey(secretKey)) };
|
|
};
|
|
}
|
|
// Internal helper only: strict hex parser for the local hardcoded PKCS8 header constants.
|
|
function hexToBytesLocal(hex) {
|
|
const pairs = hex.match(/[0-9a-f]{2}/gi);
|
|
if (!pairs || pairs.length * 2 !== hex.length)
|
|
throw new Error('invalid hex');
|
|
return Uint8Array.from(pairs, (b) => Number.parseInt(b, 16));
|
|
}
|
|
export const __TEST = /* @__PURE__ */ Object.freeze({
|
|
hexToBytesLocal,
|
|
});
|
|
function assertType(type, key) {
|
|
// Callers are expected to pass a non-null key-like object; `null` / `undefined` still fail first
|
|
// via property access before reaching the explicit wrapper error.
|
|
if (key.type !== type)
|
|
throw new Error(`invalid key type, expected ${type}`);
|
|
}
|
|
function createKeyUtils(algo, derive, keyLen, pkcs8header) {
|
|
const secUsage = derive ? ['deriveBits'] : ['sign'];
|
|
const pubUsage = derive ? [] : ['verify'];
|
|
// Return Uint8Array instead of ArrayBuffer
|
|
const arrBufToU8 = (res, format) => (format === TYPE_JWK
|
|
? res
|
|
: new Uint8Array(res));
|
|
const pub = {
|
|
async import(key, format) {
|
|
// For sign/verify wrappers we pass caller-provided JWK metadata through unchanged and let
|
|
// WebCrypto enforce mismatched `key_ops` / extractability instead of normalizing it here.
|
|
const keyi = await getSubtle().importKey(format, key, algo, true, pubUsage);
|
|
assertType('public', keyi);
|
|
return keyi;
|
|
},
|
|
async export(key, format) {
|
|
assertType('public', key);
|
|
const keyi = await getSubtle().exportKey(format, key);
|
|
return arrBufToU8(keyi, format);
|
|
},
|
|
async convert(key, inFormat, outFormat) {
|
|
return pub.export(await pub.import(key, inFormat), outFormat);
|
|
},
|
|
};
|
|
const priv = {
|
|
async import(key, format) {
|
|
const crypto = getSubtle();
|
|
let keyi;
|
|
if (format === TYPE_RAW) {
|
|
// Chrome, node, bun, deno: works
|
|
// Safari, Firefox: Data provided to an operation does not meet requirements
|
|
// This is the best one can do. JWK can't be used: it contains public key component inside.
|
|
const k = key;
|
|
const head = hexToBytesLocal(pkcs8header);
|
|
const all = new Uint8Array(head.length + k.length);
|
|
all.set(head, 0);
|
|
all.set(k, head.length);
|
|
keyi = await crypto.importKey(TYPE_PKCS, all, algo, true, secUsage);
|
|
}
|
|
else {
|
|
// Sign/verify wrappers keep caller JWK metadata as-is and assume the supplied `key_ops`
|
|
// already match the requested operation. ECDH is different: noble treats the same key
|
|
// material as usable for both sign and derive, so JWK imported through the derive path
|
|
// must rewrite `key_ops` or WebCrypto refuses otherwise-correct keys exported by keygen.
|
|
if (derive && format === TYPE_JWK)
|
|
key = { ...key, key_ops: secUsage };
|
|
keyi = await crypto.importKey(format, key, algo, true, secUsage);
|
|
}
|
|
assertType('private', keyi);
|
|
return keyi;
|
|
},
|
|
async export(key, format) {
|
|
const crypto = getSubtle();
|
|
assertType('private', key);
|
|
if (format === TYPE_RAW) {
|
|
// scure-base base64urlnopad could have been used, but we can't add more deps.
|
|
// pkcs8 would be even more fragile
|
|
const jwk = await crypto.exportKey(TYPE_JWK, key);
|
|
const base64 = jwk.d.replace(/-/g, '+').replace(/_/g, '/'); // base64url
|
|
const pad = base64.length % 4 ? '='.repeat(4 - (base64.length % 4)) : ''; // add padding
|
|
const binary = atob(base64 + pad);
|
|
// This is not ASCII, and not text: this is only semi-safe with atob output
|
|
const raw = Uint8Array.from(binary, (c) => c.charCodeAt(0));
|
|
// Pad key to key len because Bun strips leading zero for P-521 only
|
|
const res = new Uint8Array(keyLen);
|
|
res.set(raw, keyLen - raw.length);
|
|
return res;
|
|
}
|
|
const keyi = await crypto.exportKey(format, key);
|
|
return arrBufToU8(keyi, format);
|
|
},
|
|
async convert(key, inFormat, outFormat) {
|
|
return priv.export(await priv.import(key, inFormat), outFormat);
|
|
},
|
|
};
|
|
async function getPublicKey(secretKey, opts = {}) {
|
|
const fsec = opts.formatSec ?? dfsec;
|
|
const fpub = opts.formatPub ?? dfpub;
|
|
// Export to jwk, remove private scalar and then convert to format
|
|
const jwk = (fsec === TYPE_JWK ? { ...secretKey } : await priv.convert(secretKey, fsec, TYPE_JWK));
|
|
delete jwk.d;
|
|
jwk.key_ops = pubUsage;
|
|
if (fpub === TYPE_JWK)
|
|
return jwk;
|
|
return pub.convert(jwk, TYPE_JWK, fpub);
|
|
}
|
|
async function randomSecretKey(format = dfsec) {
|
|
const keyPair = await getSubtle().generateKey(algo, true, secUsage);
|
|
return priv.export(keyPair.privateKey, format);
|
|
}
|
|
// Key generation could be slow, so we cache result once.
|
|
let supported;
|
|
return {
|
|
pub: pub,
|
|
priv: priv,
|
|
async isSupported() {
|
|
if (supported !== undefined)
|
|
return supported;
|
|
try {
|
|
const crypto = getSubtle();
|
|
const key = await crypto.generateKey(algo, true, secUsage);
|
|
// Deno is broken and generates key for unsupported curves, but then fails on export
|
|
await priv.export(key.privateKey, TYPE_JWK);
|
|
// Bun fails on derive for x25519, but not x448
|
|
if (derive) {
|
|
await crypto.deriveBits({ name: typeof algo === 'string' ? algo : algo.name, public: key.publicKey }, key.privateKey, 8);
|
|
}
|
|
return (supported = true);
|
|
}
|
|
catch (e) {
|
|
return (supported = false);
|
|
}
|
|
},
|
|
getPublicKey,
|
|
keygen: createKeygenA(randomSecretKey, getPublicKey),
|
|
utils: Object.freeze({
|
|
randomSecretKey,
|
|
// Runtime expects both formats explicitly here; omitted formats just flow into
|
|
// `subtle.importKey(...)`, and JWK conversion also assumes extractable keys (`ext !== false`).
|
|
convertPublicKey: pub.convert,
|
|
// Runtime expects both formats explicitly here; omitted formats just flow into
|
|
// `subtle.importKey(...)`, and JWK conversion also assumes extractable keys (`ext !== false`).
|
|
convertSecretKey: priv.convert,
|
|
}),
|
|
};
|
|
}
|
|
function createSigner(keys, algo) {
|
|
return {
|
|
// Historical param name: wrappers pass message bytes here, while WebCrypto performs the
|
|
// algorithm-specific hashing itself for ECDSA. We also return provider signatures verbatim:
|
|
// this wrapper is intentionally "raw WebCrypto", so it does not parse scalars or normalize
|
|
// high-S ECDSA outputs into software noble's low-S convention.
|
|
async sign(msgHash, secretKey, opts = {}) {
|
|
const key = await keys.priv.import(secretKey, opts.formatSec ?? dfsec);
|
|
const sig = await getSubtle().sign(algo, key, msgHash);
|
|
return new Uint8Array(sig);
|
|
},
|
|
async verify(signature, msgHash, publicKey, opts = {}) {
|
|
const key = await keys.pub.import(publicKey, opts.formatPub ?? dfpub);
|
|
return await getSubtle().verify(algo, key, signature, msgHash);
|
|
},
|
|
};
|
|
}
|
|
function createECDH(keys, algo, keyLen) {
|
|
return {
|
|
// Runtime accepts the alternate key formats supported by `keys.import(...)`; the public type is
|
|
// still narrower than that accepted surface.
|
|
async getSharedSecret(secretKeyA, publicKeyB, opts = {}) {
|
|
// if (_isCompressed !== true) throw new Error('WebCrypto only supports compressed keys');
|
|
const secKey = await keys.priv.import(secretKeyA, opts.formatSec === undefined ? dfsec : opts.formatSec);
|
|
const pubKey = await keys.pub.import(publicKeyB, opts.formatPub === undefined ? dfpub : opts.formatPub);
|
|
const shared = await getSubtle().deriveBits({ name: typeof algo === 'string' ? algo : algo.name, public: pubKey }, secKey, 8 * keyLen);
|
|
return new Uint8Array(shared);
|
|
},
|
|
};
|
|
}
|
|
function wrapECDSA(curve, hash, keyLen, pkcs8header) {
|
|
const ECDH_ALGO = { name: 'ECDH', namedCurve: curve };
|
|
const keys = createKeyUtils({ name: 'ECDSA', namedCurve: curve }, false, keyLen, pkcs8header);
|
|
const keysEcdh = createKeyUtils(ECDH_ALGO, true, keyLen, pkcs8header);
|
|
return Object.freeze({
|
|
name: curve,
|
|
// Support probing comes from the sign-side wrapper only; ECDH availability is not checked
|
|
// independently here even though the public wrapper also exposes `getSharedSecret(...)`.
|
|
isSupported: keys.isSupported,
|
|
getPublicKey: keys.getPublicKey,
|
|
keygen: createKeygenA(keys.utils.randomSecretKey, keys.getPublicKey),
|
|
...createSigner(keys, { name: 'ECDSA', hash: { name: hash } }),
|
|
...createECDH(keysEcdh, ECDH_ALGO, keyLen),
|
|
utils: Object.freeze({
|
|
...keys.utils,
|
|
async convertSecretKey(key, inFormat, outFormat) {
|
|
const jwk = inFormat === TYPE_JWK ? key : undefined;
|
|
// `wrapECDSA(...)` exposes the same key material for both sign and derive, so an ECDH-flavored
|
|
// JWK secret key from `getSharedSecret(...)` should still round-trip through `utils`.
|
|
if (Array.isArray(jwk?.key_ops) &&
|
|
jwk.key_ops.length === 1 &&
|
|
jwk.key_ops[0] === 'deriveBits')
|
|
return keysEcdh.utils.convertSecretKey(key, inFormat, outFormat);
|
|
return keys.utils.convertSecretKey(key, inFormat, outFormat);
|
|
},
|
|
}),
|
|
});
|
|
}
|
|
function wrapEdDSA(curve, keyLen, pkcs8header) {
|
|
const keys = createKeyUtils(curve, false, keyLen, pkcs8header);
|
|
return Object.freeze({
|
|
name: curve,
|
|
isSupported: keys.isSupported,
|
|
// This wrapper intentionally re-exports the generic WebCrypto key-conversion/signing behavior
|
|
// without adding extra JWK-metadata or extractability guardrails of its own.
|
|
getPublicKey: keys.getPublicKey,
|
|
keygen: createKeygenA(keys.utils.randomSecretKey, keys.getPublicKey),
|
|
...createSigner(keys, { name: curve }),
|
|
utils: keys.utils,
|
|
});
|
|
}
|
|
function wrapMontgomery(curve, keyLen, pkcs8header) {
|
|
const keys = createKeyUtils(curve, true, keyLen, pkcs8header);
|
|
return Object.freeze({
|
|
name: curve,
|
|
isSupported: keys.isSupported,
|
|
// This wrapper intentionally re-exports the generic ECDH key-format behavior without widening
|
|
// the narrow public `Uint8Array` key types.
|
|
getPublicKey: keys.getPublicKey,
|
|
keygen: createKeygenA(keys.utils.randomSecretKey, keys.getPublicKey),
|
|
...createECDH(keys, curve, keyLen),
|
|
utils: keys.utils,
|
|
});
|
|
}
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto NIST P-256 (secp256r1).
|
|
* Inherits the generic WebCrypto ECDSA caveats: `isSupported()` only probes the sign-side API, and
|
|
* the conversion/signing helpers keep the shared `createKeyUtils(...)` / `createSigner(...)` quirks,
|
|
* including raw WebCrypto ECDSA signatures without low-S normalization.
|
|
* @example
|
|
* Check support, then sign and verify once with WebCrypto P-256.
|
|
*
|
|
* ```ts
|
|
* if (await p256.isSupported()) {
|
|
* const { secretKey, publicKey } = await p256.keygen();
|
|
* const msg = new TextEncoder().encode('hello noble');
|
|
* const sig = await p256.sign(msg, secretKey);
|
|
* const isValid = await p256.verify(sig, msg, publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const p256 = /* @__PURE__ */ wrapECDSA('P-256', 'SHA-256', 32, '3041020100301306072a8648ce3d020106082a8648ce3d030107042730250201010420');
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto NIST P-384 (secp384r1).
|
|
* Inherits the generic WebCrypto ECDSA caveats around support probing and key/signing conversion.
|
|
* @example
|
|
* Check support, then sign and verify once with WebCrypto P-384.
|
|
*
|
|
* ```ts
|
|
* if (await p384.isSupported()) {
|
|
* const { secretKey, publicKey } = await p384.keygen();
|
|
* const msg = new TextEncoder().encode('hello noble');
|
|
* const sig = await p384.sign(msg, secretKey);
|
|
* const isValid = await p384.verify(sig, msg, publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const p384 = /* @__PURE__ */ wrapECDSA('P-384', 'SHA-384', 48, '304e020100301006072a8648ce3d020106052b81040022043730350201010430');
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto NIST P-521 (secp521r1).
|
|
* Inherits the generic WebCrypto ECDSA caveats around support probing and key/signing conversion.
|
|
* @example
|
|
* Check support, then sign and verify once with WebCrypto P-521.
|
|
*
|
|
* ```ts
|
|
* if (await p521.isSupported()) {
|
|
* const { secretKey, publicKey } = await p521.keygen();
|
|
* const msg = new TextEncoder().encode('hello noble');
|
|
* const sig = await p521.sign(msg, secretKey);
|
|
* const isValid = await p521.verify(sig, msg, publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const p521 = /* @__PURE__ */ wrapECDSA('P-521', 'SHA-512', 66, '3060020100301006072a8648ce3d020106052b81040023044930470201010442');
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto ed25519.
|
|
* Inherits the generic WebCrypto EdDSA caveats around JWK conversion metadata and extractability.
|
|
* @example
|
|
* Check support, then sign and verify once with WebCrypto Ed25519.
|
|
*
|
|
* ```ts
|
|
* if (await ed25519.isSupported()) {
|
|
* const { secretKey, publicKey } = await ed25519.keygen();
|
|
* const msg = new TextEncoder().encode('hello noble');
|
|
* const sig = await ed25519.sign(msg, secretKey);
|
|
* const isValid = await ed25519.verify(sig, msg, publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const ed25519 = /* @__PURE__ */ wrapEdDSA('Ed25519', 32, '302e020100300506032b657004220420');
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto ed448.
|
|
* Inherits the generic WebCrypto EdDSA caveats around JWK conversion metadata and extractability.
|
|
* @example
|
|
* Check support, then sign and verify once with WebCrypto Ed448.
|
|
*
|
|
* ```ts
|
|
* if (await ed448.isSupported()) {
|
|
* const { secretKey, publicKey } = await ed448.keygen();
|
|
* const msg = new TextEncoder().encode('hello noble');
|
|
* const sig = await ed448.sign(msg, secretKey);
|
|
* const isValid = await ed448.verify(sig, msg, publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const ed448 = /* @__PURE__ */ wrapEdDSA('Ed448', 57, '3047020100300506032b6571043b0439');
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto x25519 (ECDH over Curve25519).
|
|
* Inherits the generic WebCrypto Montgomery caveat that runtime accepts more key formats than the
|
|
* narrow public `Uint8Array` argument types suggest.
|
|
* @example
|
|
* Check support, then derive one shared secret with WebCrypto X25519.
|
|
*
|
|
* ```ts
|
|
* if (await x25519.isSupported()) {
|
|
* const alice = await x25519.keygen();
|
|
* const bob = await x25519.keygen();
|
|
* const shared = await x25519.getSharedSecret(alice.secretKey, bob.publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const x25519 = /* @__PURE__ */ wrapMontgomery('X25519', 32, '302e020100300506032b656e04220420');
|
|
/**
|
|
* Friendly wrapper over built-in WebCrypto x448 (ECDH over Curve448).
|
|
* Inherits the generic WebCrypto Montgomery caveat that runtime accepts more key formats than the
|
|
* narrow public `Uint8Array` argument types suggest.
|
|
* @example
|
|
* Check support, then derive one shared secret with WebCrypto X448.
|
|
*
|
|
* ```ts
|
|
* if (await x448.isSupported()) {
|
|
* const alice = await x448.keygen();
|
|
* const bob = await x448.keygen();
|
|
* const shared = await x448.getSharedSecret(alice.secretKey, bob.publicKey);
|
|
* }
|
|
* ```
|
|
*/
|
|
export const x448 = /* @__PURE__ */ wrapMontgomery('X448', 56, '3046020100300506032b656f043a0438');
|
|
//# sourceMappingURL=webcrypto.js.map
|