模块 crypto

crypto 模块是 fibjs 内置的加密算法模块。它提供了对称加密、非对称加密、摘要算法、密码学随机数生成器等功能。在使用之前，需要通过 require('crypto') 加载该模块。

在 crypto 模块中，有很多对象可以使用，比如：

PKey：不对称加密算法对象
X509Cert：用于操作 X.509 证书的对象
Cipher：用于实现对称加密的对象
Digest：用于实现摘要算法的对象

在使用加密算法之前，需要先创建一个密钥对象，比如以下创建一个 AES 密钥对象的示例：

1
2
const crypto = require('crypto');
const key = crypto.randomBytes(16); // generate a 16-byte random key

接下来，使用 Cipher 对象来对明文进行加密：

1
2
3
4
const c = new crypto.Cipher(crypto.AES, crypto.ECB, key);
const data = 'hello, world';
const encrypted = c.encrypt(data).hex();
console.log(encrypted); // output encrypted data

以上示例中，创建了一个 AES 加密的 Cipher 对象，使用 encrypt 方法对明文进行加密，并返回加密结果。

除了对称加密算法，crypto 模块还可以支持非对称加密算法和摘要算法。比如以下示例是使用 PKey 和 Digest 对象实现 SHA256 加密的代码：

1
2
3
4
5
6
const privateKey = crypto.loadPKey('private.pem'); // read private key from file
const data = 'hello, world';
const digest = new crypto.Digest(hash.SHA256);
digest.update(data);
const signature = privateKey.sign(digest.digest());
console.log(signature); // output signature

在以上示例中，首先读取了一个私钥文件，并准备了输入数据。然后，创建了一个 SHA256 的 Digest 对象，使用 update 方法把数据加入到 Hash 计算中。在计算完成后，使用 privateKey.sign 方法进行签名，并输出签名结果。

综上所述，crypto 模块提供了多种加密算法、摘要算法以及相关对象，这些功能可以帮助我们实现多方面的安全需求，比如对称和非对称加密、数字签名和加密验证等。

对象

Cipher

Cipher 构造函数，参见 Cipher

1Cipher crypto.Cipher;

PKey

PKey 构造函数，参见 PKey

1PKey crypto.PKey;

ECKey

ECKey 构造函数，参见 ECKey

1ECKey crypto.ECKey;

BlsKey

BlsKey 构造函数，参见 BlsKey

1BlsKey crypto.BlsKey;

X509Cert

X509Cert 构造函数，参见 X509Cert

1X509Cert crypto.X509Cert;

X509Crl

X509Crl 构造函数，参见 X509Crl

1X509Crl crypto.X509Crl;

X509Req

X509Req 构造函数，参见 X509Req

1X509Req crypto.X509Req;

静态函数

createHash

根据给定的算法名称创建一个信息摘要对象

1
static Digest crypto.createHash(String algo);

调用参数:

algo: String, 指定信息摘要对象的算法

返回结果:

Digest, 返回信息摘要对象

createHmac

根据给定的算法名称创建一个 hmac 信息摘要对象

1
2
static Digest crypto.createHmac(String algo,
    Buffer key);

调用参数:

algo: String, 指定信息摘要对象的算法
key: Buffer, 二进制签名密钥

返回结果:

Digest, 返回信息摘要对象

loadCert

加载一个 CRT/PEM/DER 格式的证书，可多次调用

1
static X509Cert crypto.loadCert(String filename);

调用参数:

filename: String, 证书文件名

返回结果:

X509Cert, 返回包含证书的对象

loadCrl

加载一个 PEM/DER 格式的撤销证书，可多次调用

1
static X509Crl crypto.loadCrl(String filename);

调用参数:

filename: String, 撤销证书文件名

返回结果:

X509Crl, 返回包含撤销证书的对象

loadReq

加载一个 PEM/DER 格式的证书请求，可多次调用

1
static X509Req crypto.loadReq(String filename);

调用参数:

filename: String, 证书请求文件名

返回结果:

X509Req, 返回包含请求证书的对象

loadPKey

加载一个 CRT/PEM/DER 格式的非对称公钥或者私钥

1
static PKey crypto.loadPKey(String filename);

调用参数:

filename: String, 公钥或者私钥文件名

返回结果:

PKey, 返回包含 PKey 的对象

randomBytes

生成指定尺寸的随机数，使用 havege 生成器

1
static Buffer crypto.randomBytes(Integer size = 16) async;

调用参数:

size: Integer, 指定生成的随机数尺寸

返回结果:

Buffer, 返回生成的随机数

simpleRandomBytes

生成指定尺寸的低强度随机数，使用快速的算法

1
static Buffer crypto.simpleRandomBytes(Integer size = 16) async;

调用参数:

size: Integer, 指定生成的随机数尺寸

返回结果:

Buffer, 返回生成的随机数

pseudoRandomBytes

生成指定尺寸的伪随机数，使用 entropy 生成器

1
static Buffer crypto.pseudoRandomBytes(Integer size = 16) async;

调用参数:

size: Integer, 指定生成的随机数尺寸

返回结果:

Buffer, 返回生成的随机数

randomFill

使用随机数填充指定的 Buffer，使用 havege 生成器

1
2
3
static Buffer crypto.randomFill(Buffer buffer,
    Integer offset = 0,
    Integer size = -1) async;

调用参数:

buffer: Buffer, 指定生成的 Buffer
offset: Integer, 指定起始偏移，缺省为 0
size: Integer, 指定生成的随机数尺寸，缺省为 buffer.length - offset

返回结果:

Buffer, 返回生成的随机数

randomArt

生成给定数据的可视化字符图像

1
2
3
static String crypto.randomArt(Buffer data,
    String title,
    Integer size = 8);

调用参数:

data: Buffer, 指定要展示的数据
title: String, 指定字符图像的标题，多字节字符会导致宽度错误
size: Integer, 字符图像尺寸

返回结果:

String, 返回生成的可视化字符串图像

generateKey

生成一个 RSA 私钥

1
static PKey crypto.generateKey(Integer size) async;

调用参数:

size: Integer, 指定 RSA 密钥长度，bit 为单位

返回结果:

PKey, 返回包含生成私钥的对象

生成一个椭圆曲线私钥

1
static PKey crypto.generateKey(String curve = "secp521r1") async;

调用参数:

curve: String, 指定预置椭圆曲线，缺省为 'secp256r1'

返回结果:

PKey, 返回包含生成私钥的对象

curve 可选的曲线包含 NIST 曲线和别名如下：

曲线	别名
NIST P-192	'NIST P-192', 'p192', 'P-192', 'prime192v1', 'secp192r1'
NIST P-224	'NIST P-224', 'p224', 'P-224', 'prime224v1', 'secp224r1'
NIST P-256	'NIST P-256', 'p256', 'P-256', 'prime256v1', 'secp256r1'
NIST P-384	'NIST P-384', 'p384', 'P-384', 'prime384v1', 'secp384r1'
NIST P-521	'NIST P-521', 'p521', 'P-521', 'prime521v1', 'secp521r1'

其它支持的曲线包括： "brainpoolP512r1", "brainpoolP384r1", "secp256k1", "P-256K", "brainpoolP256r1", "sm2p256r1", "SM2", "Ed25519", "BLS12381_G1", "BLS12381_G2"

pbkdf1

依据 pbkdf1 根据明文 password 生成要求的二进制钥匙

1
2
3
4
5
static Buffer crypto.pbkdf1(Buffer password,
    Buffer salt,
    Integer iterations,
    Integer size,
    Integer algo) async;

调用参数:

password: Buffer, 指定使用的密码
salt: Buffer, 指定 hmac 使用的 salt
iterations: Integer, 指定迭代次数
size: Integer, 指定钥匙尺寸
algo: Integer, 指定要使用的 hash 算法，详见 hash 模块

返回结果:

Buffer, 返回生成的二进制钥匙

依据 pbkdf1 根据明文 password 生成要求的二进制钥匙

1
2
3
4
5
static Buffer crypto.pbkdf1(Buffer password,
    Buffer salt,
    Integer iterations,
    Integer size,
    String algoName) async;

调用参数:

password: Buffer, 指定使用的密码
salt: Buffer, 指定 hmac 使用的 salt
iterations: Integer, 指定迭代次数
size: Integer, 指定钥匙尺寸
algoName: String, 指定要使用的 hash 算法，详见 hash 模块

返回结果:

Buffer, 返回生成的二进制钥匙

pbkdf2

依据 rfc2898 根据明文 password 生成要求的二进制钥匙

1
2
3
4
5
static Buffer crypto.pbkdf2(Buffer password,
    Buffer salt,
    Integer iterations,
    Integer size,
    Integer algo) async;

调用参数:

password: Buffer, 指定使用的密码
salt: Buffer, 指定 hmac 使用的 salt
iterations: Integer, 指定迭代次数
size: Integer, 指定钥匙尺寸
algo: Integer, 指定要使用的 hash 算法，详见 hash 模块

返回结果:

Buffer, 返回生成的二进制钥匙

依据 rfc2898 根据明文 password 生成要求的二进制钥匙

1
2
3
4
5
static Buffer crypto.pbkdf2(Buffer password,
    Buffer salt,
    Integer iterations,
    Integer size,
    String algoName) async;

调用参数:

password: Buffer, 指定使用的密码
salt: Buffer, 指定 hmac 使用的 salt
iterations: Integer, 指定迭代次数
size: Integer, 指定钥匙尺寸
algoName: String, 指定要使用的 hash 算法，详见 hash 模块

返回结果:

Buffer, 返回生成的二进制钥匙

getHashes

获取 crypto 模块支持的的 hash(摘要) 算法, 比如 'md5', 'sha224'

1
static Array crypto.getHashes();

返回结果:

Array, 返回 fibjs 支持的 hash 算法数组

常量

AES

指定对称加密算法 AES，支持 128, 192, 256 位 key，分组密码工作模式支持 ECB, CBC, CFB128, CTR, GCM，CCM，XTS

1
const crypto.AES = 1;

DES

指定对称加密算法 DES，支持 64 位 key，分组密码工作模式支持 ECB, CBC

1
const crypto.DES = 2;

DES_EDE3

指定对称加密算法 DES-EDE3，支持 192 位 key，分组密码工作模式支持 ECB, CBC

1
const crypto.DES_EDE3 = 3;

CAMELLIA

指定对称加密算法 CAMELLIA，支持 128, 192, 256 位 key，分组密码工作模式支持 ECB, CBC, CFB128, CTR, GCM，CCM

1
const crypto.CAMELLIA = 4;

ARIA

指定对称加密算法 ARIA，支持 128, 192, 256 位 key，分组密码工作模式支持 ECB, CBC, CFB128, CTR, GCM，CCM

1
const crypto.ARIA = 5;

CHACHA20

指定对称加密算法 CHACHA20，支持 256 位 key，分组密码工作模式支持 POLY1305

1
const crypto.CHACHA20 = 6;

SM4

指定对称加密算法 SM4, 分组密码工作模式支持 ECB, CBC

1
const crypto.SM4 = 7;

ECB

指定分组密码工作模式支持 ECB

1
const crypto.ECB = 1;

CBC

指定分组密码工作模式支持 CBC

1
const crypto.CBC = 2;

CFB64

指定分组密码工作模式支持 CFB64

1
const crypto.CFB64 = 3;

CFB128

指定分组密码工作模式支持 CFB128

1
const crypto.CFB128 = 4;

OFB

指定分组密码工作模式支持 OFB

1
const crypto.OFB = 5;

CTR

指定分组密码工作模式支持 CTR

1
const crypto.CTR = 6;

GCM

指定分组密码工作模式支持 GCM

1
const crypto.GCM = 7;

STREAM

指定流密码模式

1
const crypto.STREAM = 8;

CCM

指定分组密码工作模式支持 CCM

1
const crypto.CCM = 9;

XTS

指定分组密码工作模式支持 XTS

1
const crypto.XTS = 10;

POLY1305

指定分组密码工作模式支持 POLY1305

1
const crypto.POLY1305 = 11;

PKCS7

指定填充模式为 PKCS7

1
const crypto.PKCS7 = 0;

ONE_AND_ZEROS

指定填充模式为 ONE_AND_ZEROS

1
const crypto.ONE_AND_ZEROS = 1;

ZEROS_AND_LEN

指定填充模式为 ZEROS_AND_LEN

1
const crypto.ZEROS_AND_LEN = 2;

ZEROS

指定填充模式为 ZEROS

1
const crypto.ZEROS = 3;

NOPADDING

指定填充模式为 NOPADDING

1
const crypto.NOPADDING = 4;

开发指南

基础模块

内置对象

社区模块

模块 crypto

对象

Cipher

PKey

ECKey

BlsKey

X509Cert

X509Crl

X509Req

静态函数

createHash

createHmac

loadCert

loadCrl

loadReq

loadPKey

randomBytes

simpleRandomBytes

pseudoRandomBytes

randomFill

randomArt

generateKey

pbkdf1

pbkdf2

getHashes

常量

AES

DES

DES_EDE3

CAMELLIA

ARIA

CHACHA20

SM4

ECB

CBC

CFB64

CFB128

OFB

CTR

GCM

STREAM

CCM

XTS

POLY1305

PKCS7

ONE_AND_ZEROS

ZEROS_AND_LEN

ZEROS

NOPADDING