ox
Version:
Ethereum Standard Library
185 lines • 5.83 kB
JavaScript
import { p256 as noble_p256 } from '@noble/curves/nist.js';
import * as Bytes from './Bytes.js';
import * as Hex from './Hex.js';
import { formatPublicKey, formatSignature, normalizePublicKey, normalizeSignature, } from './internal/cryptoIo.js';
import * as Entropy from './internal/entropy.js';
import { fromRecoveredBytes, toCompactBytes, toRecoveredBytes, } from './internal/signature.js';
import * as PublicKey from './PublicKey.js';
/** Re-export of noble/curves P256 utilities. */
export const noble = noble_p256;
/**
* Creates a new P256 ECDSA key pair consisting of a private key and its corresponding public key.
*
* @example
* ```ts twoslash
* import { P256 } from 'ox'
*
* const { privateKey, publicKey } = P256.createKeyPair()
* ```
*
* @param options - The options to generate the key pair.
* @returns The generated key pair containing both private and public keys.
*/
export function createKeyPair(options = {}) {
const { as = 'Hex' } = options;
const privateKey = randomPrivateKey({ as });
const publicKey = getPublicKey({ privateKey });
return {
privateKey: privateKey,
publicKey,
};
}
/**
* Computes the P256 ECDSA public key from a provided private key.
*
* @example
* ```ts twoslash
* import { P256 } from 'ox'
*
* const publicKey = P256.getPublicKey({ privateKey: '0x...' })
* ```
*
* @param options - The options to compute the public key.
* @returns The computed public key.
*/
export function getPublicKey(options) {
const { as = 'Object', privateKey } = options;
const bytes = noble_p256.getPublicKey(Bytes.from(privateKey), false);
const publicKey = PublicKey.fromBytes(bytes);
return formatPublicKey(publicKey, as);
}
/**
* Computes a shared secret using ECDH (Elliptic Curve Diffie-Hellman) between a private key and a public key.
*
* @example
* ```ts twoslash
* import { P256 } from 'ox'
*
* const { privateKey: privateKeyA } = P256.createKeyPair()
* const { publicKey: publicKeyB } = P256.createKeyPair()
*
* const sharedSecret = P256.getSharedSecret({
* privateKey: privateKeyA,
* publicKey: publicKeyB
* })
* ```
*
* @param options - The options to compute the shared secret.
* @returns The computed shared secret.
*/
export function getSharedSecret(options) {
const { as = 'Hex', privateKey, publicKey } = options;
const sharedSecret = noble_p256.getSharedSecret(Bytes.from(privateKey), PublicKey.toBytes(normalizePublicKey(publicKey)), true);
if (as === 'Hex')
return Hex.fromBytes(sharedSecret);
return sharedSecret;
}
/**
* Generates a random P256 ECDSA private key.
*
* @example
* ```ts twoslash
* import { P256 } from 'ox'
*
* const privateKey = P256.randomPrivateKey()
* ```
*
* @param options - The options to generate the private key.
* @returns The generated private key.
*/
export function randomPrivateKey(options = {}) {
const { as = 'Hex' } = options;
const bytes = noble_p256.utils.randomSecretKey();
if (as === 'Hex')
return Hex.fromBytes(bytes);
return bytes;
}
/**
* Recovers the signing public key from the signed payload and signature.
*
* @example
* ```ts twoslash
* import { P256 } from 'ox'
*
* const signature = P256.sign({
* payload: '0xdeadbeef',
* privateKey: '0x...'
* })
*
* const publicKey = P256.recoverPublicKey({
* // [!code focus]
* payload: '0xdeadbeef', // [!code focus]
* signature // [!code focus]
* }) // [!code focus]
* ```
*
* @param options - The recovery options.
* @returns The recovered public key.
*/
export function recoverPublicKey(options) {
const { as = 'Object', payload, signature } = options;
const sigBytes = toRecoveredBytes(normalizeSignature(signature));
const point = noble_p256.Signature.fromBytes(sigBytes, 'recovered').recoverPublicKey(Bytes.from(payload));
const publicKey = PublicKey.fromBytes(point.toBytes(false));
return formatPublicKey(publicKey, as);
}
/**
* Signs the payload with the provided private key and returns a P256 signature.
*
* @example
* ```ts twoslash
* import { P256 } from 'ox'
*
* const signature = P256.sign({
* // [!code focus]
* payload: '0xdeadbeef', // [!code focus]
* privateKey: '0x...' // [!code focus]
* }) // [!code focus]
* ```
*
* @param options - The signing options.
* @returns The ECDSA {@link ox#Signature.Signature}.
*/
export function sign(options) {
const { as = 'Object', extraEntropy = Entropy.extraEntropy, hash, payload, privateKey, } = options;
const sigBytes = noble_p256.sign(Bytes.from(payload), Bytes.from(privateKey), {
extraEntropy: typeof extraEntropy === 'boolean'
? extraEntropy
: Bytes.from(extraEntropy),
lowS: true,
prehash: hash === true,
format: 'recovered',
});
const signature = fromRecoveredBytes(sigBytes);
return formatSignature(signature, as);
}
/**
* Verifies a payload was signed by the provided public key.
*
* @example
*
* ```ts twoslash
* import { P256 } from 'ox'
*
* const { privateKey, publicKey } = P256.createKeyPair()
* const signature = P256.sign({
* payload: '0xdeadbeef',
* privateKey
* })
*
* const verified = P256.verify({
* // [!code focus]
* publicKey, // [!code focus]
* payload: '0xdeadbeef', // [!code focus]
* signature // [!code focus]
* }) // [!code focus]
* ```
*
* @param options - The verification options.
* @returns Whether the payload was signed by the provided public key.
*/
export function verify(options) {
const { hash, payload, publicKey, signature } = options;
return noble_p256.verify(toCompactBytes(normalizeSignature(signature)), Bytes.from(payload), PublicKey.toBytes(normalizePublicKey(publicKey)), { lowS: true, prehash: hash === true });
}
//# sourceMappingURL=P256.js.map