primary logic behind csrf tokens
npm install csrf[![NPM Version][npm-version-image]][npm-url]
[![NPM Downloads][npm-downloads-image]][npm-url]
[![Node.js Version][node-image]][node-url]
[![Build Status][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
Logic behind CSRF token creation and verification.
Read Understanding-CSRF
for more information on CSRF. Use this module to create custom CSRF middleware.
Looking for a CSRF framework for your favorite framework that uses this
module?
* Express/connect: csurf or
alt-xsrf
* Koa: koa-csrf or
koa-atomic-session
``sh`
$ npm install csrf
This module includes a TypeScript
declaration file to enable auto complete in compatible editors and type
information for TypeScript projects.
`js`
var Tokens = require('csrf')
Create a new token generation/verification instance. The options argument is
optional and will just use all defaults if missing.
#### Options
Tokens accepts these properties in the options object.
##### saltLength
The length of the internal salt to use, in characters. Internally, the salt
is a base 62 string. Defaults to 8 characters.
##### secretLength
The length of the secret to generate, in bytes. Note that the secret is
passed around base-64 encoded and that this length refers to the underlying
bytes, not the length of the base-64 string. Defaults to 18 bytes.
#### tokens.create(secret)
Create a new CSRF token attached to the given secret. The secret is atokens.secret()
string, typically generated from the or tokens.secretSync()
methods. This token is what you should add into HTML