blob: b031044a6971ee8cba149b71cd5f1c876e8aa476 (
plain)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# Sumchecker
[](https://travis-ci.org/malept/sumchecker)
[](https://ci.appveyor.com/project/malept/sumchecker)
[](https://codecov.io/gh/malept/sumchecker)
Sumchecker is a pure Node.js solution to validating files specified in a checksum file, which are
usually generated by programs such as [`sha256sum`](https://en.wikipedia.org/wiki/Sha256sum).
## Usage
```javascript
const sumchecker = require('sumchecker');
try {
await sumchecker(algorithm, checksumFilename, baseDir, filesToCheck);
console.log('All files validate!');
} catch (error) {
console.error('An error occurred', error);
}
```
Returns a [`Promise`]. The promise is resolved when all files specified in
[`filesToCheck`](#filesToCheck) are validated. The promise is rejected otherwise.
### Parameters
#### `algorithm`
`String` - The hash algorithm used in [`checksumFilename`](#checksumFilename). Corresponds to the
algorithms allowed by [`crypto.createHash()`].
#### `checksumFilename`
`String` - The path to the checksum file.
#### `baseDir`
`String` - The base directory for the files specified in [`filesToCheck`](#filesToCheck).
#### `filesToCheck`
`Array` or `String` - one or more paths of the files that will be validated, relative to
[`baseDir`](#baseDir).
### Errors
These are `sumchecker`-specific error classes that are passed to the promise's reject callback.
#### `sumchecker.ChecksumMismatchError`
When at least one of the files does not match its expected checksum.
Properties:
* `filename` (`String`) - a path to a file that did not match
#### `sumchecker.ChecksumParseError`
When the checksum file cannot be parsed (as in, it does not match the checksum file format).
Properties:
* `lineNumber` (`Number`) - the line number that could not be parsed
* `line` (`String`) - the raw line data that could not be parsed, sans newline
#### `sumchecker.NoChecksumFoundError`
When at least one of the files specified to check is not listed in the checksum file.
Properties:
* `filename` (`String`) - a filename from [`filesToCheck`](#filesToCheck)
## Support
[Get supported sumchecker with the Tidelift Subscription](https://tidelift.com/subscription/pkg/npm-sumchecker?utm_source=npm-sumchecker&utm_medium=referral&utm_campaign=readme).
## Security contact information
To report a security vulnerability, please use the [Tidelift security
contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
## Legal
This library is copyrighted under the terms of the [Apache 2.0 License].
[`crypto.createHash()`]: https://nodejs.org/dist/latest-v4.x/docs/api/crypto.html#crypto_crypto_createhash_algorithm
[`Promise`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
[Apache 2.0 License]: http://www.apache.org/licenses/LICENSE-2.0
|
