Blame view

node_modules/safe-regex/readme.markdown 1.53 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
  # safe-regex
  
  detect potentially
  [catastrophic](http://regular-expressions.mobi/catastrophic.html)
  [exponential-time](http://perlgeek.de/blog-en/perl-tips/in-search-of-an-exponetial-regexp.html)
  regular expressions by limiting the
  [star height](https://en.wikipedia.org/wiki/Star_height) to 1
  
  WARNING: This module merely *seems* to work given all the catastrophic regular
  expressions I could find scouring the internet, but I don't have enough of a
  background in automata to be absolutely sure that this module will catch all
  exponential-time cases.
  
  [![browser support](https://ci.testling.com/substack/safe-regex.png)](https://ci.testling.com/substack/safe-regex)
  
  [![build status](https://secure.travis-ci.org/substack/safe-regex.png)](http://travis-ci.org/substack/safe-regex)
  
  # example
  
  ``` js
  var safe = require('safe-regex');
  var regex = process.argv.slice(2).join(' ');
  console.log(safe(regex));
  ```
  
  ```
  $ node safe.js '(x+x+)+y'
  false
  $ node safe.js '(beep|boop)*'
  true
  $ node safe.js '(a+){10}'
  false
  $ node safe.js '\blocation\s*:[^:\n]+\b(Oakland|San Francisco)\b'
  true
  ```
  
  # methods
  
  ``` js
  var safe = require('safe-regex')
  ```
  
  ## var ok = safe(re, opts={})
  
  Return a boolean `ok` whether or not the regex `re` is safe and not possibly
  catastrophic.
  
  `re` can be a `RegExp` object or just a string.
  
  If the `re` is a string and is an invalid regex, returns `false`.
  
  * `opts.limit` - maximum number of allowed repetitions in the entire regex.
  Default: `25`.
  
  # install
  
  With [npm](https://npmjs.org) do:
  
  ```
  npm install safe-regex
  ```
  
  # license
  
  MIT