tokies

    0.0.3 • Public • Published

    Tokies

    A cookies mimicking API for JSON Web Tokens (hash tokens that can be decoded to an object)

    See jwt-simple module

    API

    var Tokies = require('tokies');
    var tokens = new Tokies(request, response, secret)
    

    This creates a tokens jar corresponding to the current request and response, the secret is important for creating unique hashes on your server (if someone has this secret they can decode your users tokens - which is bad)

    tokens.get(name)
    

    Returns a value from the payload of a token (e.g. any values that have been set), will return undefined if the token has been encoded.

    tokens.set(name, [value])
    

    Sets a value on the tokens payload, if called without a value it mimics the cookies API and clears the key from the store. For better semantics, the clear method is also supplied.

    tokens.payload
    

    A pseudo private value (available mainly for inspection purposes mainly) The object containing the keys and values is known as the payload.

    tokens.encode()
    

    Returns a token hash of the payload, clears the internal payload object. At this point the tokens is an unusable shell, until decode is called with a token hash.

    tokens.decode(hash)
    

    Populates the internal payload by decoding the hash into an object, at this point .get and .set can be used again.

    tokens.clear(name)
    

    Clears a value from the store.

    Middleware

    Tokies also supplies ready-to-go middleware go decoding incoming tokens

    Example usage:

    var app = express();
    app.use(require('tokies').middleware(opts))
    

    The middleware parses an expected Authorization header, containing Bearer <token>. If the auth header isn't found it then attempts to obtain a token from query string params, but only if a key is provided.

    Options

    {
      tokens: {}, // the tokens object, required unless using path instead
      path: [], // alternative to tokens, provide a path to the tokens
      		   // object as stored on on the request object, e.g. ['token'],
      		   // refers to req.token or ['state', 'jar'] would be req.state.jar
      key: '', //required if tokens are being passed by query params, we need to 
      		   //know the key referencing the token. 
    }
    

    Keywords

    none

    Install

    npm i tokies

    DownloadsWeekly Downloads

    0

    Version

    0.0.3

    License

    MIT

    Last publish

    Collaborators

    • davidmarkclements