Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Doc improvements and change argument name.

Fixes #1318.
  • Loading branch information...
commit d32971a8cbc0ac6ab7a044e25ff400587bc1294f 1 parent deb100f
@koichik koichik authored
Showing with 25 additions and 9 deletions.
  1. +21 −5 doc/api/crypto.markdown
  2. +4 −4 lib/crypto.js
View
26 doc/api/crypto.markdown
@@ -76,12 +76,23 @@ Calculates the digest of all of the passed data to the hmac.
The `encoding` can be `'hex'`, `'binary'` or `'base64'`.
-### crypto.createCipher(algorithm, key)
+### crypto.createCipher(algorithm, password)
-Creates and returns a cipher object, with the given algorithm and key.
+Creates and returns a cipher object, with the given algorithm and password.
`algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc.
-On recent releases, `openssl list-cipher-algorithms` will display the available cipher algorithms.
+On recent releases, `openssl list-cipher-algorithms` will display the
+available cipher algorithms.
+`password` is used to derive key and IV, which must be `'binary'` encoded
+string (See the [Buffers](buffers.html) for more information).
+
+### crypto.createCipheriv(algorithm, key, iv)
+
+Creates and returns a cipher object, with the given algorithm, key and iv.
+
+`algorithm` is the same as the `createCipher()`. `key` is a raw key used in
+algorithm. `iv` is an Initialization vector. `key` and `iv` must be `'binary'`
+encoded string (See the [Buffers](buffers.html) for more information).
### cipher.update(data, input_encoding='binary', output_encoding='binary')
@@ -95,10 +106,15 @@ Returns the enciphered contents, and can be called many times with new data as i
Returns any remaining enciphered contents, with `output_encoding` being one of: `'binary'`, `'base64'` or `'hex'`.
-### crypto.createDecipher(algorithm, key)
+### crypto.createDecipher(algorithm, password)
Creates and returns a decipher object, with the given algorithm and key.
-This is the mirror of the cipher object above.
+This is the mirror of the [createCipher()](#crypto.createCipher) above.
+
+### crypto.createDecipheriv(algorithm, key, iv)
+
+Creates and returns a decipher object, with the given algorithm, key and iv.
+This is the mirror of the [createCipheriv()](#crypto.createCipheriv) above.
### decipher.update(data, input_encoding='binary', output_encoding='binary')
View
8 lib/crypto.js
@@ -110,8 +110,8 @@ exports.createHmac = function(hmac, key) {
exports.Cipher = Cipher;
-exports.createCipher = function(cipher, key) {
- return (new Cipher).init(cipher, key);
+exports.createCipher = function(cipher, password) {
+ return (new Cipher).init(cipher, password);
};
@@ -121,8 +121,8 @@ exports.createCipheriv = function(cipher, key, iv) {
exports.Decipher = Decipher;
-exports.createDecipher = function(cipher, key) {
- return (new Decipher).init(cipher, key);
+exports.createDecipher = function(cipher, password) {
+ return (new Decipher).init(cipher, password);
};
Please sign in to comment.
Something went wrong with that request. Please try again.