[](http://badge.fury.io/js/xss)
[](http://travis-ci.org/leizongmin/js-xss)
[](https://david-dm.org/leizongmin/js-xss)
根据白名单过滤HTML(防止XSS攻击)
======
--------------
**注意：0.1.x版本与0.0.x版本在自定义配置（除白名单配置外）格式上有较大改动，如果
要使用新版本，请详细阅读下文的使用说明**
`xss`是一个用于对用户输入的内容进行过滤，以避免遭受XSS攻击的模块
（[什么是XSS攻击？](http://baike.baidu.com/view/2161269.htm)）。主要用于论坛、博客、网上商店等等一些可允许用户录入页面排版、
格式控制相关的HTML的场景，`xss`模块通过白名单来控制允许的标签及相关的标签属性，
另外还提供了一系列的接口以便用户扩展，比其他同类模块更为灵活。
**项目主页：** https://github.com/leizongmin/js-xss
---------------
## 特性
+ 白名单控制允许的HTML标签及各标签的属性
+ 通过自定义处理函数，可对任意标签及其属性进行处理
## 参考资料
+ [XSS与字符编码的那些事儿 ---科普文](http://drops.wooyun.org/tips/689)
+ [腾讯实例教程：那些年我们一起学XSS](http://www.wooyun.org/whitehats/%E5%BF%83%E4%BC%A4%E7%9A%84%E7%98%A6%E5%AD%90)
+ [XSS Filter Evasion Cheat Sheet](https://www.owasp.org/index.php/XSS_Filter_Evasion_Cheat_Sheet)
+ [Data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme)
+ [XSS with Data URI Scheme](http://hi.baidu.com/badzzzz/item/bdbafe83144619c199255f7b)
## 性能（仅作参考）
+ xss模块：8.2 MB/s
+ validator@0.3.7模块的xss()函数：4.4 MB/s
测试代码参考 benchmark 目录
## 单元测试
在源码目录执行命令： `npm test`
## 在线测试
执行以下命令，可在命令行中输入HTML代码，并看到过滤后的代码：
```bash
$ xss -t
```
## 使用方法
### 在Node.js中使用
安装：
```bash
$ npm install xss
```
简单使用方法：
```JavaScript
var xss = require('xss');
var html = xss('');
console.log(html);
```
### 在浏览器端使用
```HTML
```
### 使用命令行工具来对文件进行XSS处理
可通过内置的 `xss` 命令来对输入的文件进行XSS处理。使用方法：
```bash
xss -i <源文件> -o <目标文件>
```
例：
```bash
$ xss -i origin.html -o target.html
```
详细命令行参数说明，请输入 `$ xss -h` 来查看。
## 自定义过滤规则
在调用 `xss()` 函数进行过滤时，可通过第二个参数来设置自定义规则：
```JavaScript
options = {}; // 自定义规则
html = xss('', options);
```
如果不想每次都传入一个 `options` 参数，可以创建一个 `FilterXSS` 实例
（使用这种方法速度更快）：
```
options = {}; // 自定义规则
myxss = new xss.FilterXSS(options);
// 以后直接调用 myxss.process() 来处理即可
html = myxss.process('');
```
`options` 参数的详细说明见下文。
### 白名单
通过 `whiteList` 来指定，格式为：`{'标签名': ['属性1', '属性2']}`。不在白名单上
的标签将被过滤，不在白名单上的属性也会被过滤。以下是示例：
```JavaScript
// 只允许a标签，该标签只允许href, title, target这三个属性
var options = {
whiteList: {
a: ['href', 'title', 'target']
}
};
// 使用以上配置后，下面的HTML
// 大家好
// 将被过滤为
// 大家好
```
默认白名单参考 `xss.whiteList`。
### 自定义匹配到标签时的处理方法
通过 `onTag` 来指定相应的处理函数。以下是详细说明：
```JavaScript
function onTag (tag, html, options) {
// tag是当前的标签名称，比如标签，则tag的值是'a'
// html是该标签的HTML，比如标签，则html的值是''
// options是一些附加的信息，具体如下：
// isWhite boolean类型，表示该标签是否在白名单上
// isClosing boolean类型，表示该标签是否为闭合标签，比如时为true
// position integer类型，表示当前标签在输出的结果中的起始位置
// sourcePosition integer类型，表示当前标签在原HTML中的起始位置
// 如果返回一个字符串，则当前标签将被替换为该字符串
// 如果不返回任何值，则使用默认的处理方法：
// 在白名单上： 通过onTagAttr来过滤属性，详见下文
// 不在白名单上：通过onIgnoreTag指定，详见下文
}
```
### 自定义匹配到标签的属性时的处理方法
通过 `onTagAttr` 来指定相应的处理函数。以下是详细说明：
```JavaScript
function onTagAttr (tag, name, value, isWhiteAttr) {
// tag是当前的标签名称，比如标签，则tag的值是'a'
// name是当前属性的名称，比如href="#"，则name的值是'href'
// value是当前属性的值，比如href="#"，则value的值是'#'
// isWhiteAttr是否为白名单上的属性
// 如果返回一个字符串，则当前属性值将被替换为该字符串
// 如果不返回任何值，则使用默认的处理方法
// 在白名单上： 调用safeAttrValue来过滤属性值，并输出该属性，详见下文
// 不在白名单上：通过onIgnoreTagAttr指定，详见下文
}
```
### 自定义匹配到不在白名单上的标签时的处理方法
通过 `onIgnoreTag` 来指定相应的处理函数。以下是详细说明：
```JavaScript
function onIgnoreTag (tag, html, options) {
// 参数说明与onTag相同
// 如果返回一个字符串，则当前标签将被替换为该字符串
// 如果不返回任何值，则使用默认的处理方法（通过escape指定，详见下文）
}
```
### 自定义匹配到不在白名单上的属性时的处理方法
通过 `onIgnoreTagAttr` 来指定相应的处理函数。以下是详细说明：
```JavaScript
function onIgnoreTagAttr (tag, name, value, isWhiteAttr) {
// 参数说明与onTagAttr相同
// 如果返回一个字符串，则当前属性值将被替换为该字符串
// 如果不返回任何值，则使用默认的处理方法（删除该属）
}
```
### 自定义HTML转义函数
通过 `escapeHtml` 来指定相应的处理函数。以下是默认代码 **（不建议修改）** ：
```JavaScript
function escapeHtml (html) {
return html.replace(//g, '>');
}
```
### 自定义标签属性值的转义函数
通过 `safeAttrValue` 来指定相应的处理函数。以下是详细说明：
```JavaScript
function safeAttrValue (tag, name, value) {
// 参数说明与onTagAttr相同（没有options参数）
// 返回一个字符串表示该属性值
}
```
### 快捷配置
#### 去掉不在白名单只的标签
通过 `stripIgnoreTag` 来设置：
+ `true`：去掉不在白名单上的标签
+ `false`：（默认），使用配置的`escape`函数对该标签进行转义
示例：
当设置 `stripIgnoreTag = true`时，以下代码
```HTML
code:
```
过滤后将输出
```HTML
code:alert(/xss/);
```
#### 去掉不在白名单上的标签及标签体
通过 `stripIgnoreTagBody` 来设置：
+ `false|null|undefined`：（默认），不特殊处理
+ `'*'|true`：去掉所有不在白名单上的标签
+ `['tag1', 'tag2']`：仅去掉指定的不在白名单上的标签
示例：
当设置 `stripIgnoreTagBody = ['script']`时，以下代码
```HTML
code:
```
过滤后将输出
```HTML
code:
```
## 应用实例
### 允许标签以data-开头的属性
```JavaScript
var source = 'hello
';
var html = xss(source, {
onIgnoreTagAttr: function (tag, name, value, isWhiteAttr) {
if (name.substr(0, 5) === 'data-') {
// 通过内置的escapeAttrValue函数来对属性值进行转义
return name + '="' + xss.escapeAttrValue(value) + '"';
}
}
});
console.log('%s\nconvert to:\n%s', source, html);
```
运行结果：
```
hello
convert to:
hello
```
### 允许名称以x-开头的标签
```JavaScript
var source = 'hewwww';
var html = xss(source, {
onIgnoreTag: function (tag, html, options) {
if (tag.substr(0, 2) === 'x-') {
// 不对其属性列表进行过滤
return html;
}
}
});
console.log('%s\nconvert to:\n%s', source, html);
```
运行结果：
```
hewwww
convert to:
<x>hewwww
```
### 分析HTML代码中的图片列表
```JavaScript
var source = '
a
b
c
d';
var list = [];
var html = xss(source, {
onTagAttr: function (tag, name, value, isWhiteAttr) {
if (tag === 'img' && name === 'src') {
// 使用内置的friendlyAttrValue函数来对属性值进行转义，可将<这类的实体标记转换成打印字符<
list.push(xss.friendlyAttrValue(value));
}
// 不返回任何值，表示还是按照默认的方法处理
}
});
console.log('image list:\n%s', list.join(', '));
```
运行结果：
```
image list:
img1, img2, img3, img4
```
### 去除HTML标签（只保留文本内容）
```JavaScript
var source = 'helloend';
var html = xss(source, {
whiteList: [], // 白名单为空，表示过滤所有标签
stripIgnoreTag: true, // 过滤所有非白名单标签的HTML
stripIgnoreTagBody: ['script'] // script标签较特殊，需要过滤标签中间的内容
});
console.log('text: %s', html);
```
运行结果：
```
text: helloend
```
## License
The MIT License
## 捐赠
如果您觉得xss模块对您有帮助，欢迎请作者一杯咖啡
[](https://me.alipay.com/leizongmin)