npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@knfs-tech/csrf

v1.0.3

Published

Cross-site request forgery module

Downloads

58

Readme

This npm package provides Cross-site request forgery module for various security measures.

Install

Install the package via npm:

npm install @knfs-tech/csrf

Or via yarn:

yarn add @knfs-tech/csrf

Usage

This module provides functionality to protect against CSRF attacks.

Usage:

const csrf = require('@knfs-tech/csrf');
const express = require('express');
const session = require('express-session');
const bodyParser = require('body-parser');
const cookieParser = require("cookie-parser");

const app = express();

// Initialize session middleware
app.use(session({
  secret: 'your_secret_here',
  resave: false,
  saveUninitialized: true
}));
// Initialize cookie middleware
app.use(cookieParser());

// Initialize CSRF protection middleware with cookie
app.use(
	csrf.generate({
		param: '_csrf', // param key to check and verify (option)
		value: 'csrfToken', // param to get value (option)
		tokenLength: 16, // param to get value (option)
		storage: {
			type: csrf.CONSTANT.STORAGE.COOKIE,
			options: {
				httpOnly: true,
				maxAge: 1 * 24 * 60 * 60 * 1000, // 1days
				secure: true
			}
		} // param to get value (option)
	})
);

//OR with session
// app.use(
// 	csrf.generate({
// 		tokenLength: 16,
// 		storage: {
// 			type: csrf.CONSTANT.STORAGE.SESSION,
// 		}
// 	})
// )

//OR default
// app.use(csrf.generate())

// Set CSRF token in response locals
// if you use with view engine as ejs, bug,...
// <input type="hidden" name="_csrf" value="${csrfToken}">
// csrfToken is param to get value, you can see above
app.use(csrf.setTokenLocalsParam);



// Protect routes from CSRF attacks
/** You wile have body 
 * {_csrf: <token>, ...}
 * _csrf is param key to check and verify, you can see above
 * 
*/
app.post('/your-protected-route', csrf.protect, (req, res) => {
  res.send('CSRF protected route');
});


app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

Custom protectCondition

  • Default protectCondition is
protectCondition = (req) => {
  return req.method === 'POST' || req.method === 'PUT' || req.method === 'DELETE'
}
  • When you custom
// when you custom
const newProtectCondition = (req) => {
  return true		
}
app.use(csrf.generate({
  protectCondition: newProtectCondition
}))

Custom getTransmitToken

  • Default getTransmitToken is
getTransmitToken: (req) => {
  return req.body._csrf || req.headers['csrf-token'];
}
  • When you custom
// when you custom
const newGetTransmitToken = (req) => {
  return req.body._csrf || req.headers['csrf-token'] || req.query._csrf;
},
app.use(csrf.generate({
  getTransmitToken: newGetTransmitToken
}))

Custom errorResponse

  • Default errorResponse is
errorResponse: (req, res, next) => {
  res.status(403).send('CSRF token invalid');
}
  • When you custom
// when you custom
const newErrorResponse = (req, res, next) => {
  res.status(403).render('<h1>CSRF token invalid</h1>');
}
app.use(csrf.generate({
  errorResponse: newErrorResponse
}))

License

CSRF is open-sourced software licensed under the MIT license.

Author

Owner