Skip to contentSkip to conversation

docs: update trusted-encrypted.rst

PATCH In review Coly Li 3 participants 3 messages Aug 17, 2020 – Aug 18, 2020

Subsystems (4)
lore
Share & tools
lore

Coly Li

author
#0 lore raw

PATCH v2 1/1 docs: update trusted-encrypted.rst

The parameters in tmp2 commands are outdated, people are not able to create trusted key by the example commands.

This patch updates the paramerters of tpm2 commands, they are verified by tpm2-tools-4.1 with Linux v5.8 kernel.

Cc Dan Williams <[email protected]>
Cc James Bottomley <[email protected]>
Cc Jarkko Sakkinen <[email protected]>
Cc Mimi Zohar <[email protected]>
Cc Stefan Berger <[email protected]>

---
Changelog:
v2: remove the change of trusted key related operation.
v1: initial version.

 Documentation/security/keys/trusted-encrypted.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
Documentation/security/keys/trusted-encrypted.rst +2 -3
index 9483a7425ad5..1da879a68640 100644
@@ -39,10 +39,9 @@ With the IBM TSS 2 stack::
 
 Or with the Intel TSS 2 stack::
 
-  #> tpm2_createprimary --hierarchy o -G rsa2048 -o key.ctxt
+  #> tpm2_createprimary --hierarchy o -G rsa2048 -c key.ctxt
   [...]
-  handle: 0x800000FF
-  #> tpm2_evictcontrol -c key.ctxt -p 0x81000001
+  #> tpm2_evictcontrol -c key.ctxt 0x81000001
   persistentHandle: 0x81000001
 
 Usage::
Signature · 1 line
2.26.2
Reviewed-by on v2 1/1
#1 lore raw
Quoted 27 lines · Coly Li

The parameters in tmp2 commands are outdated, people are not able to create trusted key by the example commands.

This patch updates the paramerters of tpm2 commands, they are verified by tpm2-tools-4.1 with Linux v5.8 kernel.

Cc Dan Williams <[email protected]>
Cc James Bottomley <[email protected]>
Cc Jarkko Sakkinen <[email protected]>
Cc Mimi Zohar <[email protected]>
Cc Stefan Berger <[email protected]>

---
Changelog:
v2: remove the change of trusted key related operation.
v1: initial version.

  Documentation/security/keys/trusted-encrypted.rst | 5 ++---
  1 file changed, 2 insertions(+), 3 deletions(-)
Documentation/security/keys/trusted-encrypted.rst +0 -0
index 9483a7425ad5..1da879a68640 100644
@@ -39,10 +39,9 @@ With the IBM TSS 2 stack::
 
  Or with the Intel TSS 2 stack::

Documentation/security/keys/trusted-encrypted.rst With the IBM TSS 2 stack:: · line 47

Quoted 10 lines
Documentation/security/keys/trusted-encrypted.rst +2 -3
 
-  #> tpm2_createprimary --hierarchy o -G rsa2048 -o key.ctxt
+  #> tpm2_createprimary --hierarchy o -G rsa2048 -c key.ctxt
[...]
-  handle: 0x800000FF
-  #> tpm2_evictcontrol -c key.ctxt -p 0x81000001
+  #> tpm2_evictcontrol -c key.ctxt 0x81000001
    persistentHandle: 0x81000001
 
  Usage::
Reviewed-by Mimi Zohar Reviewed-by Dave Jiang Acked-by Dan Williams Acked-by Jerry Snitselaar on v2 1/1
#2 lore raw
In reply to Coly Li
Quoted 2 lines · Coly Li

The parameters in tmp2 commands are outdated, people are not able to create trusted key by the example commands.

Please write acronyms in capitals (e.g. TPM2).

Quoted 1 line

This patch updates the paramerters of tpm2 commands, they are verified

~~~~~~~~~~~
parameters, did you run checkpatch.pl?

Ditto.

Quoted 1 line

by tpm2-tools-4.1 with Linux v5.8 kernel.

The preffered form is to write as "Update the parameters..." (in any kernel patch) when possible.

I have to say that I don't know how to interpret either of the sentences in the long description. I don't understand how I should comprehend the change that you are making from all of this.

Also, I don't understand how Linux v5.8 relates to this.

Finally, we have multiple TPM user space.

Maybe you want to start with like

Intel TSS since v4.1 requires to add '-p' before the keyhandle when invoking tpm2_evictcontrol utility program because <...>. <And then describe in imperative form what you want to do>

BTW, this claim does not look right:

"The user must first create a storage key and make it persistent, so the key is available after reboot. This can be done using the following commands."

First, storage key is not a primary key, i.e. wrong wording is used. Secondly, afaik you don't *have to* make a primary key persistent. You can export it to dram and load when you need it.

Thirdly, no warning of any sort that you should prefer not to use persistent keys for kernel testing, which is I think the worst issue in this documentation.

This is the failing commit:

commit 4264f27a0815c46dfda9c9dd6d5f4abc1df04415

Author: Stefan Berger <[email protected]>
Date:   Fri Oct 19 06:17:58 2018 -0400

docs: Extend trusted keys documentation for TPM 2.0

Extend the documentation for trusted keys with documentation for how to set up a key for a TPM 2.0 so it can be used with a TPM 2.0 as well.

/Jarkko

Quoted 34 lines
Cc Dan Williams <[email protected]>
Cc James Bottomley <[email protected]>
Cc Jarkko Sakkinen <[email protected]>
Cc Mimi Zohar <[email protected]>
Cc Stefan Berger <[email protected]>

---
Changelog:
v2: remove the change of trusted key related operation.
v1: initial version.

 Documentation/security/keys/trusted-encrypted.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
Documentation/security/keys/trusted-encrypted.rst +2 -3
index 9483a7425ad5..1da879a68640 100644
@@ -39,10 +39,9 @@ With the IBM TSS 2 stack::
 
 Or with the Intel TSS 2 stack::
 
-  #> tpm2_createprimary --hierarchy o -G rsa2048 -o key.ctxt
+  #> tpm2_createprimary --hierarchy o -G rsa2048 -c key.ctxt
[...]
-  handle: 0x800000FF
-  #> tpm2_evictcontrol -c key.ctxt -p 0x81000001
+  #> tpm2_evictcontrol -c key.ctxt 0x81000001
   persistentHandle: 0x81000001
 
 Usage::
Signature · 1 line
2.26.2