Ftpm #7054

jenswi-linaro · 2024-09-25T09:33:15Z

Imports OP-TEE fTPM TA into optee_os/ta/ftpm folder.
Based on https://github.com/microsoft/ms-tpm-20-ref and
https://github.com/zeschg/ms-tpm-20-ref.git branch feat_add_tee_crypto

Depends on OP-TEE/build#780 and OP-TEE/manifest#293

Moves the common parts of the two make macros process-subdir-srcs-y and process-subdir-gensrcs-helper into a new macro, process-file-vars. Signed-off-by: Jens Wiklander <[email protected]>

The commit cfa34d9 ("Add support for compiling in-tree TAs") added spec-srcs and spec-out-dir for special handling of user_ta_header.c when compiling in-tree TAs. However, these variables are just as relevant for out-of-tree TAs compiled via ta/mk/ta_dev_kit.mk. So as a simplification switch to use spec-srcs and spec-out-dir in that file too. Signed-off-by: Jens Wiklander <[email protected]>

Introduce the global-incdirs_ext-y variable to deal with including header files from outside of this git (optee_os.git). Signed-off-by: Jens Wiklander <[email protected]>

Introduce two new variables srcs_ext-y and srcs_ext_base-y to deal with compiling source code outside of this git (optee_os.git). srcs_ext_base-y assigns the root directory of the external source files to compile. srcs_ext-y works as srcs-y except that it's relative to the $(srcs_ext_base-y) directory. Introduce the per source file variable oname-<file name>-y to override the default output object file name. This helps to shorten and make a more sane name for the output object file name when the source file is outside optee_os source tree, for instance, a third-party library. Signed-off-by: Jens Wiklander <[email protected]>

Import initial source from https://github.com/microsoft/ms-tpm-20-ref copy initial source code from Samples/ARM32-FirmwareTPM/optee_ta/fTPM commit e9fc7b89d865 ("Fix conflicting types for `ReadVarBytes`. (OP-TEE#102)") Signed-off-by: Jens Wiklander <[email protected]>

Import TEE crypto API wrappers from https://github.com/zeschg/ms-tpm-20-ref/ from commit ea7f4b3c3f82 ("feat: exchange wolfcrypt backend with op-tee crypto api"). Samples/ARM32-FirmwareTPM/optee_ta/fTPM/reference/include/TpmProfile.h to ta/ftpm/reference/include/TpmProfile.h Source directory TPMCmd/tpm to destination directory ta/ftpm src/crypt/tee/TpmToTEEHash.c -> tee/TpmToTEEHash.c src/crypt/tee/TpmToTEEMath.c -> tee/TpmToTEEMath.c src/crypt/tee/TpmToTEESupport.c -> tee/TpmToTEESupport.c src/crypt/tee/TpmToTEESym.c -> tee/TpmToTEESym.c include/TEE/TpmToTEEMath.h -> include/TEE/TpmToTEEMath.h include/TEE/TpmToTEESym.h -> include/TEE/TpmToTEESym.h include/TEE/TpmToTEEHash.h -> include/TEE/TpmToTEEHash.h Signed-off-by: Jens Wiklander <[email protected]>

Build the in-tree fTPM TA if CFG_MS_TPM_20_REF is supplied as a non-empty path. Signed-off-by: Jens Wiklander <[email protected]>

Add TA_FLAG_DEVICE_ENUM_TEE_STORAGE_PRIVATE to TA_FLAGS to enumerate the TA once secure storage is available. Signed-off-by: Jens Wiklander <[email protected]>

Removes the redundant or invalid s_NV* declarations Signed-off-by: Jens Wiklander <[email protected]>

_plat__Fail() is declared with a __noreturn since it's guaranteed to not return, but it only calls TEE_Panic() which doesn't have the same attribute. TEE_Panic() does indeed never return so add a while(true) after the TEE_Panic() so silence the warning. Signed-off-by: Jens Wiklander <[email protected]>

Fix conflicting types for _plat__NvMemoryWrite() by adding the return type used in the declaration. _plat__NvMemoryWrite() is updated to always return TRUE since that's the expectation of success in NvWrite in TPMCmd/tpm/src/subsystem/NvReserved.c in the reference implementation (ms-tpm-20-ref). Signed-off-by: Jens Wiklander <[email protected]>

Remove the mismatching _plat__Signal_PowerOn() prototype from fTPM.h. The real prototype is in ta/ftpm/platform/include/Platform_fp.h. Signed-off-by: Jens Wiklander <[email protected]>

Remove the redefinition of TA_ALL_PARAM_TYPE() from fTPM.c, it's originally defined in ta/ftpm/include/fTPM.h. Signed-off-by: Jens Wiklander <[email protected]>

Move user_ta_header_defines.h to the common include directory for fTPM. Signed-off-by: Jens Wiklander <[email protected]>

lib/libutils/isoc/include/ctype.h already declares toupper() and tolower() so remove the redundant declarations from RuntimeSupport.h. Signed-off-by: Jens Wiklander <[email protected]>

Updates the fTPM sub.mk file to make it compile the source files. Many warnings are disabled Signed-off-by: Jens Wiklander <[email protected]>

Remove the unused file RuntimeSupport.c. Signed-off-by: Jens Wiklander <[email protected]>

Remove the now unused wolfssl crypto wrapper. Signed-off-by: Jens Wiklander <[email protected]>

Remove the now unused sub.mk files. Signed-off-by: Jens Wiklander <[email protected]>

jenswi-linaro

Comment for the commit "ftpm: import TEE crypto API wrappers"

jenswi-linaro · 2024-09-25T09:38:31Z

ta/ftpm/include/TEE/TpmToTEEHash.h

+#  define tpmHashStateCopy_SHA1     memcpy
+#  define tpmHashStateExport_SHA1   memcpy
+#  define tpmHashStateImport_SHA1   memcpy


This will not work as intended since only a TEE_OperationHandle is stored in the hash state. We'll be copying a pointer.
The GP TEE Internal Core API doesn't have a function to import or export the hash state. That's a problem since the TPM implementation seems to depend on this.

We will most likely need to use a different implementation for hashes.

Separate TA_FTPM_UUID and the command IDs into ftpm_ta.h. Update user_ta_header_defines.h to include ftpm_ta.h instead of the old fTPM.h to minimize the include file dependencies. Set Microsoft copyright year to 2018 based on git history in the reference source. Add missing SPDX-License-Identifier and Linaro copyright. Signed-off-by: Jens Wiklander <[email protected]>

Remove TpmProfile.h overriding the version in the reference source. Adding the diverging defines via cppflags-y. The old TpmProfile.h included a few .h files not included in the reference TpmProfile.h, so add the missing includes the affected source files. Add SPDX-License-Identifier and add Linaro copyright for all modified files. Set Microsoft copyright year based on git history in the reference source. Signed-off-by: Jens Wiklander <[email protected]>

Enable SHA-384 and SHA-512 support for user TAs. Signed-off-by: Jens Wiklander <[email protected]>

etienne-lms · 2024-09-26T07:30:34Z

Comments on the preliminary patches.

Reviewed-by: Etienne Carriere <[email protected]> for commit
"mk/subdir.mk: refactor process-subdir-{srcs-y,gensrcs-helper}",
"ta_dev_kit.mk: use spec-srcs and spec-out-dir",
"mk: introduce global-incdirs_ext-y".

Some questions around commit "mk/subdir.mk: introduce srcs_ext-y and srcs_ext_base-y".

Add and use hashlib wrappers for MbedTLS. Disabling ALG_SM3_256 since it's not supported by MbedTLS. Signed-off-by: Jens Wiklander <[email protected]>

Remove the now unused TEE internal core API based hashlib implementation. It was replaced since it doesn't support import and export of the hash state. Signed-off-by: Jens Wiklander <[email protected]>

mk/subdir.mk

jforissier

For "ta_dev_kit.mk: use spec-srcs and spec-out-dir":
Acked-by: Jerome Forissier <[email protected]>

jforissier

For "mk: introduce global-incdirs_ext-y":
Reviewed-by: Jerome Forissier <[email protected]>

jforissier

For "mk/subdir.mk: introduce srcs_ext-y and srcs_ext_base-y":

Acked-by: Jerome Forissier <[email protected]>

etienne-lms

I forgot to post my comments. Here they are...

etienne-lms · 2024-09-25T15:33:43Z

mk/subdir.mk

+
+define process-subdir-srcs_ext-y
+ifneq ($(filter /%,$(1)),)
+$$(error Absolute path not supported for srcs_ext-y: $(1)


closing parenthesis missing

Thanks, I'll fix.

etienne-lms · 2024-09-25T15:37:32Z

mk/subdir.mk

@@ -123,9 +144,13 @@ endif
 # Process files in current directory
 $$(foreach g, $$(gensrcs-y), $$(eval $$(call process-subdir-gensrcs-y,$$(g))))
 $$(foreach s, $$(srcs-y), $$(eval $$(call process-subdir-srcs-y,$$(s))))
+$$(foreach s, $$(srcs_ext-y), $$(eval $$(call \
+	process-subdir-srcs_ext-y,$$(s),$$(firstword $$(srcs_ext_base-y)))))


Why do you use firstword on external source base directory?

What is the best action if srcs_ext_base-y has more than one word? Error out or ignore it?

etienne-lms · 2024-09-26T07:23:53Z

mk/subdir.mk

+# $1 is local source file name
+# $2 is output file name
+# $3 is tree source file name
+oname-$(sm)-$3	:= $$(if $$(oname-$1-y),$(out-dir)/$(base-prefix)/$$(oname-$1-y),$2)


Where is oname-<file-name>-y defined?

It's supposed to be set in the sub.mk file if used.

jforissier

"mk/subdir.mk: refactor process-subdir-{srcs-y,gensrcs-helper}":

Reviewed-by: Jerome Forissier <[email protected]>

Addressing a comment. Signed-off-by: Jens Wiklander <[email protected]>

b49020

Just few overall code import comments.

b49020 · 2024-10-01T09:53:14Z

ta/ftpm/Makefile

+
+O ?= ../out/fTPM
+WOLF_ROOT := ../../../../external/wolfssl/
+TPM_ROOT := ../../../../


I suppose these are just leftovers, can be dropped?

Thanks, I'll fix.

b49020 · 2024-10-01T10:16:33Z

ta/ftpm/include/ftpm_ta.h

+
+/* The TAFs ID implemented in this TA */
+#define TA_FTPM_SUBMIT_COMMAND  (0)
+#define TA_FTPM_EMULATE_PPI     (1)


AFAICS, TA_FTPM_EMULATE_PPI isn't being used from Linux kernel driver point of view. Also, it seems that Physical Presence Interface (PPI) specification currently implemented for ACPI based systems. So we should rather drop corresponding source code import until we see a real use-case upstream for OP-TEE based DT systems.

The primary target is OP-TEE based DT systems and the only thing we can realistically test for. However, I'm not so keen on removing features from fTPM since this is supposed to be the new upstream for the OP-TEE TA replacing the old deprecated location.

Agree and the git history of unmodified fTPM source import should be easily retrievable. The features which can't be tested and an interface is provided to normal world looks like a security concern to me. To be able to deploy fTPM for production use-cases, we really need to keep required bits enabled. At the very least you can disable this unused fTPM invoke command.

Update the fTPM Makefile to support building externally. Remove WolfSSL leftovers. Signed-off-by: Jens Wiklander <[email protected]>

jenswi-linaro added 19 commits September 20, 2024 15:45

mk/subdir.mk: refactor process-subdir-{srcs-y,gensrcs-helper}

1aee473

Moves the common parts of the two make macros process-subdir-srcs-y and process-subdir-gensrcs-helper into a new macro, process-file-vars. Signed-off-by: Jens Wiklander <[email protected]>

mk: introduce global-incdirs_ext-y

e7270a4

Introduce the global-incdirs_ext-y variable to deal with including header files from outside of this git (optee_os.git). Signed-off-by: Jens Wiklander <[email protected]>

ftpm: build the in-tree TA

8212705

Build the in-tree fTPM TA if CFG_MS_TPM_20_REF is supplied as a non-empty path. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: add secure storage TA flag

5560957

Add TA_FLAG_DEVICE_ENUM_TEE_STORAGE_PRIVATE to TA_FLAGS to enumerate the TA once secure storage is available. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: PlatformData: remove redundant s_NV*

da7e74b

Removes the redundant or invalid s_NV* declarations Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove _plat__Signal_PowerOn() from fTPM.h

f6db985

Remove the mismatching _plat__Signal_PowerOn() prototype from fTPM.h. The real prototype is in ta/ftpm/platform/include/Platform_fp.h. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove TA_ALL_PARAM_TYPE() from fTPM.c

f09e591

Remove the redefinition of TA_ALL_PARAM_TYPE() from fTPM.c, it's originally defined in ta/ftpm/include/fTPM.h. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: move user_ta_header_defines.h to include

227a13f

Move user_ta_header_defines.h to the common include directory for fTPM. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove redundant to{upp,low}er() declarations

aea6277

lib/libutils/isoc/include/ctype.h already declares toupper() and tolower() so remove the redundant declarations from RuntimeSupport.h. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: update sub.mk to make it compile

f56c684

Updates the fTPM sub.mk file to make it compile the source files. Many warnings are disabled Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove unused RuntimeSupport.c

a671813

Remove the unused file RuntimeSupport.c. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove unused wolfssl crypto wrappers

75e2fa8

Remove the now unused wolfssl crypto wrapper. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove unused sub.mk files

2f70cee

Remove the now unused sub.mk files. Signed-off-by: Jens Wiklander <[email protected]>

jenswi-linaro marked this pull request as draft September 25, 2024 09:33

jenswi-linaro commented Sep 25, 2024

View reviewed changes

jenswi-linaro added 3 commits September 25, 2024 15:41

libmbedtls: mbedtls_config_uta.h: enable SHA-384 and SHA-512 support

151ac8c

Enable SHA-384 and SHA-512 support for user TAs. Signed-off-by: Jens Wiklander <[email protected]>

jenswi-linaro added 2 commits September 26, 2024 10:18

ftpm: implement hashlib using mbedtls

84bce6e

Add and use hashlib wrappers for MbedTLS. Disabling ALG_SM3_256 since it's not supported by MbedTLS. Signed-off-by: Jens Wiklander <[email protected]>

ftpm: remove TEE based hashlib implementation

bff13fb

Remove the now unused TEE internal core API based hashlib implementation. It was replaced since it doesn't support import and export of the hash state. Signed-off-by: Jens Wiklander <[email protected]>

jforissier reviewed Sep 26, 2024

View reviewed changes

mk/subdir.mk Show resolved Hide resolved

jforissier reviewed Sep 26, 2024

View reviewed changes

etienne-lms reviewed Sep 27, 2024

View reviewed changes

jforissier reviewed Sep 30, 2024

View reviewed changes

[review] mk/subdir.mk: introduce srcs_ext-y and srcs_ext_base-y

553a74e

Addressing a comment. Signed-off-by: Jens Wiklander <[email protected]>

b49020 reviewed Oct 1, 2024

View reviewed changes

ftpm: Makefile: update for building externally

d2769d4

Update the fTPM Makefile to support building externally. Remove WolfSSL leftovers. Signed-off-by: Jens Wiklander <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ftpm #7054

Ftpm #7054

jenswi-linaro commented Sep 25, 2024 •

edited

Loading

jenswi-linaro left a comment

jenswi-linaro Sep 25, 2024

etienne-lms commented Sep 26, 2024

jforissier left a comment

jforissier left a comment

jforissier left a comment

etienne-lms left a comment

etienne-lms Sep 25, 2024

jenswi-linaro Sep 30, 2024

etienne-lms Sep 25, 2024

jenswi-linaro Sep 30, 2024

etienne-lms Sep 26, 2024

jenswi-linaro Sep 30, 2024

jforissier left a comment

b49020 left a comment

b49020 Oct 1, 2024

jenswi-linaro Oct 1, 2024

b49020 Oct 1, 2024

jenswi-linaro Oct 1, 2024

b49020 Oct 3, 2024

Ftpm #7054

Are you sure you want to change the base?

Ftpm #7054

Conversation

jenswi-linaro commented Sep 25, 2024 • edited Loading

jenswi-linaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

etienne-lms commented Sep 26, 2024

jforissier left a comment

Choose a reason for hiding this comment

jforissier left a comment

Choose a reason for hiding this comment

jforissier left a comment

Choose a reason for hiding this comment

etienne-lms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jforissier left a comment

Choose a reason for hiding this comment

b49020 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jenswi-linaro commented Sep 25, 2024 •

edited

Loading