循环冗余校验(CRC, Cyclic Redundancy Check)是一种简单快速的哈希函数,可以借由比对数据传输或是保存前后的循环冗余校验码,检测其是否有错误发生。能够横跨各领域应用的 Rust 编程语言,会有很大的机会需要使用 CRC 进行一些计算。可惜的是,Rust 编程语言的标准函数库并没有提供 CRC 的算法。那么如果要使用 Rust 编程语言来计算 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;
?>
运行结果为:
不晓得大家有没有发现?同样都是 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 函数,导致与其他系统串接时双方可能都会有一些障碍。
CRC Any
「CRC Any」是笔者开发的套件,可以使用「比特数量」、「多项式」、「起始值」、「终止 XOR 值」和「是否反射」这五个变量来控制 CRC 的输出结果,实现出任意版本的 CRC 算法。
Crates.io
Cargo.toml
使用方法
使用 use 关键字来将 crc_any 这个 crate 底下的 CRC 结构体给引用到当前的程序范围下。CRC 结构体提供了 create_crc 关联函数,能够透过参数传入 CRC 算法使用的「比特数量」、「多项式」、「起始值」、「终止 XOR 值」和「是否反射」这五个变量,来创建出该 CRC 算法的 CRC 结构实体。CRC 结构实体则拥有 digest 方法,可以读取要计算出 CRC 哈希值的数据。数据可以分割成很多段,依序透过几次调用 digest 方法来传入。在计算 CRC 哈希的过程中可以使用 get_crc、get_crc_vec_be 或 get_crc_vec_le 方法来取得当前的 CRC 哈希结果。
举例来说,以下程序可以计算 hello 字符串的 CRC24 哈希值:
use crc_any::CRC;
let mut crc24 = CRC::create_crc(0x0000000000864cfb, 24, 0x0000000000b704ce, 0x0000000000000000, false);
crc24.digest(b"hello");
assert_eq!([71, 245, 138].to_vec(), crc24.get_crc_vec_be());
assert_eq!("0x47F58A", &crc24.to_string());
当然,如果每次要计算 CRC 都要输入「比特数量」、「多项式」、「起始值」、「终止 XOR 值」和「是否反射」这五个变量,实在是很麻烦。CRC 结构体有提供数个常见的 CRC 函数,可直接被调用使用,性能也会稍微比使用 create_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
- 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
用法如下:
use crc_any::CRC;
let mut crc64 = CRC::crc64we();
crc64.digest(b"hello");
assert_eq!([236, 83, 136, 71, 154, 124, 145, 63].to_vec(), crc64.get_crc_vec_be());
assert_eq!("0xEC5388479A7C913F", &crc64.to_string());
无堆积的支持
虽然「CRC Any」没有用到标准函数库,但是它有用到堆积。如果不想要用到堆积的话,可以关闭预设激活的特色。Cargo.toml 设置档的写法如下:
[dependencies.crc-any]
version = "*"
default-features = false
当然,一旦关闭预设激活的特色,get_crc_vec_be 和 get_crc_vec_le 方法就会无法使用。不过如果还是想要让「CRC Any」能够回传 Vec 结构体却又不想要有动态内存配置的话,可以激活 heapless 特色。
[dependencies.crc-any]
version = "*"
default-features = false
features = ["heapless"]
如此一来就能够使用 get_crc_heapless_vec_be 和 get_crc_heapless_vec_le 方法了!
