Skip to content

Commit 3f106c1

Browse files
authored
Added Security Policy (#23).
Added the initial security policy.
1 parent dc830dd commit 3f106c1

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

SECURITY.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Security Policy
2+
===============
3+
4+
Supported Versions
5+
------------------
6+
7+
The differences between versions are fairly small and the code
8+
changes required to upgrade to the latest version tends to be
9+
straight-forward.
10+
11+
If you do require a version outside of this chart updated with patch fix,
12+
please contact me, otherwise I only plan to maintain the most recent
13+
major version.
14+
15+
| Version | Supported |
16+
| ------- | ------------------ |
17+
| 3.0.x | :white_check_mark: |
18+
| < 3.0 | :x: |
19+
20+
21+
Reporting a Vulnerability
22+
-------------------------
23+
24+
If you identify a security vulnerability with this implementation, please
25+
do not hesitate to contact [email protected] immediately.
26+
27+
I try to respond within the same day and will address any concern as
28+
quickly as possible (including code fixes and publishing to NPM).
29+
30+
Any vulnerability will also be published to this file, along with credits,
31+
pertinent information and links to fixes.
32+
33+
34+
Notes
35+
-----
36+
37+
The underlying scrypt algorithm has a
38+
[known side-channel cache-timing attack](https://crypto.stanford.edu/cs359c/17sp/projects/MarkAnderson.pdf),
39+
which cannot be addressed at the implementation level.
40+
41+
In many cases this is not a concern to most users and in a JavaScript context there are many other
42+
side-channel attacks to be concerned with, but [here is an article](https://medium.com/analytics-vidhya/password-hashing-pbkdf2-scrypt-bcrypt-and-argon2-e25aaf41598e)
43+
which may be useful for those considering between scrypt and Argon2 (its main "competitor").

0 commit comments

Comments
 (0)