模块 hash

hash 模块主要用于实现消息摘要算法，是实现加密算法中，非常重要的一个子模块。同时，消息摘要算法也是许多加密算法的基础。

在使用 hash 子模块之前，需要使用 require('hash'); 加载该模块。

在 hash 模块中，主要包含以下几个类 Digest、Hmac。其中，Digest 类用于计算消息摘要算法，Hmac 类用于计算带密钥的哈希消息。

以下是一个简单的使用 Digest 类计算 MD5 摘要的示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
const hash = require('hash');

// create a MD5 digest object
const digest = hash.digest(hash.MD5);

// update digest with data
const data = 'hello, world';
digest.update(data);

// output result in hex
const result = digest.digest('hex');
console.log(result);

在以上示例代码中，我们首先使用 hash.digest([hash.MD5](hash.md#MD5)) 将一个 Digest 对象初始化为 MD5 模式。然后，我们使用 update() 方法向 Digest 对象添加需要进行摘要计算的数据。接着，我们使用 digest() 方法计算摘要结果，并返回通过参数指定的编码方式（这里使用的是十六进制编码）。最后，输出计算出的摘要结果。

除了 MD5 以外，Digest 类还支持其他摘要算法，比如 SHA-1、SHA-256、SHA-512等。在使用时需要将 md5 参数改成对应的摘要算法即可。

静态函数

digest

根据指定的算法标识创建一个信息摘要运算对象

1
2
static Digest hash.digest(Integer algo,
    Buffer data = NULL);

调用参数:

algo: Integer, 指定摘要运算算法
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

md5

创建一个 MD5 信息摘要运算对象

1
static Digest hash.md5(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha1

创建一个 SHA1 信息摘要运算对象

1
static Digest hash.sha1(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha224

创建一个 SHA224 信息摘要运算对象

1
static Digest hash.sha224(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha256

创建一个 SHA256 信息摘要运算对象

1
static Digest hash.sha256(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha384

创建一个 SHA384 信息摘要运算对象

1
static Digest hash.sha384(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha512

创建一个 SHA512 信息摘要运算对象

1
static Digest hash.sha512(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

ripemd160

创建一个 RIPEMD160 信息摘要运算对象

1
static Digest hash.ripemd160(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sm3

创建一个 SM3 信息摘要运算对象

1
static Digest hash.sm3(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

创建一个 SM3 信息摘要运算对象并进行预处理

1
2
3
static Digest hash.sm3(PKey pubKey,
    String id,
    Buffer data = NULL);

调用参数:

pubKey: PKey, 签名公钥
id: String, 签名 ID
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha3_256

创建一个 SHA3_256 信息摘要运算对象

1
static Digest hash.sha3_256(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha3_384

创建一个 SHA3_384 信息摘要运算对象

1
static Digest hash.sha3_384(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

sha3_512

创建一个 SHA3_512 信息摘要运算对象

1
static Digest hash.sha3_512(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

shake128

创建一个 SHAKE128 信息摘要运算对象

1
static Digest hash.shake128(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

shake256

创建一个 SHAKE256 信息摘要运算对象

1
static Digest hash.shake256(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

keccak256

创建一个 KECCAK256 信息摘要运算对象

1
static Digest hash.keccak256(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

keccak384

创建一个 KECCAK384 信息摘要运算对象

1
static Digest hash.keccak384(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

keccak512

创建一个 KECCAK512 信息摘要运算对象

1
static Digest hash.keccak512(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

blake2s

创建一个 BLAKE2S 信息摘要运算对象

1
static Digest hash.blake2s(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

blake2b

创建一个 BLAKE2B 信息摘要运算对象

1
static Digest hash.blake2b(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

blake2sp

创建一个 BLAKE2SP 信息摘要运算对象

1
static Digest hash.blake2sp(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

blake2bp

创建一个 BLAKE2BP 信息摘要运算对象

1
static Digest hash.blake2bp(Buffer data = NULL);

调用参数:

data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac

根据指定的算法标识创建一个信息摘要签名运算对象

1
2
3
static Digest hash.hmac(Integer algo,
    Buffer key,
    Buffer data = NULL);

调用参数:

algo: Integer, 指定摘要运算算法
key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_md5

创建一个 MD5 信息摘要签名运算对象

1
2
static Digest hash.hmac_md5(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha1

创建一个 SHA1 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha1(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha224

创建一个 SHA224 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha224(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha256

创建一个 SHA256 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha256(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha384

创建一个 SHA384 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha384(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha512

创建一个 SHA512 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha512(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_ripemd160

创建一个 RIPEMD160 信息摘要签名运算对象

1
2
static Digest hash.hmac_ripemd160(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sm3

创建一个 SM3 信息摘要签名运算对象

1
2
static Digest hash.hmac_sm3(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

创建一个 SM3 信息摘要签名运算对象并进行预处理

1
2
3
4
static Digest hash.hmac_sm3(PKey pubKey,
    String id,
    Buffer key,
    Buffer data = NULL);

调用参数:

pubKey: PKey, 签名公钥
id: String, 签名 ID
key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha3_256

创建一个 SHA3_256 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha3_256(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha3_384

创建一个 SHA3_384 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha3_384(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_shake128

创建一个 SHAKE128 信息摘要签名运算对象

1
2
static Digest hash.hmac_shake128(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_shake256

创建一个 SHAKE256 信息摘要签名运算对象

1
2
static Digest hash.hmac_shake256(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_sha3_512

创建一个 SHA3_512 信息摘要签名运算对象

1
2
static Digest hash.hmac_sha3_512(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_keccak256

创建一个 KECCAK256 信息摘要签名运算对象

1
2
static Digest hash.hmac_keccak256(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_keccak384

创建一个 KECCAK384 信息摘要签名运算对象

1
2
static Digest hash.hmac_keccak384(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_keccak512

创建一个 KECCAK512 信息摘要签名运算对象

1
2
static Digest hash.hmac_keccak512(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_blake2s

创建一个 BLAKE2S 信息摘要签名运算对象

1
2
static Digest hash.hmac_blake2s(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_blake2b

创建一个 BLAKE2B 信息摘要签名运算对象

1
2
static Digest hash.hmac_blake2b(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_blake2sp

创建一个 BLAKE2SP 信息摘要签名运算对象

1
2
static Digest hash.hmac_blake2sp(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

hmac_blake2bp

创建一个 BLAKE2BP 信息摘要签名运算对象

1
2
static Digest hash.hmac_blake2bp(Buffer key,
    Buffer data = NULL);

调用参数:

key: Buffer, 二进制签名密钥
data: Buffer, 创建同时更新的二进制数据，缺省为 null，不更新数据

返回结果:

Digest, 返回构造的信息摘要对象

常量

MD5

MD5 信息摘要算法标识常量

1
const hash.MD5 = 1;

SHA1

SHA1 信息摘要算法标识常量

1
const hash.SHA1 = 2;

SHA224

SHA224 信息摘要算法标识常量

1
const hash.SHA224 = 3;

SHA256

SHA256 信息摘要算法标识常量

1
const hash.SHA256 = 4;

SHA384

SHA384 信息摘要算法标识常量

1
const hash.SHA384 = 5;

SHA512

SHA512 信息摘要算法标识常量

1
const hash.SHA512 = 6;

RIPEMD160

RIPEMD160 信息摘要算法标识常量

1
const hash.RIPEMD160 = 7;

SM3

SM3 信息摘要算法标识常量

1
const hash.SM3 = 8;

SHA3_256

SHA3_256 信息摘要算法标识常量

1
const hash.SHA3_256 = 9;

SHA3_384

SHA3_384 信息摘要算法标识常量

1
const hash.SHA3_384 = 10;

SHA3_512

SHA3_512 信息摘要算法标识常量

1
const hash.SHA3_512 = 11;

SHAKE128

SHAKE128 信息摘要算法标识常量

1
const hash.SHAKE128 = 12;

SHAKE256

SHAKE256 信息摘要算法标识常量

1
const hash.SHAKE256 = 13;

KECCAK256

KECCAK256 信息摘要算法标识常量

1
const hash.KECCAK256 = 14;

KECCAK384

KECCAK384 信息摘要算法标识常量

1
const hash.KECCAK384 = 15;

KECCAK512

KECCAK512 信息摘要算法标识常量

1
const hash.KECCAK512 = 16;

BLAKE2S

BLAKE2S 信息摘要算法标识常量

1
const hash.BLAKE2S = 17;

BLAKE2B

BLAKE2B 信息摘要算法标识常量

1
const hash.BLAKE2B = 18;

BLAKE2SP

BLAKE2SP 信息摘要算法标识常量

1
const hash.BLAKE2SP = 19;

BLAKE2BP

BLAKE2BP 信息摘要算法标识常量

1
const hash.BLAKE2BP = 20;

开发指南

基础模块

内置对象

社区模块

模块 hash

静态函数

digest

md5

sha1

sha224

sha256

sha384

sha512

ripemd160

sm3

sha3_256

sha3_384

sha3_512

shake128

shake256

keccak256

keccak384

keccak512

blake2s

blake2b

blake2sp

blake2bp

hmac

hmac_md5

hmac_sha1

hmac_sha224

hmac_sha256

hmac_sha384

hmac_sha512

hmac_ripemd160

hmac_sm3

hmac_sha3_256

hmac_sha3_384

hmac_shake128

hmac_shake256

hmac_sha3_512

hmac_keccak256

hmac_keccak384

hmac_keccak512

hmac_blake2s

hmac_blake2b

hmac_blake2sp

hmac_blake2bp

常量

MD5

SHA1

SHA224

SHA256

SHA384

SHA512

RIPEMD160

SM3

SHA3_256

SHA3_384

SHA3_512

SHAKE128

SHAKE256

KECCAK256

KECCAK384

KECCAK512

BLAKE2S

BLAKE2B

BLAKE2SP

BLAKE2BP