aboutsummaryrefslogtreecommitdiffstats
path: root/backend/node_modules/buffer-equal-constant-time/README.md
blob: 4f227f58bddbe9b1a06a4781efca74538b4b532a (plain) (blame)
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
# buffer-equal-constant-time

Constant-time `Buffer` comparison for node.js.  Should work with browserify too.

[![Build Status](https://travis-ci.org/goinstant/buffer-equal-constant-time.png?branch=master)](https://travis-ci.org/goinstant/buffer-equal-constant-time)

```sh
  npm install buffer-equal-constant-time
```

# Usage

```js
  var bufferEq = require('buffer-equal-constant-time');

  var a = new Buffer('asdf');
  var b = new Buffer('asdf');
  if (bufferEq(a,b)) {
    // the same!
  } else {
    // different in at least one byte!
  }
```

If you'd like to install an `.equal()` method onto the node.js `Buffer` and
`SlowBuffer` prototypes:

```js
  require('buffer-equal-constant-time').install();

  var a = new Buffer('asdf');
  var b = new Buffer('asdf');
  if (a.equal(b)) {
    // the same!
  } else {
    // different in at least one byte!
  }
```

To get rid of the installed `.equal()` method, call `.restore()`:

```js
  require('buffer-equal-constant-time').restore();
```

# Legal

© 2013 GoInstant Inc., a salesforce.com company

Licensed under the BSD 3-clause license.