Table of Contents
- OP-TEE
Open Portable TEE
- TA
Trusted Application
- TEE
Trusted Execution Environment
- TZASC
TrustZone Address Space Controller
- TZPC
TrustZone Protection Controller
- The
platforms_supported
page lists all platforms and architectures currently supported in the official tree.
- Both 32- and 64-bit are fully supported for all OP-TEE components.
Q: Does OP-TEE support mixed-mode, i.e., both AArch32 and AArch64 Trusted Applications on top of an AArch64 core?
- Yes!
- Yes, it can be changed. In the current setup (for vexpress for example), there are
32MB DDR
dedicated for OP-TEE.1MB
forTEE RAM
and1MB
forPUB RAM
, this leaves30MB
for Trusted Applications. In the Trusted Applications, you setTA_STACK_SIZE
andTA_DATA_SIZE
. Typically, we set stack to2KB
and data to32K
. But you are free to adjust those according to the amount of memory you have available. If you need them to be bigger than1MB
then you also must adjust TA’s MMU L1 table accordingly, since default section mapping is 1MB.
- As of 2016.01, optee_os is about
244KB
(release build). It is preferred to runoptee_os
entierly in SRAM, but if there is not enough room, DRAM can be used and protected with TZASC. We are also looking into the possibility of creating a ‘minimal’ OP-TEE, i.e. a limited OP-TEE usable even in a very memory constrained environment, by eliminating as many memory-hungry parts as possible. There is however no ETA for this at the moment.You can check the memory usage by using the
make mem_usage
target inoptee_os
, for example:$ make ... mem_usage # Which will output a file with the figures here: # out/arm/core/tee.mem_usageYou will of course get different sizes depending on what compile time flags you have enabled when running make mem_usage.
- Yes (for additional information, please also see Issue#953)
- C++ libraries are currently not supported. Technically, it is possible but will require a fair amount of work to implement, especially more so if exceptions are required. There are currently no plans to do this.
- See Issue#2628 for related information.
malloc()
in OP-TEE currently gives physically contiguous memory. It is not guaranteed as it is not mentioned anywhere in the documentation, but in practice the heap only has physically contiguous memory in the pool(s). The heap in OP-TEE is normally quite small, ~24KiB, and could be a bit fragmented.
- Currently it’s up to the kernel to decide which core it runs on, i.e, it will be the same core as the one initiating the SMC in Linux. Please also see Issue#1194.
- OP-TEE does not have its own scheduler, instead it is being scheduled by Linux kernel. For more information, please see Issue#1036 and Issue#1183.
- Start by reading the
porting_guidelines
.- See the
presentations
page. There might be some interesting information in the "LCU14-302 How To Port OP-TEE To Another Platform" deck and video. Beware that the presentation is more than five years old, so even though it is a good source, there might be parts that are not relevant any longer.As a good example for
- Armv8-A patch enabling OP-TEE support on a new device, please see the ZynqMP port that enabled support for running OP-TEE on Xilinx UltraScale+ Zynq MPSoC. Besides that there are similar patches for Juno port, Raspberry Pi3 port, HiKey port.
- ARMv7-A, please have a look at the Freescale ls1021a port, another example would be the TI DRA7xx port.
- What did you try to build? Only
optee_os
? A full OP-TEE developer setup using QEMU, HiKey, RPi3, Juno using repo? AOSP? OpenEmbedded? What we build on daily basis are the OP-TEE developer setups (seeoptee_developer_setup
) , but other builds like AOSP and OpenEmbedded are builds that we try from time to time, but we have no CI/regression testing configured for those builds.- By running latest instead of stable also comes with a risk of getting build errors due to version and/or interdependency skew which can result in build error. Now, such issues most often affects running xtest and not the building. If you however clean all gits and do a
repo sync -d
. Then we're almost 100% sure you will get back to a working state again, since as mentioned in next bullet, we build (and run xtest) on all QEMU on all patches sent to OP-TEE.- Every pull request in OP-TEE are tested on hardware (see
how_are_you_testing_optee
).
- Stable releases are quite well tested both in terms of building for all supported platforms and running xtest on all platforms, so if you cannot get that to build and run, then there is a great chance you have something wrong on your side. All platforms that has been tested on a stable release can be found in CHANGELOG.md file. Having that said, we do make mistakes on stable builds also from time to time.
- Most likely you're trying to build OP-TEE using the regular x86 compiler and not the using the Arm toolchain. Please install the
prerequisites
and make sure you have gotten and installed the Arm toolchains as described at thetoolchains
page. (for additional information, please see Issue#846).
build
is a git that is used in conjunction with themanifest
to create full OP-TEE developer builds. It contains helper makefiles that makes it easy to get OP-TEE up and running on the setups that are using repo.
- We try to stay somewhat up to date with running recent
GCC
versions. But just like everywhere else on the net things moves around. In some cases like Issue#1195, the URL was changed without us noticing it. If you find and fix such an issue, please send the fix as pull request and we will be happy to merge it.
That would be running it on QEMU on a local PC. To do that you would need to:
- Install the OP-TEE
prerequisites
.- Build for QEMU according to the instructions at
qemu_v7
.- And
optee_test_run_xtest
.
- By summarizing the above, you would need to:
$ sudo apt-get install [pre-reqs] $ mkdir optee-qemu && cd optee-qemu $ repo init -u https://github.com/OP-TEE/manifest.git $ repo sync $ cd build $ make toolchains -j2 $ make run QEMU console: (qemu) c Normal world shell: # xtest
- No, not as of now. Most often certification is performed using a certain software version and on a unique device. I.e., it is the combination software + hardware that gets certified. This is typically something that the SoC or OEM needs to do on their own.
- But it is worth mentioning that since OP-TEE is coming from a proprietary TEE solution that was GlobalPlatform certified on some products in the past and we regularly have people from some member companies running the extended test suite from GlobalPlatform we know that the gap to become GlobalPlatform certified/qualified isn’t that big.
- Applus Laboratories have done some side-channel attack testing and fault injection testing on OP-TEE using the
hikey
device. Their findings and fixes can be found at the Security Advisories page at optee.org.- Riscure did a mini-audit of OP-TEE which generated a couple of patches (see PR#2745). The Security Advisories page at optee.org will be updated with more information regarding that in the future.
- Full audit? No! But in the past Linaro have been collaborating with Riscure trying to identify and fix potential security issues. There has also been some companies that have done audits internally and they have then shared the result with us and where relevant, we have created patches resolving the issues reported to us (see
q_has_any_test_lab_been_testing_op-tee
).- Code review, yes! Every single patch going into OP-TEE has been reviewed in a pull request on GitHub. We more or less have a requirement that every patch going into OP-TEE shall at least have one "Reviewed-by" tag in the patch.
- Third party / test lab code review, no! Again some companies have reviewed internally and shared the result with us, but other than that no (see related
q_has_any_test_lab_been_testing_op-tee
)
- Please see the
contribute
page.
- Please see the
contact
page.
- We always need help with code reviews, feel free to review any of the open OP-TEE OS Pull Requests. Please also note that there could be open pull request in the other
optee_gits
that needs reviews too.- We always need help answering all the questions asked at OP-TEE OS Issues.
- If you want to try to solve a bug, please have a look at the OP-TEE OS Bugs or the OP-TEE OS Enhancements.
- Documentation tends to become obsolete if not maintained on regular basis. We try to do our best, but we're not perfect. Please have a look at
optee_docs
and try to update where you find gaps.- Enable repo for the device in
manifest
andbuild
(and alsoplatforms_supported
) currently not using repo.- If you would like to implement a bigger feature, please reach out to us (see
contact
) and we can discuss what is most relevant to look into for the moment. If you already have an idea, feel free to send the proposal to us.
- GlobalPlatform (see
globalplatform_api
for more details).
- GlobalPlatform's TEE Client API v1.1 specification
- GlobalPlatform's TEE Internal Core API v1.1 specification.
- GlobalPlatform's Secure Elements v1.0 (now deprecated, see
git log
).- GlobalPlatform's Socket API v1.0 (TCP and UDP, but not TLS).
- AOSP Keymaster (v3) and AOSP Gatekeeper (see
aosp
for more details).- Android Verified Boot 2.0 (AVB 2.0)
- Yes, OP-TEE has a Crypto Abstraction Layer (see
cryptographic_implementation
that was designed mainly to make it easy to add support for hardware crypto acceleration. There you will find information about the abstraction layer itself and what you need to do to be able to support new software/hardware “drivers” in OP-TEE.
- The software is mostly provided under the BSD 2-Clause license.
- The TEE kernel driver is released under GPLv2 for obvious reasons.
- xtest (
optee_test
) uses BSD 2-Clause for code running in secure world (Trusted Applications etc) and GPLv2 for code running in normal world (client code).
- Since OP-TEE is a GlobalPlatform based TEE which implements the APIs as specified by GlobalPlatform one has to accept, the click-through license which is presented when trying to download the
globalplatform_api
specifications before start using OP-TEE.
- That is something we deal with case by case. But as a general answer, if it does not contaminate the BSD 2-Clause license we will accept it. Reach out to us (see
contact
) and we will take it from there.
- If your company has done significant contributions to OP-TEE, then please
contact
us and we will do our best to include your company. Pay attention to that we will review this on regular basis and inactive supporting companies might be removed in the future again.
- Please see the
Contact
page.
- It is located on GitHub under the project OP-TEE and linaro-swg.
- All the source code for that can be found in the git called
optee_test
.- The
globalplatform_tests
can be purchased separately.
- You can find both the generic TEE framework including the OP-TEE driver included in the official Linux kernel project since v4.12. Having that said, we "buffer up" pending patches on a our
linux_kernel
branch. I.e., that is where we keep new features being developed for OP-TEE. In the long run we aim to completely stop using our own branch and just send all patches to the official Linux kernel tree directly. But as of now we cannot do that.
- There is a test suite called xtest that tests the complete TEE-solution to ensure that the communication between all architectural layers is working as it should. The test suite also tests the majority of the GlobalPlatform TEE Internal Core API. It has close to 50,000 and ever increasing test cases, and is also extendable to include the official GlobalPlatform test suite (see
globalplatform_tests
).- Every pull request in OP-TEE are built for a multitude of different platforms automatically using Travis, Shippable and IBART. Please have a look there to see whether it failed building on the platform you're using before submitting any issue about build errors.
- For more information see
optee_test
.
- Have a look at the
build_trusted_applications
page as well as theoptee_examples
page. Those provides guidelines and examples on how to implement basic Trusted Applications.- If you want to see more advanced uses cases of Trusted Applications, then we encourage that you have a look at the Trusted Applications
optee_test
.
- See the example in
build_trusted_applications_submk
.- Also see Issue#280, Issue#601, Issue#901, Issue#1003.
/lib/optee_armtz
, that is the default location where tee-supplicant will look for Trusted Applications.
- A Pseudo TA is an OP-TEE firmware service offered through the generic API used to invoke Trusted Applications. Pseudo TA interface and services all runs in TEE kernel / core context. I.e., it will have access to the same functions, memory and hardware etc as the TEE core itself. If we're talking ARMv8-A it is running in
S-EL1
.
- No!
- Yes, for a longer discussion see Issue#967, Issue#1085, Issue#1132.
- You may develop your own “Pseudo TA”, which is part of the core (see
what_is_a_pseudo_ta_and_how_do_i_write_one
for more information about the Pseudo TA).
- Please see the section
core_pub_priv_keypair
in theporting_guidelines
.- Alternatively one can also build a Trusted Application and embed its raw binary content into the OP-TEE firmware binary. At runtime, if invoked, the Trusted Application will be loaded from the OP-TEE firmware image instead of being fetched from the normal world and authenticated in the secure world (see
early_ta
for more information).
- Yes, you can have two or more TAs running simultaneously. Please see also Issue#1194.
- No, there is no such concept as
pthreads
or similar. I.e, you cannot spawn thread from a TA. If you need to run tasks in parallel, then you should probably look into running two TAs or more simultaneously and then let them communicate with each other using theTA2TA
interface.
- Use the Java Native Interface (JNI).
First get familiar with sample_hellojni.html and make sure you can run the sample. After that, replace the C-side Implementation with for example
hello_world
or one of the other examples inoptee_examples
.Note
Note that
hello_world
and other binaries in optee_examples are built as executables, and have to be modified to be built as a .so shared library instead so that it can be loaded by the Java-side Implementation.- Note that
*.apk
apps by default have no access to the TEE driver. See Issue#903 for details. The workaround is to disable SELinux before launching any*.apk
app that calls into OP-TEE. The solution is to create/write SELinux domains/rules to allow any required access, but since this is not a TEE-related issue, it is left as an exercise for the users.
- TrustedFirmware have no such implementation, but Linaro do have reference implementations for that that they share with their members who have signed the WMLA and NDA/MLA with Google and Microsoft. So the advice is to reach out to Linaro if you have questions about that.