关于linux内核模块:SCE-内核态接口使用手册

1.介绍

SCE部件作为飞腾平台的平安组件，提供了对称算法加速器(SCA)、哈希算法加速器(HASH)、非对称算法加速器(ACA)和真随机数生成器(TRNG)。

用户通过Linux Kernel Crypto API框架实现内核对各种算法驱动的反对，目前内核态已实现SCA、HASH、TRNG反对的算法驱动。通过装置SCE内核层驱动可查看已反对的算法驱动，利用开发者可通过相应的内核态接口实现对算法模块的调用。

2.装置与测试

2.1硬件及零碎要求

硬件要求如下表所示。

2.2软件目录架构

软件目录架构如图所示：
1.src文件夹：驱动模块源码。
2.include文件夹：驱动模块头文件。
3.test文件夹：内核层驱动测试代码。

2.3内核驱动算法概述

目前反对的内核态驱动算法如下表所示。

2.4内核层编译、装置与测试

1.SCE内核层内核驱动编译装置步骤

进入驱动代码目录cd driver# 编译驱动模块make# 加载驱动模块sudo insmod phytium_sce.ko# 抉择应用内核层驱动模块# 驱动模块反对用户态和内核态切换# 通过操作/proc/sce_dir/sce_work_state管制# 输出1启用内核态模块，输出2启用用户态模块，输出0敞开所有模块sudo echo 1 > /proc/sce_dir/sce_work_state# 查看驱动模块以后模式cat /proc/sce_dir/sce_work_state# 查看内核反对的SCE算法驱动cat /proc/crypto | grep phytium

2.SCE内核态接口编译装置

#进入内核态测试代码目录cd driver/test# 编译测试模块make# 在执行mtest.ko前必须先加载好内核驱动模块# 执行mtest.ko时通过传入参数可反对对不同算法进行功能性测试# 倡议关上两个终端窗口A和B，其中可在A终端输出测试命令，B终端执行命令“sudo dmesg -w”sudo insmod mtest.ko #当在终端A执行该命令之后，可在终端B查到到内核打印信息，其中表明须要传入的参数信息#示例命令，对hash进行功能测试sudo insmod mtest.ko alg=sm3 mode=hash

3 SCE内核态API阐明

该章节介绍SCE内核态API接口，接口的应用示例可浏览参考kernel/test目录下的测试用例。

3.1哈希算法

3.1.1调配哈希算法对象

3.1.2调配哈希算法数据申请对象

3.1.3设置异步回调

3.1.4设置密钥

3.1.5设置数据

3.1.6性能接口

3.1.7开释req资源

3.1.8开释tfm资源

3.2对称算法

3.2.1调配对称算法对象

3.2.2调配对称算法数据申请对象

3.2.3设置异步回调

3.2.4设置密钥

3.2.5设置数据

3.2.6加密

3.2.7解密

3.2.8开释req资源

3.2.9开释tfm资源

3.3真随机数生成器

3.3.1调配真随机数生成器对象

3.3.2获取随机数

3.3.3开释tfm资源

4 算法应用示例

4.1哈希算法应用示例

4.1.1定义构造

定义多个构造体变量，其中：
struct crypto_wait：异步操作期待对象
struct ahash_request：异步操作申请对象
struct crypto_ahash：哈希算法对象（上下文）
struct scatterlist：用来保留加/解密缓冲区的构造

     struct crypto_wait wait;     struct ahash_request *req;     struct crypto_ahash *tfm;     struct scatterlist *sg = NULL;

4.1.2申请内存

申请明文（src）和哈希值（dst）的数据内存空间。

     src = kmalloc(1024 + 512, GFP_KERNEL);     if (src == NULL) {          printk(KERN_ERR"%s:kmalloc failed!\n", __func__);          return;      }     dst = src+1024;

4.1.3调配算法对象

通过传入的算法名alg和内核接口crypto_alloc_ahash调配算法名对应的算法对象，反对的算法对象能够通过在/proc/crypto文件中查看。

     tfm = crypto_alloc_ahash(alg, 0, 0);         if (IS_ERR(tfm)) {             printk(KERN_ERR"failed to load transform for %s: %ld\n", alg, PTR_ERR(tfm));             return;         }

4.1.4调配算法数据申请对象

调配request异步操作期待对象。

     req = ahash_request_alloc(tfm, GFP_KERNEL);         if (!req) {          printk(KERN_INFO"ahash: Failed to allocate request for %s\n", alg);                  goto fail;     }

4.1.5设置上下文

设置上下文，通过ahash_request_set_callback接口给异步申请对象设置回调函数，负责唤醒实现量相干的的回调传给加解密函数，以使其能在实现后唤醒对应线程。通过crypto_ahash_setkey接口为hash算法设置密钥。通过ahash_request_set_crypt接口设置生成哈希值操作相干参数，如源数据sg指针、填充音讯哈希值的缓冲区以及数据长度信息。

         crypto_init_wait(&wait);         ahash_request_set_callback(req, CRYPTO_TFM_REQ_MAY_BACKLOG, crypto_req_done, &wait);         if (key && klen)              crypto_ahash_setkey(tfm, key, klen);         if (len) {                  sg = kmalloc(sizeof(struct scatterlist) * len, GFP_KERNEL);                  if (sg == NULL) {                       printk(KERN_ERR"%s:kmalloc sg failed!\n", __func__);                       goto fail1;                  }                  sg_init_table(sg, len);                  for (i = 0; i < len; i ++) {                      sg_set_buf(sg + i, data + i, 1);                  }         }         ahash_request_set_crypt(req, sg, out, len);

4.1.6进行digest摘要操作

     ret = crypto_wait_req(crypto_ahash_digest(req), &wait);     if (ret) {          printk(KERN_ERR"hashing failed ret=%d\n", ret);     }

4.1.7开释对象

     ahash_request_free(req);     crypto_free_ahash(tfm);

4.2对称算法应用示例

定义多个构造体变量，其中：
struct crypto_wait：异步操作期待对象
struct skcipher_request：对称密钥异步操作申请对象
struct crypto_skcipher：加密算法对象（上下文）
struct scatterlist：用来保留加/解密缓冲区的构造

struct crypto_wait wait;struct skcipher_request *req;struct crypto_skcipher *tfm;struct scatterlist *ssg = NULL, *dsg = NULL;

4.2.2申请内存

申请明文（src）、密文（dst）、密钥（key）和IV（iv）等数据内存空间。

     src = kmalloc(1024 * 3, GFP_KERNEL);     if (src == NULL) {        printk(KERN_ERR"%s:kmalloc failed!\n", __func__);        return;     }     memset(src, 0, 1024*3);     dst = src + 1024;     key = dst + 1024;     iv = key + 512;

4.2.3调配算法对象

通过传入的算法名alg和内核接口crypto_alloc_skcipher调配算法名对应的算法对象，反对的算法对象能够通过在/proc/crypto文件中查看。

    tfm = crypto_alloc_skcipher(alg, 0, 0);    if (IS_ERR(tfm)) {        printk(KERN_ERR"failed to load transform for %s: %ld\n", alg, PTR_ERR(tfm));        return;    }

4.2.4调配算法数据申请对象

调配request异步操作期待对象。

     req = skcipher_request_alloc(tfm, GFP_KERNEL);     if (!req) {         printk(KERN_INFO"skcipher: Failed to allocate request for %s\n", alg);         goto fail;     }

4.2.5设置上下文

设置上下文，通过 skcipher_request_set_callback接口给异步申请对象设置回调函数，负责唤醒实现量相干的的回调传给加解密函数，以使其能在实现后唤醒对应线程。通过crypto_skcipher_setkey接口为skcipher算法设置密钥。通过skcipher_request_set_crypt接口设置加解密操作相干参数，如源数据、目标数据sg指针、iv指针以及数据长度信息。

    crypto_init_wait(&wait);    skcipher_request_set_callback(req, CRYPTO_TFM_REQ_MAY_BACKLOG, crypto_req_done, &wait);    crypto_skcipher_clear_flags(tfm, ~0);    crypto_skcipher_setkey(tfm, key, klen);    ssg = kmalloc(sizeof(struct scatterlist) * len, GFP_KERNEL);    if (ssg == NULL) {        printk(KERN_ERR"%s:kmalloc ssg failed!\n", __func__);        goto fail1;    }    sg_init_table(ssg, len);    for (i = 0; i < len; i ++) {        sg_set_buf(ssg + i, data + i, 1);    }     dsg = kmalloc(sizeof(struct scatterlist) * len, GFP_KERNEL);     if (dsg == NULL) {         printk(KERN_ERR"%s:kmalloc dsg failed!\n", __func__);         goto fail2;     }     sg_init_table(dsg, len);     for (i = 0; i < len; i ++) {         sg_set_buf(dsg + i, out + i, 1);     }    skcipher_request_set_crypt(req, ssg, dsg, len, iv);

4.2.6实现加/解密

通过crypto_skcipher_encrypt接口执行理论的加密流程。
通过crypto_skcipher_decrypt接口执行理论的解密流程。

    if (enc)        ret = crypto_wait_req(crypto_skcipher_encrypt(req), &wait);    else        ret = crypto_wait_req(crypto_skcipher_decrypt(req), &wait);    if (ret) {        printk(KERN_ERR"failed ret=%d\n", ret);    }

4.2.7开释对象

     skcipher_request_free(req);     crypto_free_skcipher(tfm);

4.3真随机数生成器应用示例

4.3.1定义构造

定义多个构造体变量，其中：
struct crypto_rng：随机数算法对象（上下文）

    struct crypto_rng *tfm;

4.3.2调配算法对象

通过传入的算法名alg和内核接口crypto_alloc_rng调配算法名对应的算法对象，反对的算法对象能够通过在/proc/crypto文件中查看。

     tfm = crypto_alloc_rng("trng", 0, 0);     if (IS_ERR(tfm)) {         printk(KERN_ERR "alg: cprng: Failed to load transform for %s: ""%ld\n", "trng", PTR_ERR(tfm));         return;     }

4.3.3获取随机数

     err = crypto_rng_get_bytes(tfm, buf, len);     if(err) {        printk(KERN_ERR"generate len %d error", len);        break;     }

4.3.4开释对象

     crypto_free_rng(tfm);

5 术语和缩略语

6 常见问题

无

版权所有。飞腾信息技术有限公司 2023。保留所有权力。
未经本公司批准，任何单位、公司或集体不得擅自复制，翻译，摘抄本文档内容的局部或全副，不得以任何形式或路径进行流传和宣传。

商标申明
Phytium和其余飞腾商标均为飞腾信息技术有限公司的商标。
本文档提及的其余所有商标或注册商标，由各自的所有人领有。

留神
本文档的内容视为飞腾的窃密信息，您该当严格遵守窃密工作；未经飞腾当时书面批准，您不得向任何第三方披露本文档内容或提供给任何第三方应用。

因为产品版本升级或其余起因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为应用领导，飞腾在现有技术的根底上尽最大致力提供相应的介绍及操作指引，但飞腾在此明确申明对本文档内容的准确性、完整性、适用性、可靠性的等不作任何明示或暗示的保障。

本文档中所有内容，包含但不限于图片、架构设计、页面布局、文字描述，均由飞腾和/或其关联公司依法领有其知识产权，包含但不限于商标权、专利权、著作权等。非经飞腾和/或其关联公司书面批准，任何人不得擅自应用、批改，复制上述内容。
如有技术问题，可分割support@phytium.com.cn获取反对。