Skip to contentSkip to conversation

Install the swtpm package, if available

PATCH In review Mimi Zohar 4 participants 5 messages Aug 16, 2020 – Aug 17, 2020 Keys-trusted

lore
Share & tools
lore

Mimi Zohar

author maintainer
#0 lore raw

PATCH 1/1 Install the swtpm package, if available

The "boot_aggregate.test" requires either a hardware or software TPM. Support using the swtpm, if packaged for the distro, in addition to tpm_server.

Note: Some travis/<distro>.sh scripts are links to other scripts. Don't fail the build of the linked script if the swtpm package doesn't exist.

---
 .travis.yml               |  2 +-
 tests/boot_aggregate.test | 40 ++++++++++++++++++++++++++++-----------
 travis/fedora.sh          |  1 +
 3 files changed, 31 insertions(+), 12 deletions(-)
.travis.yml +1 -1
index 849fcb6ba822..9bea5d19bd0e 100644
@@ -75,4 +75,4 @@ before_install:
 script:
     - INSTALL="${DISTRO%%:*}"
     - INSTALL="${INSTALL%%/*}"
-    - docker run -t ima-evm-utils /bin/sh -c "cd travis && if [ \"$VARIANT\" ]; then ARCH=\"$ARCH\" ./$INSTALL.$VARIANT.sh; fi && ARCH=\"$ARCH\" CC=\"$CC\" TSS=\"$TSS\" ./$INSTALL.sh && if [ ! \"$VARIANT\" ]; then which tpm_server || ../tests/install-swtpm.sh; fi && CC=\"$CC\" VARIANT=\"$VARIANT\" ../build.sh"
+    - docker run -t ima-evm-utils /bin/sh -c "cd travis && if [ \"$VARIANT\" ]; then ARCH=\"$ARCH\" ./$INSTALL.$VARIANT.sh; fi && ARCH=\"$ARCH\" CC=\"$CC\" TSS=\"$TSS\" ./$INSTALL.sh && if [ ! \"$VARIANT\" ]; then which tpm_server || which swtpm || ../tests/install-swtpm.sh; fi && CC=\"$CC\" VARIANT=\"$VARIANT\" ../build.sh"
tests/boot_aggregate.test +29 -11
index 43de67de1468..ce310b6ae5b4 100755
@@ -33,6 +33,10 @@ else
 	ASCII_RUNTIME_MEASUREMENTS="./sample-ascii_runtime_measurements-pcrs-8-9"
 	export TPM_INTERFACE_TYPE="socsim"
 	export TPM_COMMAND_PORT=2321
+	export TPM_PLATFORM_PORT=2322
+	export TPM_SERVER_NAME="localhost"
+	export TPM_SERVER_TYPE="raw"
+
 fi
 
 # Only stop this test's software TPM.  Preferred method: "tsstpmcmd -stop"
@@ -48,22 +52,36 @@ cleanup() {
 
 # Try to start a software TPM if needed.
 swtpm_start() {
-	local swtpm
+	local swtpm swtpm1
 
 	swtpm="$(which tpm_server)"
-	if [ -z "${swtpm}" ]; then
-		echo "${CYAN}SKIP: Softare TPM (tpm_server) not found${NORM}"
+	swtpm1="$(which swtpm)"
+	if [ -z "${swtpm}" ] && [ -z "${swptm1}" ]; then
+		echo "${CYAN}SKIP: Softare TPM (tpm_server and swtpm) not found${NORM}"
 		return "$SKIP"
 	fi
 
-	pgrep tpm_server
-	if [ $? -eq 0 ]; then
-		echo "INFO: Software TPM (tpm_server) already running"
-		return 114
-	else
-		echo "INFO: Starting software TPM: ${swtpm}"
-		${swtpm} > /dev/null 2>&1 &
-		SWTPM_PPID=$!
+	if [ ! -z "${swtpm1}" ]; then
+		pgrep swtpm1
+		if [ $? -eq 0 ]; then
+			echo "INFO: Software TPM (swtpm) already running"
+			return 114
+		else
+			echo "INFO: Starting software TPM: ${swtpm1}"
+			mkdir ./myvtpm
+			${swtpm1} socket --tpmstate dir=./myvtpm --tpm2 --ctrl type=tcp,port=2322 --server type=tcp,port=2321 --flags not-need-init > /dev/null 2>&1 &
+			SWTPM_PPID=$!
+		fi
+	elif [ ! -z "${swtpm}" ]; then
+		pgrep swtpm
+		if [ $? -eq 0 ]; then
+			echo "INFO: Software TPM (tpm_server) already running"
+			return 114
+		else
+			echo "INFO: Starting software TPM: ${swtpm}"
+			${swtpm} > /dev/null 2>&1 &
+			SWTPM_PPID=$!
+		fi
 	fi
 	return 0
 }
travis/fedora.sh +1 -0
index d3459e408d81..f9ee9bed7bc1 100755
@@ -41,6 +41,7 @@ yum -y install \
 	which
 
 yum -y install docbook5-style-xsl || true
+yum -y install swtpm || true
 
 # FIXME: debug
 echo "find /tss2_esys.h"
Signature · 1 line
2.18.4
author maintainer
#1 lore raw

tests/boot_aggregate.test cleanup() { · line 59

Quoted 13 lines · Mimi Zohar

# Only stop this test's software TPM. Preferred method: "tsstpmcmd -stop"

tests/boot_aggregate.test +3 -3
@@ -48,22 +52,36 @@ cleanup() {
 
 # Try to start a software TPM if needed.
 swtpm_start() {
-       local swtpm
+       local swtpm swtpm1
 
        swtpm="$(which tpm_server)"
-       if [ -z "${swtpm}" ]; then
-               echo "${CYAN}SKIP: Softare TPM (tpm_server) not found${NORM}"
+       swtpm1="$(which swtpm)"
+       if [ -z "${swtpm}" ] && [ -z "${swptm1}" ]; then

Need to fix "swptm1" typo.

Mimi

Quoted 3 lines
tests/boot_aggregate.test +1 -0
+               echo "${CYAN}SKIP: Softare TPM (tpm_server and swtpm) not found${NORM}"
                return "$SKIP"
        fi
Reviewed-by
#2 lore raw

Hi Mimi,

Quoted 3 lines

Note: Some travis/<distro>.sh scripts are links to other scripts. Don't fail the build of the linked script if the swtpm package doesn't exist.

...

travis/fedora.sh yum -y install \ · line 44

Quoted 7 lines
travis/fedora.sh +1 -0
@@ -41,6 +41,7 @@ yum -y install \
        which
 
 yum -y install docbook5-style-xsl || true
+yum -y install swtpm || true

Yes, that's probably the best way how to solve. Sometimes I also passed $INSTALL to the script and had if clause.

Quoted 9 lines · Mimi Zohar
Quoted 7 lines

# Only stop this test's software TPM. Preferred method: "tsstpmcmd -stop"

tests/boot_aggregate.test +1 -1
@@ -48,22 +52,36 @@ cleanup() {
 
 # Try to start a software TPM if needed.
 swtpm_start() {
-       local swtpm
+       local swtpm swtpm1
Quoted 7 lines

tests/boot_aggregate.test cleanup() { · line 59

Quoted 5 lines
tests/boot_aggregate.test +2 -2
        swtpm="$(which tpm_server)"
-       if [ -z "${swtpm}" ]; then
-               echo "${CYAN}SKIP: Softare TPM (tpm_server) not found${NORM}"
+       swtpm1="$(which swtpm)"
+       if [ -z "${swtpm}" ] && [ -z "${swptm1}" ]; then

Need to fix "swptm1" typo.

+1

Also, not related to this commit:
* add pgrep and pkill to _require (fix of a different commit)
* add magic constant 114 to exit codes (in tests/functions.sh)
* I'd like reuse exit codes in build.sh. I could source tests/functions.sh (they look to be general enough, just I didn't like script in root directory depending on it, as it's general enough for build without testing) have these constants in separate file.

Kind regards,
Petr

Acked-by on v1 1/1
#3 lore raw
In reply to Mimi Zohar
Quoted 93 lines · Mimi Zohar

The "boot_aggregate.test" requires either a hardware or software TPM. Support using the swtpm, if packaged for the distro, in addition to tpm_server.

Note: Some travis/<distro>.sh scripts are links to other scripts. Don't fail the build of the linked script if the swtpm package doesn't exist.

---
 .travis.yml               |  2 +-
 tests/boot_aggregate.test | 40 ++++++++++++++++++++++++++++-----------
 travis/fedora.sh          |  1 +
 3 files changed, 31 insertions(+), 12 deletions(-)
.travis.yml +1 -1
index 849fcb6ba822..9bea5d19bd0e 100644
@@ -75,4 +75,4 @@ before_install:
 script:
     - INSTALL="${DISTRO%%:*}"
     - INSTALL="${INSTALL%%/*}"
-    - docker run -t ima-evm-utils /bin/sh -c "cd travis && if [ \"$VARIANT\" ]; then ARCH=\"$ARCH\" ./$INSTALL.$VARIANT.sh; fi && ARCH=\"$ARCH\" CC=\"$CC\" TSS=\"$TSS\" ./$INSTALL.sh && if [ ! \"$VARIANT\" ]; then which tpm_server || ../tests/install-swtpm.sh; fi && CC=\"$CC\" VARIANT=\"$VARIANT\" ../build.sh"
+    - docker run -t ima-evm-utils /bin/sh -c "cd travis && if [ \"$VARIANT\" ]; then ARCH=\"$ARCH\" ./$INSTALL.$VARIANT.sh; fi && ARCH=\"$ARCH\" CC=\"$CC\" TSS=\"$TSS\" ./$INSTALL.sh && if [ ! \"$VARIANT\" ]; then which tpm_server || which swtpm || ../tests/install-swtpm.sh; fi && CC=\"$CC\" VARIANT=\"$VARIANT\" ../build.sh"
tests/boot_aggregate.test +29 -11
index 43de67de1468..ce310b6ae5b4 100755
@@ -33,6 +33,10 @@ else
 	ASCII_RUNTIME_MEASUREMENTS="./sample-ascii_runtime_measurements-pcrs-8-9"
 	export TPM_INTERFACE_TYPE="socsim"
 	export TPM_COMMAND_PORT=2321
+	export TPM_PLATFORM_PORT=2322
+	export TPM_SERVER_NAME="localhost"
+	export TPM_SERVER_TYPE="raw"
+
 fi
 
 # Only stop this test's software TPM.  Preferred method: "tsstpmcmd -stop"
@@ -48,22 +52,36 @@ cleanup() {
 
 # Try to start a software TPM if needed.
 swtpm_start() {
-	local swtpm
+	local swtpm swtpm1
 
 	swtpm="$(which tpm_server)"
-	if [ -z "${swtpm}" ]; then
-		echo "${CYAN}SKIP: Softare TPM (tpm_server) not found${NORM}"
+	swtpm1="$(which swtpm)"
+	if [ -z "${swtpm}" ] && [ -z "${swptm1}" ]; then
+		echo "${CYAN}SKIP: Softare TPM (tpm_server and swtpm) not found${NORM}"
 		return "$SKIP"
 	fi
 
-	pgrep tpm_server
-	if [ $? -eq 0 ]; then
-		echo "INFO: Software TPM (tpm_server) already running"
-		return 114
-	else
-		echo "INFO: Starting software TPM: ${swtpm}"
-		${swtpm} > /dev/null 2>&1 &
-		SWTPM_PPID=$!
+	if [ ! -z "${swtpm1}" ]; then
+		pgrep swtpm1
+		if [ $? -eq 0 ]; then
+			echo "INFO: Software TPM (swtpm) already running"
+			return 114
+		else
+			echo "INFO: Starting software TPM: ${swtpm1}"
+			mkdir ./myvtpm
+			${swtpm1} socket --tpmstate dir=./myvtpm --tpm2 --ctrl type=tcp,port=2322 --server type=tcp,port=2321 --flags not-need-init > /dev/null 2>&1 &
+			SWTPM_PPID=$!
+		fi
+	elif [ ! -z "${swtpm}" ]; then
+		pgrep swtpm
+		if [ $? -eq 0 ]; then
+			echo "INFO: Software TPM (tpm_server) already running"
+			return 114
+		else
+			echo "INFO: Starting software TPM: ${swtpm}"
+			${swtpm} > /dev/null 2>&1 &
+			SWTPM_PPID=$!
+		fi
 	fi
 	return 0
 }
travis/fedora.sh +0 -0
index d3459e408d81..f9ee9bed7bc1 100755

travis/fedora.sh yum -y install \ · line 45

Quoted 5 lines
travis/fedora.sh +1 -0
@@ -41,6 +41,7 @@ yum -y install \
 	which
 
 yum -y install docbook5-style-xsl || true
+yum -y install swtpm || true
 

just fyi..

centos:7 doesn't has swtpm while centos:{latest,8} does. Should we consider getting it built manually? I can take a look on it if desirable.

Quoted 5 lines
travis/fedora.sh +0 -0
 # FIXME: debug
 echo "find /tss2_esys.h"
Signature · 1 line
2.18.4

With "swptm1" fixed:

Thanks Mimi.

Signature · 2 lines
bmeneg 
PGP Key: http://bmeneg.com/pubkey.txt
#4 lore raw
In reply to Mimi Zohar
Quoted 55 lines · Mimi Zohar

The "boot_aggregate.test" requires either a hardware or software TPM. Support using the swtpm, if packaged for the distro, in addition to tpm_server.

Note: Some travis/<distro>.sh scripts are links to other scripts. Don't fail the build of the linked script if the swtpm package doesn't exist.

---
  .travis.yml               |  2 +-
  tests/boot_aggregate.test | 40 ++++++++++++++++++++++++++++-----------
  travis/fedora.sh          |  1 +
  3 files changed, 31 insertions(+), 12 deletions(-)
.travis.yml +1 -1
index 849fcb6ba822..9bea5d19bd0e 100644
@@ -75,4 +75,4 @@ before_install:
  script:
      - INSTALL="${DISTRO%%:*}"
      - INSTALL="${INSTALL%%/*}"
-    - docker run -t ima-evm-utils /bin/sh -c "cd travis && if [ \"$VARIANT\" ]; then ARCH=\"$ARCH\" ./$INSTALL.$VARIANT.sh; fi && ARCH=\"$ARCH\" CC=\"$CC\" TSS=\"$TSS\" ./$INSTALL.sh && if [ ! \"$VARIANT\" ]; then which tpm_server || ../tests/install-swtpm.sh; fi && CC=\"$CC\" VARIANT=\"$VARIANT\" ../build.sh"
+    - docker run -t ima-evm-utils /bin/sh -c "cd travis && if [ \"$VARIANT\" ]; then ARCH=\"$ARCH\" ./$INSTALL.$VARIANT.sh; fi && ARCH=\"$ARCH\" CC=\"$CC\" TSS=\"$TSS\" ./$INSTALL.sh && if [ ! \"$VARIANT\" ]; then which tpm_server || which swtpm || ../tests/install-swtpm.sh; fi && CC=\"$CC\" VARIANT=\"$VARIANT\" ../build.sh"
tests/boot_aggregate.test +8 -3
index 43de67de1468..ce310b6ae5b4 100755
@@ -33,6 +33,10 @@ else
  	ASCII_RUNTIME_MEASUREMENTS="./sample-ascii_runtime_measurements-pcrs-8-9"
  	export TPM_INTERFACE_TYPE="socsim"
  	export TPM_COMMAND_PORT=2321
+	export TPM_PLATFORM_PORT=2322
+	export TPM_SERVER_NAME="localhost"
+	export TPM_SERVER_TYPE="raw"
+
  fi
 
  # Only stop this test's software TPM.  Preferred method: "tsstpmcmd -stop"
@@ -48,22 +52,36 @@ cleanup() {
 
  # Try to start a software TPM if needed.
  swtpm_start() {
-	local swtpm
+	local swtpm swtpm1
 
  	swtpm="$(which tpm_server)"
-	if [ -z "${swtpm}" ]; then
-		echo "${CYAN}SKIP: Softare TPM (tpm_server) not found${NORM}"
+	swtpm1="$(which swtpm)"
+	if [ -z "${swtpm}" ] && [ -z "${swptm1}" ]; then
+		echo "${CYAN}SKIP: Softare TPM (tpm_server and swtpm) not found${NORM}"
  		return "$SKIP"
  	fi

tests/boot_aggregate.test cleanup() { · line 64

Quoted 10 lines
tests/boot_aggregate.test +1 -8
 
-	pgrep tpm_server
-	if [ $? -eq 0 ]; then
-		echo "INFO: Software TPM (tpm_server) already running"
-		return 114
-	else
-		echo "INFO: Starting software TPM: ${swtpm}"
-		${swtpm} > /dev/null 2>&1 &
-		SWTPM_PPID=$!
+	if [ ! -z "${swtpm1}" ]; then

Change to 'if [ -n "${swtpm1}" ]; then' ?

tests/boot_aggregate.test cleanup() { · line 75

Quoted 11 lines
tests/boot_aggregate.test +11 -0
+		pgrep swtpm1
+		if [ $? -eq 0 ]; then
+			echo "INFO: Software TPM (swtpm) already running"
+			return 114
+		else
+			echo "INFO: Starting software TPM: ${swtpm1}"
+			mkdir ./myvtpm
+			${swtpm1} socket --tpmstate dir=./myvtpm --tpm2 --ctrl type=tcp,port=2322 --server type=tcp,port=2321 --flags not-need-init > /dev/null 2>&1 &
+			SWTPM_PPID=$!
+		fi
+	elif [ ! -z "${swtpm}" ]; then

Same here.

Quoted 24 lines
tests/boot_aggregate.test +9 -0
+		pgrep swtpm
+		if [ $? -eq 0 ]; then
+			echo "INFO: Software TPM (tpm_server) already running"
+			return 114
+		else
+			echo "INFO: Starting software TPM: ${swtpm}"
+			${swtpm} > /dev/null 2>&1 &
+			SWTPM_PPID=$!
+		fi
  	fi
  	return 0
  }
travis/fedora.sh +1 -0
index d3459e408d81..f9ee9bed7bc1 100755
@@ -41,6 +41,7 @@ yum -y install \
  	which
 
  yum -y install docbook5-style-xsl || true
+yum -y install swtpm || true
 
  # FIXME: debug
  echo "find /tss2_esys.h"