OpenHarmony源码分析之分布式软总线：mbed TLS库的应用_mbedtls源码解释

一、概述

Mbed TLS 库旨在与现有（嵌入式）应用程序集成，并为安全通信、加密和密钥管理提供构建块。Mbed TLS 设计为尽可能松散耦合，允许您只集成您需要的部分，而无需其他部分的开销。这也导致 Mbed TLS 库的内存占用和构建占用非常低。通过消除系统中不需要的部件，您可以获得从低至 45 kB 到更典型的 300 kB 的构建大小，以实现功能更齐全的设置。Mbed TLS 是用可移植的 C 语言设计的，以嵌入式环境为主要目标，可在从 ARM 和 AVR 等嵌入式平台到 PC 和 iPad、iPhone 甚至 XBox 的广泛目标上运行。
本文重点介绍Mbed TLS 库在认证传输模块中用于传输数据的加解密，加密方式采用对称加密算法AES，加密模式是GCM模式，GCM是对该对称加密采用Counter模式，并带有GMAC消息认证码。GCM可以提供对消息的加密和完整性校验，另外，它还可以提供附加消息的完整性校验。在实际应用场景中，有些信息是我们不需要保密，但信息的接收者需要确认它的真实性的，例如源IP，源端口，目的IP，IV，等等。因此，我们可以将这一部分作为附加消息加入到MAC值的计算当中。下面将对应用到mbed TLS库的相关源码进行详细分析。

二、源码分析

主要源码集中在aes_gcm.c中。

#include "aes_gcm.h"

#include <securec.h>

#include "hks_client.h"
#include "mbedtls/gcm.h"

#include "data_bus_error.h"
#include "os_adapter.h"

static mbedtls_gcm_context g_aesContext;//定义GCM模式的上下文信息结构体

/*
函数功能：产生一个随机的IV值
函数参数：无
函数返回值：随机的IV
详细：
*/
unsigned char* GenerateRandomIv(void)
{
    unsigned char *randomIv = malloc(IV_LEN);//申请保存IV值的空间
    if (randomIv == NULL) {
        return NULL;
    }

    struct hks_blob blob = {HKS_BLOB_TYPE_IV, randomIv, IV_LEN};

    int ret = hks_generate_random(&blob);//产生随机IV值，保存在结构体blob中
    if (ret != 0) {
        SOFTBUS_PRINT("[TRANS] EncryptTransData hks_generate_random fail\n");
        free(randomIv);
        return NULL;
    }
    return randomIv;
}

/*
函数功能：加密要进行传输的数据
函数参数：
    cipherkey：密钥
    plainText：明文首地址
    plainTextSize：明文长度
    cipherText：密文首地址
    cipherTextLen：密文长度
函数返回值：
    成功：返回加密之后的密文长度，会有额外的OVERHEAD_LEN
    失败：返回加密错误码
详细：
*/
int EncryptTransData(const AesGcmCipherKey *cipherkey, const unsigned char* plainText, unsigned int plainTextSize,
    unsigned char* cipherText, unsigned int cipherTextLen)
{
    if ((cipherkey == NULL) || (plainText == NULL) || (plainTextSize == 0) || cipherText == NULL ||
        (cipherTextLen < plainTextSize + OVERHEAD_LEN)) {//健壮性检查
        SOFTBUS_PRINT("[TRANS] EncryptTransData invalid para\n");
        return -DBE_AES_CALC_ERROR;
    }

    int ret;
    unsigned char tagBuf[TAG_LEN] = {0};
	//此函数初始化指定的 GCM 上下文，使引用有效，并为mbedtls_gcm_setkey()或mbedtls_gcm_free()准备上下文，该函数不会将 GCM 上下文绑定到特定的密码，也不会设置密钥
    mbedtls_gcm_init(&g_aesContext);
    ret = mbedtls_gcm_setkey(&g_aesContext, MBEDTLS_CIPHER_ID_AES, cipherkey->key, cipherkey->keybits);//该函数将 GCM 上下文结构体与密码算法和密钥相关联
    if (ret != 0) {
        mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
        return -DBE_AES_CALC_ERROR;
    }
	//此函数执行缓冲区的 GCM 加密或解密，参数MBEDTLS_GCM_ENCRYPT表示加密模式
    ret = mbedtls_gcm_crypt_and_tag(&g_aesContext, MBEDTLS_GCM_ENCRYPT, plainTextSize, cipherkey->iv,
        IV_LEN, NULL, 0, plainText, cipherText + IV_LEN, TAG_LEN, tagBuf);
    if (ret != 0) {
        mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
        return -DBE_AES_CALC_ERROR;
    }

    if (memcpy_s(cipherText, IV_LEN, cipherkey->iv, IV_LEN) != 0) {
        mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
        return -DBE_AES_CALC_ERROR;
    }

    if (memcpy_s(cipherText + IV_LEN + plainTextSize, TAG_LEN, tagBuf, TAG_LEN) != 0) {
        mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
        return -DBE_AES_CALC_ERROR;
    }

    mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
    return (plainTextSize + OVERHEAD_LEN);
}

/*
函数功能：解密传输的密文，应用aes_gcm算法
函数参数：
    cipherkey：密钥
    cipherText：密文
    cipherTextSize：密文长度
    plain：明文
    plainLen：预计明文长度
函数返回值：
    成功：返回实际明文长度
    失败：返回解密错误码
详细：
*/
int DecryptTransData(const AesGcmCipherKey *cipherkey, const unsigned char* cipherText, unsigned int cipherTextSize,
    unsigned char* plain, unsigned int plainLen)
{
    if ((cipherkey == NULL) || (cipherText == NULL) || (cipherTextSize <= OVERHEAD_LEN) || plain == NULL ||
        (plainLen < cipherTextSize - OVERHEAD_LEN)) {//健壮性检查
        SOFTBUS_PRINT("[TRANS] DecryptTransData invalid para\n");
        return -DBE_AES_CALC_ERROR;
    }

    mbedtls_gcm_init(&g_aesContext);//初始化aes加密上下文信息结构体
    int ret = mbedtls_gcm_setkey(&g_aesContext, MBEDTLS_CIPHER_ID_AES, cipherkey->key, cipherkey->keybits);//该函数将 GCM 上下文结构体与密码算法和密钥相关联
    if (ret != 0) {
        SOFTBUS_PRINT("[TRANS] DecryptTransData mbedtls_gcm_setkey fail\n");
        mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
        return -DBE_AES_CALC_ERROR;
    }

    int actualPlainLen = cipherTextSize - OVERHEAD_LEN;
    //此函数执行 GCM 验证的缓冲区解密，解密后的内容存储在plain中。对于解密，输出缓冲区不能与输入缓冲区相同。如果缓冲区重叠，则输出缓冲区必须落后于输入缓冲区至少 8 个字节
    ret = mbedtls_gcm_auth_decrypt(&g_aesContext, cipherTextSize - OVERHEAD_LEN,
        cipherkey->iv, IV_LEN, NULL, 0, cipherText + actualPlainLen + IV_LEN, TAG_LEN, cipherText + IV_LEN, plain);
    if (ret != 0) {
        SOFTBUS_PRINT("[TRANS] DecryptTransData mbedtls_gcm_auth_decrypt fail\n");
        mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
        return -DBE_AES_CALC_ERROR;
    }

    mbedtls_gcm_free(&g_aesContext);//此函数清除 GCM 上下文和底层密码子上下文
    return actualPlainLen;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132