https://github.com/jsonmaur/xss-clean

Middleware to sanitize user input
https://github.com/jsonmaur/xss-clean

Last synced: 14 days ago
JSON representation

Middleware to sanitize user input

• Host: GitHub
• URL: https://github.com/jsonmaur/xss-clean
• Owner: jsonmaur
• Created: 2016-02-25T23:33:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-06-02T07:08:56.000Z (over 1 year ago)
• Last Synced: 2024-04-15T00:15:28.531Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 71
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Announcement

**This library has been deprecated. The implementation is quite simple, and I would suggest you copy the source code directly into your application using the [xss-filters](https://github.com/YahooArchive/xss-filters) dependency, or look for alternative libraries with more features and attention. Thanks for your support.**

---

Node.js Connect middleware to sanitize user input coming from POST body, GET queries, and url params. Works with [Express](http://expressjs.com/), [Restify](http://restify.com/), or any other [Connect](https://github.com/senchalabs/connect) app.

- [How to Use](#use)

- [License](#license)

## How to Use

```bash

npm install xss-clean --save

```

```javascript

const restify = require('restify')

const xss = require('xss-clean')

const app = restify.createServer()

app.use(restify.bodyParser())

// make sure this comes before any routes

app.use(xss())

app.listen(8080)

```

This will sanitize any data in `req.body`, `req.query`, and `req.params`. You can also access the API directly if you don't want to use as middleware.

```javascript

const clean = require('xss-clean/lib/xss').clean

const cleaned = clean('')

// will return "<script></script>"

```