循环冗余校验(CRC, Cyclic Redundancy Check)是一种简单快速的哈希函数,可以借由比对数据传输或是保存前后的循环冗余校验码,检测其是否有错误发生。常被用来作为服务器应用为目的来使用的 Node.js,会有很大的机会需要使用 CRC 进行一些计算。可惜的是,Node.js 虽然可以借由内置的 crypto 模块来使用许多常见的哈希函数计算数据的校验和(checksum),但就是不支持 CRC。那么如果要在 Node.js 上计算 CRC,该怎么做比较好呢?

首先我们需要知道 CRC 算法,实际上分了许多不同版本的函数,如 8 比特的 CRC8、16 比特的 CRC16、32 比特的 CRC32、64 比特的 CRC64,CRC 的比特数愈高,哈希出来的数值碰撞概率自然会比较低,但会需要更多的时间去运算。但是 CRC 也不完全是使用比特数量去做变化,很有可能会遇到同样的数据,A 函数库算出来的 CRC32 和 B 函数库算出来的 CRC32 结果不同的情形。举例来说,请看以下的 PHP 程序:

<?php
	header('Content-Type: text/plain');
	$data = 'test';
	$crc1 = dechex(crc32($data));
	$crc2 = bin2hex(mhash(MHASH_CRC32, $data));
	$crc3 = bin2hex(mhash(MHASH_CRC32B, $data));
	echo $crc1, ', ', $crc2, ', ', $crc3;
?>

运行结果为:

d87f7e0c, accf8b33, d87f7e0c

不晓得大家有没有发现?同样都是 CRC32,字符串 test 在上面程序中似乎可以算出 d87f7e0c16 和 accf8b3316 这两种结果。这是由于除了 CRC 的比特数量之外,还有其他变量在影响着 CRC 算法的计算结果。

大体来说,若不包含准备进行 CRC 计算的数据的话,会影响 CRC 算法结果的变量共有五个,分别是「比特数量」、「多项式」、「起始值」、「终止 XOR 值」和「是否反射」。

借由调控这五个变量,可以衍生出各种版本的 CRC 哈希函数,于是会细分成 CRC8-ATM、CRC8-CDMA、CRC16-CCITT、CRC32-IEEE、CRC32-C、CRC64-ECMA、CRC64-ISO 等等十分杂乱的 CRC 函数名称。

顺带一提,mhash 函数库的 CRC32 函数算是比较特别的,并没有其他常见的 CRC 函数库可以算出跟 mhash 函数库一样的结果。于是在乎这点的程序员多半就会使用比较标准的 CRC32B 去计算 CRC 校验和,以求在不同的平台上也能一致。但也是有没发现到或是不在乎这个问题的程序员依旧使用 mhash 函数库的 CRC32 函数,导致与其他系统串接时双方可能都会有一些障碍。

回到 Node.js 的主题上,若要在 Node.js 上实作 CRC 算法,最好是能将先前提到的五个变量考虑进去,确保算法去串接其他人实作的 CRC 函数之兼容性。至于实作的方式本篇文章将不会介绍,本篇文章要介绍的是 node-crc 这个模块。

node-crc

node-crc 是一个使用 Node.js 8 之后才支持的 N-API 所开发的模块,使用 Rust 语言实作出各种不同版本的 CRC 函数,并且可用「比特数量」、「多项式」、「起始值」、「终止 XOR 值」和「是否反射」这五个变量来控制输出结果。

npmjs.com

npm 安装指令

npm install node-crc

使用方法

计算 CRC 校验和

使用模块的 crc 函数可以传入「比特数量」、「多项式」、「起始值」、「终止 XOR 值」和「是否反射」这五个变量以及要计算的数据 Buffer 来计算出该数据的 CRC 校验和,结果会以 Buffer 的型态回传。

import { crc } from "node-crc";

const result = crc(0x00864cfb, 0x00000000, 24, 0x00b704ce, 0x00000000, 0x00000000, 0x00000000, false, Buffer.from("hello", "utf8")).toString("hex");
// Arguments: low bits of expression, high bits of expression, the length of bits, low bits of the initial value, high bits of the initial value, low bits of the final xor value, high bits of the final xor value, reflection, the source data buffer

模块同时也提供数个常见的 CRC 函数,可直接被调用使用,列表如下:

  • crc3gsm
  • crc4itu
  • crc4interlaken
  • crc5epc
  • crc5itu
  • crc5usb
  • crc6cdma2000_a
  • crc6cdma2000_b
  • crc6darc
  • crc6gsm
  • crc6itu
  • crc7
  • crc7umts
  • crc8
  • crc8cdma2000
  • crc8darc
  • crc8dvb_s2
  • crc8ebu
  • crc8icode
  • crc8itu
  • crc8maxim
  • crc8rohc
  • crc8wcdma
  • crc10
  • crc10cdma2000
  • crc10gsm
  • crc11
  • crc12
  • crc12cdma2000
  • crc12gsm
  • crc13bbc
  • crc14darc
  • crc14gsm
  • crc15can
  • crc15mpt1327
  • crc16
  • crc16ccitt_false
  • crc16aug_ccitt
  • crc16buypass
  • crc16cdma2000
  • crc16dds_110
  • crc16dect_r
  • crc16dect_x
  • crc16dnp
  • crc16en_13757
  • crc16genibus
  • crc16maxim
  • crc16mcrf4cc
  • crc16riello
  • crc16t10_dif
  • crc16teledisk
  • crc16tms13157
  • crc16usb
  • crc_a
  • crc16kermit
  • crc16modbus
  • crc16_x25
  • crc16xmodem
  • crc17can
  • crc21can
  • crc24
  • crc24ble
  • crc24flexray_a
  • crc24flexray_b
  • crc24lte_a
  • crc24lte_b
  • crc24os9
  • crc30cdma
  • crc32(在 mhash 中的名称为 CRC32B)
  • crc32mhash(在 mhash 中的名称为 CRC32)
  • crc32bzip2
  • crc32c
  • crc32d
  • crc32mpeg2
  • crc32posix
  • crc32q
  • crc32jamcrc
  • crc32xfer
  • crc40gsm
  • crc64
  • crc64iso
  • crc64we
  • crc64jones

用法如下:

import { crc32, crc64 } from "node-crc";

const result = crc32(Buffer.from("hello", "utf8")).toString("hex");
const result2 = crc64(Buffer.from("world", "utf8")).toString("hex");