PASETO: Platform-Agnostic SEcurity TOkens for Node.js no dependencies.
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? | ✓ | ✓ | ✕ | ✓ |
If you or your business use paseto, please consider becoming a sponsor so I can continue maintaining it and adding new features carefree.
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, generateKey }
// errors utilized by paseto
const { errors } = pasetoconst { V2: { sign } } = paseto
(async () => {
{
const token = await sign({ sub: 'johndoe' }, privateKey)
// v2.public.eyJzdWIiOiJqb2huZG9lIiwiaWF0IjoiMjAxOS0wNy0wMVQxNToyMTozMS40OTJaIn0tpEwuwb-loL652KAZhmCYdDUNW8YbF6UYCFCYLk-fexhzs2ofL4AyHTqIk0HzIxawufEibT1ZyJ7MPBJUVpsF
}
})()const { V2: { verify } } = paseto
(async () => {
{
const payload = await verify(token, publicKey)
// { sub: 'johndoe', iat: '2019-07-01T15:22:47.982Z' }
}
})()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('public')
console.log(key instanceof crypto.KeyObject)
// true
console.log(key.type === 'private')
// true
console.log(key.asymmetricKeyType === 'ed25519')
// true
}
})()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.
It is only built for Node.js environment versions ^12.19.0 || >=14.15.0