louis3797 / xss-shield

A powerful middleware for securing your express.js applications against cross-site scripting (XSS) attacks

xss-shield

This package provides a middleware for Express.js that helps protect against cross-site scripting (XSS) attacks. It's built on top of the xss module and is written in TypeScript.

Installation

To use this middleware, first install it using npm or yarn:

npm install xss-shield

or

yarn add xss-shield

Usage

To use this middleware in your Express.js application, simply require or import it and add it to your middleware stack:

const express = require('express'); 
const xssShield = require('xss-shield');

const app = express();

// Add the middleware to the middleware stack
app.use(xssShield());

You can also pass options to the middleware to customize its behavior. See the xss documentation for available options.

const express = require('express'); 
const xssShield = require('xss-shield');

const app = express();

// Add the middleware to the middleware stack with options
app.use(xssShield({
  whiteList: {
    a: ['href', 'title', 'target'],
    img: ['src', 'alt'],
  }
}));

License

xss-shield is licensed under the MIT License. See LICENSE for more information.

xss-shield's Issues

Integration with typeScript

• I'm submitting a ...
  [ ] bug report

• Summary
  I am trying to import the package in my express typeScript app like that:
  import xssShield from "xss-shield";
  app.use(xssShield());
  I am getting error that xssShield is not callable

issues using xssShield()

• I'm submitting a ...
  [x ] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

Trying to use xss-shield as:
const xssShield = require("xss-shield");
app.use(xssShield());

throws back an error:

TypeError: xssShield is not a function