TCTI: Add USB TPM (LetsTrust-TPM2Go) TCTI module #2479

wxleong · 2022-11-12T07:10:54Z

Bringing up a TCTI module to support the LetsTrust-TPM2Go, a USB TPM from @PaulKissinger. It's a combined effort and resources are taken from:

The CI is expected to fail at this stage since the library libusb-1.0-0-dev is missing from the CI container image.

AndreasFuchsTPM · 2022-12-13T09:13:21Z

Apparently, the build is still failing on Fedora-32 and Alpine-3.15.

This is weird, because of https://github.com/tpm2-software/tpm2-software-container/blob/f15f2ee3e4d69ac332c8acfaa8867d0546090cda/fedora-32.docker.m4#L62 and https://github.com/tpm2-software/tpm2-software-container/blob/f15f2ee3e4d69ac332c8acfaa8867d0546090cda/alpine-3.15.docker.m4#L55

I thought, the dockers were updated automatically?

@williamcroberts Do you have any idea ?

williamcroberts · 2022-12-13T14:26:23Z

Apparently, the build is still failing on Fedora-32 and Alpine-3.15.

This is weird, because of https://github.com/tpm2-software/tpm2-software-container/blob/f15f2ee3e4d69ac332c8acfaa8867d0546090cda/fedora-32.docker.m4#L62 and https://github.com/tpm2-software/tpm2-software-container/blob/f15f2ee3e4d69ac332c8acfaa8867d0546090cda/alpine-3.15.docker.m4#L55

I thought, the dockers were updated automatically?

@williamcroberts Do you have any idea ?

Their's a rule in the build do only build/and publish for containers detected in the diff, but the diff action seems to have a bug and only compares the top level commit (the build output said this is the valid compare url):

tpm2-software/tpm2-software-container@c081d3e...f15f2ee
In that diff, their is no changes to published containers so the publish is all skipped.

williamcroberts · 2022-12-14T02:37:39Z

@wxleong and @AndreasFuchsTPM I have updated all the containers, what a nightmare. I have no idea why their is a curl error popping up in the build now, here is the PR that fixes that:

fapi: fix curl curl_url_strerror not found error #2519

So @wxleong you can cherry-pick that change into your branch or just rebase once it's merged.

wxleong · 2022-12-21T07:23:26Z

@williamcroberts CI workflow has passed, but CIFuzz and CirrusCI workflows still encountered libusb-1.0 library missing error.

williamcroberts · 2022-12-21T16:17:58Z

@williamcroberts CI workflow has passed, but CIFuzz and CirrusCI workflows still encountered libusb-1.0 library missing error.

@wxleong for
CI Fuzz, add it to the dockerfile here:

https://github.com/google/oss-fuzz/tree/aadb0925eef67d068ef2b66fa44764496e4d4493/projects/tpm2-tss

For CirrusCI add it to this file (Note it's FreeBSD):

https://github.com/tpm2-software/tpm2-tss/blob/master/.cirrus.yml

wxleong · 2022-12-22T09:18:12Z

Last item to fix: CIFuzz, simple fix but have to sort out the Google Contributor License Agreement before I can do anything.

PaulKissinger · 2022-12-22T09:23:07Z

Hi WenXin, Thank you for all this effort! Happy holidays if you have one 😅 Paul

…

-----Original Message----- From: WenXin ***@***.***> To: tpm2-software/tpm2-tss ***@***.***> Cc: Paul Kissinger ***@***.***>, Mention ***@***.***> Sent: Do., 22 Dez. 2022 10:18 Subject: Re: [tpm2-software/tpm2-tss] TCTI: Add USB TPM (LetsTrust-TPM2Go) TCTI module (PR #2479) Last item to fix: CIFuzz, simple fix but have to sort out the Google Contributor License Agreement before I can do anything.

-- Reply to this email directly or view it on GitHub: #2479 (comment) You are receiving this because you were mentioned. Message ID: ***@***.***>

williamcroberts · 2022-12-22T14:10:29Z

Last item to fix: CIFuzz, simple fix but have to sort out the Google Contributor License Agreement before I can do anything.

I can do CI Fuzz

williamcroberts · 2022-12-22T14:27:24Z

@wxleong:

I sent the PR to oss-fuzz here: tpm2-tss: disable spi lt2go TCTI google/oss-fuzz#9264
Can you rebase this on-top of current master and fix the conflicts and re-push
a. git pull --rebase origin master
b. fix merge conflicts
c. commit
d. git push -f wxleong develop-tcti-spi-lt2go3; # You may need to change the names to match what you have

Thanks,
Bill

wxleong · 2022-12-23T04:07:31Z

@wxleong:

I sent the PR to oss-fuzz here: tpm2-tss: disable spi lt2go TCTI google/oss-fuzz#9264

Can you rebase this on-top of current master and fix the conflicts and re-push
a. git pull --rebase origin master
b. fix merge conflicts
c. commit
d. git push -f wxleong develop-tcti-spi-lt2go3; # You may need to change the names to match what you have

Thanks, Bill

@williamcroberts thanks for the help with oss-fuzz. The conflicts was already resolved prior to this. I just did a dummy force push and all are passing now.

tobyp · 2022-12-23T11:00:52Z

Awesome! I look forward to giving this a spin after Christmas.

williamcroberts

I think you also want to rebase ontop of current master

.cirrus.yml

configure.ac

src/tss2-tcti/tcti-spi-lt2go.c

wxleong · 2022-12-27T03:39:42Z

I think you also want to rebase ontop of current master

merged master, 2b7007c

williamcroberts

Please force reset you branch and amend the history, as you make a change related to the PR git commit --amend. If you need to update the branch ontop of master, git pull --rebase origin master is your friend as well.

Makefile-test.am

tobyp · 2023-01-03T16:12:44Z

I was able to build this on ArchLinux, but it fails for me with "Probing TPM failed" because spi_tpm_helper_read_reg(TCTI_SPI_HELPER_TPM_DID_VID_REG) keeps reading 0. Logs with tcti+TRACE are here if you'd like to have a look.

@PaulKissinger have there been any changes to the hardware? I have the relatively old stick with serial number 000008 here.

PaulKissinger · 2023-01-03T16:21:57Z

I was able to build this on ArchLinux, but it fails for me with "Probing TPM failed" because spi_tpm_helper_read_reg(TCTI_SPI_HELPER_TPM_DID_VID_REG) keeps reading 0. Logs with tcti+TRACE are here if you'd like to have a look.

@PaulKissinger have there been any changes to the hardware? I have the relatively old stick with serial number 000008 here.

Hi @tobyp,
It is possible that you have the wrong hardware.
May you send me a detailed picture of the area between the chips with parts of both chips?

Thanks for testing!

Paul

tobyp · 2023-01-03T16:26:50Z

I also see an error message in the kernel log for every tss command, like this:

[ 9695.096293] usb 1-1.3: usbfs: process 108052 (tpm2_startup) did not claim interface 0 before use

I made a fix commit here, feel free to squash it into your branch if you agree this is a good solution (I'm not really fit with USB, I'm not even sure what "claiming" an interface means, just that the error bothers me :P).

williamcroberts · 2023-01-03T16:30:13Z

I also see an error message in the kernel log for every tss command, like this:
[ 9695.096293] usb 1-1.3: usbfs: process 108052 (tpm2_startup) did not claim interface 0 before use
I made a fix commit here, feel free to squash it into your branch if you agree this is a good solution (I'm not really fit with USB, I'm not even sure what "claiming" an interface means, just that the error bothers me :P).

I'm not fit either, but I don't see anything glairingly wrong... I'll let @wxleong weigh in and we can pick it in.

tobyp · 2023-01-03T16:35:39Z

Hi @tobyp, It is possible that you have the wrong hardware. May you send me a detailed picture of the area between the chips with parts of both chips?

@PaulKissinger I hope this is detailed enough, else I'll have to find a better camera than my phone 😅

PaulKissinger · 2023-01-04T13:56:43Z

Hi @tobyp,

yes, wrong hardware revision. The chip select of the TPM is connected to the GPIO1 of the USB Bridge. I have a new revision on my desk so I'll replace your stick in the next weeks.

Context: The patchset from @wxleong uses the burst count register and so wait states are not needed. This behavior reduces the communication between the host and the USB bridge. In the early phases of the hardware, it was not clear if the Chipselect works as expected, or that these sticks need a user-controllable chip select via GPIO. The latest HW revision will have a USB Bridge-controlled chip select.

Thank you and best regards,

Paul

wxleong · 2023-01-06T03:24:05Z

I also see an error message in the kernel log for every tss command, like this:
[ 9695.096293] usb 1-1.3: usbfs: process 108052 (tpm2_startup) did not claim interface 0 before use
I made a fix commit here, feel free to squash it into your branch if you agree this is a good solution (I'm not really fit with USB, I'm not even sure what "claiming" an interface means, just that the error bothers me :P).

I'll look into this

wxleong · 2023-01-06T03:27:22Z

I think you also want to rebase ontop of current master

merged master, 2b7007c

Again, always rebase, if your using git directly its:
git pull --rebase origin master
Ill update this one as well, same instructions for updating as:

TCTI: Add USB TPM (FTDI MPSSE USB to SPI bridge) TCTI module #2503

Also, ill squash the history down to one comimt, we don't want commits that are like:

add feature X

fix thing A

fix thing B

It should all be atomic.

Thanks for the help on squashing the commits. Merge was a mistake, moving forward i'll stick to rebase.

wxleong · 2023-01-10T09:47:32Z

I also see an error message in the kernel log for every tss command, like this:
[ 9695.096293] usb 1-1.3: usbfs: process 108052 (tpm2_startup) did not claim interface 0 before use
I made a fix commit here, feel free to squash it into your branch if you agree this is a good solution (I'm not really fit with USB, I'm not even sure what "claiming" an interface means, just that the error bothers me :P).
I'll look into this

Fixed in 9b97f20 thanks @tobyp.

LetsTrust-TPM2Go is a USB 2.0 stick with built-in TPM. The base is taken from https://gist.github.com/tobyp/aed5598188088f4abbeb737b408e5287. Signed-off-by: Peter Huewe <Peter.Huewe@infineon.com> Signed-off-by: wenxin.leong <wenxin.leong@infineon.com> Signed-off-by: William Roberts <william.c.roberts@intel.com>

codecov · 2023-01-12T06:57:04Z

Codecov Report

Merging #2479 (2b7007c) into master (6c2f14c) will decrease coverage by 0.00%.
The diff coverage is 57.25%.

❗ Current head 2b7007c differs from pull request most recent head 47b13bb. Consider uploading reports for the commit 47b13bb to get more accurate results

@@            Coverage Diff             @@
##           master    #2479      +/-   ##
==========================================
- Coverage   83.70%   83.70%   -0.01%     
==========================================
  Files         362      363       +1     
  Lines       41537    41564      +27     
==========================================
+ Hits        34769    34790      +21     
- Misses       6768     6774       +6

Impacted Files	Coverage Δ
src/tss2-tcti/tcti-spi-helper.c	`41.23% <50.00%> (+0.05%)`	⬆️
src/tss2-tcti/tcti-spi-lt2go.c	`57.37% <57.37%> (ø)`
src/tss2-esys/esys_crypto_ossl.c	`75.25% <0.00%> (-0.76%)`	⬇️
src/tss2-tcti/tcti-mssim.c	`70.22% <0.00%> (ø)`
src/tss2-esys/esys_crypto.c	`87.18% <0.00%> (+0.15%)`	⬆️
src/tss2-esys/esys_iutil.c	`91.84% <0.00%> (+4.82%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

wxleong · 2023-02-07T00:32:41Z

@williamcroberts all requested changes are applied, please review

williamcroberts

I am good with this, I'll let @JuergenReppSIT do a review and merge since I am stepping down as a full time maintainer.

wxleong mentioned this pull request Nov 14, 2022

Add libusb-1.0-0-dev tpm2-software/tpm2-software-container#72

Merged

AndreasFuchsTPM marked this pull request as draft November 15, 2022 11:48

wxleong force-pushed the develop-tcti-spi-lt2go3 branch from 4422c73 to 7e8615c Compare November 30, 2022 07:00

williamcroberts self-requested a review December 14, 2022 00:27

wxleong force-pushed the develop-tcti-spi-lt2go3 branch 6 times, most recently from 5ea4383 to 8e0ebd8 Compare December 21, 2022 07:00

wxleong force-pushed the develop-tcti-spi-lt2go3 branch 4 times, most recently from 12823a5 to 4337fe1 Compare December 22, 2022 08:46

williamcroberts marked this pull request as ready for review December 22, 2022 14:13

wxleong force-pushed the develop-tcti-spi-lt2go3 branch from 4337fe1 to 2bd97b1 Compare December 23, 2022 02:20

williamcroberts requested changes Dec 26, 2022

View reviewed changes

.cirrus.yml Show resolved Hide resolved

configure.ac Outdated Show resolved Hide resolved

src/tss2-tcti/tcti-spi-lt2go.c Outdated Show resolved Hide resolved

src/tss2-tcti/tcti-spi-lt2go.c Show resolved Hide resolved

src/tss2-tcti/tcti-spi-lt2go.c Outdated Show resolved Hide resolved

wxleong force-pushed the develop-tcti-spi-lt2go3 branch from 64e7628 to 2b7007c Compare December 27, 2022 03:35

williamcroberts force-pushed the develop-tcti-spi-lt2go3 branch 2 times, most recently from de82b7d to 020c7c3 Compare December 30, 2022 18:03

williamcroberts requested changes Dec 30, 2022

View reviewed changes

Makefile-test.am Outdated Show resolved Hide resolved

Makefile-test.am Show resolved Hide resolved

wxleong force-pushed the develop-tcti-spi-lt2go3 branch 2 times, most recently from f8207a0 to 0aea261 Compare January 6, 2023 03:15

wxleong force-pushed the develop-tcti-spi-lt2go3 branch 2 times, most recently from 4dd5e4d to 9b97f20 Compare January 10, 2023 09:07

wxleong requested a review from williamcroberts January 10, 2023 09:47

wxleong force-pushed the develop-tcti-spi-lt2go3 branch 6 times, most recently from 8cbd219 to f5e27f9 Compare January 12, 2023 05:39

wxleong force-pushed the develop-tcti-spi-lt2go3 branch from f5e27f9 to 47b13bb Compare January 12, 2023 06:56

williamcroberts approved these changes Feb 7, 2023

View reviewed changes

AndreasFuchsTPM merged commit 24713d0 into tpm2-software:master Feb 17, 2023

wxleong deleted the develop-tcti-spi-lt2go3 branch April 20, 2023 07:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TCTI: Add USB TPM (LetsTrust-TPM2Go) TCTI module #2479

TCTI: Add USB TPM (LetsTrust-TPM2Go) TCTI module #2479

wxleong commented Nov 12, 2022 •

edited

Loading

AndreasFuchsTPM commented Dec 13, 2022

williamcroberts commented Dec 13, 2022

williamcroberts commented Dec 14, 2022

wxleong commented Dec 21, 2022

williamcroberts commented Dec 21, 2022

wxleong commented Dec 22, 2022

PaulKissinger commented Dec 22, 2022 via email •

edited

Loading

williamcroberts commented Dec 22, 2022

williamcroberts commented Dec 22, 2022

wxleong commented Dec 23, 2022 •

edited

Loading

tobyp commented Dec 23, 2022

williamcroberts left a comment

wxleong commented Dec 27, 2022 •

edited

Loading

williamcroberts left a comment

tobyp commented Jan 3, 2023

PaulKissinger commented Jan 3, 2023

tobyp commented Jan 3, 2023

williamcroberts commented Jan 3, 2023

tobyp commented Jan 3, 2023 •

edited

Loading

PaulKissinger commented Jan 4, 2023

wxleong commented Jan 6, 2023

wxleong commented Jan 6, 2023

wxleong commented Jan 10, 2023

codecov bot commented Jan 12, 2023

wxleong commented Feb 7, 2023

williamcroberts left a comment

TCTI: Add USB TPM (LetsTrust-TPM2Go) TCTI module #2479

TCTI: Add USB TPM (LetsTrust-TPM2Go) TCTI module #2479

Conversation

wxleong commented Nov 12, 2022 • edited Loading

AndreasFuchsTPM commented Dec 13, 2022

williamcroberts commented Dec 13, 2022

williamcroberts commented Dec 14, 2022

wxleong commented Dec 21, 2022

williamcroberts commented Dec 21, 2022

wxleong commented Dec 22, 2022

PaulKissinger commented Dec 22, 2022 via email • edited Loading

williamcroberts commented Dec 22, 2022

williamcroberts commented Dec 22, 2022

wxleong commented Dec 23, 2022 • edited Loading

tobyp commented Dec 23, 2022

williamcroberts left a comment

Choose a reason for hiding this comment

wxleong commented Dec 27, 2022 • edited Loading

williamcroberts left a comment

Choose a reason for hiding this comment

tobyp commented Jan 3, 2023

PaulKissinger commented Jan 3, 2023

tobyp commented Jan 3, 2023

williamcroberts commented Jan 3, 2023

tobyp commented Jan 3, 2023 • edited Loading

PaulKissinger commented Jan 4, 2023

wxleong commented Jan 6, 2023

wxleong commented Jan 6, 2023

wxleong commented Jan 10, 2023

codecov bot commented Jan 12, 2023

Codecov Report

wxleong commented Feb 7, 2023

williamcroberts left a comment

Choose a reason for hiding this comment

wxleong commented Nov 12, 2022 •

edited

Loading

PaulKissinger commented Dec 22, 2022 via email •

edited

Loading

wxleong commented Dec 23, 2022 •

edited

Loading

wxleong commented Dec 27, 2022 •

edited

Loading

tobyp commented Jan 3, 2023 •

edited

Loading