tpm: Relocate buf->handles to appropriate place
Subsystems (5)
Jarkko Sakkinen
maintainerPATCH v3 1/1 tpm: Relocate buf->handles to appropriate place
tpm_buf_append_name() has the following snippet in the beginning:
if (!tpm2_chip_auth(chip)) {
tpm_buf_append_u32(buf, handle);
/* count the number of handles in the upper bits of flags */
buf->handles++;
return;
}The claim in the comment is wrong, and the comment is in the wrong place as alignment in this case should not anyway be a concern of the call site. In essence the comment is lying about the code, and thus needs to be adressed.
Further, 'handles' was incorrectly place to struct tpm_buf, as tpm-buf.c does manage its state. It is easy to grep that only piece of code that actually uses the field is tpm2-sessions.c.
Address the issues by moving the variable to struct tpm_chip.
v3:
* Reset chip->handles in the beginning of tpm2_start_auth_session() so that it shows correct value, when TCG_TPM2_HMAC is enabled but tpm2_sessions_init() has never been called.
v2:
* Was a bit more broken than I first thought, as 'handles' is only useful for tpm2-sessions.c and has zero relation to tpm-buf.c.
--- drivers/char/tpm/tpm-buf.c | 1 - drivers/char/tpm/tpm2-cmd.c | 2 +- drivers/char/tpm/tpm2-sessions.c | 7 ++++--- include/linux/tpm.h | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-)
drivers/char/tpm/tpm-buf.c +0 -1
@@ -44,7 +44,6 @@ void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal) head->tag =cpu_to_be16 (tag); head->length =cpu_to_be32 (sizeof (*head)); head->ordinal =cpu_to_be32 (ordinal); - buf->handles =0 ; }EXPORT_SYMBOL_GPL (tpm_buf_reset);
drivers/char/tpm/tpm2-cmd.c +1 -1
@@ -776,7 +776,7 @@ int tpm2_auto_startup(struct tpm_chip *chip)if (rc) goto out; - rc =tpm2_sessions_init (chip); +/* rc = tpm2_sessions_init(chip); */ out:/*
drivers/char/tpm/tpm2-sessions.c +4 -3
@@ -238,8 +238,7 @@ void tpm_buf_append_name(struct tpm_chip *chip, struct tpm_buf *buf,if (!tpm2_chip_auth (chip)) {tpm_buf_append_u32 (buf, handle); -/* count the number of handles in the upper bits of flags */ - buf->handles++; + chip->handles++;return ; }
@@ -310,7 +309,7 @@ void tpm_buf_append_hmac_session(struct tpm_chip *chip, struct tpm_buf *buf,if (!tpm2_chip_auth (chip)) {/* offset tells us where the sessions area begins */ -int offset = buf->handles *4 +TPM_HEADER_SIZE ; +int offset = chip->handles *4 +TPM_HEADER_SIZE ;u32 len =9 + passphrase_len;if (tpm_buf_length (buf) != offset) {
@@ -963,6 +962,8 @@ int tpm2_start_auth_session(struct tpm_chip *chip)int rc;u32 null_key; + chip->handles =0 ; +if (!auth) {dev_warn_once (&chip->dev,"auth session is not active\n" );return 0 ;
include/linux/tpm.h +4 -4
@@ -202,9 +202,9 @@ struct tpm_chip {/* active locality */ int locality; +/* handle count for session: */ +u8 handles;#ifdef CONFIG_TCG_TPM2_HMAC -/* details for communication security via sessions */ -/* saved context for NULL seed */ u8 null_key_context[TPM2_MAX_CONTEXT_SIZE ];/* name of NULL seed */
@@ -377,7 +377,6 @@ struct tpm_buf {u32 flags;u32 length;u8 *data; -u8 handles; };enum tpm2_object_attributes {
@@ -517,7 +516,7 @@ static inline void tpm_buf_append_hmac_session_opt(struct tpm_chip *chip,if (tpm2_chip_auth (chip)) {tpm_buf_append_hmac_session (chip, buf, attributes, passphrase, passphraselen); }else { - offset = buf->handles *4 +TPM_HEADER_SIZE ; + offset = chip->handles *4 +TPM_HEADER_SIZE ; head = (struct tpm_header *)buf->data;/*
@@ -541,6 +540,7 @@ void tpm2_end_auth_session(struct tpm_chip *chip);static inline int tpm2_start_auth_session (struct tpm_chip *chip) { + chip->handles =0 ;return 0 ; }static inline void tpm2_end_auth_session (struct tpm_chip *chip)
Signature · 1 line
2.45.2
Jarkko Sakkinen
maintainerQuoted 18 lines · Jarkko Sakkinen
tpm_buf_append_name()has the following snippet in the beginning:if (!tpm2_chip_auth(chip)) { tpm_buf_append_u32(buf, handle); /* count the number of handles in the upper bits of flags */ buf->handles++; return; }The claim in the comment is wrong, and the comment is in the wrong place as alignment in this case should not anyway be a concern of the call site. In essence the comment is lying about the code, and thus needs to be adressed.
Further, 'handles' was incorrectly place to struct
tpm_buf, astpm-buf.cdoes manage its state. It is easy to grep that only piece of code that actually uses the field istpm2-sessions.c.
Quoted 6 lines
Address the issues by moving the variable to struct
tpm_chip.Cc [email protected] # v6.10+Fixes 699e3efd6c64 ("tpm: Add HMAC session start and end functions")Signed-off-by Jarkko Sakkinen <[email protected]>
Dashes missing but I can fix that when I apply this. Just like to keep change log in git and I add the dashes before sending...
Quoted 8 lines
v3:
* Resetchip->handlesin the beginning oftpm2_start_auth_session()so that it shows correct value, whenTCG_TPM2_HMACis enabled buttpm2_sessions_init()has never been called.
v2:
* Was a bit more broken than I first thought, as 'handles' is only useful fortpm2-sessions.cand has zero relation totpm-buf.c.
---
BR, Jarkko
James Bottomley
maintainerOn Tue, 2024-07-16 at 21:52 +0300, Jarkko Sakkinen wrote:
[...]
Quoted 5 lines
Further, 'handles' was incorrectly place to struct
tpm_buf, as tpm-buf.cdoes manage its state. It is easy to grep that only piece of code that actually uses the field istpm2-sessions.c.Address the issues by moving the variable to struct
tpm_chip.
That's really not a good idea, you should keep counts local to the structures they're counting, not elsewhere.
tpm_buf->handles counts the number of handles present in the command encoded in a particular tpm_buf. Right at the moment we only ever construct one tpm_buf per tpm (i.e. per tpm_chip) at any one time, so you can get away with moving handles into tpm_chip. If we ever constructed more than one tpm_buf per chip, the handles count would become corrupted.
James
Jarkko Sakkinen
maintainerQuoted 11 lines · James Bottomley
On Tue, 2024-07-16 at 21:52 +0300, Jarkko Sakkinen wrote:
[...]Quoted 5 lines
Further, 'handles' was incorrectly place to struct
tpm_buf, as tpm-buf.cdoes manage its state. It is easy to grep that only piece of code that actually uses the field istpm2-sessions.c.Address the issues by moving the variable to struct
tpm_chip.That's really not a good idea, you should keep counts local to the structures they're counting, not elsewhere.
Quoted 6 lines
tpm_buf->handlescounts the number of handles present in the command encoded in a particular tpm_buf. Right at the moment we only ever construct onetpm_bufper tpm (i.e. pertpm_chip) at any one time, so you can get away with moving handles into tpm_chip. If we ever constructed more than onetpm_bufper chip, the handles count would become corrupted.
It is not an idea. That count is in the wrong place. Buffer code has no use for it.
BR, Jarkko
Jarkko Sakkinen
maintainerQuoted 19 lines · Jarkko Sakkinen
Quoted 11 lines · James Bottomley
On Tue, 2024-07-16 at 21:52 +0300, Jarkko Sakkinen wrote:
[...]Quoted 5 lines
Further, 'handles' was incorrectly place to struct
tpm_buf, as tpm-buf.cdoes manage its state. It is easy to grep that only piece of code that actually uses the field istpm2-sessions.c.Address the issues by moving the variable to struct
tpm_chip.That's really not a good idea, you should keep counts local to the structures they're counting, not elsewhere.
Quoted 6 lines
tpm_buf->handlescounts the number of handles present in the command encoded in a particular tpm_buf. Right at the moment we only ever construct onetpm_bufper tpm (i.e. pertpm_chip) at any one time, so you can get away with moving handles into tpm_chip. If we ever constructed more than onetpm_bufper chip, the handles count would become corrupted.
Quoted 2 lines
It is not an idea. That count is in the wrong place. Buffer code has no use for it.
Also you are misleading here again. Depending on context tpm_buf stores different data, including handles.
BR, Jarkko
Jarkko Sakkinen
maintainerQuoted 20 lines · Jarkko Sakkinen
Quoted 19 lines · Jarkko Sakkinen
Quoted 17 lines · James Bottomley
On Tue, 2024-07-16 at 21:52 +0300, Jarkko Sakkinen wrote:
[...]Quoted 5 lines
Further, 'handles' was incorrectly place to struct
tpm_buf, as tpm-buf.cdoes manage its state. It is easy to grep that only piece of code that actually uses the field istpm2-sessions.c.Address the issues by moving the variable to struct
tpm_chip.That's really not a good idea, you should keep counts local to the structures they're counting, not elsewhere.
tpm_buf->handlescounts the number of handles present in the command encoded in a particular tpm_buf. Right at the moment we only ever construct onetpm_bufper tpm (i.e. pertpm_chip) at any one time, so you can get away with moving handles into tpm_chip. If we ever constructed more than onetpm_bufper chip, the handles count would become corrupted.
Quoted 5 lines
Quoted 2 lines
It is not an idea. That count is in the wrong place. Buffer code has no use for it.
Also you are misleading here again. Depending on context
tpm_bufstores different data, including handles.
These false claims can be also proved wrong by trivial git grep, which clearly shows its scope.
BR, Jarkko
Quoted 55 lines · Jarkko Sakkinen
tpm_buf_append_name()has the following snippet in the beginning:if (!tpm2_chip_auth(chip)) { tpm_buf_append_u32(buf, handle); /* count the number of handles in the upper bits of flags */ buf->handles++; return; }The claim in the comment is wrong, and the comment is in the wrong place as alignment in this case should not anyway be a concern of the call site. In essence the comment is lying about the code, and thus needs to be adressed.
Further, 'handles' was incorrectly place to struct
tpm_buf, astpm-buf.cdoes manage its state. It is easy to grep that only piece of code that actually uses the field istpm2-sessions.c.Address the issues by moving the variable to struct
tpm_chip.Cc [email protected] # v6.10+Fixes 699e3efd6c64 ("tpm: Add HMAC session start and end functions")Signed-off-by Jarkko Sakkinen <[email protected]>v3:
* Resetchip->handlesin the beginning oftpm2_start_auth_session()so that it shows correct value, whenTCG_TPM2_HMACis enabled buttpm2_sessions_init()has never been called.
v2:
* Was a bit more broken than I first thought, as 'handles' is only useful fortpm2-sessions.cand has zero relation totpm-buf.c.--- drivers/char/tpm/tpm-buf.c | 1 - drivers/char/tpm/tpm2-cmd.c | 2 +- drivers/char/tpm/tpm2-sessions.c | 7 ++++--- include/linux/tpm.h | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-)drivers/char/tpm/tpm-buf.c +0
-1@@ -44,7 +44,6 @@ void tpm_buf_reset(struct tpm_buf *buf, u16 tag, u32 ordinal) head->tag =cpu_to_be16 (tag); head->length =cpu_to_be32 (sizeof (*head)); head->ordinal =cpu_to_be32 (ordinal); - buf->handles =0 ; }EXPORT_SYMBOL_GPL (tpm_buf_reset);drivers/char/tpm/tpm2-cmd.c +0
-0
drivers/char/tpm/tpm2-cmd.c int tpm2_auto_startup(struct tpm_chip *chip) · line 779
Quoted 5 lines
drivers/char/tpm/tpm2-cmd.c +1
-1@@ -776,7 +776,7 @@ int tpm2_auto_startup(struct tpm_chip *chip)if (rc) goto out; - rc =tpm2_sessions_init (chip); +/* rc = tpm2_sessions_init(chip); */
Left over from testing? Or should be removed entirely?
Quoted 77 lines
drivers/char/tpm/tpm2-cmd.c +0
-0out:/* drivers/char/tpm/tpm2-sessions.c +4
-3@@ -238,8 +238,7 @@ void tpm_buf_append_name(struct tpm_chip *chip, struct tpm_buf *buf,if (!tpm2_chip_auth (chip)) {tpm_buf_append_u32 (buf, handle); -/* count the number of handles in the upper bits of flags */ - buf->handles++; + chip->handles++;return ; }@@ -310,7 +309,7 @@ void tpm_buf_append_hmac_session(struct tpm_chip *chip, struct tpm_buf *buf,if (!tpm2_chip_auth (chip)) {/* offset tells us where the sessions area begins */ -int offset = buf->handles *4 +TPM_HEADER_SIZE ; +int offset = chip->handles *4 +TPM_HEADER_SIZE ;u32 len =9 + passphrase_len;if (tpm_buf_length (buf) != offset) {@@ -963,6 +962,8 @@ int tpm2_start_auth_session(struct tpm_chip *chip)int rc;u32 null_key; + chip->handles =0 ; +if (!auth) {dev_warn_once (&chip->dev,"auth session is not active\n" );return 0 ;include/linux/tpm.h +4
-4@@ -202,9 +202,9 @@ struct tpm_chip {/* active locality */ int locality; +/* handle count for session: */ +u8 handles;#ifdef CONFIG_TCG_TPM2_HMAC -/* details for communication security via sessions */ -/* saved context for NULL seed */ u8 null_key_context[TPM2_MAX_CONTEXT_SIZE ];/* name of NULL seed */ @@ -377,7 +377,6 @@ struct tpm_buf {u32 flags;u32 length;u8 *data; -u8 handles; };enum tpm2_object_attributes {@@ -517,7 +516,7 @@ static inline void tpm_buf_append_hmac_session_opt(struct tpm_chip *chip,if (tpm2_chip_auth (chip)) {tpm_buf_append_hmac_session (chip, buf, attributes, passphrase, passphraselen); }else { - offset = buf->handles *4 +TPM_HEADER_SIZE ; + offset = chip->handles *4 +TPM_HEADER_SIZE ; head = (struct tpm_header *)buf->data;/* @@ -541,6 +540,7 @@ void tpm2_end_auth_session(struct tpm_chip *chip);static inline int tpm2_start_auth_session (struct tpm_chip *chip) { + chip->handles =0 ;return 0 ; }static inline void tpm2_end_auth_session (struct tpm_chip *chip)Signature · 1 line
2.45.2
J.
Signature · 2 lines
"I'm not anti-establishment, I just don't see the point." -- Matthew Kirkwood, OxLUG mailing list.
Quoted 1 line · Jonathan McDowell
Left over from testing? Or should be removed entirely?
Yes. You're right. I noticed it too yesterday, but I'll probably postpone this patch after holidays and since it is only cosmetic fix, it can be included to any feature patch set for hmac.
Thanks for the remark however! I'll revisit these when the patch is needed.
BR, Jarkko