Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
.npmignore
.travis.yml
LICENSE.txt
README.md
defaultKeys.json
index.js
install.js
package.json
test.js

README.md

Keygrip

Build Status

Keygrip is a node.js module for signing and verifying data (such as cookies or URLs) through a rotating credential system, in which new server keys can be added and old ones removed regularly, without invalidating client credentials.

Install

$ npm install keygrip

API

keys = new Keygrip([ keylist ])

This creates a new Keygrip based on the provided keylist, an array of secret keys used for SHA1 HMAC digests. If no list is given, or the list is empty, Keygrip uses the default key created during npm installation, and will issue a warning to the console.

Note that the new operator is also optional, so all of the following will work when Keygrip = require( "keygrip" ):

keys = new Keygrip
keys = new Keygrip([ "SEKRIT2", "SEKRIT1" ])
keys = Keygrip()
keys = Keygrip([ "SEKRIT2", "SEKRIT1" ])
keys = require( "keygrip" )()

The keylist is an array of all valid keys for signing, in descending order of freshness; new keys should be unshifted into the array and old keys should be popped.

The tradeoff here is that adding more keys to the keylist allows for more granular freshness for key validation, at the cost of a more expensive worst-case scenario for old or invalid hashes.

Keygrip keeps a reference to this array to automatically reflect any changes. This reference is stored using a closure to prevent external access.

keys.sign( data )

This creates a SHA1 HMAC based on the first key in the keylist, and outputs it as a 27-byte url-safe base64 digest (base64 without padding, replacing + with - and / with _).

keys.index( data, digest )

This loops through all of the keys currently in the keylist until the digest of the current key matches the given digest, at which point the current index is returned. If no key is matched, -1 is returned.

The idea is that if the index returned is greater than 0, the data should be re-signed to prevent premature credential invalidation, and enable better performance for subsequent challenges.

keys.verify( data, digest )

This uses index to return true if the digest matches any existing keys, and false otherwise.

Example

// ./test.js
var assert = require( "assert" )
  , Keygrip = require( "keygrip" )
  , keylist, keys, hash, index

// keygrip takes an array of keys, but if none exist,
// it uses the defaults created during npm installation.
// (but it'll will warn you)
console.log( "Ignore this message:" )
keys = new Keygrip( /* empty list */ )

// .sign returns the hash for the first key
// all hashes are SHA1 HMACs in url-safe base64
hash = keys.sign( "bieberschnitzel" )
assert.ok( /^[\w\-]{27}$/.test( hash ) )

// but we're going to use our list.
// (note that the 'new' operator is optional)
keylist = [ "SEKRIT3", "SEKRIT2", "SEKRIT1" ]
keys = Keygrip( keylist )
hash = keys.sign( "bieberschnitzel" )

// .index returns the index of the first matching key
index = keys.index( "bieberschnitzel", hash )
assert.equal( index, 0 )

// .verify returns the a boolean indicating a matched key
matched = keys.verify( "bieberschnitzel", hash )
assert.ok( matched )

index = keys.index( "bieberschnitzel", "o_O" )
assert.equal( index, -1 )

// rotate a new key in, and an old key out
keylist.unshift( "SEKRIT4" )
keylist.pop()

// if index > 0, it's time to re-sign
index = keys.index( "bieberschnitzel", hash )
assert.equal( index, 1 )
hash = keys.sign( "bieberschnitzel" ) 

TODO

  • Write a library for URL signing

Copyright

Copyright (c) 2012 Jed Schmidt. See LICENSE.txt for details.

Send any questions or comments here.

Something went wrong with that request. Please try again.