JSON Web Algorithms (JWA)

JSON Web Algorithms (JWA) for JSON Object Signing and Encryption (JOSE)

Install via npm

$ npm install --save json-web-algorithms

Signature Algorithms

HMAC (Hash-based Message Authentication Code)

RSASSA (RSA Signature Scheme with Appendix)

ECDSA (Elliptic Curve Digital Signature Algorithm)

PLAIN

Usage

var JOSE = require( 'jose' )

// Sign something
var signature = JOSE.sign( 'HS256' input, key )
// Verify a signature
var isValid = JOSE.verify( 'HS256', signature, input, key )

API Reference

JWA : Object

JSON Web Algorithms

Kind: global variable

• JWA : Object
  • .SignatureAlgorithm : function
    • new JWA.SignatureAlgorithm()
  • .sign(algorithm, input, key) ⇒ Buffer
  • .verify(algorithm, signature, input, key) ⇒ Boolean

JWA.SignatureAlgorithm : function

Kind: static class of JWA

new JWA.SignatureAlgorithm()

JWA SignatureAlgorithm

JWA.sign(algorithm, input, key) ⇒ Buffer

Sign an input with a given algorithm

Kind: static method of JWA Returns: Buffer - signature

JWA.verify(algorithm, signature, input, key) ⇒ Boolean

Verify a signature with a given algorithm

Kind: static method of JWA

SignatureAlgorithm

Kind: global class

• SignatureAlgorithm
  • new SignatureAlgorithm(type, bits)
  • instance
    • ._signECDSA(digest) ⇒ Buffer
    • .sign(input, key) ⇒ Buffer
    • ._verifyHMAC(signature, input, key) ⇒ Boolean
    • ._verifyRSA(signature, input, key) ⇒ Boolean
    • ._verifyECDSA(signature, input, key) ⇒ Boolean
    • .verify(signature, input, key) ⇒ Boolean
  • static
    • .type : Object

new SignatureAlgorithm(type, bits)

SignatureAlgorithm

signatureAlgorithm._signECDSA(digest) ⇒ Buffer

Create a ECDSA signature for a given digest

Kind: instance method of SignatureAlgorithm Internal: used by .sign()

signatureAlgorithm.sign(input, key) ⇒ Buffer

Sign an input with a given key

Kind: instance method of SignatureAlgorithm

signatureAlgorithm._verifyHMAC(signature, input, key) ⇒ Boolean

Verify an HMAC signature

Kind: instance method of SignatureAlgorithm Internal: used by .verify()

signatureAlgorithm._verifyRSA(signature, input, key) ⇒ Boolean

Verify an RSA signature

Kind: instance method of SignatureAlgorithm Internal: used by .verify()

signatureAlgorithm._verifyECDSA(signature, input, key) ⇒ Boolean

Verify an ECDSA signature

Kind: instance method of SignatureAlgorithm Internal: used by .verify()

signatureAlgorithm.verify(signature, input, key) ⇒ Boolean

Verify a signature against an input & key

Kind: instance method of SignatureAlgorithm

SignatureAlgorithm.type : Object

SignatureAlgorithm type algorithms NOTE: OpenSSL only signs EC with SHA2 when specifying RSA and using an EC key

Kind: static property of SignatureAlgorithm