paseto
PASETO: Platform-Agnostic SEcurity TOkens for Node.js with minimal dependencies
Implemented specs & features
All crypto operations are using their async node's crypto API, where such API is not available the operation is pushed to a Worker Thread so that your main thread's I/O is not blocked.
| v1.local | v1.public | v2.local | v2.public | |
|---|---|---|---|---|
| supported? | ✓ | ✓ | ✓ | ✓ |
Have a question about using paseto? - ask.
Found a bug? - report it.
Missing a feature? - If it wasn't already discussed before, ask for it.
Found a vulnerability? - Reach out to us via email first, see security vulnerability disclosure.
Support
If you or your business use paseto, please consider becoming a sponsor so I can continue maintaining it and adding new features carefree.
Documentation
Usage
For its improvements in the crypto module
Installing paseto
npm install pasetoUsage
const paseto = require('paseto')
// Generic (all versions) APIs
const { decode } = paseto
// PASETO Protocol Version v1 specific API
const { V1 } = paseto // { sign, verify, encrypt, decrypt, generateKey }
// PASETO Protocol Version v2 specific API
const { V2 } = paseto // { sign, verify, encrypt, decrypt, generateKey }
// errors utilized by paseto
const { errors } = pasetoProducing tokens
const { V2: { encrypt, sign } } = paseto
(async () => {
{
const token = await encrypt({ sub: 'johndoe' }, secretKey)
// v2.local.rRfHP25HDj5Pda40FwdTsGcsEMoQAKM6ElH6OhCon6YzG1Pzmj1ZPAHORhPaxKQo0XLM5LPYgaevWGrkEy2Os3N68Xee_Me9A0LmbMlV6MNVt-UZMos7ETha
}
{
const token = await sign({ sub: 'johndoe' }, privateKey)
// v2.public.eyJzdWIiOiJqb2huZG9lIiwiaWF0IjoiMjAxOS0wNy0wMVQxNToyMTozMS40OTJaIn0tpEwuwb-loL652KAZhmCYdDUNW8YbF6UYCFCYLk-fexhzs2ofL4AyHTqIk0HzIxawufEibT1ZyJ7MPBJUVpsF
}
})()Consuming tokens
const { V2: { decrypt, verify } } = paseto
(async () => {
{
const payload = await decrypt(token, secretKey)
// { sub: 'johndoe', iat: '2019-07-01T15:22:47.982Z' }
}
{
const payload = await verify(token, publicKey)
// { sub: 'johndoe', iat: '2019-07-01T15:22:47.982Z' }
}
})()Keys
Node's KeyObject is ultimately what the
library works with, depending on the operation, if the key parameter is not already a KeyObject
instance the corresponding create function will be called with the input
crypto.createSecretKey()for local encrypt/decrypt operationscrypto.createPublicKey()for public verify operationscrypto.createPrivateKey()for public sign operations
You can also generate keys valid for the given operation directly through paseto
const crypto = require('crypto')
const { V1, V2 } = paseto
(async () => {
{
const key = await V1.generateKey('local')
console.log(key instanceof crypto.KeyObject)
// true
console.log(key.type === 'secret')
// true
console.log(key.symmetricKeySize === 32)
// true
}
{
const key = await V1.generateKey('public')
console.log(key instanceof crypto.KeyObject)
// true
console.log(key.type === 'private')
// true
console.log(key.asymmetricKeyType === 'rsa')
// true
}
{
const key = await V2.generateKey('local')
console.log(key instanceof crypto.KeyObject)
// true
console.log(key.type === 'secret')
// true
console.log(key.symmetricKeySize === 32)
// true
}
{
const key = await V2.generateKey('public')
console.log(key instanceof crypto.KeyObject)
// true
console.log(key.type === 'private')
// true
console.log(key.asymmetricKeyType === 'ed25519')
// true
}
})()FAQ
Semver?
Yes. Everything that's either exported in the TypeScript definitions file or documented is subject to Semantic Versioning 2.0.0. The rest is to be considered private API and is subject to change between any versions.
How do I use it outside of Node.js
It is only built for Node.js environment - it builds on top of the crypto module and requires
the KeyObject API that was added in Node.js v11.6.0 and one-shot sign/verify API added in v12.0.0
What is the ultimate goal?
- No dependencies, the moment
XChaCha20-Poly1305is supported by OpenSSL and therefore node'scryptothe direct dependency count will go down from 1 to 0.🚀
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent