human-crypto-keys
Advanced tools
Generate and import human-friendly cryptographic keys using mnemonics or seeds
Generate and import human-friendly cryptographic keys using mnemonics or seeds.
$ npm install human-crypto-keys
This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.
import { generateKeyPair, getKeyPairFromMnemonic, getKeyPairFromSeed } from 'human-crypto-keys';
const keyPair = await generateKeyPair('rsa');
// => Generates a key pair with rsa encryption and provides information for recovery.
const keyPairFromMnemonic = await getKeyPairFromMnemonic(keyPair.mnemonic, keyPair.algorithm);
// => Generates the same key pair based on the mnemonic.
const keyPairFromSeed = await getKeyPairFromSeed(keyPair.seed, keyPair.algorithm);
// => Generates the same key pair based on the seed.
⚠️ human-crypto-keys depends on cryptographic modules that can increase the bundle size of your projects significantly. You might want to break big bundles in smaller pieces with the help of dynamic imports.
Generates a key pair based on the specified algorithm.
Returns an object with the following:
{
algorithm, // An object with the algorithm identifier and respective parameters that were used during generation.
mnemonic, // The mnemonic used to create a seed for generation.
seed, // The seed used for generation.
privateKey, // The generated private key composed in a specific format.
publicKey, // The generated public key composed in a specific format.
}
Type: Object or String
The algorithm identifier and the respective parameters to generate a key pair. Please read the algorithm section for more information.
Type: Object
Options to be used while composing keys. Please read the options section for more information.
Generates a key pair based on the specified mnemonic and algorithm.
Returns an object with the following:
{
privateKey, // The generated private key composed in a specific format.
publicKey, // The generated public key composed in a specific format.
}
Type: String
The mnemonic provided as one of the recovery methods for a key pair.
Type: Object or String
The algorithm identifier and the respective parameters to generate a key pair. Please read the algorithm section for more information.
Type: Object
Options to be used while composing keys. Please read the options section for more information.
Generates a key pair based on the specified seed and algorithm.
Returns an object with the following:
{
privateKey, // The generated private key composed in a specific format.
publicKey, // The generated public key composed in a specific format.
}
Type: String
The seed provided as one of the recovery methods for a key pair.
Type: Object or String
The algorithm identifier and the respective parameters to generate a key pair. Please read the algorithms section for more information.
Type: Object
Options to be used while composing keys. Please read the options section for more information.
Type: Object or String
The algorithm identifier and the respective parameters to generate a key pair.
It can be specified as an Object or a String. Using an Object will provide freedom to override default algorithm parameters in relation to its type. On the other hand, a String presents a useful and quick approach if the default parameters are suitable.
The default parameters are different for each algorithm type. Currently only 2 types are supported:
Default Parameters:
{
modulusLength: 2048 // Number
publicExponent: 65537 // Number
method: 'PRIMEINC' // String
}
You can override only the parameters that you need, all the other ones remain with default values.
⚠️ Please make sure that values follow the same type as default ones. Also, parameters that are not available as default are not supported.
Example Object:
const algorithm = { id: 'rsa', modulusLength: 4096 };
Example String:
const algorithm = 'rsa';
In the examples above we are using an alias for RSA encryption. Although this is possible, the full list of supported RSA key algorithms can be found in the RSA Keys Section of crypto-key-composer package.
The following steps detail how the generation of a RSA key pair is being done:
prng for short, with HMAC-DRBG using a seed as its generation entropy. This seed is directly provided when using getKeyFromSeed or inferred from a mnemonic passed in getKeyFromMnemonic. If neither the seed nor the mnemonic are available they can both be generated, as done in generateKeyPair. The generation of a mnemonic and its derived seed are done with bip39, a well established method used in bitcoin wallets.prng created previously.This algorithm doesn't have any default parameters since it just relies on 32 bytes randomly generated.
Example Object:
const algorithm = { id: 'ed25519' };
Example String:
const algorithm = 'ed25519';
The following steps detail how the generation of a ED25519 key pair is being done:
seed. If the seed is bigger than the necessary size, only the first 32 bytes will be used. This seed is directly provided when using getKeyFromSeed or inferred from a mnemonic passed in getKeyFromMnemonic. If neither the seed nor the mnemonic are available they can both be generated, as done in generateKeyPair. The generation of a mnemonic and its derived seed are done with bip39, a well established method used in bitcoin wallets.Type: Object
The current options allow you to decide both private and public key formats, the private key encryption and the password to use to encrypt the key.
Available options:
Type: String
Default: pkcs8-pem
The format in which the private key will be composed.
Keys can be composed in different formats and vary by algorithm. All formats available are described in the Formats Section of crypto-key-composer package.
Type: String
Default: spki-pem
The format in which the public key will be composed.
Keys can be composed in different formats and vary by algorithm. All formats available are described in the Formats Section of crypto-key-composer package.
Type: Object
The encryption algorithm that will be used to encrypt the private key.
For more information please read the Encryption Algorithms Section of crypto-key-composer package.
Type: String
The password to be used on the encryption of the private key.
$ npm test
$ npm test -- --watch # during development
Released under the MIT License.
FAQs
Generate and import human-friendly cryptographic keys using mnemonics or seeds
The npm package human-crypto-keys receives a total of 217 weekly downloads. As such, human-crypto-keys popularity was classified as not popular.
We found that human-crypto-keys demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 18 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
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.