1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc improvements and change argument name.

Browse Source 
Fixes #1318.
This commit is contained in:
koichik 2011-07-24 15:56:23 +09:00
parent deb100fb17
commit d32971a8cb
2 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/api/crypto.markdown
View File

@ -76,12 +76,23 @@ Calculates the digest of all of the passed data to the hmac.
The `encoding` can be `'hex'`, `'binary'` or `'base64'`. 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. `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') ### 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'`. 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. 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') ### decipher.update(data, input_encoding='binary', output_encoding='binary')

8
lib/crypto.js
View File

@ -110,8 +110,8 @@ exports.createHmac = function(hmac, key) {
exports.Cipher = Cipher; exports.Cipher = Cipher;
exports.createCipher = function(cipher, key) { exports.createCipher = function(cipher, password) {
return (new Cipher).init(cipher, key); return (new Cipher).init(cipher, password);
}; };
@ -121,8 +121,8 @@ exports.createCipheriv = function(cipher, key, iv) {
exports.Decipher = Decipher; exports.Decipher = Decipher;
exports.createDecipher = function(cipher, key) { exports.createDecipher = function(cipher, password) {
return (new Decipher).init(cipher, key); return (new Decipher).init(cipher, password);
}; };