Dasharo Security: TPM Support

Test cases common documentation

Test setup

Proceed with the Generic test setup: firmware.
Proceed with the Generic test setup: OS installer.
Proceed with the Generic test setup: OS installation.
Proceed with the Generic test setup: OS boot from disk.

TPM001.001 TPM Support (TPM events)

Test description

This test aims to verify that the TPM is initialized correctly and the TPM event logs can be accessed from the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.
Download cbmem from the cloud to the DUT.
Make sure the package is executable: sudo chmod +x /usr/local/bin/cbmem.
Disable Secure Boot.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Run the following command in the shell:
```
sudo cbmem -L
```

Expected result

The command should return information about the TPM log entries.

Example output:

TPM2 log:
    Specification: 2.00
    Platform class: PC Client
    No vendor information provided
TPM2 log entry 1:
    PCR: 2
    Event type: Action
    Digests:
         SHA1: f78a530fb5a70afcffdc86a98529abd24a90bac9
    Event data: FMAP: FMAP
TPM2 log entry 2:
    PCR: 2
    Event type: Action
    Digests:
         SHA1: 369155e6eab3b0a874140e591a4c0e992268b4b9
    Event data: FMAP: BOOTBLOCK
TPM2 log entry 3:
    PCR: 2
    Event type: Action
    Digests:
         SHA1: 5e785c080264aa6e169f70c80ac40b556066292b
    Event data: FMAP: COREBOOT CBFS: fallback/romstage
TPM2 log entry 4:
    PCR: 2
    Event type: Action
    Digests:
         SHA1: ba2a5af955811fbac58a5198545539596eb38c3e
    Event data: FMAP: COREBOOT CBFS: fallback/ramstage
TPM2 log entry 5:
    PCR: 2
    Event type: Action
    Digests:
         SHA1: ba35d4ce29d7b633b5644e2a3206c6069cf7f24d
    Event data: FMAP: COREBOOT CBFS: fallback/payload
TPM2 log entry 6:
    PCR: 2
    Event type: Action
    Digests:
         SHA1: 47b49026133377e05193f8440c9a7cad239e883c
    Event data: FMAP: COREBOOT CBFS: 1-cpu.dtb
TPM2 log entry 7:
    PCR: 3
    Event type: Action
    Digests:
         SHA256: 6e7b06693452d997ac534e823b1ea79e5bb8ed19ba8a7af878abf10199c3d515
         SHA1: 6e7b06693452d997ac534e823b1ea79e5bb8ed19
    Event data: VERSION
TPM2 log entry 8:
    PCR: 2
    Event type: Action
    Digests:
         SHA256: de73053377e1ae5ba5d2b637a4f5bfaeb410137722f11ef135e7a1be524e3092
         SHA1: de73053377e1ae5ba5d2b637a4f5bfaeb4101377
    Event data: IMA_CATALOG
TPM2 log entry 9:
    PCR: 4
    Event type: Action
    Digests:
         SHA256: ba427f9349b1f9e589f98909e26086b0cfd5ced78a7fbcb140a70a506c38a8e5
         SHA1: ba427f9349b1f9e589f98909e26086b0cfd5ced7
    Event data: BOOTKERNEL
(...)

TPM001.002 TPM Support (Ubuntu)

Test description

This test aims to verify that the TPM is initialized correctly and the PCRs can be accessed from the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.
Install the tpm2-tools package: sudo apt install tpm2-tools.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Check the version of installed tpm2-tools - execute the following command in the terminal:
```
dpkg --list tpm2-tools
```
If your device is equipped with TPM2.0 and the version of tpm2-tools is 4.0 or higher - execute the following command in the terminal:
```
tpm2_pcrread
```
If your device is equipped with TPM2.0 and the version of tpm2-tools is lower than 4.0 - execute the following command in the terminal:
```
tpm2_pcrlist
```
If your device is equipped with TPM1.2 - execute the following command in the terminal:
```
cat /sys/class/tpm/tpm0/pcrs
```

Expected result

The command should return a list of PCRs and their contents.

Output example for TPM2.0:

sha1 :
  0  : 3a3f780f11a4b49969fcaa80cd6e3957c33b2275
  1  : 8a074fdf65a11e5dbf02d25e7f26b00c26c98b41
  2  : c36c2509d636c9cfa075d6d0a03b7a37bec14ee9
  3  : 3a3f780f11a4b49969fcaa80cd6e3957c33b2275
  4  : 2d247bb671ec17ded623ca45967df5482517291b
  5  : 49d543eb1d1df3439d9fca695ee47b8cdf4b9e2f
  6  : 3a3f780f11a4b49969fcaa80cd6e3957c33b2275
  7  : 3a3f780f11a4b49969fcaa80cd6e3957c33b2275
  8  : 0000000000000000000000000000000000000000
  9  : 0000000000000000000000000000000000000000
  10 : 0000000000000000000000000000000000000000
  11 : 0000000000000000000000000000000000000000
  12 : 0000000000000000000000000000000000000000
  13 : 0000000000000000000000000000000000000000
  14 : 0000000000000000000000000000000000000000
  15 : 0000000000000000000000000000000000000000
  16 : 0000000000000000000000000000000000000000
  17 : ffffffffffffffffffffffffffffffffffffffff
  18 : ffffffffffffffffffffffffffffffffffffffff
  19 : ffffffffffffffffffffffffffffffffffffffff
  20 : ffffffffffffffffffffffffffffffffffffffff
  21 : ffffffffffffffffffffffffffffffffffffffff
  22 : ffffffffffffffffffffffffffffffffffffffff
  23 : 0000000000000000000000000000000000000000
sha256 :
  0  : d27cc12614b5f4ff85ed109495e320fb1e5495eb28d507e952d51091e7ae2a72
  1  : b29a64bd6895966b777eb803f45e6bbffade81cc1b996a34f7cbd26f1d04028b
  2  : 3122422e43b9fbfc0cb70eb467b55e99ec61462370e6b15c515484f821e1d4d9
  3  : 909e4261938378c0556a4c335c38718d1c313bd151fdf222df674aabb7aeee97
  4  : 984763b42633ee11e5167e2f67c2e6879bd6efac683f1df1ef16d7ce96d4b49b
  5  : dab92c45eeb765e29784f8cc33f92d0a39afed173f2b07e0e328586c3c3b19ed
  6  : d27cc12614b5f4ff85ed109495e320fb1e5495eb28d507e952d51091e7ae2a72
  7  : d27cc12614b5f4ff85ed109495e320fb1e5495eb28d507e952d51091e7ae2a72
  8  : 0000000000000000000000000000000000000000000000000000000000000000
  9  : 0000000000000000000000000000000000000000000000000000000000000000
  10 : 0000000000000000000000000000000000000000000000000000000000000000
  11 : 0000000000000000000000000000000000000000000000000000000000000000
  12 : 0000000000000000000000000000000000000000000000000000000000000000
  13 : 0000000000000000000000000000000000000000000000000000000000000000
  14 : 0000000000000000000000000000000000000000000000000000000000000000
  15 : 0000000000000000000000000000000000000000000000000000000000000000
  16 : 0000000000000000000000000000000000000000000000000000000000000000
  17 : ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
  18 : ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
  19 : ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
  20 : ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
  21 : ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
  22 : ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
  23 : 0000000000000000000000000000000000000000000000000000000000000000

Output example for TPM1.2:

PCR-00: B3 F3 60 E1 D5 1F 82 D4 62 E6 B9 69 92 2F 65 F4 9F 1A 5F 8E
PCR-01: 21 9F 1F 4A C1 AD AD 4D F1 8B 9F AB 98 23 68 B1 73 A6 32 87
PCR-02: 40 CF E3 DC A7 FF 67 FB AA BB 20 85 A4 39 43 D8 54 A7 AB 98
PCR-03: E3 E7 E6 89 CA FB F5 75 38 95 D0 CD 83 96 F6 0C 38 04 DC D5
PCR-04: 01 7A 3D E8 2F 4A 1B 77 FC 33 A9 03 FE F6 AD 27 EE 92 BE 04
PCR-05: 93 6A 12 98 07 73 85 9D 91 27 61 82 E7 11 C5 1D 08 98 C4 28
PCR-06: 3A 3F 78 0F 11 A4 B4 99 69 FC AA 80 CD 6E 39 57 C3 3B 22 75
PCR-07: 3A 3F 78 0F 11 A4 B4 99 69 FC AA 80 CD 6E 39 57 C3 3B 22 75
PCR-08: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-09: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-10: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-11: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-12: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-13: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-14: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-15: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-16: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
PCR-17: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
PCR-18: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
PCR-19: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
PCR-20: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
PCR-21: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
PCR-22: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
PCR-23: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00

TPM001.003 TPM Support (Windows)

Test description

This test aims to verify that the TPM is initialized correctly and the PCRs can be accessed from the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Windows

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Open a PowerShell as administrator and run the following command:
```
get-tpm
```

Expected result

The command should return information about the TPM state: if the TPM is present, ready and enabled:

TpmPresent     : True
TpmReady       : True
TpmEnabled     : True

TPM001.004 TPM Support (BIOS)

Test description

This test aims to verify that the TPM is initialized correctly.

Test configuration data

FIRMWARE = Dasharo

Test setup

Proceed with the Test cases common documentation section.
Disable Secure Boot.

Test steps

Power on the DUT.
Boot into the BIOS.
Enter Device Manager.
Enter TCG2 Configuration

Expected result

Current TPM Device should contain TPM 2.0 or TPM 1.2.

TPM002.001 Verify TPM version (Ubuntu)

Test description

This test aims to verify that the TPM version is correctly recognized by the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Check the version of used TPM - execute the following command in the terminal:
```
cat /sys/class/tpm/tpm0/tpm_version_major
```

Expected result

The command should return the TPM major version.

Example output:

TPM002.002 Verify TPM version (Windows)

Test description

This test aims to verify that the TPM version is correctly recognized by the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Windows

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.

Open a PowerShell as administrator and run the following command:

wmic /namespace:\\root\cimv2\security\microsofttpm path win32_tpm get * /format:textvaluelist.xsl

Expected result

The command should return information about the TPM version.

Example output:

SpecVersion=2.0

TPM003.001 Check TPM Physical Presence Interface (firmware)

Test description

This test aims to verify that the TPM Physical Presence Interface is supported by the firmware.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.
Download cbmem from the cloud to the DUT.
Make sure the package is executable: sudo chmod +x /usr/local/bin/cbmem.
Disable Secure Boot.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Open the terminal and run the following command and note results:
```
sudo cbmem -1 |grep PPI
```

Expected result

The cbmem.log should contain the following lines (the hex numbers may be different per platform):

[DEBUG]  PPI: Pending OS request: 0x0 (0x0)
[DEBUG]  PPI: OS response: CMD 0x39073907 = 0x0
[DEBUG]    TPM PPI     8. 0x76ffe620 0x0000015a

If the above lines are present, the firmware supports TPM PPI.

TPM003.002 Check TPM Physical Presence Interface (Ubuntu)

Test description

This test aims to verify that the TPM Physical Presence Interface is correctly recognized by the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu
Platform with TPM 2.0 module present.

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Open the terminal and run the following command to check the version of TPM PPI in sysfs:
```
cat /sys/class/tpm/tpm0/ppi/version
```

Expected result

The command should return information about the TPM PPI version (only 1.3 is valid). If PPI is not available the file will not be found and test fails.

Example output:

cat /sys/class/tpm/tpm0/ppi/version
1.3

TPM003.003 Check TPM Physical Presence Interface (Windows)

Test description

This test aims to verify that the TPM Physical Presence Interface is correctly recognized by the operating system.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Windows
Platform with TPM 2.0 module present.

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.
Open a PowerShell as administrator and run the following command:
```
tpmtool getdeviceinformation
```

Expected result

The command should return information about the TPM PPI version (only 1.3 is valid). If PPI is not available on the list, test fails.

Example output:

tpmtool getdeviceinformation

-TPM Present: True
-TPM Version: 2.0
-TPM Manufacturer ID: INTC
-TPM Manufacturer Full Name: Intel
-TPM Manufacturer Version: 600.18.0.0
-PPI Version: 1.3
-Is Initialized: True
-Ready For Storage: True
-Ready For Attestation: True
-Is Capable For Attestation: True
-Clear Needed To Recover: False
-Clear Possible: True
-TPM Has Vulnerable Firmware: False
-Maintenance Task Complete: True
-Bitlocker PCR7 Binding State: Binding Not Possible
-TPM Spec Version: 1.38
-TPM Errata Date: Wednesday, December 18, 2019
-PC Client Version: 1.04
-Lockout Information:
    -Is Locked Out: False
    -Lockout Counter: 0
    -Max Auth Fail: 32
    -Lockout Interval: 7200s
    -Lockout Recovery: 86400s

TPM004.001 Check TPM Clear procedure

Test description

This test aims to verify whether the TPM Clear procedure works properly, starts with running TPM Clear procedure to ensure correct state of ownership.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.
Install the tpm2-tools package: sudo apt install tpm2-tools.

Test steps

Power on the DUT.
Boot into the BIOS.
Enter Device Manager.
Enter TCG2 Configuration.
Scroll down to TPM2 Operation and press Enter.
Choose TPM2 ClearControl(NO) + Clear.
Save and Reboot.
When prompted, press F12 to clear the TPM.
Boot into the system.
Log into the system by using the proper login and password.

Open the terminal and run the following commands to take ownership over TPM2:

tpm2_changeauth --quiet -c owner pass
tpm2_changeauth --quiet -c lockout pass
tpm2_createprimary -Q --hierarchy=o --key-context=/tmp/test --key-auth=pass2 -P pass
tpm2_evictcontrol -Q -C o -P pass -c /tmp/test 0x81000001
rm /tmp/test

Execute the following commands to check that the ownership is taken:
```
! tpm2_changeauth --quiet -c owner 2>/dev/null
echo $?
```
Reboot the DUT and enter BIOS.
Enter Device Manager.
Enter TCG2 Configuration.
Scroll down to TPM2 Operation and press Enter.
Choose TPM2 ClearControl(NO) + Clear.
Save and Reboot.
When prompted, press F12 to clear the TPM.
Boot into the system and log in.
Execute the commands from step 11.

Expected result

The output in step 11 should be equal 1.
The output in step 21 should be 0.

TPM005.01 Check TPM Hash Algorithm Support SHA1 (Firmware)

Test description

This test aims to verify that the TPM supports needed hash algorithm (SHA1).

Test configuration data

FIRMWARE = Dasharo

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the BIOS.
Enter Device Manager.
Enter TCG2 Configuration
Scroll down to TPM2 Hardware Supported Hash Algorithm

Expected result

The entry should contain SHA1.

TPM005.02 Check TPM Hash Algorithm Support SHA256 (Firmware)

Test description

This test aims to verify that the TPM supports needed hash algorithm (SHA256).

Test configuration data

FIRMWARE = Dasharo

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the BIOS.
Enter Device Manager.
Enter TCG2 Configuration
Scroll down to TPM2 Hardware Supported Hash Algorithm

Expected result

The entry should contain SHA256.

TPM005.03 Check TPM Hash Algorithm Support SHA384 (Firmware)

Test description

This test aims to verify that the TPM supports needed hash algorithm (SHA384).

Test configuration data

FIRMWARE = Dasharo

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the BIOS.
Enter Device Manager.
Enter TCG2 Configuration
Scroll down to TPM2 Hardware Supported Hash Algorithm

Expected result

The entry should contain SHA384.

TPM005.04 Check TPM Hash Algorithm Support SHA512 (Firmware)

Test description

This test aims to verify that the TPM supports needed hash algorithm (SHA512).

Test configuration data

FIRMWARE = Dasharo

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the BIOS.
Enter Device Manager.
Enter TCG2 Configuration
Scroll down to TPM2 Hardware Supported Hash Algorithm

Expected result

The entry should contain SHA512.

TPM006.001 Encrypt and Decrypt non-rootfs partition (Ubuntu)

Test description

Test encrypting and decrypting non-rootfs partition using TPM.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.

Test steps

Power on the DUT.
Boot into the system.
Log into the system by using the proper login and password.

Create ext4 formatted LUKS partition with hello-world named file on it using following commands:

fallocate -l 20MB test-partition
dd if=/dev/urandom bs=1 count=32 status=none > key
cryptsetup luksFormat -q --key-file=key test-partition
cryptsetup luksOpen --key-file=key test-partition test-partition
mkfs.ext4 /dev/mapper/test-partition
mount /dev/mapper/test-partition /mnt
touch /mnt/hello-world
umount /dev/mapper/test-partition
cryptsetup luksClose test-partition

Create the sealing object by executing the following commands:

tpm2_createprimary -Q -C o -c prim.ctx
cat key | tpm2_create -Q -g sha256 -u seal.pub -r seal.priv -i- -C prim.ctx
tpm2_load -Q -C prim.ctx -u seal.pub -r seal.priv -n seal.name -c seal.ctx
tpm2_evictcontrol -C o -c seal.ctx 0x81010001
tpm2_unseal -Q -c 0x81010001 > key

Check a file stored on the partition by executing the following commands:

cryptsetup luksOpen ./test-partition --key-file=key test-partition
mount /dev/mapper/test-partition /mnt
ls /mnt | grep hello-world

Clean up by executing the following commands:

umount /mnt
cryptsetup luksClose test-partition
rm -f key seal.* prim.* test-partition
tpm2_evictcontrol -c 0x81010001

Expected result

The output in step 5 should contain hello-world.

TPM007.001 Encrypt and Decrypt rootfs partition (Ubuntu)

Test description

Test encrypting and decrypting rootfs partition using TPM.

Test configuration data

FIRMWARE = Dasharo
OPERATING_SYSTEM = Ubuntu

Test setup

Proceed with the Test cases common documentation section.
This test assumes that there is another Ubuntu with encrypted rootfs connected to the system, so it can be booted and two partitions with specific labels: EFI partition with label ubuntu-enc and rootfs with label encrypted-rootfs.
Install needed packages: sudo apt install tpm2-tools clevis clevis-luks clevis-tpm2 clevis-initramfs

Test steps

Power on the DUT.
Boot into the BIOS.
Enter the Boot Maintenance Manager.
Enter Boot Options.
Enter Add Boot Option.
Enter the ubuntu-enc volume.
Go to <EFI>/<ubuntu> and select shimx64.efi.
Go to Input the description and enter ubuntu-enc-rootfs.
Go to Commit Changes and Exit and press Enter.
Save the changes and reset.
Enter the boot menu and choose the newly added option.
Unlock the rootfs with your password.
Log into the system by using the proper login and password.

Bind clevis by executing the following command:

echo ${UBUNTU_PASSWORD} | clevis luks bind -d /dev/disk/by-label/encrypted-rootfs tpm2 '{"pcr_ids":"0,1,2,3,7"}' -s 1

where ${UBUNTU_PASSWORD} is your password.

Reboot the system.
Wait for the partition to be unlocked.
Log into the system.

Clean up by executing the following command:

clevis luks unbind -d /dev/vda3 -f -s 1

Expected result

In step 12 you should be prompted to unlock the rootfs.
In step 16 the partition should the unlocked automatically.