The secp256k1 npm package provides an implementation of the elliptic curve secp256k1, which is widely used in cryptographic applications, particularly in blockchain technologies like Bitcoin and Ethereum. This package allows for key generation, signing, and verification of messages using the secp256k1 curve.
Key Generation
This feature allows you to generate a private key and derive the corresponding public key using the secp256k1 curve.
const secp256k1 = require('secp256k1');
const crypto = require('crypto');
// Generate a private key
let privateKey;
do {
privateKey = crypto.randomBytes(32);
} while (!secp256k1.privateKeyVerify(privateKey));
// Generate the public key
const publicKey = secp256k1.publicKeyCreate(privateKey);
console.log('Private Key:', privateKey.toString('hex'));
console.log('Public Key:', publicKey.toString('hex'));Message Signing
This feature allows you to sign a message hash using a private key, producing a signature and a recovery ID.
const secp256k1 = require('secp256k1');
const crypto = require('crypto');
// Generate a private key
let privateKey;
do {
privateKey = crypto.randomBytes(32);
} while (!secp256k1.privateKeyVerify(privateKey));
// Create a message hash
const message = 'Hello, world!';
const msgHash = crypto.createHash('sha256').update(message).digest();
// Sign the message hash
const sigObj = secp256k1.ecdsaSign(msgHash, privateKey);
console.log('Signature:', sigObj.signature.toString('hex'));
console.log('Recovery ID:', sigObj.recid);Signature Verification
This feature allows you to verify a signature against a message hash and a public key, ensuring the authenticity of the message.
const secp256k1 = require('secp256k1');
const crypto = require('crypto');
// Generate a private key
let privateKey;
do {
privateKey = crypto.randomBytes(32);
} while (!secp256k1.privateKeyVerify(privateKey));
// Generate the public key
const publicKey = secp256k1.publicKeyCreate(privateKey);
// Create a message hash
const message = 'Hello, world!';
const msgHash = crypto.createHash('sha256').update(message).digest();
// Sign the message hash
const sigObj = secp256k1.ecdsaSign(msgHash, privateKey);
// Verify the signature
const isValid = secp256k1.ecdsaVerify(sigObj.signature, msgHash, publicKey);
console.log('Signature is valid:', isValid);The elliptic package is a general-purpose elliptic curve library that supports multiple curves, including secp256k1. It provides similar functionalities for key generation, signing, and verification but also supports other curves like ed25519 and p256. It is more versatile but may be more complex to use for secp256k1-specific applications.
The bitcoinjs-lib package is a comprehensive library for Bitcoin-related operations, including key generation, signing, and verification using secp256k1. While it offers similar functionalities, it is more specialized for Bitcoin and includes additional features like transaction creation and parsing.
The noble-secp256k1 package is a modern, fast, and secure implementation of the secp256k1 elliptic curve. It focuses on performance and security, providing similar functionalities for key generation, signing, and verification. It is a good alternative if performance and security are critical.
This module provides native bindings to ecdsa secp256k1 functions.
This library is experimental, so use at your own risk.
npm install secp256k1
git clone git@github.com:wanderer/secp256k1-node.git
cd secp256k1-node
git submodule init
git submodule update
npm install
NOTE: if you have the development version gmp installed secp256k1 will use it. Otherwise it should fallback to openssl.
var ecdsa = require('secp256k1'),
sr = require('secure-random');
var privateKey = sr.randomBuffer(32);
//a random message to sign
var msg = sr.randomBuffer(32);
//get the public key in a compressed format
var pubKey = ecdsa.createPublicKey(privateKey, true);
//sign the message
var sig = ecdsa.sign(privateKey, msg);
//verify the signature
if(ecdsa.verify(pubKey, msg, sig)){
console.log("valid signature");
}
run npm test
Verify an ECDSA secret key.
Parameters
Buffer, the secret Key to verifyReturns: Boolean, true if secret key is valid, false secret key is invalid
Verify an ECDSA public key.
Parameters
Buffer, the public Key to verifyReturns: Boolean, true if public key is valid, false secret key is invalid
Create an ECDSA signature.
Parameters
Buffer, a 32-byte secret key (assumed to be valid)Buffer, a 32-byte message hash being signedfunction, the callback given. The callback is given the signatureReturns: Buffer, if no callback is given a 72-byte signature is returned
Create a compact ECDSA signature (64 byte + recovery id). Runs asynchronously if given a callback
Parameters
Buffer, a 32-byte secret key (assumed to be valid)Buffer, 32-byte message hash being signedcb: function, the callback which is give err, sig the
Buffer a 64-byte buffer repersenting the signatureBuffer an int which is the recovery id.Returns: result only returned if no callback is given
Verify an ECDSA signature. Runs asynchronously if given a callback
Parameters
Buffer, the public keyBuffer, the 32-byte message hash being verifiedBuffer, the signature being verifiedReturns: Integer,
Recover an ECDSA public key from a compact signature in the process also verifing it. Runs asynchronously if given a callback
Parameters
Buffer, the message assumed to be signedBuffer, the signature as 64 byte bufferInteger, the recovery id (as returned by ecdsa_sign_compact)Boolean, whether to recover a compressed or uncompressed pubkeyfunction, Recover an ECDSA public key from a compact signature. In the process also verifing it.Returns: Buffer, the pubkey, a 33 or 65 byte buffer
Compute the public key for a secret key.
Parameters
Buffer, a 32-byte private key.Boolean, whether the computed public key should be compressedReturns: Buffer, a 33-byte (if compressed) or 65-byte (if uncompressed) area to store the public key.
Parameters
BufferBoolean** Returns**: Buffer, privateKey
Parameters
BufferReturns: Buffer, secertKey
Parameters
BufferReturns: Buffer, This module provides native bindings to ecdsa secp256k1 functions
Parameters
BufferBufferReturns: Buffer
Parameters
BufferBufferReturns: Buffer
Parameters
BufferBufferReturns: Buffer
Parameters
BufferBufferReturns: Buffer
MIT
FAQs
This module provides native bindings to ecdsa secp256k1 functions
The npm package secp256k1 receives a total of 859,021 weekly downloads. As such, secp256k1 popularity was classified as popular.
We found that secp256k1 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.