commit
This commit is contained in:
parent
be4fd23bcf
commit
0bd53741af
728 changed files with 86573 additions and 0 deletions
58
node_modules/safe-compare/README.md
generated
vendored
Normal file
58
node_modules/safe-compare/README.md
generated
vendored
Normal file
|
@ -0,0 +1,58 @@
|
|||
# safe-compare
|
||||
Constant-time comparison algorithm to prevent Node.js timing attacks.
|
||||
|
||||
For more information about Node.js timing attacks, please visit https://snyk.io/blog/node-js-timing-attack-ccc-ctf/.
|
||||
|
||||
[](https://www.npmjs.org/package/safe-compare)
|
||||
[](https://github.com/Bruce17/safe-compare/releases)
|
||||
[](https://david-dm.org/Bruce17/safe-compare)
|
||||
[](https://david-dm.org/Bruce17/safe-compare#info=devDependencies)
|
||||
[](https://coveralls.io/github/Bruce17/safe-compare?branch=master)
|
||||
[](https://codeclimate.com/github/Bruce17/safe-compare)
|
||||
[](https://snyk.io/test/github/bruce17/safe-compare)
|
||||
[](https://travis-ci.org/Bruce17/safe-compare)
|
||||
[](https://ci.appveyor.com/project/Bruce17/safe-compare/branch/master)
|
||||
|
||||
**NOTICE**:
|
||||
|
||||
If you are using Node.js v6.6.0 or higher, you can use [crypto.timingSafeEqual(a, b)](https://nodejs.org/api/crypto.html#crypto_crypto_timingsafeequal_a_b) from the `crypto` module. Keep in mind that the method `crypto.timingSafeEqual` only accepts `Buffer`s with the same length! This bundle will handle strings with different lengths for you.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
$ npm install safe-compare --save
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
var safeCompare = require('safe-compare');
|
||||
|
||||
safeCompare('hello world', 'hello world'); // -> true
|
||||
|
||||
safeCompare('hello', 'not hello'); // -> false
|
||||
safeCompare('hello foo', 'hello bar'); // -> false
|
||||
```
|
||||
|
||||
Note: runtime is always corresponding to the length of the first parameter.
|
||||
|
||||
|
||||
## Tests
|
||||
|
||||
```
|
||||
$ npm test
|
||||
```
|
||||
|
||||
|
||||
## What's the improvement of this package?
|
||||
|
||||
This Node.js module is a improvement of the two existing modules [scmp](https://github.com/freewil/scmp) and [secure-compare](https://github.com/vdemedes/secure-compare). It uses the best parts of both implementations.
|
||||
|
||||
The implementation of [scmp](https://github.com/freewil/scmp) is a good base, but it has a shorter execution time if the string's length is not equal. The package [secure-compare](https://github.com/vdemedes/secure-compare) always compares the two input strings, but its implementation is not as clean as in [scmp](https://github.com/freewil/scmp).
|
||||
|
||||
|
||||
## License
|
||||
|
||||
safe-compare is released under the MIT license.
|
Loading…
Add table
Add a link
Reference in a new issue