How to build TEE for Android

This article explains how to build TEE components, except the OP-TEE drivers. The latter are part of the Linux build process and are compiled as loadable modules, please refer to How to build kernel for Android. It is intended for Distribution Package users.

The OP-TEE Security feature is composed of several parts:

OP-TEE drivers: included in the Linux Kernel
OP-TEE OS: part of bootloader image.
OP-TEE Client: the OP-TEE userland client and is part of the STM32MPU distribution for Android™.
OP-TEE Tests: OP-TEE Tests suite with dedicated trusted applications part of the STM32MPU distribution for Android™.
- This module proposes a tests suite for OP-TEE
- Only available when NOT in user building profile

For detail, you can refer to OP-TEE overview page.

1. Prerequisites[edit source]

The environment must be installed using the distribution package adapted to the selected microprocessor device. See the list of supported Android Distribution Package.

To be able to execute the following instructions, work from the distribution root directory, initialize the environment and then run lunch:

 source build/envsetup.sh
 bspsetup
 lunch aosp_<BoardId>-userdebug

Information

The bspsetup instruction needs to be run only once for the distribution

2. Partition layout[edit source]

The OP-TEE OS is separated in three different partitions teeh, teed and teex to allow page management.

The OP-TEE TA (Trusted Applications) are integrated in the vendor partition.

The binaries are available in device/stm/<STM32Series>-tee/prebuilt.

Information

For more information on the complete partition layout depending on your development platform, refer to the corresponding Flash mapping article named Your_development_platform Flash mapping for Android. Example: STM32MP15 Flash mapping for Android for the STM32MP15 boards.

All Flash mapping for Android articles belong to the Category:Flash mapping for Android.

3. Load the TEE sources[edit source]

By default, the OP-TEE sources are not part of the STM32MPU distribution for Android™. To load the sources, execute the following instruction:

 load_tee

Information

The load_tee script uses the configuration file android_opteeos.config located in the device/stm/<STM32Series>-tee/source/patch/optee-<version>/directory.

The loaded sources can then be accessed at the device/stm/<STM32Series>-tee/optee_os-<STM32Series> directory.

Information

By default, only the archive is loaded from the remote repository (reducing size). If required you can clone the remote repository if all the git history is needed.

For this purpose, replace the android_opteeos.config file TEE_ARCHIVE_PATH by TEE_GIT_PATH. Then execute load_tee again (with -f option to replace previously loaded source).

4. Build the TEE[edit source]

After retrieving the OP-TEE sources, build them using:

 build_tee

This instruction generates an OP-TEE for every available board. To generate an OP-TEE for one board:

 build_tee -b <BoardId>

To get back more details on available options, run:

 build_tee -h

Here after, see the result for the version 1.3:

Usage: build_tee [Options] [Command]

  This script allows building the OP-TEE OS source

Options:
  -h / --help: print this message
  -i / --install: update prebuilt images
  -r <level> / --rpmb=<level>:
      0: disable RPMB (default)
      1: enable RPMB with TESTKEY for anti-rollback only (TAKE CARE: CFG_RPMB_WRITE_KEY is enabled, fusing the TESTKEY on your device)
      2: enable RPMB with TESTKEY for secure storage (TAKE CARE: CFG_RPMB_WRITE_KEY is enabled, fusing the TESTKEY on your device)
  -v / --version: get script version
  --verbose=<level>: enable build verbosity
      0: no verbosity (default)
      1: remove script filtering
      2: remove script filtering and quiet option for the build
  -d <level> / --debug=<level>: TEE debug level
      0: no debug (default)
      1: TEE core and TA log level 2
      2: TEE core and TA log level 3)
  -b <name> / --board=<name>: set board name from following list = eval (default: all)

Command: Optional, only one command at a time supported
  clean: execute make clean on targeted module

5. Integrate the TEE[edit source]

To integrate the new OP-TEE solution within your distribution, first the prebuilt images have to be updated:

 build_tee -i

Then build the full distribution

 make -j

Finally, update the associated partitions for the device. Refer to Flashing the built image

6. Build Trusted Applications[edit source]

Customize trusted applications can be built as needed. For this purpose, the configuration fileandroid_tabuild.config located in device/stm/<STM32Series>-tee/source has to be changed.

To build trusted applications, execute:

 build_ta

This script generates every applications for all available boards. To generate an application for one board only:

 build_ta -b <BoardId>

To get back more details on available options, run:

 build_ta -h

Here after, see the result for the version 1.1:

Usage: build_ta [Options] [Board options]

  This script allows building the trust applications (TA) source listed in android_tabuild.config file

Options:
  -h / --help: print this message
  -i / --install: update prebuilt images
  -v / --version: get script version
  --verbose=<level>: enable verbosity (1 or 2 depending on level of verbosity required)
  -b <name> / --board=<name>: set board name from following list = eval (default: all)

7. Integrate Trusted Applications[edit source]

To integrate the new trusted applications into a distribution, first update the prebuilt images:

 build_ta -i

Then update the file device.mk copying the trusted application in the /vendor/lib/optee_armtz directory.

PRODUCT_COPY_FILES += \
	device/stm/<STM32Series>-tee/prebuilt/<BoardId>/ta/<UUID>.ta:$(TARGET_COPY_OUT_VENDOR)/lib/optee_armtz/<UUID>.ta

Next build the full distribution

 make -j

Finally, update the associated partitions on the device. Refer to How to populate boards for Android