概述
mbedtls提供加解密算法(AES, RSA, MD5/SHA1/SHA256/SHA512 etc.),X.509證書管理和TLS/DTLS協議支持。詳細介紹可參考mbedtls官網。 組件支持以下功能:
TLS(1.0, 1.1, 1.2), DTLS(1.0, 1.2)
X.509證書
加解密算法(DES/3DES/AES/RSA/ARIA/ARC4/BLOWFISH/CAMELLIA/XTEA/CHACHA20/POLY1305)
摘要算法(MD5/SHA1/SHA256/SHA512/RIPEMD160)
版權信息
Apache license v2.0
目錄結構
mbedtls
|-- apache-2.0.txt
|-- ChangeLog
|-- example #適配過AliOS Things的示例代碼
|-- include #mbedtls頭文件
|-- library #mbedtls實現代碼
|-- LICENSE #License申明
|-- package.yaml #編譯和配置文件
|-- platform #適配不同平臺的代碼,目前支持AliOS Things和yoc
|-- programs #開源原生的示例代碼
|-- README.mbedtls.md #開源原生的README文檔
|-- README.md #README文檔
依賴組件
osal_aos
netmgr
常用配置
系統中相關配置已有默認值,如需修改配置,統一在platform/include/config_aos_base.h中修改,具體如下:
使能加解密:默認使能, 如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO: 0
使能MD5: 默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MD5: 0
使能SHA1: 默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_SHA1: 0
使能SHA256: 默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_SHA256: 0
使能SHA512: 默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_SHA512: 1
使能RIPEMD160: 默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_RIPEMD160: 1
使能ARIA: 默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_ARIA: 1
使能DES: 默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_DES: 1
使能AES: 默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_AES: 0
使用AES ROM表:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_AES_ROM_TABLES: 1
使用較少的AES ROM/RAM表:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_AES_FEWER_TABLES: 1
使能CBC加密模式:默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_CBC: 0
使能CFB加密模式:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_CFB: 1
使能CTR加密模式:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_CTR: 1
使能OFB加密模式:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_OFB: 1
使能XTS加密模式:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_XTS: 1
使能GCM加密模式:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_GCM: 1
使能CCM加密模式:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_MODE_CCM: 1
使能ARC4加密:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_ARC4: 1
使能BLOWFISH加密:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_BLOWFISH: 1
使能CAMELLIA加密:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_CAMELLIA: 1
使能XTEA加密:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_XTEA: 1
使能CHACHA20加密:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_CHACHA20:
使能POLY1305 MAC算法:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_POLY1305: 1
使能CHACHAPOLY AEAD算法:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_CRYPTO_CHACHAPOLY: 1
使能X.509證書支持:默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_X509: 0
使能TLS協議支持:默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_TLS: 0
使能TLS1.2協議支持:默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_TLS1_2: 0
使能DTLS協議支持:默認使能,如需關閉,可修改配置如:
def_config:
MBEDTLS_CONFIG_DTLS: 0
使能TLS協議調試支持:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_TLS_DEBUG: 1
TLS/DTLS最大收發報文長度:單位:字節,默認為4096。可修改配置如2K:
def_config:
MBEDTLS_CONFIG_TLS_MAX_CONTENT_LEN: 2048
是否包含自測程序:默認不包含,如需包含,可修改配置如:
def_config:
MBEDTLS_CONFIG_SELFTEST: 1
使能錯誤字符串支持:默認不使能,如需使能,可修改配置如:
def_config:
MBEDTLS_CONFIG_ERROR: 1
API說明
mbedtls API用法與開源版本一致,API用法可以參考mbedtls官網API說明。
使用示例
組件使用示例相關的代碼下載、編譯和固件燒錄均依賴AliOS Things配套的開發工具,所以首先需要參考《AliOS Things集成開發環境使用說明之搭建開發環境》,下載安裝。 待開發環境搭建完成后,可以按照以下步驟進行示例的測試。
步驟1 創建或打開工程
打開已有工程
如果用于測試的案例工程已存在,可參考《AliOS Things集成開發環境使用說明之打開工程》打開已有工程。
創建新的工程
組件的示例代碼可以通過編譯鏈接到AliOS Things的任意案例(solution)來運行,這里選擇helloworld_demo案例。helloworld_demo案例相關的源代碼下載可參考《AliOS Things集成開發環境使用說明之創建工程》。
步驟2 添加組件
案例下載完成后,需要在helloworld_demo組件的package.yaml中添加對組件的依賴:
depends:
- mbedtls: dev_aos # helloworld_demo中引入mbedtls組件
步驟3 下載組件
在已安裝了的開發環境工具欄中,選擇Terminal -> New Terminal啟動終端,并且默認工作路徑為當前工程的workspace,此時在終端命令行中輸入:
aos install mbedtls
上述命令執行成功后,組件源碼則被下載到了./components/mbedtls路徑中。
步驟4 添加示例
在mbedtls組件的package.yaml中添加example示例代碼:
source_file:
- example/tls_example.c #添加編譯tls_example.c
步驟5 編譯固件
在示例代碼已經添加至組件的配置文件,并且helloworld_demo已添加了對該組件的依賴后,就可以編譯helloworld_demo案例來生成固件了,具體編譯方法可參考《AliOS Things集成開發環境使用說明之編譯固件》。
步驟6 燒錄固件
helloworld_demo案例的固件生成后,可參考《AliOS Things集成開發環境使用說明之燒錄固件》來燒錄固件。
步驟7 打開串口
固件燒錄完成后,可以通過串口查看示例的運行結果,打開串口的具體方法可參考《AliOS Things集成開發環境使用說明之查看日志》。
當串口終端打開成功后,可在串口中輸入help來查看已添加的測試命令。
步驟8 測試示例
CLI命令行輸入:
netmgr_example # 執行netmgr示例,使能netmgr命令
關鍵日志:
netmgr test
add_hdl_info:64
add_hdl_info:70
CLI命令行輸入:
netmgr -t wifi -c <ssid(你的wifi名)> <passworld(你的wifi密碼)> # 連接wifi網絡
關鍵日志:
wifi event cb
Got IP
CLI命令行輸入:
tls_example # 連接wifi網絡
關鍵日志:
tls_example test success!
FAQ
Q1: TLS 握手失敗,Debug消息顯示"buffer too small ..." 或者 "bad message length"
答:這通常是由于內部用來處理TLS消息的I/O buffer小于消息的長度,通過修改MBEDTLS_CONFIG_TLS_MAX_CONTENT_LEN配置增大I/O buffer即可。 AliOS Things默認配置的I/O buffer為4KB, 一般擴大到16384 (16KB)可以解決所有的此類問題。