Rockchip TEE SDK开发指南：TrustZone、CA/TA与安全存储

依据中英文V1.16.1原稿（64/69页）完整整理。作为ArmSoM平台参考，须按具体SoC、SDK/BSP、OP-TEE V1/V2、U-Boot、内核与库版本配套验证；不宣称所有板卡支持。原稿列出的Android版本、驱动和固件配套条件保留，未做ArmSoM硬件验证；性能结果、命令、输出均来自原厂示例。

OTP写入、密钥变更、生命周期和安全等级配置可能不可逆或导致启动/数据访问失败。必须先核对芯片及配套软件，在专用测试设备验证；本次未执行任何烧写、安全配置、锁定或密钥操作。原文对Android与威胁模型的概述属于文档时代背景，不作为当前所有Android设备的安全断言。

原稿差异与待核：①rk_rsa_sign的salt_len，中文第50页写“如果不存在”，英文第55页明确写“if it is 0”，均说此时盐长度等于摘要长度；两种条件并不等价，本文并列保留，实际默认行为须核对所用SDK实现。②TA签名示例中文指定RK3588/Android12，英文泛称arm64/OP-TEE V2/Android12，本文按中文具体平台保留，不扩大适用性。③REE FS TA防回滚章节中文只将REE FS中的TA称为明文，英文还把Secure Storage描述为明文；本文采用中文表述，不将安全存储认定为明文。④trusted key段文字写key_ctl，安装命令为keyutils，示例实际调用keyctl，三处源写法不混同。⑤rktest表crypto_aes描述原文写AED，标记为原文拼写，未更改API标识。

ArmSoM Docs · OP-TEE · GlobalPlatform

1. 阅读指引

下面介绍了阅读本文档以及使用TEE的步骤,可作为开发者的阅读指引。

1. 了解TEE基础,查看TrustZone软硬件架构和TEE基础知识。

2. 确认和配置功能需求确认OPTEE版本,查看平台说明章节。强弱安全等级配置,查看强弱安全等级可选的方案章节。TA签名密钥,查看TA签名章节。TA额外的保护机制,查看内置TA到安全存储、加密TA、REE FS TA防回滚等章节。安全存储和性能,查看安全存储章节。OTP说明,查看OTP说明章节。

3. 搭建TEE环境配置安全存储的文件系统,查看安全存储和Parameter.txt说明章节。使能TEE固件,查看TEE固件章节。U-Boot使能TEE,查看U-Boot 中TEE驱动章节。kernel使能TEE,查看TEE linux kernel驱动章节。

4. 测试CA/TA确认环境和工程目录,查看TEE库文件、环境配置、Android、Linux等章节。了解RK提供的demo并编译,查看CA/TA demo介绍、Android、Linux等章节。安装相关库文件和CA/TA demo,查看Android、Linux等章节。测试demo,查看Android、Linux等章节。

5. 开发CA/TA了解TA调试方法,查看TA调试方法章节。参考demo和TA API,开发CA/TA,查看CA/TA demo介绍、TA API说明等章节。

2. TrustZone简介

2.1 什么是TrustZone

ARM TrustZone技术是系统范围的安全方法,针对高性能计算平台上的大量应用,包括安全支付、数字版权管理(DRM)、企业服务和基于Web的服务。TrustZone技术与CortexTM-A处理器紧密集成,并通过AMBA-AXI总线和特定的TrustZone系统IP块在系统中进行扩展。此系统方法意味着可以保护安全内存、加密块、键盘和屏幕等外设,从而可确保它们免遭软件攻击。按照TrustZone Ready Program建议开发并利用TrustZone技术的设备提供了能够支持完全可信执行环境(TEE)以及安全感知应用程序和安全服务的平台。智能手机和平板电脑等最新设备为消费者提供了基于扩展服务集的高价值体验,移动设备已发展为能够从Internet下载各种大型应用程序的开放软件平台。这些应用程序通常由设备OEM进行验证以确保质量,但并非可对所有功能进行测试,并且攻击者正在不断创建越来越多以此类设备为目标的恶意代码。同时,移动设备处理重要服务的需求日益增加。从能够支付、下载和观看某一特定时段的最新好莱坞大片,到能够通过手机远程支付帐单和管理银行帐戶,这一切都表明,新的商业模式已开始出现。这些发展趋势已使手机有可能成为恶意软件、木⻢和rootkit等病毒的下一软件攻击目标。但是,通过应用基于ARMTrustZone技术的高级安全技术并整合SecurCoreTM防篡改元素,可开发出能够提供功能丰富的开放式操作环境和强大安全解决方案的设备。可信应用程序采用基TrustZone技术的SoC(运行可信执行环境),与主OS分开,可防止软件/恶意软件攻击。TrustZone可切换到安全模式,提供硬件支持的隔离。可信应用程序通常是可集装箱化的,如允许不同支付公司的可信应用程序共存于一台设备上。处理器支持ARM TrustZone技术是所有Cortex-A类处理器的基本功能,是通过ARM架构安全扩展引入的。这些扩展可在供应商、平台和应用程序中提供一致的程序员模型,同时提供真实的硬件支持的安全环境。

2.2 TrustZone软硬件架构

2.2.1 硬件架构

TrustZone硬件架构旨在提供安全框架,从而使设备能够抵御将遇到的众多特定威胁。TrustZone技术可提供允许SoC设计人员从大量可在安全环境中实现特定功能的组件中进行选择的基础结构,而不提供固定且一成不变的安全解决方案。架构的主要安全目标是支持构建可编程环境, 以防止资产的机密性和完整性受到特定攻击。具备这些特性的平台可用于构建一组范围广泛的安全解决方案,而使用传统方法构建这些解决方案将费时费力。

图1：中文原稿第10页

可通过以下方式确保系统安全:隔离所有SoC硬件和软件资源,使它们分别位于两个区域(用于安全子系统的安全区域以及用于存储其他所有内容的普通区域)中。支持TrustZone的AMBA3 AXITM总线构造中的硬件逻辑可确保普通区域组件无法访问安全区域资源,从而在这两个区域之间构建强大边界。将敏感资源放入安全区域的设计,以及在安全的处理器内核中可靠运行软件可确保资产能够抵御众多潜在攻击,包括那些通常难以防护的攻击(例如,使用键盘或触摸屏输入密码)。通过在硬件中隔离安全敏感的外设,设计人员可限制需要通过安全评估的子系统的数目,从而在提交安全认证设备时节省成本。TrustZone硬件架构的第二个方面是在一些ARM处理器内核中实现的扩展。通过这些额外增加的扩展,单个物理处理器内核能够以时间片的方式安全有效地同时从普通区域和安全区域执行代码。这样,便无需使用专用安全处理器内核,从而节省了芯片面积和能源,并且允许高性能安全软件与普通区域操作环境一起运行。更改当前运行的虚拟处理器后,这两个虚拟处理器通过新处理器模式(称为监视模式)来进行上下文切换。物理处理器用于从普通区域进入监视模式的机制受到密切控制, 并且这些机制始终被视为监视模式软件的异常。要监视的项可由执行专用指令(安全监视调用 (SMC)指令)的软件触发,或由硬件异常机制的子集触发。可对IRQ、FIQ、外部数据中止和外部预取中止异常进行配置,以使处理器切换到监视模式。在监视模式中执行的软件是实现定义的,但它通常保存当前区域的状态,并还原将切换到的区域位置的状态。然后,它会执行从异常返回的操作,以在已还原区域中重新启动处理过程。TrustZone硬件架构的最后一个方面是安全感知调试基础结构,它可控制对安全区域调试的访问,而不会削弱普通区域的调试可视化。

2.2.2 软件架构

图2：中文原稿第11页

在SoC硬件中实现安全区域要求在其中运行某些安全软件,并利用存储在其中的敏感资产。可能有许多支持TrustZone的处理器内核上的安全区域软件堆栈可实现的软件架构。最高级的软件架构是专用安全区域操作系统;最简单的是放置在安全区域中的同步代码库。这两个极端架构之间有许多中间选项。专用安全内核可能是一种复杂但强大的设计。它可模拟多个独立安全区域应用程序的并发执行、新安全应用程序的运行时下载以及完全与普通区域环境独立的安全区域任务。这些设计与将在SoC中看到的软件堆栈非常类似,它们在非对称多处理(AMP)配置中使用两个单独的物理处理器。在每个虚拟处理器上运行的软件是独立的操作系统,并且每个区域使用硬件中断来抢占当前运行的区域和获得处理器时间。使用将安全区域任务与请求这些任务的普通区域威胁相关联的通信协议的紧密集成设计可提供对称多处理(SMP)设计的许多优点。例如,在这些设计中,安全区域应用程序可继承它支持的普通区域任务的优先级。这将导致对媒体应用程序做出某些形式的软实时响应。安全扩展是ARM架构的开放式组件,因此任何开发人员都可创建自定义安全区域软件环境,以满足其要求。

2.2.3 TrustZone与TEE

支付、网上银行、内容保护和企业身份验证之类的应用可通过利用TrustZone技术增强型设备所提供的三个关键要素来提高其完整性、功能和用戶体验:

1. 面向软件的安全执行环境,可防止从富操作系统发起恶意软件攻击

2. 已知良好的硬件信任根,可在富操作领域检查数据和应用程序的完整性,确保安全环境不受到损害

3. 按需访问安全外设,如内存、键盘/触摸屏,甚至显示器基于ARM TrustZone技术的设备与开放API相结合,提供了可信执行环境(TEE),开发人员需要通过一种新型软件才能实现其功能和一致性:这种软件就是可信应用程序。典型可信应用程序可在普通区域和安全区域各包含部分代码,例如,处理关键存储和操控。TEE还提供了与其他可信应用程序的隔离,使多个可信服务可以共存。

TEE API的标准化(由GlobalPlatform管理)将会使服务提供商、运营商和OEM的可互操作可信应用程序和服务实现市场化。ARM TrustZone技术无需单独的安全硬件来验证设备或用戶的完整性。它通过在主手机芯片集中提供真正的硬件信任根来实现这一点。为确保应用程序的完整性,TrustZone还提供了安全执行环境(即可信执行环境 (TEE)),在此环境中只有可信应用程序才能运行,从而防止遭到黑客/病毒/恶意软件形式的攻击。TrustZone硬件提供了TEE与软件攻击媒介的隔离。硬件隔离可扩展为保护一直到物理外设(包括键盘/触摸屏等)的数据输入和输出。正是具备了这些关键功能,采用TrustZone技术的芯片集提供了众多机会来重新定义用戶可以访问的服务(更多、更好的服务),如何访问服务(更快、更轻松)以及在何处访问服务(随时随地)。在大多数 Android设备上,Android Boot加载程序都不会验证设备内核的真实性。希望进一步控制其设备的用戶可能会安装破解的Android内核来对设备进行root。破解的内核可让超级用戶访问所有数据文件、应用程序和资源。一旦破解内核损坏,则会导致服务被拒绝。如果内核包含恶意软件,则将危害企业数据的安全性。而Secure Boot可有效防止上述问题,Secure Boot是一种安全机制,它可防止在启动过程中加载未经授权的启动加载程序和内核。由值得信任的已知权威机构以加密方式签名的固件映像(如操作系统和系统组件)会被视为经过授权的固件。安全启动组件可以形成第一道防线,用以防范恶意软件对设备进行攻击。

3. TEE环境

3.1 平台说明

Rockchip平台中Android 7.1及更高版本SDK默认均支持TEE环境,Android7.1以下版本默认不支持TEE环境。Linux版本SDK默认没有开启TEE环境,但可以参考后续章节手动配置TEE环境。Rockchip平台采用的TEE方案为OP-TEE,TEE API符合GlobalPlatform标准。目前运行在rockchip平台上的OP-TEE有两个版本,OP-TEE V1与OP-TEE V2。

1.OP-TEE V1:RK312x、RK322x、RK3288、RK3328、RK322xh、RK3368、RK3399、RK3399Pro。

2.OP-TEE V2:RK3326/PX30、RK3358、RK3308、RK1808、RV1109/RV1126、RK3566/RK3568、RK3588、RK3528、RK3562、RV1106和后续新平台。两个版本在TEE固件、TEE库文件、TA文件方面均有不同,需根据具体平台采用不同版本TEE相关组件。不在 OP-TEE V1 列表中的平台即可视为采用 OP-TEE V2 的平台。

3.2 Parameter.txt说明

目前OP-TEE支持多种安全存储文件系统,详⻅ “安全存储” 章节。security安全存储是其中一种,使用security安全存储需要确认parameter.txt文件中定义了该分区,parameter.txt记录了各镜像及分区的位置与大小信息,设置security分区的方法只需在parameter.txt中添加0x00002000@0x000xxxxx(security)即可,0x00002000表示大小4M,0x000xxxxx表示起始地址,具体根据实际的parameter.txt来修改,一般默认都有定义。

3.3 TEE固件

TEE固件也可以叫做TEE binary、Secure OS固件,64位平台还可以叫做BL32。TEE Secure OS的源码默认不开源,TEE binary位于目录 u-boot/tools/rk_tools/bin 或 rkbin/bin 下。

1. ARMv7平台的TEE binary由工具 u-boot/tools/loaderimage 打包成固件trust.img,TEE binary的命名如下:

<platform>_tee_[ta]_<version>.bin
such as: rkbin/bin/rk35/rk3506_tee_v1.26.bin
such as: rkbin/bin/rk35/rk3506_tee_ta_v1.00.bin

名称中带ta的为支持运行User TA,不带ta则不支持运行User TA。U-Boot编译时默认使用TOS.ini进行固件打包,若config有定义CONFIG_TRUST_INI则使用该宏对应的ini文件进行固件打包。这里以RK3506为例,编译时默认使用RK3506TOS.ini进行固件打包,RK3506TOS.ini指向不带ta的固件,所以RK3506默认不支持运行User TA,若开发者需要运行User TA则需要在config中定义CONFIG_TRUST_INI=”RK3506TOS_TA.ini”,RK3506TOS_TA.ini指向带ta的固件。RK3506快速启动方案默认会运行TEE但是不运行U-Boot,无法通过U-Boot自动挖掉TEE使用的安全内存,所以当使用带ta固件时还需要额外在Kernel dts文件reserved_memory节点下添加如下配置,目的是挖掉TEE使用的安全内存。

trust@1 {
    reg = <0x3c00000 0x140000>;
};

其他平台U-Boot运行时会自动挖掉TEE使用的安全内存,不需要额外去配置Kernel dts。

1. ARMv8平台的TEE binary由工具 u-boot/tools/trust_merger 将BL31/BL32等bin打包成固件trust.img,TEE binary的命名如下:

<platform>_bl32_<version>.bin
such as: rkbin/bin/rk35/rk3588_bl32_v1.18.bin

1. 若rkbin/RKTRUST/.ini中[BL32_OPTION]下SEC=0,则需要将其改成SEC=1,否则trust.img将不包含SecureOS,无法运行TEE相关服务。

2. RK3566/RK3568、RK3588、RK3528、RK3562、RV1106和后续新平台会把TEE binary打包进uboot.img,不会生成trust.img固件。出现类似以下打印说明已运行OPTEE V1平台TEE固件。

INF [0x0] TEE-CORE:init_primary_helper:337: Initializing (1.1.0-278-gef70f120a #9 Fri Sep 17
09:39:24 UTC 2021 aarch64)
INF [0x0] TEE-CORE:init_primary_helper:338: Release version: 1.2
INF [0x0] TEE-CORE:init_teecore:83: teecore inits done
INFO:    BL31: Preparing for EL3 exit to normal world
INFO:    Entry point address = 0x200000
INFO:    SPSR = 0x3c9

出现类似以下打印说明已运行OPTEE V2平台TEE固件。

I/TC: OP-TEE version: 3.13.0-897-g5813e173a
I/TC: OP-TEE memory: TEEOS 0x200000 TA 0xc00000 SHM 0x200000
I/TC: Primary CPU initializing
I/TC: Primary CPU switching to normal world boot
INFO:    BL31: Preparing for EL3 exit to normal world
INFO:    Entry point address = 0x200000
INFO:    SPSR = 0x3c9

3.4 U-Boot 中TEE驱动

目前一些安全的操作需要在U-Boot这级操作,比如读取一些数据必须需要OP-TEE帮忙获取。U-Boot里面实现了OP-TEE Client代码,可以通过该接口与OP-TEE通信。OP-TEE Client驱动在lib/optee_client目录下,API符合GP规范。

3.4.1 宏定义说明

CONFIG_OPTEE_CLIENT：U-Boot调用OP-TEE总开关。CONFIG_OPTEE_V1：采用OP-TEE V1的平台使用。CONFIG_OPTEE_V2：采用OP-TEE V2的平台使用。CONFIG_OPTEE_ALWAYS_USE_SECURITY_PARTITION：不开启时，U-Boot安全存储根据硬件自动选择区域，eMMC使用RPMB，NAND使用security分区；开启后固定存于security，不使用RPMB。该宏仅影响U-Boot阶段，对内核及UserSpace无影响。RPMB安全性和稳定性高于security，但便利性较低。将其他设备的eMMC换入本设备，或更换主控时，security只需用烧写工具擦除flash并重新烧写；RPMB无法用烧写工具清除，需特殊固件清除RPMB数据再重新烧写。请权衡便利性与安全性；部分平台默认开启该宏，高安全要求可自行去除。

3.4.2 共享内存说明

U-Boot与OP-TEE通信的数据需放在共享内存中，通过TEEC_AllocateSharedMemory()申请。各平台共享内存大小不同，建议不超过1M，超出时分割数据多次传递；使用后调用TEEC_ReleaseSharedMemory()释放。

3.4.3 安全存储功能测试

3.4.3.1 测试步骤

按以下步骤,可执行安全存储功能测试。该测试用例将循环测试安全存储读写功能,测试程序会自动检查硬件,当硬件使用emmc时将测试rpmb与security分区两种安全存储方式,当硬件使用nand时只测试security分区安全存储。硬件采用emmc时需要确认U-Boot已开启CONFIG_SUPPORT_EMMC_RPMB宏。

1. 进入U-Boot串口命令行:设备串口连接PC,PC按住ctrl+c,启动设备,启动时设备检测到ctrl+c操作则会停在uboot。

2. 执行:以下指令启动测试。

=> mmc testsecurestorage

3.4.3.2 常⻅错误排查

"TEEC: Could not find device"

没有找到emmc或者nand设备,请检查U-Boot中驱动,或者硬件是否损坏。

"TEEC: Could not find security partition"

当采用security分区安全存储时,加密数据会存储在该分区,请检查parameter.txt中是否定义了security分区。

"TEEC: verify [%d] fail, cleanning ...."

第一次使用security分区进行安全存储时,或者security分区数据被非法篡改时出现,security分区会全部清空。

"TEEC: Not enough space available in secure storage !"

安全存储的空间不足,请检查存储的数据是否过大,或者存储的文件数量过多,或者之前是否存储过大量的数据而没有删除。

INF [0x0] TEE-CORE:storage_read_obj:201: Warning! head data not find!
ERR [0x0] TEE-CORE:storage_read_obj:210: cpu or emmc was replaced!

U-Boot启动过程中关键数据会调用TEE进行安全存储,关键数据经过TEE加密存储在security分区或者rpmb分区,而且加密密钥与CPU绑定;若更换CPU将导致关键数据无法正常解密,导致U-Boot启动失败;若更换emmc且emmc之前被使用过,security分区或者rpmb分区存在旧数据,也会出现该错误导致U-Boot启动失败;解决办法为需要清空security分区或者rpmb分区中的旧数据,若使用的是security分区则直接格式化emmc即可,若是使用rpmb则需要联系技术支持提供特殊固件清除rpmb中旧数据。

“optee check api revision fail”

U-Boot与TEE版本不匹配,U-Boot版本高于TEE版本,解决办法如下(二选一):

1. 回退U-Boot版本至 cf13b78438 (tag: android-10.0-mid-rkr9) rockchip: spl: add rollback index check with otp。

2. revert以下几个提交:396e3049bd rochchip: board: only map op-tee share memory as dcache enabled7a349fdcbd lib: optee_client: add optee initialize flag74eb602743 lib: optee_client: update to new optee msg for optee v1 platform102dfafc4a rochchip: board: map op-tee memory as dcache enabled正常情况下对外释放的SDK版本都是匹配的。

"optee api revision mismatch with u-boot/kernel, panic"

若在U-Boot启动阶段打印,则是U-Boot版本与TEE版本不匹配,U-Boot版本低于TEE版本,可升级U-Boot版本至396e3049bd (tag: android-10.0-mid-rkr11, tag: android-10.0-mid-rkr10) rochchip: board: only map及以上版本。op-tee share memory as dcache enabled

若在Android系统启动阶段打印，则升级 android/vendor/rockchip/common 至 8bc7bf97 (tag: android-10.0-mid-rkr10) vpu: librockit: add Rockit MetadataRetriever 或以上版本。

若在Linux系统启动阶段打印，则升级 linux/external/security/bin 至 f59085c optee_v1: lib: arm&arm64: update binary and library 或以上版本。正常情况下对外释放的SDK版本都是匹配的。

3.4.4 U-Boot运行User TA

部分开发者需要在U-Boot阶段运行自己开发的TA应用,可以参考本章节。

1. 确认是否包含该功能提交,若不包含请更新U-Boot代码。

436fc6d8486 lib: optee_clientApi: support load user ta for optee v1
4d4c5043204 lib: optee_clientApi: add user ta test demo
b122ee17db0 lib: optee_clientApi: support load user ta
deb4d4879d5 lib: optee_clientApi: support pack TA to image

1. 开发者拷⻉TA文件到 u-boot/lib/optee_clientApi/userta 目录下,该目录支持存放多个TA文件,默认已经存放了rktest ta文件用于测试。

2. 执行以下命令打包TA文件生成userta.img固件。

cd lib/optee_clientApi
./tabinary_to_img.py --tadir ./userta --out ./userta/userta.img

1. 修改parameter.txt新增一个userta分区,分区大小需要大于userta.img固件大小。

2. 使用烧写工具烧写 parameter.txt 和 userta.img。

3. U-Boot可以调用 trusty_oem_user_ta_transfer 和 trusty_oem_user_ta_storage 测试 rktest ta 是否运行正常。开发者可以参考这两个函数,调用自己的TA。

3.5 TEE linux kernel驱动

TEE linux kernel驱动位于 security/optee_linuxdriver/ 与 drivers/tee/ 中。

3.5.1 OP-TEE V1

采用OP-TEE V1的芯片的驱动位于,默认均有开启。开启方法如下:security/optee_linuxdriver/config中添加以下配置:

CONFIG_TEE_SUPPORT=y

目前我们将逐步废弃OP-TEE V1的TEE linux kernel驱动,OP-TEE V1平台将使用OP-TEE V2的TEE linux kernel驱动,若rkbin/bin目录下TEE binary文件名中 version >= v2.00,则还需要开启OP-TEE V2的TEE linux kernel驱动。2020年8月份以后释放的Android10以及以上版本和Linux版本默认使用OP-TEE V2的kernel驱动。

3.5.2 OP-TEE V2

采用 OP-TEE V2 的芯片的驱动位于 drivers/tee/ 下,开启方法如下:确认对应平台 dtsi 中添加了如下节点:

firmware {
    optee: optee {
        compatible = "linaro,optee-tz";
        method = "smc";
        #status = "disabled";
    };
};

各平台默认情况下都有添加该节点,但部分平台会设置 status = “disabled”; 导致该驱动默认关闭,所以如果要开启optee驱动,只要去除 status = “disabled”; 即可。config 中添加以下两个配置:

CONFIG_TEE=y
CONFIG_OPTEE=y

3.5.3 确认驱动开启

若出现 /dev/opteearmtz00 节点,说明optee v1的TEE linux kernel驱动已开启;若出现 /dev/tee0 和 /dev/teepriv0 节点,说明optee v2的TEE linux kernel驱动已开启。

3.6 trusted key功能开启

trusted key 是 Linux 内核提供的一种 安全密钥管理机制,它利用 可信执行环境(TPM 或 TEE) 来保护密钥,使得密钥内容 不会暴露在普通内存或用戶空间。

3.6.1 kernel trusted key功能开启

config 中添加以下两个配置:

CONFIG_TRUSTED_KEYS=y
CONFIG_TRUSTED_KEYS_TEE=y

3.6.2 optee_os trusted key功能开启

1. 该功能需要BL32开启支持,目前当前支持的芯片平台和BL32版本如下:

1. 确认功能是否开启,trusted_key的tee后端如果开启,将会看到以下打印。

root@linaro-alip:/# dmesg | grep trusted
[    1.814593] Initialise system trusted keyrings
[    2.456306] Key type trusted registered

3.6.3 功能使用

以ubuntu平台为例,需要预先安装key_ctl工具

sudo apt-get install keyutils

测试添加key功能是否正常,可以使用以下命令

root@linaro-alip:/# keyctl add trusted test_key "new 32" @u
1028348999
root@linaro-alip:/#
root@linaro-alip:/# keyctl list @u
1 key in keyring:
1028348999: --alswrv     0     0 trusted: test_key
root@linaro-alip:/#
root@linaro-alip:/# keyctl unlink 1028348999 @u
root@linaro-alip:/#

3.7 TEE库文件

Android TEE组件位于工程vendor/rockchip/common/security或hardware/rockchip/optee目录（含V1与V2，按平台选择）：

1. lib:包含32bit与64bit平台编译出来的tee-supplicant、libteec.so以及keymaster/gatekeeper相关库文件。

2. ta：编译好的keymaster/gatekeeper等TA文件。Linux TEE组件位于工程external/security/bin目录（含V1与V2，按平台选择）：

3. lib:包含32bit与64bit平台编译出来的tee-supplicant、libteec.so以及其他CA相关库文件。

4. ta:存放编译好的TA文件。

4. CA/TA开发与测试

4.1 环境配置

1. 若编译报错 No module named Crypto.Signature ,这是开发电脑没有安装python的算法库导致的,执行如下命令即可:

pip uninstall Crypto
pip uninstall pycrypto
pip install pycrypto

1. 若出现如下错误: ModuleNotFoundError: No module named ‘Cryptodome’开发主机上请安装python包:pip3 install [–user] pycryptodomex

4.2 CA/TA demo介绍

RK提供一套CA/TA demo,目的是:给开发者提供参考,或直接用于测试TEE环境CA/TA demo的源码在Android工程目录的 external/rk_tee_user ,或Linux工程目录的external/security/rk_tee_userCA/TA demo包含“rktest”和“xtest”,其中“xtest”仅在Android环境的 external/rk_tee_user/v2 仓库支持,“xtest”是OPTEE开源的测试代码,包含较完整的测试项。通常的,如果用于测试TEE环境或者参考开发,用“rktest”基本能满足。下面介绍rktest的功能。

rktest demo的CA名为“rktest”,TA名为“1db57234-dacd-462d-9bb1ae79de44e2a5.ta”或“1db57234-dacd-462d-9bb1-ae79de44e2a5.ta”。运行CA程序时,需输入功能参数以选择执行对应的功能。可以输入CA程序名+空格+任意字符,log将提示可用的参数。当前rktest程序实现的测试功能⻅下表。备注:测试程序只涉及常用的部分功能,不覆盖OPTEE支持的所有功能。

执行测试程序,指令如:

# rktest transfer_data
# rktest [command]

CA程序执行成功提示PASS,失败提示Fail。

4.3 Android

4.3.1 目录介绍

TEE CA/TA开发环境在安卓工程目录 external/rk_tee_user 下:

1. Android.mk:其中决定了编译的工具和需要编译的ca 文件。

2. host:存放CA的相关源文件。

3. ta:存放TA的源文件。

4. export*:存放编译TA 所依赖的环境。

4.3.2 编译开发说明

若external/rk_tee_user下只有v1/、v2/两个目录，master已合并至develop-next，master将废弃；合并点为master提交492f1cbf testapp: support new OP-TEE MSG。执行以下命令编译。

#OP-TEE V1平台进⼊v1⽬录
cd external/rk_tee_user/v1
#OP-TEE V2平台进⼊v2⽬录
cd external/rk_tee_user/v2
rm -rf out/
./build.sh ta
mm

若external/rk_tee_user下没有v1/、v2/目录，仍使用两个分支；OP-TEE V1先切换master，V2先切换develop-next，然后执行以下命令编译。

cd external/rk_tee_user/
rm -rf out/
./build.sh ta (git log包含“Android.mk: remove build ta from android”则执⾏，否则不执⾏)
mm

编译成功后会得到相应的执行程序,执行程序分为CA(Client Application,运行在normal world)和TA(TrustApplication,运行在secure world)。CA为普通执行文件,编译后生成于Android工程out目录中。TA是文件名为uuid,后缀为.ta的文件,编译后生成于rk_tee_user/ta、rk_tee_user/out/ta、rk_tee_user/v1/out/ta、rk_tee_user/v2/out/ta其中一个目录对应的文件夹中。

4.3.3 运行测试TEE环境

1. adb shell进入设备

2. 安装TEE库、CA与TA。Android 7：libteec.so放/system/lib或/system/lib64；tee-supplicant和CA放/system/bin；创建/system/lib/optee_armtz并放入TA。Android 8及更高：libteec.so放/vendor/lib或/vendor/lib64；tee-supplicant和CA放/vendor/bin；创建/vendor/lib/optee_armtz并放入TA。若tee-supplicant自启动，系统已有它和libteec.so，无需再次push。注意区分OP-TEE V1/V2及32/64位，push后检查tee-supplicant与CA执行权限。

3. 若开机未自动运行tee-supplicant,则需手动root权限后台运行tee-supplicant:

# tee-supplicant &

若出现打印,说明parameter.txt中没有定义security分区,详情请参tee_supp_rk_fs_init: unsupported考 “parameter.txt说明” 章节,若开发者只使用rpmb分区或REE文件系统进行安全存储,可以忽略该错误打印。

1. 运行CA,调用TA,测试TEE相关功能。rk_tee_user自带的rktest程序,可用于直接测试TEE基本功能,执行:

# rktest [command]

1. 若rktest的各指令运行通过,则TEE环境正常,可进行TEE相关开发。若运行报错,请先检查驱动及各组件;也可能是rk_tee_user版本与TEE OS版本不匹配导致,以下为常用匹配关系:OP-TEE V1:rkbin/bin目录下TEE binary文件名中 version >= v2.00,对应492f1cbf testapp: support new OP-TEE MSGrkbin/bin目录下TEE binary文件名中 version < v2.00,对应e8d7215d Android.mk: support build in android R或者466515ec add tools for user to resign TAOP-TEE V2:

TEE启动阶段串口打印”OP-TEE version: 3.13.0”，对应 a566557 - v2: update to keep up with v3.13.0 of optee_test。

TEE启动阶段串口打印”OP-TEE version: 3.6.0”，对应 1aa969e2 Android.mk: support build in android R。

TEE启动阶段串口打印”OP-TEE version: 3.3.0”，对应 aa0a0c00 Android.mk: remove build ta from android。

androidTEE启动阶段串口打印”OP-TEE version: 2.5.0”,对应 1ec9913a add tools for user to resign TA

4.3.4 Step By Step

这里以安卓12上采用OP-TEE V2的arm64平台举例

//编译CA TA
cd /home1/xxxx/rk_android_12
source build/envsetup.sh
lunch rk3568_s-userdebug
cd /home1/xxxx/rk_android_12/external/rk_tee_user/v2
./build.sh ta
mm

//推送TEE库⽂件和CA TA到设备
adb root && adb remount
adb push Y:\rk_android_12\hardware\rockchip\optee\v2\arm64\libteec.so /vendor/lib64
adb push Y:\rk_android_12\hardware\rockchip\optee\v2\arm64\tee-supplicant /vendor/bin
adb push Y:\rk_android_12\out\target\product\rk3568_s\vendor\bin\rktest /vendor/bin
adb push Y:\rk_android_12\external\rk_tee_user\v2\out\ta\rk_test\1db57234-dacd-462d-9bb1-ae79de44e2a5.ta /vendor/lib/optee_armtz

//运⾏CA TA
# tee-supplicant &  //若tee-supplicant已经运⾏，可以忽略本步骤，安卓平台⼀般默认已经有运⾏
# rktest transfer_data

4.3.5 开发CA/TA

可参考CA,TA中的Makefile与头文件的UUID需要修改成新生成的UUID,可用uuidgen命令生成。在每个TA的include目录下的头文件user_ta_header_defines.h中定义了堆栈的大小,堆的大小为32KB(TA_DATA_SIZE),栈的大小为2KB(TA_STACK_SIZE)。一般情况下最好不要去修改,若实在无法满足需求,可适当改大一些,堆的大小不要超过1MB,栈的大小不要超过64KB。

#define TA_STACK_SIZE               (2 * 1024)
#define TA_DATA_SIZE                (32 * 1024)

4.4 Linux

4.4.1 目录介绍

TEE CA/TA开发环境在linux工程目录 external/security/rk_tee_user 下:

1. build.sh:编译执行脚本,编译说明请参考脚本中的注释。

2. Makefile:其中决定了编译的工具和需要编译的ca 文件。

3. host:存放CA的相关源文件以及对应Makefile。

4. ta:存放TA的源文件。

5. export*:存放编译TA 所依赖的环境。

4.4.2 编译开发说明

若external/security/rk_tee_user下只有v1/、v2/目录，master已合并至develop-next，master将废弃；合并点为492f1cbf testapp: support new OP-TEE MSG。执行以下命令编译。

#OP-TEE V1平台进⼊v1⽬录
cd external/security/rk_tee_user/v1
#OP-TEE V2平台进⼊v2⽬录
cd external/security/rk_tee_user/v2
rm -rf out/
./build.sh 3232 （32位平台执⾏，CA 32bits，TA 32bits）
./build.sh 6432 （64位平台执⾏，CA 64bits，TA 32bits）

若external/security/rk_tee_user下没有v1/、v2/目录，仍使用两个分支。OP-TEE V1先切换master，V2先切换develop-next，然后编译。

cd external/security/rk_tee_user/
rm -rf out/
./build.sh 3232 （32位平台执⾏，CA 32bits，TA 32bits）
./build.sh 6432 （64位平台执⾏，CA 64bits，TA 32bits）

编译成功后会得到相应的执行程序,执行程序分为CA(Client Application,运行在normal world)和TA(TrustApplication,运行在secure world)。CA为普通执行文件,编译后生成于rk_tee_user/out、rk_tee_user/v1/out、rk_tee_user/v2/out其中一个目录下对应的文件夹中。TA是文件名为uuid,后缀为.ta的文件,编译后生成于rk_tee_user/out/ta、rk_tee_user/v1/out/ta、rk_tee_user/v2/out/ta其中一个目录对应的文件夹中。

4.4.3 运行测试TEE环境

1. adb shell进入设备。

2. 把相关TEE库文件、CA、TA安装到设备中。libteec.so*等库文件放置到/lib或/lib64目录下;tee-supplicant,CA程序放置到/usr/bin目录下;创建/lib/optee_armtz目录,TA程序放置到/lib/optee_armtz目录下。(若开机tee-supplicant自启动,则tee-supplicant和libteec.so不用再push,系统中已有这两个文件;libteec.so和tee-supplicant注意区分OP-TEE V1与OP-TEE V2,注意区分32位和64位;push后检查下tee-supplicant和CA程序是否有执行权限)

3. 其他步骤,与Android平台相同,⻅上述“Android”章节。

4.4.4 Step By Step

这里以Linux上采用OP-TEE V2的arm64平台举例

//编译CA TA
cd /home1/xxxx/rk_px30_linux/external/security/rk_tee_user/v2
rm -rf out/
./build.sh 6432

//设备上创建optee_armtz⽬录，⽤于存放TA⽂件
# mkdir -p /lib/optee_armtz

//推送TEE库⽂件和CA TA到设备
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\libteec.so /lib64
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\libteec.so.1 /lib64
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\tee-supplicant /usr/bin
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\rk_test\rktest /usr/bin
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\rk_test\1db57234-dacd-462d-9bb1-ae79de44e2a5.ta /lib/optee_armtz

//添加可执⾏权限
# chmod +x /usr/bin/tee-supplicant
# chmod +x /usr/bin/rktest

//运⾏CA TA
# tee-supplicant &  //若tee-supplicant已经运⾏，可以忽略本步骤
# rktest transfer_data

4.4.5 开发CA/TA

可参考CA/TA。Makefile及头文件中的UUID须修改为通过uuidgen生成的新UUID。各TA的include/user_ta_header_defines.h定义堆32KB（TA_DATA_SIZE）和栈2KB（TA_STACK_SIZE）。一般不建议修改；确有需要可增大，但堆不超过1MB，栈不超过64KB。

#define TA_STACK_SIZE               (2 * 1024)
#define TA_DATA_SIZE                (32 * 1024)

4.5 rk_tee_service

4.5.1 功能介绍

rk_tee_service 是基于TEE开发的安全功能服务,为开发者提供了常用的安全功能,简单清晰的对外接口极大便利了开发者使用。rk_tee_service 本质上是CA TA应用,因此请按照 “运行测试TEE环境” 章节测试TEE环境正常后再使用rk_tee_service。

开发者可以直接调用 rk_tee_service 对敏感数据进行加解密,数据在TA端进行加解密,加解密密钥由TEE使用设备硬件唯一密钥HUK派生,因此每台设备的加解密密钥都不同,拷⻉设备A的敏感数据到设备B上是无法正常解密的,保证敏感数据不被盗用。受限于共享内存的大小,建议单次加解密数据大小不要超过1M,大数据建议分多次进行加解密。目前OP-TEE V2平台支持该功能,OP-TEE V1平台暂不支持。

4.5.2 组件

目前支持 Linux 平台和 Android 平台(Android 12及更高版本)。

Userspace 应用可以直接调用 librk_tee_service.so 动态库,函数的参数说明请参考 rk_tee_service.h,Linux平台请把4367fd45-4469-42a6-925d-3857b952704a.ta放置到 /lib/optee_armtz 目录下,Android平台请把4367fd45-4469-42a6-925d-3857b952704a.ta放置到 /vendor/lib/optee_armtz 目录下。

4.5.3 参考Demo

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "rk_tee_service.h"

int main(int argc, char *argv[])
{
    unsigned char plain[256];
    unsigned int plain_len;
    unsigned char cipher[256];
    unsigned int cipher_len;
    int res;

    memset((void *)plain, 0xab, sizeof(plain));
    cipher_len = 256;
    res = rk_encrypt_data(plain, sizeof(plain), cipher, &cipher_len);
    printf("res=0x%x cipher_len=%d\n", res, cipher_len);

    memset((void *)plain, 0, sizeof(plain));
    plain_len = 256;
    res = rk_decrypt_data(cipher, cipher_len, plain, &plain_len);
    printf("res=0x%x plain_len=%d\n", res, plain_len);

    return 0;
}

4.6 测试xtest

xtest是OPTEE开源的测试代码,包含较完整的测试项,客戶可以参考本章节测试xtest。这里以安卓13上采用OP-TEE V2的arm64平台举例:

//编译CA TA
cd /home1/xxxx/rk_android_13
source build/envsetup.sh
lunch rk3568_t-userdebug
cd /home1/xxxx/rk_android_13/external/rk_tee_user/v2
./build.sh ta
mm

//设备上创建plugins⽬录
# mkdir -p /vendor/lib64/tee-supplicant/plugins/

//推送TEE库⽂件和CA TA到设备
adb root && adb remount
adb push Y:\rk_android_13\hardware\rockchip\optee\v2\arm64\libteec.so /vendor/lib64
adb push Y:\rk_android_13\hardware\rockchip\optee\v2\arm64\tee-supplicant /vendor/bin
adb push Y:\rk_android_13\out\target\product\rk3568_t\vendor\bin\xtest /vendor/bin
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\crypt\cb3e5ba0-adf1-11e0-998b-0002a5d5c51b.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\concurrent\e13010e0-2ae1-11e5-896a-0002a5d5c51b.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\create_fail_test\c3f6e2c0-3548-11e1-b86c-0800200c9a66.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\rpc_test\d17f73a0-36ef-11e1-984a-0002a5d5c51b.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\sims\e6a33ed4-562b-463a-bb7e-ff5e15a493c8.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\concurrent_large\5ce0c432-0ab0-40e5-a056-782ca0e6aba2.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\miss\528938ce-fc59-11e8-8eb2-f2801f1b9fd1.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\socket\873bcd08-c2c3-11e6-a937-d0bf9c45c61c.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\sims_keepalive\a4c04d50-f180-11e8-8eb2-f2801f1b9fd1.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\os_test\5b9e0e40-2636-11e1-ad9e-0002a5d5c51b.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\os_test_lib\ffd2bded-ab7d-4988-95ee-e4962fff7154.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\os_test_lib_dl\b3091a65-9751-4784-abf7-0298a7cc35ba.ta /vendor/lib/optee_armtz
//测试安全存储，security空间有限会导致测试失败，删除parameter.txt中security分区，
//uboot不要定义CONFIG_OPTEE_ALWAYS_USE_SECURITY_PARTITION，默认使⽤安卓⽂件系统可以测试通过
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\storage\b689f2a7-8adf-477a-9f99-32e90c0ad0a2.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\storage2\731e279e-aafb-4575-a771-38caa6f0cca6.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\storage_benchmark\f157cda0-550c-11e5-a6fa-0002a5d5c51b.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\external\rk_tee_user\v2\out\ta\supp_plugin\380231ac-fb99-47ad-a689-9e017eb6e78a.ta /vendor/lib/optee_armtz
adb push Y:\rk_android_13\out\target\product\rk3568_t\vendor\lib64\tee-supplicant\plugins\f07bfc66-958c-4a15-99c0-260e4e7375dd.plugin.so /vendor/lib64/tee-supplicant/plugins/
adb push Y:\rk_android_13\hardware\rockchip\optee\v2\arm64\libckteec.so /vendor/lib64
adb push Y:\rk_android_13\external\rk_tee_user\v2\export-ta_arm32\ta\fd02c9da-306c-48c7-a49c-bbd827ae86ee.ta /vendor/lib/optee_armtz

//运⾏xtest
# tee-supplicant &  //若tee-supplicant已经运⾏，可以忽略本步骤，安卓平台⼀般默认已经有运⾏
# xtest

这里以Linux上采用OP-TEE V2的arm64平台举例

//编译CA TA
cd /home1/xxxx/rk_px30_linux/external/security/rk_tee_user/v2
rm -rf out/
./build.sh 6432

//设备上创建optee_armtz⽬录，⽤于存放TA⽂件
# mkdir -p /lib/optee_armtz
//设备上创建plugins⽬录
# mkdir -p /usr/lib/tee-supplicant/plugins/

//推送TEE库⽂件和CA TA到设备
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\libteec.so /lib64
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\libteec.so.1 /lib64
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\tee-supplicant /usr/bin
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\xtest\xtest /usr/bin
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\crypt\cb3e5ba0-adf1-11e0-998b-0002a5d5c51b.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\concurrent\e13010e0-2ae1-11e5-896a-0002a5d5c51b.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\create_fail_test\c3f6e2c0-3548-11e1-b86c-0800200c9a66.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\rpc_test\d17f73a0-36ef-11e1-984a-0002a5d5c51b.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\sims\e6a33ed4-562b-463a-bb7e-ff5e15a493c8.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\concurrent_large\5ce0c432-0ab0-40e5-a056-782ca0e6aba2.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\miss\528938ce-fc59-11e8-8eb2-f2801f1b9fd1.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\socket\873bcd08-c2c3-11e6-a937-d0bf9c45c61c.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\sims_keepalive\a4c04d50-f180-11e8-8eb2-f2801f1b9fd1.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\os_test\5b9e0e40-2636-11e1-ad9e-0002a5d5c51b.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\os_test_lib\ffd2bded-ab7d-4988-95ee-e4962fff7154.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\os_test_lib_dl\b3091a65-9751-4784-abf7-0298a7cc35ba.ta /lib/optee_armtz
//测试安全存储，security空间有限会导致测试失败，删除parameter.txt中security分区，
//uboot不要定义CONFIG_OPTEE_ALWAYS_USE_SECURITY_PARTITION，默认使⽤安卓⽂件系统可以测试通过
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\storage\b689f2a7-8adf-477a-9f99-32e90c0ad0a2.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\storage2\731e279e-aafb-4575-a771-38caa6f0cca6.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\storage_benchmark\f157cda0-550c-11e5-a6fa-0002a5d5c51b.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\ta\supp_plugin\380231ac-fb99-47ad-a689-9e017eb6e78a.ta /lib/optee_armtz
adb push Y:\rk_px30_linux\external\security\rk_tee_user\v2\out\supp_plugin\f07bfc66-958c-4a15-99c0-260e4e7375dd.plugin /usr/lib/tee-supplicant/plugins/
adb push Y:\rk_px30_linux\external\security\bin\optee_v2\lib\arm64\libckteec.so.0 /lib64
adb push  Y:\rk_px30_linux\external\security\rk_tee_user\v2\export-ta_arm32\ta\fd02c9da-306c-48c7-a49c-bbd827ae86ee.ta /lib/optee_armtz

//添加可执⾏权限
# chmod +x /usr/bin/tee-supplicant
# chmod +x /usr/bin/xtest

//运⾏CA TA
# tee-supplicant &  //若tee-supplicant已经运⾏，可以忽略本步骤
# xtest

5. TA签名

5.1 原理

TA编译时，脚本自动用rk_tee_user工程export-user_ta/keys或export-ta_arm32/keys目录下的密钥签名。密钥为2048位RSA，PEM格式，生成.ta文件。TEE binary内置RSA公钥；加载TA时TEE OS用公钥验证，验证通过才运行，以确保仅运行合法TA。

5.2 替换公钥

为防止开发者A的TA应用运行在开发者B的板子上,建议开发者替换公钥。开发者可以使用工具替换TEE binary中的公钥,所需工具在rk_tee_user工程tools/目录中。Linux下替换:

./change_puk  --teebin  <TEE binary>

该命令将自动生成一个2048⻓度的RSA密钥oemkey.pem并保存在当前目录下,并自动使用该密钥中的公钥替换TEE binary中的原始公钥。

./change_puk  --teebin  <TEE binary> --key oemkey.pem

使用开发者指定的密钥中的公钥来替换TEE binary中的原始公钥,密钥⻓度须2048⻓度。Windows下替换:打开Windows_change_puk.exe点击“生成oemkey.pem”按钮生成并保存密钥。选择刚刚生成的密钥和TEE binary,点击修改公钥。(由于Windows_change_puk.exe会调用BouncyCastle.Crypto.dll第三方库,请确保BouncyCastle.Crypto.dll与Windows_change_puk.exe在同一目录下)替换公钥后,开发者需使用新的TEE binary(新公钥)替换rkbin/目录下的TEE binary(原始公钥),重新编译U-Boot,烧写新生成的trust.img固件,部分平台trust打包进uboot.img所以没有trust.img,开发者烧写uboot.img即可。

将工具生成或自己指定的密钥重命名为oem_privkey.pem，替换rk_tee_user工程export-user_ta/keys或export-ta_arm32/keys目录中的密钥，再编译CA/TA。所得TA可由包含新公钥的TEE binary正确加载运行；未用正确私钥签名的TA视为非法，不能运行。

5.3 TA签名Step By Step

这里以RK3588平台安卓12为例:

cd /home1/xxxx/rk_android_12/external/rk_tee_user/v2/tools/change_puk_tool-release/change_puk_linux

chmod +x change_puk

./change_puk --teebin /home1/xxxx/rk_android_12/rkbin/bin/rk35/rk3588_bl32_v1.17.bin

cp oem_privkey.pem /home1/xxxx/rk_android_12/external/rk_tee_user/v2/export-ta_arm32/keys/

cp oem_privkey.pem /home1/xxxx/rk_android_12/external/rk_tee_user/v2/export-ta_arm64/keys/

//重新编译烧写uboot固件，重新编译CA TA应⽤

6. 内置TA到安全存储

正常情况下TA开发完成后,TA文件会以明文形式存放于非安全文件系统中,部分对安全性要求较高的OEM厂商不希望TA以明文的形式暴露出去,为了支持OEM厂商这一需求,OP-TEE V2支持内置TA到安全存储(OP-TEE V1暂不支持)。

6.1 原理

CA端读取非安全文件系统中的TA文件,再把TA数据发送给OP-TEE OS,OP-TEE OS接收到TA数据会先校验TA的合法性,若TA是合法的则随机生成TA加密密钥,使用TA加密密钥对TA数据进行加密,再将密文TA数据和TA加密密钥进行安全存储(若有定义security分区则存储于security分区,若没有定义则存储于安卓或Linux文件系统中),安全存储所使用的密钥由硬件唯一密钥派生,每台设备都不同。最后开发者需自行删除掉非安全文件系统中的TA文件,防止明文TA暴露。上诉步骤完成后,CA可以正常调用TA应用,当CA调用安全存储中的TA时,OP-TEE OS会根据传入的uuid在安全存储中查找对应TA,若查找到对应TA则解密并加载运行TA,若没有查找到对应TA则会到非安全文件系统中查找对应TA。

6.2 参考实现

以下为CA端代码,开发者可以先读取TA文件,然后通过 install_ta 函数把TA数据发送到OP-TEE OS。

static void install_ta(void *buf, size_t blen)
{
    TEEC_Result res = TEEC_ERROR_GENERIC;
    uint32_t err_origin = 0;
    TEEC_UUID uuid = PTA_SECSTOR_TA_MGMT_UUID;
    TEEC_Operation op;
    TEEC_Context ctx = { };
    TEEC_Session sess = { };
    int i = 0;

    res = TEEC_InitializeContext(NULL, &ctx);
    if (res != TEEC_SUCCESS) {
        printf("TEEC_InitializeContext failed with code 0x%x\n", res);
        goto exit;
    }

    res = TEEC_OpenSession(&ctx, &sess, &uuid,
                   TEEC_LOGIN_PUBLIC, NULL, NULL, &err_origin);
    if (res != TEEC_SUCCESS) {
        printf("TEEC_Opensession failed with code 0x%x origin 0x%x\n",
               res, err_origin);
        goto exit;
    }

    memset(&op, 0, sizeof(op));
    op.paramTypes = TEEC_PARAM_TYPES(TEEC_MEMREF_TEMP_INPUT, TEEC_NONE,
                     TEEC_NONE, TEEC_NONE);
    op.params[0].tmpref.buffer = buf;
    op.params[0].tmpref.size = blen;

    res = TEEC_InvokeCommand(&sess, PTA_SECSTOR_TA_MGMT_BOOTSTRAP, &op,
                 &err_origin);
    if (res != TEEC_SUCCESS) {
        printf("TEEC_InvokeCommand failed with code 0x%x origin 0x%x\n",
               res, err_origin);
        goto exit;
    }
    printf("Installing TAs done\n");

exit:
    TEEC_CloseSession(&sess);
    TEEC_FinalizeContext(&ctx);

    return;
}

7. 加密TA

在上一章节 ”内置TA到安全存储“ 中介绍了避免暴露明文TA的一种方法,但是内置TA到安全存储会占用安全存储的空间,若是安全存储数据异常则无法使用内置TA,且加密TA的密钥是随机生成的,不是开发者自己的加密密钥,本章节将介绍另外一种加密TA的方法(OP-TEE V2支持,OP-TEE V1暂不支持)。

7.1 加密TA方法

若有TA源码，在export-ta_arm32/mk/link.mk中开启CFG_ENCRYPT_TA，同时将TA_ENC_KEY改为自己的加密密钥；开启后，编译脚本自动签名并加密TA。若只有TA二进制而无源码，可使用rk_tee_user工程tools/目录中的工具加密。对明文TA加密的命令如下：

python3 ta_encrypt_tool.py --key oem_privkey.pem --in 1db57234-dacd-462d-9bb1-ae79de44e2a5.ta --enc_key 'b64d239b1f3c7d3b06506229cd8ff7c8af2bb4db2168621ac62c84948468c4f4'

对密文TA重新加密的命令:

python3 ta_encrypt_tool.py --key oem_privkey.pem --in 1db57234-dacd-462d-9bb1-ae79de44e2a5.ta --ori_enc_key 'b64d239b1f3c7d3b06506229cd8ff7c8af2bb4db2168621ac62c84948468c4f4' --enc_key 'c74d239b1f3c7d3b06506229cd8ff7c8af2bb4db2168621ac62c84948468c4f4'

工具参数说明:–key 指向用戶私有的用于签名TA的非对称密钥文件。–in 指向TA文件。–enc_key 用戶私有的用于加密TA的对称密钥。–ori_enc_key 原始加密TA的对称密钥。

7.2 烧写TA encryption key

开发者使用SDK工程RKTools目录下 RKDevInfoWriteTool 工具(版本号大于等于1.2.8)烧写TA encryption key。使用前开发者需新建一个密钥文件,以16进制编辑格式打开该文件,在文件中编辑开发者的32字节加密密钥,打开RKDevInfoWriteTool工具,勾选 “TA encryption key” ,点击按钮选择开发者新建的密钥文件,确认设备进入LOADER模式后,点击 “写入” 按钮进行烧写,密钥最终会写入到设备OTP中(OTP区域一旦写入不可更改,所以一台设备密钥只能烧写一次)。为防止TA encryption key泄漏,工具不支持读TA encryption key。

图3：中文原稿第33页

7.3 解密并运行TA

加密TA与明文TA在使用上完全一致,OP-TEE OS在加载TA过程会自动识别到TA是加密的,OP-TEE OS会自动读取OTP中TA encryption key并解密运行TA,该过程由OP-TEE OS自动完成。

7.4 Soft TA encryption key

若开发者不想增加额外步骤去烧写 TA encryption key 到设备 OTP,可以使用 Soft TA encryption key,它是内置在TEE binary 中的对称密钥。若开发者有烧写 TA encryption key 到设备 OTP,则 OP-TEE OS 优先使用 OTP 中的 TA encryption key 去解密并运行TA,安全性较高。

若开发者没有烧写 TA encryption key 到设备 OTP,则 OP-TEE OS 使用 Soft TA encryption key 去解密并运行TA,安全性较低。开发者需要使用工具替换 TEE binary 中的 Soft TA encryption key,所需工具在rk_tee_user工程tools/目录中。替换 TEE binary 中默认 Soft TA encryption key 密钥的命令:

./change_ta_enc_key --teebin <TEE binary> --takey 'b64d239b1f3c7d3b06506229cd8ff7c8af2bb4db2168621ac62c84948468c4f4'

工具参数说明:–teebin 为 TEE binary 固件路径。–takey 为开发者私有的32字节密钥,需与加密TA时使用的密钥保持一致。

8. REE FS TA防回滚

由“内置TA到安全存储”章节可知,OP-TEE V2版本既支持把TA明文存放在非安全文件系统(REE FS)中,也支持把TA存放在安全存储(Secure Storage)中。对于TA明文存放在REE FS的场景,OP-TEE V2版本支持TA防回滚,防止在REE非安全环境中TA版本降级。

8.1 使用TA防回滚

REE FS TA防回滚始终开启。开发者可在Makefile定义TA版本号CFG_TA_VERSION使用此功能。始终不定义时，系统识别版本号为0，允许相同版本TA运行。若Makefile定义CFG_TA_VERSION当前大于0（如下例），则后续禁止该TA降级。

# unsigned integer format
CFG_TA_VERSION=1

9. 强弱安全等级可选的方案

9.1 方案的适用范围

方案适用于:RK3588、RK3528、RK3562及后续新平台。

9.2 注意事项

在使用本方案之前,开发者需注意以下事项。请在首次下载固件之前,确认uboot的配置项CONFIG_OPTEE_SECURITY_LEVEL已按需求配置。芯片只支持一次配置,后续无法修改。SDK默认是level0,若是测试开发板已经烧写过leve0固件了,那么再烧写leve1或level2固件可能无法正常启动,所以更改CONFIG_OPTEE_SECURITY_LEVEL后建议拿新设备进行测试。如果采用“强安全方案1”,请先用工具“RKDevInfoWriteTool(V1.3.5及以上版本)”,下载OEM HUK。

9.3 方案说明

方案支持由开发者配置OPTEE的安全等级,不同的安全等级对eMMC/安全存储的保护强度不同。

以上不同安全等级的差异,源于eMMC和安全存储相关密钥的差异。下面介绍本方案相关的密钥。HUK(Hardware Unique Key):用于派生RPMB Key、Secure Storage Key以及其他密钥。不同安全的等级,HUK不同,详⻅下图。Hard HUK是基于Device Root Key派生的,一机一密,Device Root Key在芯片出厂时已烧录到安全OTP中。OEM HUK是由开发者定义的,由开发者烧录到安全OTP中。Soft HUK是Rockchip定义的,所有芯片为同一个密钥,固化在固件的密钥。RPMB Key:eMMC芯片RPMB分区的存储保护密钥。Secure Storage Key:安全存储保护密钥。Other Key:OP-TEE中用于其他用途的密钥。

强安全⽅案2

                                  /------> RPMB Key
Device Root Key ---> Hard HUK ------> Secure Storage Key
                                  \------> Other Key
强安全⽅案1

Device Root Key ---> Hard HUK ------> Other Key

                      /------> RPMB Key
OEM HUK --------------
                      \------> Secure Storage Key

弱安全⽅案

Device Root Key ---> Hard HUK ------> Other Key

                      /------> RPMB Key
Soft HUK --------------
                      \------> Secure Storage Key

10. TA调试方法

10.1 optee v1平台

TA出现异常时会打印如下信息。

user TA data-abort at address 0x2a

 esr 0x92000021  ttbr0 0x400000852fc00   ttbr1 0x00000000   cidr 0x0

 cpu #4          cpsr 0x20000130

#32位平台打印r0-r12, sp, lr, pc(402000a0)
#64位平台打印x0-x30, sp_el0, elr(00000000402000a0)

Status of TA 8cccf200-2450-11e4-abe20002a5d5c52c (0x85109b0) (active)
- load addr : 0x40200000    ctx-idr: 4
- code area : 0x9200000 2097152
- stack: 0x9400000 stack:2048
TEEC_InvokeCommand failed with code 0xffff3024 origin 0x3

异常打印中pc或elr就是异常发生的地址,load addr是TA加载到内存中的运行虚拟地址,所以elr - load addr =0x402000a0 - 0x40200000 = 0xa0就是异常代码在TA中的偏移地址。在TA文件同级目录下有个uuid.dmp文件,该文件是TA的反汇编文件,记录了TA中各函数的偏移地址,打开uuid.dmp文件并查找 a0,其中就是异常偏移地址,a0: 681b ldr r3, [r3, #0]testapp_ta.c:97表示异常代码在testapp_ta.c第97行。

/home/xxx/android/vendor/optee_test/ta/testapp/testapp_ta.c:97
      98:   6823        ldr r3, [r4, #0]
      9a:   2202        movs    r2, #2
      9c:   2161        movs    r1, #97 ; 0x61
9e:   4820        ldr r0, [pc, #128]  ; (120 <TA_InvokeCommandEntryPoint+0xa0>)
a0:   681b        ldr r3, [r3, #0]
a2:   4478        add r0, pc
a4:   3033        adds    r0, #51 ; 0x33
a6:   9301        str r3, [sp, #4]
a8:   4b1e        ldr r3, [pc, #120]  ; (124 <TA_InvokeCommandEntryPoint+0xa4>)
aa:   447b        add r3, pc
ac:   9300        str r3, [sp, #0]
ae:   2301        movs    r3, #1
b0:   f002 fbc0   bl  2834 <trace_printf>

10.2 optee v2平台

TA出现异常时会打印如下信息。

E/TC:? 0 User mode data-abort at address 0x2a (translation fault)
E/TC:? 0  esr 0x92000005  ttbr0 0x20000084a7020   ttbr1 0x00000000   cidr 0x0
E/TC:? 0  cpu #1          cpsr 0x20000130

#32位平台打印r0-r12, sp, lr, pc(c00870a4)
#64位平台打印x0-x30, sp_el0, elr(00000000c00870a4)

E/LD:  region  0: va 0xc0004000 pa 0x08600000 size 0x002000 flags rw-s (ldelf)
E/LD:  region  1: va 0xc0006000 pa 0x08602000 size 0x008000 flags r-xs (ldelf)
E/LD:  region  2: va 0xc000e000 pa 0x0860a000 size 0x001000 flags rw-s (ldelf)
E/LD:  region  3: va 0xc000f000 pa 0x0860b000 size 0x004000 flags rw-s (ldelf)
E/LD:  region  4: va 0xc0013000 pa 0x0860f000 size 0x001000 flags r--s
E/LD:  region  5: va 0xc0014000 pa 0x08625000 size 0x001000 flags rw-s (stack)
E/LD:  region  6: va 0xc0015000 pa 0x09201000 size 0x002000 flags rw-- (param)
E/LD:  region  7: va 0xc0087000 pa 0x00001000 size 0x009000 flags r-xs [0]
E/LD:  region  8: va 0xc0090000 pa 0x0000a000 size 0x00c000 flags rw-s [0]
E/LD:   [0] 8cccf200-2450-11e4-abe2-0002a5d5c52c @ 0xc0087000
E/LD:  Call stack:
E/LD:   0xc00870a4
E/LD:   0xc0088b21
E/LD:   0xc008d507
E/LD:   0xc008716c

异常打印中pc或elr就是异常发生的地址,region 0 到 region 8 是TA代码段在内存中的地址,这里异常地址0xc00870a4 属于 region 7 代码段,所以elr - region 7 : va = 0xc00870a4 - 0xc0087000 = 0xa4 就是异常代码在TA中的偏移地址。在TA文件同级目录下有个uuid.dmp文件,该文件是TA的反汇编文件,记录了TA中各函数的偏移地址,打开uuid.dmp文件并查找 a4,其中就是异常偏移地址,a4: 681b ldr r3, [r3, #0]testapp_ta.c:101表示异常代码在testapp_ta.c第101行。

/home/xxx/rk_px30_linux/external/optee_test/ta/testapp/testapp_ta.c:101
      9c:   6823        ldr r3, [r4, #0]
      9e:   2202        movs    r2, #2
      a0:   4d28        ldr r5, [pc, #160]  ; (144 <TA_InvokeCommandEntryPoint+0xc4>)
a2:   4e29        ldr r6, [pc, #164]  ; (148 <TA_InvokeCommandEntryPoint+0xc8>)
a4:   681b        ldr r3, [r3, #0]
a6:   447d        add r5, pc
a8:   447e        add r6, pc
aa:   3533        adds    r5, #51 ; 0x33
ac:   4628        mov r0, r5
ae:   9600        str r6, [sp, #0]
b0:   9301        str r3, [sp, #4]
b2:   2301        movs    r3, #1
b4:   f000 f912   bl  2dc <trace_printf>

10.3 查看调用栈

若开发者调试代码时不仅仅要查看程序异常地址,还想查看整个函数调用栈,optee v2平台提供了脚本export-ta_arm32\scripts\symbolize.py脚本实现该功能。optee v1平台暂不支持。第一步,设置脚本需要的编译器路径,开发者请根据自己本地编译器路径自行调整。

#32位TA执⾏
export PATH=/home1/hisping/rk_px30_linux/prebuilts/gcc/linux-x86/arm/gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf/bin:$PATH
export CROSS_COMPILE=arm-linux-gnueabihf-

#64位TA执⾏
export PATH=/home1/hisping/rk_px30_linux/prebuilts/gcc/linux-x86/aarch64/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/bin:$PATH
export CROSS_COMPILE=aarch64-linux-gnu-

第二步,执行脚本,其中-d参数指向开发者编译出的TA目录。

./export-ta_arm32/scripts/symbolize.py -d out/ta/testapp/

第三步,脚本会等待开发者输入异常打印信息,复制并粘贴异常打印信息,可以得到如下结果,其中 Call stack就是函数调用栈。

I/TA: Hello Test App!
E/TC:? 0
E/TC:? 0 User mode data-abort at address 0x2a (translation fault)
E/TC:? 0  esr 0x92000005  ttbr0 0x20000084a7020   ttbr1 0x00000000   cidr 0x0
E/TC:? 0  cpu #1          cpsr 0x20000130
E/TC:? 0  x0  00000000000069ee x1  0000000000000062
E/TC:? 0  x2  0000000000000002 x3  000000000000002a
E/TC:? 0  x4  00000000c0014f30 x5  00000000c0014f40
E/TC:? 0  x6  00000000c0074080 x7  00000000c0074308
E/TC:? 0  x8  00000000c00742e8 x9  00000000c0014f30
E/TC:? 0  x10 0000000000000065 x11 00000000c007f2d8
E/TC:? 0  x12 0000000000000773 x13 00000000c0014f00
E/TC:? 0  x14 00000000c006cb0d x15 0000000000000000
E/TC:? 0  x16 0000000000000000 x17 0000000000000000
E/TC:? 0  x18 0000000000000000 x19 0000000000000000
E/TC:? 0  x20 0000000000000000 x21 0000000000000000
E/TC:? 0  x22 0000000000000000 x23 0000000000000000
E/TC:? 0  x24 0000000000000000 x25 0000000000000000
E/TC:? 0  x26 0000000000000000 x27 0000000000000000
E/TC:? 0  x28 0000000000000000 x29 0000000000000000
E/TC:? 0  x30 0000000000000000 elr 00000000c006b0a4
E/TC:? 0  sp_el0 00000000c0014f80
E/LD:  Status of TA 8cccf200-2450-11e4-abe2-0002a5d5c52c
E/LD:   arch: arm
E/LD:  region  0: va 0xc0004000 pa 0x08600000 size 0x002000 flags rw-s (ldelf)
E/LD:  region  1: va 0xc0006000 pa 0x08602000 size 0x008000 flags r-xs (ldelf)
E/LD:  region  2: va 0xc000e000 pa 0x0860a000 size 0x001000 flags rw-s (ldelf)
E/LD:  region  3: va 0xc000f000 pa 0x0860b000 size 0x004000 flags rw-s (ldelf)
E/LD:  region  4: va 0xc0013000 pa 0x0860f000 size 0x001000 flags r--s
E/LD:  region  5: va 0xc0014000 pa 0x08625000 size 0x001000 flags rw-s (stack)
E/LD:  region  6: va 0xc0015000 pa 0x09201000 size 0x002000 flags rw-- (param)
E/LD:  region  7: va 0xc006b000 pa 0x00001000 size 0x009000 flags r-xs [0] .ta_head .text
.rodata .ARM.extab .ARM.exidx .dynsym .dynstr .hash
E/LD:  region  8: va 0xc0074000 pa 0x0000a000 size 0x00c000 flags rw-s [0] .dynamic .got
.rel.got .data .bss .rel.dyn
E/LD:   [0] 8cccf200-2450-11e4-abe2-0002a5d5c52c @ 0xc006b000 (out/ta/testapp/8cccf200-2450-
11e4-abe2-0002a5d5c52c.elf)
E/LD:  Call stack:
E/LD:   0xc006b0a4 TA_InvokeCommandEntryPoint at ta/testapp/testapp_ta.c:98
E/LD:   0xc006cb0d entry_invoke_command at
/home/zhangzj/secure/optee_3.6.0/optee_os/lib/libutee/arch/arm/user_ta_entry.c:357
E/LD:   0xc00714f3 __ta_entry_c at export-ta_arm32/src/user_ta_header.c:48
E/LD:   0xc006b158 __ta_entry at export-ta_arm32/src/ta_entry_a32.S:20

11. 内存相关说明

11.1 OP-TEE V1

说明:Secure OS运行在TEE_RAM,TA运行在 TA_RAM ,SHMEM为共享内存。

11.2 OP-TEE V2

说明:Secure OS运行在TEE_RAM,TA运行在 TA_RAM ,SHMEM为共享内存。OPTEE OS已支持打印安全内存大小,开发者可以在启动log中查看到如下信息。

I/TC: OP-TEE memory: TEEOS 0x200000 TA 0xc00000 SHM 0x200000
I/TC: Primary CPU initializing
I/TC: Primary CPU switching to normal world boot

若启动log打印的大小与上述列表不一致则以打印为准。

12. 安全存储

12.1 分区

1. 安全存储是OPTEE OS重要的功能之一,一般用于存储用戶重要数据,数据经过OPTEE OS加密存储于security分区、rpmb分区、Android/Linux文件系统。TEE安全存储共3种:第一种,TA代码中设置storageID = TEE_STORAGE_PRIVATE_RPMB,则使用emmc rpmb进行安全存储,各emmc型号rpmb大小不同,常⻅为4M。第二种,parameter.txt中有定义security分区,且TA代码中设置storageID = TEE_STORAGE_PRIVATE_REE,此时安全存储存放于security分区,security分区目前可用为512k。第三种,parameter.txt中没有定义security分区,且TA代码中设置storageID =

TEE_STORAGE_PRIVATE_REE,此时安全存储存放于Android/Linux文件系统 /metadata/tee 或/data/vendor/tee 或 /data/tee 目录下(请确认tee-supplicant有权限访问该目录),总空间不限制。缺点是设备需要使用emmc且uboot不能定义CONFIG_OPTEE_ALWAYS_USE_SECURITY_PARTITION宏,即uboot阶段的安全数据默认会存储到emmc rpmb中。

1. Uboot端安全存储,请参考 “U-Boot 中TEE驱动” 章节。

2. 在进行安全存储写入数据时请确保设备不发生断电,虽然我们做了断电保护测试,但不保证文件系统完整性,所以建议开发者减少对重要数据的写入次数,确保操作安全数据时环境的稳定性。理论上RPMB的断电保护能力优于security和Android/Linux文件系统。

12.2 性能测试

OPTEE V1平台,RK3399 Linux平台,CPU定频1200000,DDR定频200000000,进行测试:

OPTEE V2平台,RK356x Linux平台,CPU定频1416000,DDR定频324000000,进行测试:

13. OTP说明

OTP指One Time Programmable Memory,OTP区域支持多次读取,但只能写入一次。Secure OTP中预留多种不同的OEM Zone区域用以满足用戶不同的使用需求。

更多细节请参考《Rockchip_Developer_Guide_OTP_CN.pdf》文档。

14. TA API说明

14.1 概述

RK提供以下TA API,有两个目的:供开发者参考常用的TEE Internal API的用法供开发者直接使用API

14.2 API的返回值

API的返回值有:TEE_SUCCESS: 成功TEE_ERROR_BAD_PARAMETERS: 参数错误其他错误: ⻅tee_api_defines.h

14.3 API说明

14.3.1 Crypto API

14.3.1.1 rk_crypto_malloc_ctx

crypto_ctx_t *rk_crypto_malloc_ctx(void);

功能申请crypto操作句柄资源。参数无

14.3.1.2 rk_crypto_free_ctx

void rk_crypto_free_ctx(crypto_ctx_t **ctx);

功能释放crypto操作句柄,完整的算法执行完毕,需执行本函数以释放资源。参数ctx: 操作句柄

14.3.1.3 rk_hash_crypto

TEE_Result rk_hash_crypto(uint8_t *in, uint8_t *out, uint32_t in_len,
                          uint32_t out_len, uint32_t algo);

功能消息摘要算法。如需分段,可使用 接口。rk_hash_begin/update/finish参数in: 输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度

algo：算法类型，支持 TEE_ALG_MD5, TEE_ALG_SHA1, TEE_ALG_SHA224, TEE_ALG_SHA256,

TEE_ALG_SHA384, TEE_ALG_SHA512

14.3.1.4 rk_hash_begin

TEE_Result rk_hash_begin(crypto_ctx_t *ctx, uint32_t algo);

功能消息摘要分段算法,初始化操作。参数ctx: 操作句柄

algo：算法类型，支持 TEE_ALG_MD5, TEE_ALG_SHA1, TEE_ALG_SHA224, TEE_ALG_SHA256,

TEE_ALG_SHA384, TEE_ALG_SHA512

14.3.1.5 rk_hash_update

TEE_Result rk_hash_update(crypto_ctx_t *ctx, uint8_t *in, uint32_t in_len);

功能消息摘要分段算法,对输入的数据,在内部计算摘要。参数ctx: 操作句柄in: 输入数据in_len: 输入数据⻓度

14.3.1.6 rk_hash_finish

TEE_Result rk_hash_finish(crypto_ctx_t *ctx, uint8_t *in, uint8_t *out,
                          uint32_t in_len, uint32_t *out_len);

功能消息摘要分段算法,计算最后一段数据并输出所有数据的摘要。参数ctx: 操作句柄in: 输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度

14.3.1.7 rk_cipher_crypto

TEE_Result rk_cipher_crypto(uint8_t *in, uint8_t *out, uint32_t len,
                            uint8_t *key, uint32_t key_len, uint8_t *iv,
                            uint32_t algo, TEE_OperationMode mode);

功能对称加解密算法接口。如需分段,可使用 接口。rk_cipher_begin/update/finish参数in: 输入数据len: 输入数据的⻓度out: 输出数据key: algo对应的密钥key_len: 密钥⻓度,不同的algo,支持的密钥⻓度略有不同iv: 初始向量algo: 算法类型,支持以下算法(OP-TEE V1版本不支持SM算法)

TEE_ALG_AES_ECB_NOPAD
TEE_ALG_AES_CBC_NOPAD
TEE_ALG_AES_CTR
TEE_ALG_AES_CTS
TEE_ALG_AES_XTS
TEE_ALG_SM4_ECB_NOPAD
TEE_ALG_SM4_CBC_NOPAD
TEE_ALG_SM4_CTR
TEE_ALG_DES_ECB_NOPAD
TEE_ALG_DES_CBC_NOPAD
TEE_ALG_DES3_ECB_NOPAD
TEE_ALG_DES3_CBC_NOPAD

mode: 加密或解密模式

14.3.1.8 rk_set_padding

TEE_Result rk_set_padding(crypto_ctx_t *ctx, int padding);

功能设置对加解密数据的填充模式。参数ctx: 操作句柄padding: 支持的模式⻅ rk_padding_t

14.3.1.9 rk_cipher_begin

TEE_Result rk_cipher_begin(crypto_ctx_t *ctx, uint8_t *key, uint32_t key_len,
                           uint8_t *iv, uint32_t algo, TEE_OperationMode mode);

功能对称加解密分段算法的初始化操作。参数ctx: 操作句柄key: 密钥key_len: 密钥⻓度,不同的algo,支持的密钥⻓度略有不同iv: 初始向量algo: 算法类型,支持以下算法(OP-TEE V1版本不支持SM算法)

TEE_ALG_AES_ECB_NOPAD
TEE_ALG_AES_CBC_NOPAD
TEE_ALG_AES_CTR
TEE_ALG_AES_CTS
TEE_ALG_AES_XTS
TEE_ALG_SM4_ECB_NOPAD
TEE_ALG_SM4_CBC_NOPAD
TEE_ALG_SM4_CTR
TEE_ALG_DES_ECB_NOPAD
TEE_ALG_DES_CBC_NOPAD
TEE_ALG_DES3_ECB_NOPAD
TEE_ALG_DES3_CBC_NOPAD

mode: 加密或解密模式

14.3.1.10 rk_cipher_update

TEE_Result rk_cipher_update(crypto_ctx_t *ctx, uint8_t *in, uint8_t *out,
                            uint32_t in_len, uint32_t *out_len);

功能对称加解密分段算法,对输入的数据进行加解密。参数ctx: 操作句柄in: 待加解密的输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度

14.3.1.11 rk_cipher_finish

TEE_Result rk_cipher_finish(crypto_ctx_t *ctx, uint8_t *out, uint32_t *out_len);

功能对称加解密分段算法,完成加解密操作。参数ctx: 操作句柄out: 输出数据out_len: 输出数据⻓度

14.3.1.12 rk_ae_begin

TEE_Result rk_ae_begin(crypto_ctx_t *ctx, uint8_t *key, uint32_t key_len,
                       uint8_t *iv, uint32_t iv_len,
                       uint32_t add_len, uint32_t tag_len,
                       uint32_t payload_len, uint32_t algo, TEE_OperationMode mode);

功能AES-CCM或AES-GCM算法的初始化操作。参数ctx: 操作句柄key: 密钥key_len: 密钥⻓度,支持16,24,32iv: 初始向量iv_len: 向量⻓度add_len: AES-CCM时的ADD⻓度tag_len: tag⻓度(bit),AES-GCM支持128, 120, 112, 104, 96; AES-CCM支持128, 112, 96, 80, 64, 48, 32payload_len: AES-CCM时的payload⻓度algo: 算法类型,支持 TEE_ALG_AES_GCM, TEE_ALG_AES_CCMmode: 加密或解密模式

14.3.1.13 rk_ae_update

TEE_Result rk_ae_update(crypto_ctx_t *ctx, uint8_t *in, uint8_t *out,
                        uint32_t in_len, uint32_t *out_len,
                        rk_ae_update_type_t is_aad);

功能AES-CCM或AES-GCM算法,对输入的数据进行加解密。参数ctx: 操作句柄in: 待加解密的输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度is_add: 是否有AAD(Additional Authentication Data)

14.3.1.14 rk_ae_finish

TEE_Result rk_ae_finish(crypto_ctx_t *ctx, uint8_t *in, uint8_t *out,
                        uint8_t *tag, uint32_t in_len,
                        uint32_t *out_len, uint32_t *tag_len);

功能AES-CCM或AES-GCM算法,完成加解密操作。参数ctx: 操作句柄in: 待处理的最后一段输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度tag: 输出数据缓冲区填充的tagtag_len: tag⻓度

14.3.1.15 rk_gen_rsa_key

TEE_Result rk_gen_rsa_key(rsa_key_t *rsa_key, uint32_t key_len,
                          uint64_t public_exponent);

功能随机生成RSA公私钥对。参数rsa_key: 生成的RSA公私钥对key_len: RSA密钥⻓度(字节),支持32,64,96,128,192,256,384,512public_exponent: 指数,支持3,65537

14.3.1.16 rk_rsa_crypto

TEE_Result rk_rsa_crypto(uint8_t *in, uint8_t *out, uint32_t len,
                         rsa_key_t *key, uint32_t algo, TEE_OperationMode mode);

功能RSA加密、解密算法。也可使用接口实现。rk_rsa_begin/finish参数in: 输入数据

len: 输入数据⻓度out: 输出数据key: RSA密钥algo: RSA算法填充模式,支持以下

TEE_ALG_RSAES_PKCS1_V1_5
TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA1
TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA224
TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA256
TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA384
TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA512
TEE_ALG_RSA_NOPAD

mode: 加解密模式, TEE_MODE_ENCRYPT 或 TEE_MODE_DECRYPT

14.3.1.17 rk_rsa_sign

TEE_Result rk_rsa_sign(uint8_t *digest, uint8_t *signature, uint32_t digest_len,
                       uint32_t *signature_len, rsa_key_t *key,
                       uint32_t salt_len, uint32_t algo, TEE_OperationMode mode);

功能RSA签名、验签。也可使用接口实现。rk_rsa_begin/finish参数digest: 摘要值signature: 签名输出的值,或者输入待验签的值digest_len: 摘要⻓度signature_len: 签名值⻓度key: rsa密钥salt_len: salt的字节数,此参数是可选的。如果不存在,salt⻓度等于摘要⻓度algo: 算法,详⻅GPD_TEE_Internal_Core_API_Specification,Table 6-4mode: 模式, TEE_MODE_SIGN 或 TEE_MODE_VERIFY

14.3.1.18 rk_set_sign_mode

TEE_Result rk_set_sign_mode(crypto_ctx_t *ctx, unsigned int mode);

功能设置RSA签名模式,对数据签名或对摘要签名。参数

ctx: 操作句柄mode: 数据 SIGN_DATA 或摘要 SIGN_DIGEST

14.3.1.19 rk_rsa_begin

TEE_Result rk_rsa_begin(crypto_ctx_t *ctx, rsa_key_t *key,
                        uint32_t algo, TEE_OperationMode mode);

功能RSA加密、解密、签名、验签算法的初始化操作。参数ctx: 操作句柄key: RSA密钥algo: 算法填充模式,不同的mode允许的algo不同,详⻅GPD_TEE_Internal_Core_API_Specification,Table6-4mode: 算法类型,支持 TEE_MODE_ENCRYPT, TEE_MODE_DECRYPT, TEE_MODE_SIGN, TEE_MODE_VERIFY

14.3.1.20 rk_rsa_finish

TEE_Result rk_rsa_finish(crypto_ctx_t *ctx, uint8_t *in, uint8_t *out,
                         uint32_t in_len, uint32_t *out_len, uint32_t salt_len);

功能在之后执行的RSA加密、解密、签名、验签算法。rk_rsa_begin参数ctx: 操作句柄in: 输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度salt_len: salt的字节数,此参数是可选的

14.3.1.21 rk_gen_ec_key

TEE_Result rk_gen_ec_key(ec_key_t *ec_key, uint32_t key_len, uint32_t curve);

功能随机生成ECC密钥对。

参数ec_key: 生成的ECC公私钥对key_len: 密钥⻓度(bit),支持192,224,256,384,521curve: ECC曲线,支持的曲线⻅ tee_api_defines.h

14.3.1.22 rk_ecdh_genkey

TEE_Result rk_ecdh_genkey(uint8_t *private, uint8_t *publicx, uint32_t *publicy,
                          uint32_t algo,  uint32_t curve,
                          uint32_t keysize, uint8_t *out);

功能进行ECDH,协商对称密钥。参数private: ECC私钥publicx: ECC公钥X坐标publicy: ECC公钥Y坐标

algo：支持 TEE_ALG_ECDH_P192, TEE_ALG_ECDH_P224, TEE_ALG_ECDH_P256, TEE_ALG_ECDH_P384,

TEE_ALG_ECDH_P521

curve：ECC曲线，支持 TEE_ECC_CURVE_NIST_P192, TEE_ECC_CURVE_NIST_P224,

TEE_ECC_CURVE_NIST_P256, TEE_ECC_CURVE_NIST_P384, TEE_ECC_CURVE_NIST_P521keysize: 密钥⻓度(bit),支持192,224,256,384,521out: 输出的对称密钥

14.3.1.23 rk_ecdsa_sign

TEE_Result rk_ecdsa_sign(uint8_t *digest, uint8_t *signature,
                         uint32_t digest_len, uint32_t *signature_len,
                         ec_key_t *key, uint32_t algo, TEE_OperationMode mode);

功能ECDSA签名、验签算法。也可使用接口实现。rk_ecdsa_begin/finish参数digest: 输入的摘要signature: 输出的签名值,或者输入的待验签的值digest_len: 摘要⻓度signature_len: 签名值⻓度key: ECC密钥

algo: 支持 TEE_ALG_ECDSA_P224, TEE_ALG_ECDSA_P256, TEE_ALG_ECDSA_P384, TEE_ALG_ECDSA_P521mode: 支持 TEE_MODE_SIGN, TEE_MODE_VERIFY

14.3.1.24 rk_ecdsa_begin

TEE_Result rk_ecdsa_begin(crypto_ctx_t *ctx, ec_key_t *key,
                          uint32_t algo,TEE_OperationMode mode);

功能ECDSA签名、验签算法的初始化操作。参数ctx: 操作句柄key: ECC密钥algo: 支持 TEE_ALG_ECDSA_P224, TEE_ALG_ECDSA_P256, TEE_ALG_ECDSA_P384, TEE_ALG_ECDSA_P521mode: 支持 TEE_MODE_SIGN, TEE_MODE_VERIFY

14.3.1.25 rk_ecdsa_finish

TEE_Result rk_ecdsa_finish(crypto_ctx_t *ctx, uint8_t *in, uint8_t *out,
                           uint32_t in_len, uint32_t *out_len);

功能ECDSA签名、验签算法,对输入的摘要进行签名,或者对输入的摘要、签名值进行验签。参数ctx: 操作句柄in: 输入的摘要out: 输出的签名值,或者输入的待验签的值in_len: 摘要⻓度out_len: 签名值⻓度

14.3.1.26 rk_sm2_pke

TEE_Result rk_sm2_pke(uint8_t *in, uint32_t in_len, uint8_t *out,
                      uint32_t *out_len, ec_key_t *key,
                      uint32_t algo, TEE_OperationMode mode);

功能SM2加密、解密。OP-TEE V1版本不支持该接口。

参数in: 输入待加密解密的数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度key: SM2密钥algo: 算法,支持 TEE_ALG_SM2_PKEmode: 模式,支持 TEE_MODE_ENCRYPT 和 TEE_MODE_DECRYPT

14.3.1.27 rk_sm2_dsa_sm3

TEE_Result rk_sm2_dsa_sm3(uint8_t *digest, uint32_t digest_len,
                          uint8_t *signature, uint32_t *signature_len,
                          ec_key_t *key, uint32_t algo, TEE_OperationMode mode);

功能SM2签名或验签。OP-TEE V1版本不支持该接口。参数digest: SM3摘要digest_len: SM3摘要⻓度,固定为32signature: 输出的签名数据,或者输入的待验证的签名数据signature_len: 签名数据的⻓度key: SM2密钥algo: 算法,支持 TEE_ALG_SM2_DSA_SM3mode: 签名 TEE_MODE_SIGN 或验签 TEE_MODE_VERIFY

14.3.1.28 rk_sm2_kep_genkey

TEE_Result rk_sm2_kep_genkey(rk_sm2_kep_parms *kep_parms, uint8_t *share_key,
                             uint32_t share_key_len, uint8_t *conf_out);

功能基于SM2的ECDH算法。OP-TEE V1版本不支持该接口。参数kep_parms: SM2密钥信息,包含A的私钥和B的公钥share_key: 输出ECDH协商的对称密钥share_key_len: share_key⻓度conf_out: 用于校验的会话信息

14.3.1.29 rk_mac_crypto

TEE_Result rk_mac_crypto(uint8_t *in, uint8_t *out, uint32_t in_len,
                         uint32_t *out_len, uint8_t *key, uint32_t key_len,
                         uint8_t *iv, uint32_t algo);

功能MAC计算。如需分段,可使用接口。rk_mac_begin/update/finish参数in: 输入数据in_len: 输入数据⻓度out: 输出数据out_len: 输出数据⻓度key: MAC密钥key_len: 密钥⻓度iv: 初始向量

algo：MAC算法类型（OP-TEE V1版本不支持SM算法），TEE_ALG_HMAC_MD5, TEE_ALG_HMAC_SHA1,

TEE_ALG_HMAC_SHA256, TEE_ALG_AES_CMAC, TEE_ALG_HMAC_SM3

14.3.1.30 rk_mac_begin

TEE_Result rk_mac_begin(crypto_ctx_t *ctx, uint8_t *key, uint32_t key_len,
                        uint8_t *iv, uint32_t algo);

功能MAC分段算法,初始化操作。参数ctx: 操作句柄key: MAC密钥key_len: 密钥⻓度iv: 初始向量

algo：MAC算法类型（OP-TEE V1版本不支持SM算法），TEE_ALG_HMAC_MD5, TEE_ALG_HMAC_SHA1,

TEE_ALG_HMAC_SHA256, TEE_ALG_AES_CMAC, TEE_ALG_HMAC_SM3

14.3.1.31 rk_mac_update

TEE_Result rk_mac_update(crypto_ctx_t *ctx, uint8_t *in, uint32_t in_len);

功能

MAC分段算法,积累输入数据,用于计算MAC。参数ctx: 操作句柄in: 输入数据in_len: 输入数据⻓度

14.3.1.32 rk_mac_finish

TEE_Result rk_mac_finish(crypto_ctx_t *ctx, uint8_t *in, uint8_t *mac,
                         uint32_t in_len, uint32_t *mac_len, rk_mac_mode_t mode);

功能MAC分段算法,输入最后一段数据计算MAC,或者输入最后一段数据和预期的MAC值,输出校验结果。参数ctx: 操作句柄in: 最后一段输入数据in_len: 输入数据⻓度mac: 当 mode=RK_MAC_SIGN 时输出MAC值,当 mode=RK_MAC_VERIFY 时,输入预期的MAC值mac_len: MAC值的⻓度mode: ⻅“mac”

14.3.1.33 rk_hkdf_genkey

TEE_Result rk_hkdf_genkey(uint8_t *ikm, uint32_t ikm_len,
                          uint8_t *salt, uint32_t salt_len,
                          uint32_t *info, uint32_t info_len,
                          uint32_t algo, uint32_t okm_len, uint8_t *okm);

功能HKDF密钥派生函数。参数ikm: 输入的密码ikm_len: 密码⻓度salt: 输入的saltsalt_len: salt⻓度info: 输入的infoinfo_len: info⻓度

algo：支持 TEE_ALG_HKDF_MD5_DERIVE_KEY, TEE_ALG_HKDF_SHA1_DERIVE_KEY,

TEE_ALG_HKDF_SHA224_DERIVE_KEY, TEE_ALG_HKDF_SHA256_DERIVE_KEY,TEE_ALG_HKDF_SHA384_DERIVE_KEY, TEE_ALG_HKDF_SHA512_DERIVE_KEYokm_len: 输入的派生的密钥⻓度okm: 派生的密钥

14.3.1.34 rk_pkcs5_pbkdf2_hmac

TEE_Result rk_pkcs5_pbkdf2_hmac(uint8_t *password, uint32_t password_len,
                                uint8_t *salt, uint32_t salt_len,
                                uint32_t iterations, uint32_t algo,
                                uint32_t key_len, uint8_t *out_key);

功能通过指定的salt和iteration count以及password,派生密钥。参数password: 输入的密码password_len: 密码⻓度salt: 输入的saltsalt_len: salt⻓度iterations: 输入的iteration count值algo: 支持 TEE_ALG_PBKDF2_HMAC_SHA1_DERIVE_KEYkey_len: 输入的派生的密钥⻓度out_key: 派生的密钥

14.3.2 HW Crypto API

14.3.2.1 rk_user_ta_cipher

TEE_Result rk_user_ta_cipher(rk_cipher_config *config, uint8_t *src, uint32_t len)

功能User TA使用硬件Crypto进行加解密计算。参数config: 算法参数,用于配置算法类型、算法模式、密钥等src: 输入输出数据len:数据⻓度源码参考代码位于rk_tee_user工程。

14.3.2.2 rk_keylad_hmac

TEE_Result rk_keylad_hmac(uint32_t algo, enum RK_OEM_OTP_KEYID otp_keyid,
                          uint32_t key_len, uint8_t *msg, uint32_t msg_len,
                          uint8_t *mac, uint32_t *mac_len)

功能User TA使用OTP中指定密钥并调用硬件Crypto进行HMAC计算。需要先参考OTP API烧写密钥后再调用本接口。仅部分平台支持,如果不支持该接口,将返回TEE_ERROR_NOT_SUPPORTED。参数algo: 算法模式otp_keyid: 指定OTP中密钥索引key_len: 密钥⻓度msg: 输入数据msg_len: 输入数据⻓度mac: 输出数据mac_len: 输出数据⻓度源码参考代码位于rk_tee_user工程。

14.3.2.3 rk_keylad_cipher

TEE_Result rk_keylad_cipher(enum RK_OEM_OTP_KEYID otp_keyid,
                            rk_cipher_config *config,
                            uint8_t *src, uint32_t len);

功能User TA使用OTP中指定密钥并调用硬件Crypto进行加解密计算。需要先参考OTP API烧写密钥后再调用本接口。仅部分平台支持,如果不支持该接口,将返回TEE_ERROR_NOT_SUPPORTED。参数otp_keyid: 指定OTP中密钥索引config: 算法参数,用于配置算法类型、算法模式、密钥⻓度等src: 输入输出数据len:数据⻓度源码

参考代码位于rk_tee_user工程。

14.3.3 TRNG API

14.3.3.1 rk_get_trng

TEE_Result rk_get_trng(uint8_t *buffer, uint32_t size);

功能User TA获取硬件随机数。仅部分平台支持,如果不支持该接口,将返回TEE_ERROR_NOT_SUPPORTED。参数buffer: 返回的硬件随机数,buffer内存空间必须不小于sizesize: 待获取的随机数⻓度源码参考代码位于rk_tee_user工程。

14.3.4 Derive Key API

14.3.4.1 rk_derive_ta_unique_key

TEE_Result rk_derive_ta_unique_key(uint8_t *extra, uint16_t extra_size, uint8_t *key,
uint16_t key_size)

功能User TA获取由硬件唯一密钥派生的密钥。每颗芯片生产时都会注入硬件唯一密钥,由此密钥派生的密钥具有唯一性。OP-TEE V1版本不支持该接口。OP-TEE V1可以使用 TEE_DerivekeyFromHard 接口替代。参数extra: 输入数据,用于派生出不同的密钥extra_size: 输入数据⻓度key:派生出来的密钥key_size:密钥⻓度源码参考代码位于rk_tee_user工程。

14.3.5 OTP API

14.3.5.1 rk_otp_size

TEE_Result rk_otp_size(uint32_t *otp_size);

功能User TA获取安全OTP中Protected OEM Zone的总大小。参数otp_size: 返回的OTP的总大小源码参考代码位于rk_tee_user工程。详情请参考《Rockchip_Developer_Guide_OTP_CN.pdf》中”Protected OEM Zone”章节。

14.3.5.2 rk_otp_read

TEE_Result rk_otp_read(uint32_t offset, uint8_t *data, uint32_t len);

功能User TA读取安全OTP中Protected OEM Zone数据。参数offset: 待读取的OTP区域的位置偏移data: 返回的OTP数据,data内存空间必须不小于lenlen: 待读取的⻓度源码参考代码位于rk_tee_user工程。详情请参考《Rockchip_Developer_Guide_OTP_CN.pdf》中”Protected OEM Zone”章节。

14.3.5.3 rk_otp_write

TEE_Result rk_otp_write(uint32_t offset, uint8_t *data, uint32_t len);

功能User TA写数据到安全OTP中Protected OEM Zone。参数offset: 待写入到OTP区域的位置偏移

data: 待写入到OTP的数据len: data⻓度源码参考代码位于rk_tee_user工程。详情请参考《Rockchip_Developer_Guide_OTP_CN.pdf》中”Protected OEM Zone”章节。

14.3.5.4 rk_write_oem_otp_key

TEE_Result rk_write_oem_otp_key(enum RK_OEM_OTP_KEYID key_id,
                                uint8_t *key, uint32_t key_len)

功能User TA烧写密钥到OTP。参数key_id: 密钥索引key: 待写入到OTP的密钥key_len: 密钥⻓度源码参考代码位于rk_tee_user工程。详情请参考《Rockchip_Developer_Guide_OTP_CN.pdf》中”OEM Cipher Key”章节。

14.3.5.5 rk_is_oem_otp_key_written

TEE_Result rk_is_oem_otp_key_written(enum RK_OEM_OTP_KEYID key_id, bool *is_written)

功能User TA判断密钥是否已烧写。密钥已锁定情况下,该接口将返回TEE_ERROR_ACCESS_DENIED错误码。参数key_id: 密钥索引is_written: 0未烧写,1已烧写源码参考代码位于rk_tee_user工程。详情请参考《Rockchip_Developer_Guide_OTP_CN.pdf》中”OEM Cipher Key”章节。

14.3.5.6 rk_oem_otp_key_set_read_lock

TEE_Result rk_oem_otp_key_set_read_lock(enum RK_OEM_OTP_KEYID key_id)

功能User TA锁定密钥,密钥一旦锁定后cpu将不可访问,即软件无权读写该密钥,只能硬件Crypto读取使用。仅部分平台支持密钥锁定功能。参数key_id: 密钥索引源码参考代码位于rk_tee_user工程。详情请参考《Rockchip_Developer_Guide_OTP_CN.pdf》中”OEM Cipher Key”章节。

15. PTA说明

15.1 概述

PTA是内嵌在TEE OS内部的应用,所以也称为内部TA,PTA对外提供接口供开发者使用,有两个目的:实现TEE Internal API没有的功能供开发者参考调用方法或直接使用

15.2 PTA功能

15.2.1 安全存储功能

该功能用于存储用戶重要数据,数据经过TEE OS加密存储于security分区、rpmb分区、Android/Linux文件系统。默认情况下是User TA调用TEE Internal API进行安全存储,但U-Boot端也需要存储启动相关的关键数据,所以在PTA对其开放安全存储接口,接口内可通过参数选择存储区域。

15.2.2 OTP读写功能

OTP是一次性存储设备,数据写入后不可更改。TEE Internal API没有OTP相关接口,所以在PTA实现OTP读写功能并对外提供接口。PTA OTP接口可用于烧写以下数据:

15.2.3 硬件Crypto加解密功能

TEE Internal API默认提供软件加解密功能,硬件Crypto加解密功能通过PTA实现并对外提供接口。PTA Crypto接口支持DES、TDES、AES、SM4对称加解密算法,支持使用OTP中指定密钥。PTA Crypto接口支持HMAC算法,支持使用OTP中指定密钥。

15.2.4 硬件随机数功能

TEE Internal API没有真随机数相关接口,所以在PTA实现获取真随机数功能并对外提供接口。PTA TRNG接口支持获取任意⻓度的真随机数,随机数由硬件生成符合真随机数要求。

15.2.5 硬件唯一密钥派生功能

TEE Internal API没有硬件唯一密钥派生相关接口,所以在PTA实现该功能并对外提供接口。每颗芯片生产时都会注入HUK(硬件唯一密钥),HUK是由真随机数设备生成的随机数,确保每一颗芯片的HUK都不同,由此密钥派生的密钥具有唯一性。

15.3 调用PTA方法

U-Boot接口源码：u-boot/lib/optee_clientApi；接口说明见Rockchip_Developer_Guide_UBoot_Nextdev_CN的Optee Client章节。UserSpace接口源码：librkcrypto；说明见Rockchip_Developer_Guide_Crypto_HWRNG_CN.pdf。User TA接口源码：rk_tee_user；说明见本文TA API章节。

16. 相关资料扩展

ARM官方TrustZonehttps://developer.arm.com/ip-products/security-ip/trustzoneGlobalPlatform官网:https://globalplatform.org/该网站可下载CA开发API参考文档:TEE Client API SpecificationTA开发API参考文档:TEE Internal Core API Specification以及其他架构方面参考文档。