aboutsummaryrefslogtreecommitdiff
path: root/node_modules/evp_bytestokey/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/evp_bytestokey/readme.md')
-rw-r--r--node_modules/evp_bytestokey/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/node_modules/evp_bytestokey/readme.md b/node_modules/evp_bytestokey/readme.md
new file mode 100644
index 000000000..86234dbf3
--- /dev/null
+++ b/node_modules/evp_bytestokey/readme.md
@@ -0,0 +1,13 @@
+EVP_BytesToKey
+===
+
+The super secure [key derivation algorithm from openssl](https://wiki.openssl.org/index.php/Manual:EVP_BytesToKey(3)) (spoiler alert not actually secure, only every use it for compatibility reasons).
+
+Api:
+===
+
+```js
+var result = EVP_BytesToKey('password', 'salt', keyLen, ivLen);
+Buffer.isBuffer(result.password); // true
+Buffer.isBuffer(result.iv); // true
+```