移植国密密码工具箱GmSSL到i.MX平台Enable GmSSL which supports OSCCA Algorithm Toolbox on i.MX

[#1]

GmSSL is an open source cryptographic toolbox that supports SM2 / SM3 / SM4 / SM9 and other national secret (national commercial password) algorithm, SM2 digital certificate and SM2 certificate based on SSL / TLS secure communication protocol to support the national security hardware password device , To provide in line with the national standard programming interface and command line tools, can be used to build PKI / CA, secure communication, data encryption and other standards in line with national security applications. For more information, please access GmSSL official website http://gmssl.org/english.html.

Software environments as the belows:

Linux kernel: imx_4.14.98_2.0.0_ga

cryptodev: 1.9

HW platform: i.MX6UL, i.MX7D/S, i.MX8M/MM, i.MX8QM/QXP.

The patches include the following features:

1, Support SM2/SM9 encryption/decryption/sign/verify/key exchange, RSA encryption/decryption, DSA/ECDSA sign/verify, DH/ECDH key agreement, ECC & DLC & RSA key generation and big number operation and elliptic curve math by CAAM hardware accelerating.

2, run "git apply 0001-Enhance-cryptodev-and-its-engine-in-GmSSL-by-CAAM-s-.patch" under folder sources/poky, and "git apply 0001-Add-public-key-cryptography-operations-in-CAAM-drive.patch" under folder sources/meta-fsl-bsp-release for patch these codes.

3, GmSSL Build command:

$ tar zxvf GmSSL-master-iMX.tgz

$ cd GmSSL-master-iMX

(For i.MX8M/MM, i.MX8QM/QXP)

$ source /opt/arm-arch64/environment-setup-aarch64-poky-linux 

$ ./Configure -DHAVE_CRYPTODEV -DUSE_CRYPTODEV_DIGESTS -DHW_ENDIAN_SWAP  --prefix=~/install64 --openssldir=/etc/gmssl --libdir=/usr/lib no-saf no-sdf no-skf no-sof no-zuc -no-ssl3 shared linux-aarch64

$ make 

$ make install                            /*image and config file will be installed to folder ~/install64 */

(For i.MX6UL, i.MX7D/S)

$ source /opt/arm-arch32/environment-setup-cortexa7hf-neon-poky-linux-gnueabi

$ ./Configure -DHAVE_CRYPTODEV -DUSE_CRYPTODEV_DIGESTS --prefix=~/install32 --openssldir=/etc/gmssl --libdir=/usr/lib no-saf no-sdf no-skf no-sof no-zuc -no-ssl3 shared linux-armv4

$ make 

$ make install                            /*image and config file will be installed to folder ~/install32 */

4, How to use GmSSL:

copy image gmssl to /usr/bin on i.MX board; copy gmssl libcrypto.so.1.1 and libssl.so.1.1 to /usr/lib on i.MX board; copy folder etc/gmssl to /etc/ on i.MX board. copy test examples (dhtest, dsatest, rsa_test, ecdhtest, ecdsatest, eciestest, sm3test, sms4test, sm2test, sm9test) under GmSSL-master-iMX/test  to U disk for running.

You can run test examples by the following commands:

#insmod /lib/modules/4.14.98-imx_4.14.98_2.0.0_ga+g5d6cbeafb80c/extra/cryptodev.ko

#/run/media/sda1/dhtest
#/run/media/sda1/dsatest
#/run/media/sda1/rsa_test
#/run/media/sda1/ecdhtest
#/run/media/sda1/ecdsatest
#/run/media/sda1/eciestest
#/run/media/sda1/sm3test
#/run/media/sda1/sms4test
#/run/media/sda1/sm2test
#/run/media/sda1/sm9test

and speed test commands:

#gmssl speed sm2
#gmssl genrsa -rand -f4 512
#gmssl speed dsa
#gmssl genrsa -rand -f4 1024
#gmssl speed rsa
#gmssl genrsa -rand -f4 2048
#gmssl speed ecdsa
#gmssl genrsa -rand -f4 3072
#gmssl speed ecdh
#gmssl genrsa -rand -f4 4096

++++++++++++++++++++++++++++     updating at 2019-09-10   +++++++++++++++++++++++++++++++++++++++++++++

0001-fix-the-bug-which-hash-and-cipher-key-don-t-use-DMA-.patch fix the issue which dismatching on key buffer between crytodev and caam driver. Crytodev uses stack's buffer for key storage and caam driver use it to dma map which cause flush cache failure. The patch need to apply on cryptodev-module in Yocto build.

++++++++++++++++++  updating at 2019-10-14 +++++++++++++++++++++++++++++++++++

This updating is for China C-V2X application. The meta-gmcrypto is Yocto layer which bases on GmSSL and Cryptodev. I add HW SM2 verification by dedicated CAAM job descriptor and enhanced SW SM2 verification by precomputed multiples of generator and ARMv8 assembler language to accelerate point  operation.

Software environments as the belows:

Linux kernel: imx_4.14.98_2.0.0_ga

cryptodev: 1.9

HW platform: i.MX8M/MM/MN, i.MX8QM/QXP.

How to build:

1, You need to git clone https://gitee.com/zxd2021-imx/meta-gmcrypto.git, and git checkout Linux-4.14.98_2.0.0.  Copy meta-gmcrypto to folder (Yocto 4.14.98_2.0.0_ga dir)/sources/

2, Run DISTRO=fsl-imx-wayland MACHINE=imx8qxpmek source fsl-setup-release.sh -b build-cv2x and add BBLAYERS += " ${BSPDIR}/sources/meta-cv2x " into (Yocto 4.14.98_2.0.0_ga dir)/build-cv2x/conf/bblayers.conf and  IMAGE_INSTALL_append += " gmssl-bin "  into local.conf

3, Run bitbake fsl-image-validation-imx.

4, You can find cv2x-verify.c under (build dir)/tmp/work/aarch64-poky-linux/cryptodev-tests/1.9-r0/git/tests. It is example for using CAAM cryptdev interface to do C-V2X verification (includes SM2 p256, NIST p256 and brainpoolP256r1).  cv2x_benchmark.c under (build dir)/tmp/work/aarch64-poky-linux/gmssl/1.0-r0/gmssl-1.0/test is the benchmark test program of C-V2X verifying. It includes HW, SW and HW+SW(one CPU) verifying for SM2 p256, NIST p256 and brainpoolP256r1.

5, Run the below command on your i.MX8QXP MEK board.

modprobe cryptodev

./cv2x_benchmark

Note: the udpated GmSSL also support projective coordinates and affine coordinates (CAAM only support affine coordinates). Affine coordinates is used by default. You can call EC_GROUP_set_coordinates() and EC_GROUP_restore_coordinates() to change coordinates and restore default. When you hope to use some EC APIs under expected coordinates, you need to call EC_GROUP_set_coordinates() before EC APIs and EC_GROUP_restore_coordinates() after them. Like the below example:

orig_coordinate = EC_GROUP_set_coordinates(EC_PROJECTIVE_COORDINATES);
group = EC_GROUP_new_by_curve_name(NID_sm2p256v1);
EC_GROUP_restore_coordinates(orig_coordinate);

++++++++++++++++++++++++++++     updating at 2020-11-09   +++++++++++++++++++++++++++++++++++++++++++++

This updating is for Yocto release of Linux 5.4.47_2.2.0​​. The meta-gmcrypto is Yocto layer which also support c-v2x feature in previous release. 

Software environments as the belows:

Linux kernel: imx_5.4.47_2.2.0

cryptodev: 1.10

HW platform: i.MX6UL, i.MX7D/S, i.MX8M/8M Mini/8M Nano/8M Plus, i.MX8/8X.

How to build:

1, You need to git clone https://gitee.com/zxd2021-imx/meta-gmcrypto.git, and git checkout Linux-5.4.47-2.2.0. Copy meta-gmcrypto to folder (Yocto 5.4.47_2.2.0 dir)/sources/

2, Run DISTRO=fsl-imx-xwayland MACHINE=imx8mmevk source imx-setup-release.sh -b build-imx8mmevk and add BBLAYERS += " ${BSPDIR}/sources/meta-gmcrypto " into (Yocto 5.4.47_2.2.0 dir)/build-imx8mmevk/conf/bblayers.conf and  IMAGE_INSTALL_append += " gmssl-bin "  into local.conf

3, Run bitbake fsl-image-validation-imx.

4, You can find cv2x-verify.c under (build dir)/tmp/work/aarch64-poky-linux/cryptodev-tests/1.10caam-r0/git/tests. It is example for using CAAM cryptdev interface to do C-V2X verification (includes SM2 p256, NIST p256 and brainpoolP256r1).  cv2x_benchmark.c under (build dir)/tmp/work/aarch64-poky-linux/gmssl/1.0-r0/gmssl-1.0/test is the benchmark test program of C-V2X verifying. It includes HW, SW and HW+SW(one CPU) verifying for SM2 p256, NIST p256 and brainpoolP256r1.

5, Run the below command on your i.MX8M Mini evk board.

modprobe cryptodev

./cv2x_benchmark

gmssl speed sm2

gmssl speed dsa

gmssl speed rsa

gmssl speed ecdsa

gmssl speed ecdh

gmssl genrsa -rand -f4 -engine cryptodev 4096

Note:

1, the udpated GmSSL also support projective coordinates and affine coordinates (CAAM only support affine coordinates). Affine coordinates is used by default. You can call EC_GROUP_set_coordinates() and EC_GROUP_restore_coordinates() to change coordinates and restore default. When you hope to use some EC APIs under expected coordinates, you need to call EC_GROUP_set_coordinates() before EC APIs and EC_GROUP_restore_coordinates() after them. Like the below example:

orig_coordinate = EC_GROUP_set_coordinates(EC_PROJECTIVE_COORDINATES);
group = EC_GROUP_new_by_curve_name(NID_sm2p256v1);
EC_GROUP_restore_coordinates(orig_coordinate);

2, Yocto Zeus integrates openssl 1.1.1g, so I change library name of gmssl from libcrypto to libgmcrypto and from libssl to libgmssl to avoid name confliction with openssl 1.1.1g (lib name are also libcrypto.so.1.1 and libssl.so.1.1). You should use -lgmcrypto and -lgmssl when you link gmssl library instead of -lcrypto and -lssl.

+++++++++++++++++++++++    updating at 2021-02-08  ++++++++++++++++++++++++++++

This updating is for Yocto release of Linux 5.4.70_2.3.0​​. The package meta-gmcrypto is Yocto layer which also support c-v2x feature in previous release. You need to git clone https://gitee.com/zxd2021-imx/meta-gmcrypto.git, and git checkout Linux-5.4.70-2.3.0. 

+++++++++++++++++++++++    updating for Linux-5.10.52-2.1.0  +++++++++++++++++++++++

This updating is for Yocto release of Linux 5.10.52_2.1.0​​. The package meta-gmcrypto is Yocto layer which also support c-v2x feature in previous release. 

1, You need to git clone https://gitee.com/zxd2021-imx/meta-gmcrypto.git, and git checkout Linux-5.10.52-2.1.0.  Copy meta-gmcrypto to folder (Yocto 5.10.52_2.1.0 dir)/sources/.

2, Run DISTRO=fsl-imx-xwayland MACHINE=imx8mmevk source imx-setup-release.sh -b build-imx8mmevk and add BBLAYERS += " ${BSPDIR}/sources/meta-gmcrypto " into (Yocto 5.10.52_2.1.0 dir)/build-imx8mmevk/conf/bblayers.conf and  IMAGE_INSTALL_append += " gmssl-bin "  into local.conf

3, Run bitbake imx-image-multimedia.

4, Run the below command on your i.MX8M Mini EVK board.

modprobe cryptodev

gmssl speed sm2
gmssl genrsa -rand -f4 -engine cryptodev 512
gmssl speed dsa
gmssl genrsa -rand -f4 -engine cryptodev 1024
gmssl speed rsa
gmssl genrsa -rand -f4 -engine cryptodev 2048
gmssl speed ecdsa
gmssl genrsa -rand -f4 -engine cryptodev 3072
gmssl speed ecdh
gmssl genrsa -rand -f4 -engine cryptodev 4096

gmssl speed -evp sha256 -engine cryptodev -elapsed
gmssl speed -evp aes-128-cbc -engine cryptodev -elapsed
gmssl speed -evp aes-128-ecb -engine cryptodev -elapsed
gmssl speed -evp aes-128-cfb -engine cryptodev -elapsed
gmssl speed -evp aes-128-ofb -engine cryptodev -elapsed
gmssl speed -evp des-ede3 -engine cryptodev -elapsed
gmssl speed -evp des-cbc -engine cryptodev -elapsed
gmssl speed -evp des-ede3-cfb -engine cryptodev -elapsed

+++++++++++++++++++++++    updating for Linux-5.15.71-2.2.0 +++++++++++++++++++++++

This updating is for Yocto release of Linux 5.15.71-2.2.0​​. The package meta-gmcrypto is Yocto layer which also support c-v2x feature in previous release. 

1, You need to git clone https://gitee.com/zxd2021-imx/meta-gmcrypto.git, and git checkout Linux-5.15.71-2.2.0.  Copy meta-gmcrypto to folder (Yocto 5.15.71-2.2.0 dir)/sources/.

2, Run DISTRO=fsl-imx-xwayland MACHINE=imx8mmevk source imx-setup-release.sh -b build-imx8mmevk and add BBLAYERS += " ${BSPDIR}/sources/meta-gmcrypto " into (Yocto 5.15.71-2.2.0 dir)/build-imx8mmevk/conf/bblayers.conf and  IMAGE_INSTALL:append = " gmssl-bin "  into local.conf

3, Run bitbake imx-image-multimedia.

4, Run the below command on your i.MX8M Mini EVK board.

modprobe cryptodev

gmssl speed sm2
gmssl genrsa -rand -f4 -engine cryptodev 512
gmssl speed dsa
gmssl genrsa -rand -f4 -engine cryptodev 1024
gmssl speed rsa
gmssl genrsa -rand -f4 -engine cryptodev 2048
gmssl speed ecdsa
gmssl genrsa -rand -f4 -engine cryptodev 3072
gmssl speed ecdh
gmssl genrsa -rand -f4 -engine cryptodev 4096

gmssl speed -evp sha256 -engine cryptodev -elapsed
gmssl speed -evp aes-128-cbc -engine cryptodev -elapsed
gmssl speed -evp aes-128-ecb -engine cryptodev -elapsed
gmssl speed -evp aes-128-cfb -engine cryptodev -elapsed
gmssl speed -evp aes-128-ofb -engine cryptodev -elapsed
gmssl speed -evp des-ede3 -engine cryptodev -elapsed
gmssl speed -evp des-cbc -engine cryptodev -elapsed
gmssl speed -evp des-ede3-cfb -engine cryptodev -elapsed

+++++++++++++++++++++++    Updating for Linux-6.1.55-2.2.0 +++++++++++++++++++++++

This updating is new GmSSL 3.1.1 and Yocto release of Linux 6.1.55-2.2.0.

主要特性

• 超轻量：GmSSL 3 大幅度降低了内存需求和二进制代码体积，不依赖动态内存，可以用于无操作系统的低功耗嵌入式环境(MCU、SOC等)，开发者也可以更容易地将国密算法和SSL协议嵌入到现有的项目中。
• 更合规：GmSSL 3 可以配置为仅包含国密算法和国密协议(TLCP协议)，依赖GmSSL 的密码应用更容易满足密码产品型号检测的要求，避免由于混杂非国密算法、不安全算法等导致的安全问题和合规问题。
• 更安全：TLS 1.3在安全性和通信延迟上相对之前的TLS协议有巨大的提升，GmSSL 3 支持TLS 1.3协议和RFC 8998的国密套件。GmSSL 3 默认支持密钥的加密保护，提升了密码算法的抗侧信道攻击能力。
• 跨平台：GmSSL 3 更容易跨平台，构建系统不再依赖Perl，默认的CMake构建系统可以容易地和Visual Studio、Android NDK等默认编译工具配合使用，开发者也可以手工编写Makefile在特殊环境中编译、剪裁。

More information, please refer to Readme

Recipe file is the attached gmssl_3.1.1.bb.tar.gz

[xiaodong_zhang]

Attach performance data based on 1xA35 CPU + CAAM

./cv2x_benchmark

C-V2X BPp256r1 benchmark pre-start: sign message

C-V2X BPp256r1 SW verify benchmark:
C-V2X BPp256r1 SW verify benchmark: 5000 messages took 18.000000 second
C-V2X BPp256r1 SW verify benchmark: Average 277.78 verification/second with verification failures: 0

C-V2X BPp256r1 HW verify benchmark:
C-V2X BPp256r1 HW verify benchmark: 5000 messages took 8.000000 second
C-V2X BPp256r1 HW verify benchmark: Average 625.00 verification/second with verification failures: 0

C-V2X BPp256r1 HW+SW verify benchmark:
C-V2X BPp256r1 HW+SW verify benchmark: 10000 messages took 10.000000 second
C-V2X BPp256r1 HW+SW verify benchmark: Average 1000.00 verification/second with verification failures: 0

C-V2X NISTp256 benchmark pre-start: sign message

C-V2X NISTp256 SW verify benchmark:
C-V2X NISTp256 SW verify benchmark: 5000 messages took 5.000000 second
C-V2X NISTp256 SW verify benchmark: Average 1000.00 verification/second with verification failures: 0

C-V2X NISTp256 HW verify benchmark:
C-V2X NISTp256 HW verify benchmark: 5000 messages took 6.000000 second
C-V2X NISTp256 HW verify benchmark: Average 833.33 verification/second with verification failures: 0

C-V2X NISTp256 HW+SW verify benchmark:
C-V2X NISTp256 HW+SW verify benchmark: 10000 messages took 6.000000 second
C-V2X NISTp256 HW+SW verify benchmark: Average 1666.67 verification/second with verification failures: 0

C-V2X SM2p256 benchmark pre-start: sign message

C-V2X SM2p256 SW verify benchmark:
C-V2X SM2p256 SW verify benchmark: 5000 messages took 4.000000 second
C-V2X SM2p256 SW verify benchmark: Average 1250.00 verification/second with verification failures: 0

C-V2X SM2p256 HW verify benchmark:
C-V2X SM2p256 HW verify benchmark: 5000 messages took 7.000000 second
C-V2X SM2p256 HW verify benchmark: Average 714.29 verification/second with verification failures: 0

C-V2X SM2p256 HW+SW verify benchmark:
C-V2X SM2p256 HW+SW verify benchmark: 10000 messages took 5.000000 second
C-V2X SM2p256 HW+SW verify benchmark: Average 2000.00 verification/second with verification failures: 0
C-V2X benchmark test passed

[xiaodong_zhang]

你可以在meta-cv2x_4.14.98_2.0.0_ga.tgz里找到patch。解压后的路径是meta-cv2x/recipes-cv2x-kit/cryptodev/files

you can find all patches in meta-cv2x_4.14.98_2.0.0_ga.tgz . Pleas decompress it and path is meta-cv2x/recipes-cv2x-kit/cryptodev/files.

[2424983169]

谢谢，还有我想问下imx6ul可以通过openssl或者gmssl，利用caam实现sm2或者其他国密算法加解密吗

[xiaodong_zhang]

请看蓝色的字 (For i.MX6UL, i.MX7D/S) 部分，之前的gmssl版本已经支持6ul，同时也支持用CAAM加速SM2/SM9国密算法。不过SM3/4还是软件。

please look at the section (For i.MX6UL, i.MX7D/S) ，6ul already support GmSSL with SM2/9. But for SM3/4, they are pure software yet. 

[2424983169]

非常感谢，我有认真看过您写的内容，不过我打完0001-Enhance-cryptodev-and-its-engine-in-GmSSL-by-CAAM-s-.patch和0001-Add-public-key-cryptography-operations-in-CAAM-drive.patch，这两个补丁之后，执行"gmssl speed sm2"会出错

[fengyao_jilin]

@xiaodong_zhang Hello，你好我正在按照你的方法将gmssl移植到imx6q，现在按照开发板手册做完了yocto交叉编译工具的制作，imx6q是cortex-A9，和imx6ull还是不同的，在执行./Configure的时候，后面应该加什么选项呢？或者有什么好的资料可以推荐一下，谢谢了

[xiaodong_zhang]

@fengyao_jilin 你不用考虑使用Yocto交叉编译工具去build GmSSL，只要安装上面的介绍，在Yocto里使用bitbake gmssl就可以编译。