npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

session25519

1.1.0 • Public • Published

session25519

session25519 is a public key cryptography library for the generation of Curve25519 encryption and ed25519 digital signature keys.

The encryption and signing keys are created with TweetNaCl.js, a port of TweetNaCl / NaCl to JavaScript for modern browsers and Node.js. The encryption keys are for the Public-key authenticated encryption box construction which implements curve25519-xsalsa20-poly1305. The signing keys are for the ed25519 digital signature system.

The strength of the system lies in the fact that the keypairs are derived from passing an email address and a high-entropy passphrase through a chain of secure hash functions and the scrypt key derivation function. This means that no private key files need ever be stored to disk. The key pairs are deterministic; for any given user ID (email or username) and password combination the same keys will always be generated.

The code is simple, asynchronous, and uses only the fast and secure BLAKE2s hash function, scrypt with 64 Bytes of key material for strong key derivation, and NaCL compatible encryption and signing provided by tweetnacl-js.

Security

It bears repeating that the strength of this system is very strongly tied to the strength of the passphrase chosen by the user. Application developers are strongly encouraged to enforce the use of high-entropy pass phrases by users. Memorable high-entropy pass phrases, such as can be generated with Diceware, and measured with password strength estimation tools like zxcvbn are critically important to the overall security of the system.

Version 1.1.x Changes

In version 1.1.x of this package the scrypt key derivation was changed from 32 Bytes of output to 64 Bytes. The first 32 Bytes remain the same as before when used as a seed for generating encryption keys. The extra 32 Bytes now being derived are used to seed the generation of a TweetNaCL digital signature key pair. These extra signing keys are now returned in the Object returned from this function. The security of this new approach has been reviewed by Dmitry Chestnykh (@dchest), who is the author of the TweetNacl.js package and a cryptography expert.

As an additional convenience, a Base64 encoded version of each key is now also returned in the Object literal alongside the Uint8Array keys.

Usage

Simply pass in a user identifier, such as an email address, and a high-entropy passphrase and an Object Literal with the keys will be returned. The keys returned are Uint8Array objects.

session25519('me@example.com', 'brig alert rope welsh foss rang orb', function(err, keys) {
  // {
  //   publicKey: ...,
  //   publicKeyBase64: ...,
  //   secretKey: ...,
  //   secretKeyBase64: ...,
  //   publicSignKey: ...,
  //   publicSignKeyBase64: ...,
  //   secretSignKey: ...,
  //   secretSignKeyBase64: ...
  // }
})

Crypto Description

From miniLock:

Advancements in elliptic curve cryptography, specifically in systems such as Curve25519, allow us to generate key pairs where the lengths of both public and private keys are relatively very small. This means that public keys become far easier to share (miniLock public keys, called miniLock IDs, fit inside less than half a tweet). This also means that a human-memorizable passphrase of adequate entropy can be used as the basis for deriving a private key.

The following pseudo-code illustrates how session25519 derives keys:

key               = BLAKE2s(password) // A 32 Byte hash of the password
salt              = email
logN              = 17   // CPU/memory cost parameter (1 to 31)
r                 = 8    // block size parameter
dkLen             = 64   // length of derived key in Bytes
 
// Returns 64 Bytes of key material
derivedBytes      = scrypt(key, salt, logN, r, dkLen)
 
// Split the 64 Bytes of key material into two 32 Byte sub-arrays
encryptKeySeed    = derivedBytes[0, 32]
signKeySeed       = derivedBytes[32, 64]
 
keyPair           = nacl.box.keyPair.fromSecretKey(encryptKeySeed) // 32 Byte seed
signingKeyPair    = nacl.sign.keyPair.fromSeed(signKeySeed) // 32 Byte seed

Performance

The author of scrypt-async-js, which is the strong key derivation mechanism used by session25519, recommends using setImmediate:

Using setImmediate massively improves performance. Since most browsers don't support it, you'll have to include a shim for it.

Resources

BLAKE2s-js

scrypt-async-js

TweetNaCl.js

tweetnacl-util-js

base64-js

Build

You can build a dist version of session25519 using browserify. There is a pre-built version in the dist directory of this repository which includes all dependencies and can be used with a <script> tag in the browser.

npm run build

Test

npm test

Thanks

Thanks to Dmitry Chestnykh (@dchest) for the awesome TweetNaCL.js code and for providing a code review and security guidance on the implementation of this code.

install

npm i session25519

Downloadsweekly downloads

182

version

1.1.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability