加密（Crypto）

使用 require(‘crypto‘) 来调用该模块。

crypto模块提供在HTTPS或HTTP连接中封装安全凭证的方法。

它提供OpenSSL中的一系列哈希方法，包括hmac、cipher、decipher、签名和验证等方法的封装。

crypto.getCiphers()

示例：

var ciphers = crypto.getCiphers();
console.log(ciphers); // [‘AES-128-CBC‘, ‘AES-128-CBC-HMAC-SHA1‘, ...]

crypto.getHashes()

示例：

var hashes = crypto.getHashes();
console.log(hashes); // [‘sha‘, ‘sha1‘, ‘sha1WithRSAEncryption‘, ...]

crypto.createCredentials(details)

• pfx : 一个字符串或者buffer对象，代表经PFX或者PKCS12编码产生的私钥、证书以及CA证书
• key : 一个字符串，代表经PEM编码产生的私钥
• passphrase : 私钥或者pfx的密码
• cert : 一个字符串，代表经PEM编码产生的证书
• ca : 一个字符串或者字符串数组，表示可信任的经PEM编码产生的CA证书列表
• crl : 一个字符串或者字符串数组，表示经PEM编码产生的CRL（证书吊销列表 Certificate Revocation List）
• ciphers: 一个字符串，表示需要使用或者排除的加密算法 可以在http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT 查看更多关于加密算法格式的资料。

crypto.createHash(algorithm)

algorithm 取决与平台上所安装的 OpenSSL 版本所支持的算法。比如‘sha1‘、‘md5‘、‘sha256‘、‘sha512‘ 等等。在最近的发行版本中，openssl list-message-digest-algorithms 会显示可用的摘要算法。

示例：这段程序会计算出一个文件的 sha1 摘要值。

var filename = process.argv[2];
var crypto = require(‘crypto‘);
var fs = require(‘fs‘);

var shasum = crypto.createHash(‘sha1‘);

var s = fs.ReadStream(filename);
s.on(‘data‘, function(d) {
  shasum.update(d);
});

s.on(‘end‘, function() {
  var d = shasum.digest(‘hex‘);
  console.log(d + ‘  ‘ + filename);
});

类: Hash

它是一个既可读又可写的流。所写入的数据会被用作计算哈希。当流的可写端终止后，使用 read() 方法来获取计算得的哈希摘要。同时也支持旧有的 update 和 digest 方法。

通过 crypto.createHash 返回。

hash.update(data, [input_encoding])

因为它是流式数据，所以可以使用不同的数据调用很多次。

hash.digest([encoding])

注意：hash 对象在 digest() 方法被调用后将不可用。

crypto.createHmac(algorithm, key)

它是一个既可读又可写的流（stream）。写入的数据会被用于计算hmac。写入终止后，可以使用read()方法获取计算后的摘要值。之前版本的update和digest方法仍然支持。

algorithm在OpenSSL支持的算法列表中被抛弃了——见上方createHash部分。key是hmac算法用到的密钥。

类: Hmac

由crypto.createHmac返回。

hmac.update(data)

hmac.digest([encoding])

注意： hmac对象在调用digest()之后就不再可用了。

crypto.createCipher(algorithm, password)

algorithm算法是依赖OpenSSL库的, 例如: ‘aes192‘算法等。在最近发布的版本， 执行命令 openssl list-cipher-algorithms 就会显示出所有可用的加密算法，password是用来派生key和IV的，它必须是一个‘binary‘ 2进制格式的字符串或者是一个buffer。

它是一个既可读又可写的流。所写入的数据会被用作计算哈希。当流的可写端终止后，使用 read() 方法来获取计算得的哈希摘要。同时也支持旧有的 update 和 digest 方法。

crypto.createCipheriv(algorithm, key, iv)

algorithm算法和createCipher() 方法的参数相同. key密钥是一个被算法使用的原始密钥，iv是一个初始化向量。

key密钥和iv向量必须是‘binary‘2进制格式的字符串或buffers。

类: Cipher

这个类由 crypto.createCipher 和 crypto.createCipheriv 返回。

Cipher加密对象是 streams，他是具有 readable 可读和 writable 可写的。写入的纯文本数据是用来在可读流一侧加密数据的。 以前版本的update 和final方法也还是支持的。

cipher.update(data, [input_encoding], [output_encoding])

参数 output_encoding输出编码指定了加密数据的输出格式，可以是‘binary‘, ‘base64‘ 或者‘hex‘，如果没有提供这个参数，buffer将会返回。

返回加密内容，并且Returns the enciphered contents, 用新数据作为流的话，它可以被调用多次。

cipher.final([output_encoding])

注意: 调用final()函数后cipher 对象不能被使用。

cipher.setAutoPadding(auto_padding=true)

crypto.createDecipher(algorithm, password)

根据给定的算法和密钥，创建并返回一个解密器对象。这是上述createCipher()的一个镜像。

crypto.createDecipheriv(algorithm, key, iv)

根据给定的算法，密钥和初始化向量，创建并返回一个解密器对象。这是上述createCipheriv()的一个镜像。

类: Decipher

由crypto.createDecipher和crypto.createDecipheriv返回。

解密器对象是可读写的流对象。用被写入的加密数据生成可读的平文数据。解码器对象也支持The legacy update和 final函数。

decipher.update(data, [input_encoding], [output_encoding])

output_decoding指明了用以下哪种编码方式返回解密后的平文：‘binary‘, ‘ascii‘ 或 ‘utf8‘。如果没有指明编码方式，则返回一个buffer对象。

decipher.final([output_encoding])

注意: 调用final()函数后不能使用decipher 对象。

decipher.setAutoPadding(auto_padding=true)

crypto.createSign(algorithm)

类: Sign

由crypto.createSign返回。

Sign对象是可写的流对象。被写入的数据用来生成数字签名。当所有的数据都被写入后，sign 函数会返回数字签名。Sign对象也支持The legacy update函数。

sign.update(data)

sign.sign(private_key, [output_format])

返回一个数字签名，该签名的格式可以是‘binary‘, ‘hex‘或 ‘base64‘. 如果没有指明编码方式，则返回一个buffer对象。

注意：调用sign()后不能使用sign对象。

crypto.createVerify(algorithm)

类: Verify

由 crypto.createVerify返回。

验证器对象是可写的流对象. 被写入的数据会被用来验证提供的数字签名。在所有的数据被写入后，如果提供的数字签名有效，verify函数会返回真。验证器对象也支持 The legacy update函数。

verifier.update(data)

verifier.verify(object, signature, [signature_format])

根据数字签名对于数据和公钥的有效性，返回true或false。

注意: 调用verify()函数后不能使用verifier对象。

crypto.createDiffieHellman(prime_length)

创建一个迪菲－赫尔曼密钥交换(Diffie-Hellman key exchange)对象，并根据给定的位长度生成一个质数。所用的生成器是2。

crypto.createDiffieHellman(prime, [encoding])

类: DiffieHellman

由crypto.createDiffieHellman返回。

diffieHellman.generateKeys([encoding])

diffieHellman.computeSecret(other_public_key, [input_encoding], [output_encoding])

如果没有指明输出的编码方式，则返回一个buffer对象。

diffieHellman.getPrime([encoding])

diffieHellman.getGenerator([encoding])

diffieHellman.getPublicKey([encoding])

diffieHellman.getPrivateKey([encoding])

diffieHellman.setPublicKey(public_key, [encoding])

diffieHellman.setPrivateKey(private_key, [encoding])

crypto.getDiffieHellman(group_name)

示例(获取一个共享秘密):

var crypto = require(‘crypto‘);
var alice = crypto.getDiffieHellman(‘modp5‘);
var bob = crypto.getDiffieHellman(‘modp5‘);

alice.generateKeys();
bob.generateKeys();

var alice_secret = alice.computeSecret(bob.getPublicKey(), null, ‘hex‘);
var bob_secret = bob.computeSecret(alice.getPublicKey(), null, ‘hex‘);

/* alice_secret and bob_secret should be the same */
console.log(alice_secret == bob_secret);

crypto.pbkdf2(password, salt, iterations, keylen, callback)

crypto.pbkdf2Sync(password, salt, iterations, keylen)

crypto.randomBytes(size, [callback])

// async
crypto.randomBytes(256, function(ex, buf) {
  if (ex) throw ex;
  console.log(‘Have %d bytes of random data: %s‘, buf.length, buf);
});

// sync
try {
  var buf = crypto.randomBytes(256);
  console.log(‘Have %d bytes of random data: %s‘, buf.length, buf);
} catch (ex) {
  // handle error
  // most likely, entropy sources are drained
}

crypto.pseudoRandomBytes(size, [callback])

用法与 crypto.randomBytes一模一样。

crypto.DEFAULT_ENCODING

要注意，新的程序会期待buffer对象，所以使用这个时请只作为暂时的手段。

Recent API Changes

因为这样，与流有关的类中并没有其它Node类的典型函数，而且很多函数接受和返回默认的二进制编码的字符串，而不是Buffer对象。在最近的修改中，这些函数都被改成默认使用Buffer对象。

这对于某些(但不是全部)使用场景来讲是重大的改变。

例如，如果你现在使用Sign类的默认参数，然后在没有检查数据的情况下，将结果传递给Verify类，那么程序会照常工作。在以前，你会拿到一个二进制字符串，然后它传递给Verify对象；而现在，你会得到一个Buffer对象，然后把它传递给Verify对象。

但是，如果你以前是使用那些在Buffer对象上不能正常工作的字符串数据，或者以默认编码方式将二进制数据传递给加密函数的话，那你就要开始提供编码方式参数来指明你想使用的编码方式了。如果想准换回旧的风格默认使用二进制字符串，那么你需要把crypto.DEFAULT_ENCODING字段设为‘binary‘。但请注意，因为新的程序很可能会期望buffer对象，所以仅将此当做临时手段。

Node.js v0.10.31API手册-加密