tpm: use tpm_buf in tpm_transmit_cmd() as the IO parameter

Since we pass an initialized struct tpm_buf instance in every call site
now, it is cleaner to pass that directly to the tpm_transmit_cmd() as
the TPM command/response buffer.

Fine-tune a little bit tpm_transmit() and tpm_transmit_cmd() comments
while doing this.

Signed-off-by: Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
Reviewed-by: Stefan Berger <stefanb@linux.ibm.com>
Tested-by: Stefan Berger <stefanb@linux.ibm.com>
Reviewed-by: Jerry Snitselaar <jsnitsel@redhat.com>
Reviewed-by: James Bottomley <James.Bottomley@HansenPartnership.com>
Tested-by: Alexander Steffen <Alexander.Steffen@infineon.com>
This commit is contained in:
Jarkko Sakkinen 2018-10-26 14:34:22 +01:00
parent 36ce089758
commit 412eb58558
7 changed files with 64 additions and 80 deletions

View File

@ -307,23 +307,22 @@ out_locality:
/** /**
* tpm_transmit - Internal kernel interface to transmit TPM commands. * tpm_transmit - Internal kernel interface to transmit TPM commands.
* @chip: a TPM chip to use
* @space: a TPM space
* @buf: a TPM command buffer
* @bufsiz: length of the TPM command buffer
* @flags: TPM transmit flags
* *
* @chip: TPM chip to use * A wrapper around tpm_try_transmit() that handles TPM2_RC_RETRY returns from
* @space: tpm space * the TPM and retransmits the command after a delay up to a maximum wait of
* @buf: TPM command buffer * TPM2_DURATION_LONG.
* @bufsiz: length of the TPM command buffer
* @flags: tpm transmit flags - bitmap
* *
* A wrapper around tpm_try_transmit that handles TPM2_RC_RETRY * Note that TPM 1.x never returns TPM2_RC_RETRY so the retry logic is TPM 2.0
* returns from the TPM and retransmits the command after a delay up * only.
* to a maximum wait of TPM2_DURATION_LONG.
*
* Note: TPM1 never returns TPM2_RC_RETRY so the retry logic is TPM2
* only
* *
* Return: * Return:
* the length of the return when the operation is successful. * * The response length - OK
* A negative number for system errors (errno). * * -errno - A system error
*/ */
ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space, ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
u8 *buf, size_t bufsiz, unsigned int flags) u8 *buf, size_t bufsiz, unsigned int flags)
@ -374,33 +373,31 @@ ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
} }
return ret; return ret;
} }
/** /**
* tpm_transmit_cmd - send a tpm command to the device * tpm_transmit_cmd - send a tpm command to the device
* The function extracts tpm out header return code * @chip: a TPM chip to use
* * @space: a TPM space
* @chip: TPM chip to use * @buf: a TPM command buffer
* @space: tpm space * @min_rsp_body_length: minimum expected length of response body
* @buf: TPM command buffer * @flags: TPM transmit flags
* @bufsiz: length of the buffer * @desc: command description used in the error message
* @min_rsp_body_length: minimum expected length of response body
* @flags: tpm transmit flags - bitmap
* @desc: command description used in the error message
* *
* Return: * Return:
* 0 when the operation is successful. * * 0 - OK
* A negative number for system errors (errno). * * -errno - A system error
* A positive number for a TPM error. * * TPM_RC - A TPM error
*/ */
ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space, ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
void *buf, size_t bufsiz, struct tpm_buf *buf, size_t min_rsp_body_length,
size_t min_rsp_body_length, unsigned int flags, unsigned int flags, const char *desc)
const char *desc)
{ {
const struct tpm_output_header *header = buf; const struct tpm_output_header *header =
(struct tpm_output_header *)buf->data;
int err; int err;
ssize_t len; ssize_t len;
len = tpm_transmit(chip, space, buf, bufsiz, flags); len = tpm_transmit(chip, space, buf->data, PAGE_SIZE, flags);
if (len < 0) if (len < 0)
return len; return len;
@ -537,14 +534,22 @@ EXPORT_SYMBOL_GPL(tpm_pcr_extend);
*/ */
int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen) int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen)
{ {
struct tpm_buf buf;
int rc; int rc;
chip = tpm_find_get_ops(chip); chip = tpm_find_get_ops(chip);
if (!chip) if (!chip)
return -ENODEV; return -ENODEV;
rc = tpm_transmit_cmd(chip, NULL, cmd, buflen, 0, 0, rc = tpm_buf_init(&buf, 0, 0);
if (rc)
goto out;
memcpy(buf.data, cmd, buflen);
rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0,
"attempting to a send a command"); "attempting to a send a command");
tpm_buf_destroy(&buf);
out:
tpm_put_ops(chip); tpm_put_ops(chip);
return rc; return rc;
} }

View File

@ -53,7 +53,7 @@ static ssize_t pubek_show(struct device *dev, struct device_attribute *attr,
tpm_buf_append(&tpm_buf, anti_replay, sizeof(anti_replay)); tpm_buf_append(&tpm_buf, anti_replay, sizeof(anti_replay));
rc = tpm_transmit_cmd(chip, NULL, tpm_buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &tpm_buf,
READ_PUBEK_RESULT_MIN_BODY_SIZE, 0, READ_PUBEK_RESULT_MIN_BODY_SIZE, 0,
"attempting to read the PUBEK"); "attempting to read the PUBEK");
if (rc) { if (rc) {

View File

@ -503,9 +503,8 @@ enum tpm_transmit_flags {
ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space, ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
u8 *buf, size_t bufsiz, unsigned int flags); u8 *buf, size_t bufsiz, unsigned int flags);
ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space, ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
void *buf, size_t bufsiz, struct tpm_buf *buf, size_t min_rsp_body_length,
size_t min_rsp_body_length, unsigned int flags, unsigned int flags, const char *desc);
const char *desc);
int tpm_get_timeouts(struct tpm_chip *); int tpm_get_timeouts(struct tpm_chip *);
int tpm_auto_startup(struct tpm_chip *chip); int tpm_auto_startup(struct tpm_chip *chip);

View File

@ -334,11 +334,9 @@ static int tpm1_startup(struct tpm_chip *chip)
tpm_buf_append_u16(&buf, TPM_ST_CLEAR); tpm_buf_append_u16(&buf, TPM_ST_CLEAR);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0,
"attempting to start the TPM"); "attempting to start the TPM");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
return rc; return rc;
} }
@ -461,9 +459,7 @@ int tpm1_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, const u8 *hash,
tpm_buf_append_u32(&buf, pcr_idx); tpm_buf_append_u32(&buf, pcr_idx);
tpm_buf_append(&buf, hash, TPM_DIGEST_SIZE); tpm_buf_append(&buf, hash, TPM_DIGEST_SIZE);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf, TPM_DIGEST_SIZE, 0, log_msg);
TPM_DIGEST_SIZE, 0, log_msg);
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
return rc; return rc;
} }
@ -493,11 +489,9 @@ ssize_t tpm1_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
tpm_buf_append_u32(&buf, 4); tpm_buf_append_u32(&buf, 4);
tpm_buf_append_u32(&buf, subcap_id); tpm_buf_append_u32(&buf, subcap_id);
} }
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf, min_cap_length, 0, desc);
min_cap_length, 0, desc);
if (!rc) if (!rc)
*cap = *(cap_t *)&buf.data[TPM_HEADER_SIZE + 4]; *cap = *(cap_t *)&buf.data[TPM_HEADER_SIZE + 4];
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
return rc; return rc;
} }
@ -536,7 +530,7 @@ int tpm1_get_random(struct tpm_chip *chip, u8 *dest, size_t max)
do { do {
tpm_buf_append_u32(&buf, num_bytes); tpm_buf_append_u32(&buf, num_bytes);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf,
sizeof(out->rng_data_len), 0, sizeof(out->rng_data_len), 0,
"attempting get random"); "attempting get random");
if (rc) if (rc)
@ -582,8 +576,7 @@ int tpm1_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf)
tpm_buf_append_u32(&buf, pcr_idx); tpm_buf_append_u32(&buf, pcr_idx);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf, TPM_DIGEST_SIZE, 0,
TPM_DIGEST_SIZE, 0,
"attempting to read a pcr value"); "attempting to read a pcr value");
if (rc) if (rc)
goto out; goto out;
@ -617,11 +610,8 @@ static int tpm1_continue_selftest(struct tpm_chip *chip)
if (rc) if (rc)
return rc; return rc;
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0, "continue selftest");
0, 0, "continue selftest");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
return rc; return rc;
} }
@ -746,9 +736,7 @@ int tpm1_pm_suspend(struct tpm_chip *chip, u32 tpm_suspend_pcr)
return rc; return rc;
/* now do the actual savestate */ /* now do the actual savestate */
for (try = 0; try < TPM_RETRY; try++) { for (try = 0; try < TPM_RETRY; try++) {
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0, NULL);
0, 0, NULL);
/* /*
* If the TPM indicates that it is too busy to respond to * If the TPM indicates that it is too busy to respond to
* this command then retry before giving up. It can take * this command then retry before giving up. It can take

View File

@ -197,8 +197,8 @@ int tpm2_pcr_read(struct tpm_chip *chip, u32 pcr_idx, u8 *res_buf)
tpm_buf_append(&buf, (const unsigned char *)pcr_select, tpm_buf_append(&buf, (const unsigned char *)pcr_select,
sizeof(pcr_select)); sizeof(pcr_select));
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0, res_buf ?
res_buf ? "attempting to read a pcr value" : NULL); "attempting to read a pcr value" : NULL);
if (rc == 0 && res_buf) { if (rc == 0 && res_buf) {
out = (struct tpm2_pcr_read_out *)&buf.data[TPM_HEADER_SIZE]; out = (struct tpm2_pcr_read_out *)&buf.data[TPM_HEADER_SIZE];
memcpy(res_buf, out->digest, SHA1_DIGEST_SIZE); memcpy(res_buf, out->digest, SHA1_DIGEST_SIZE);
@ -264,7 +264,7 @@ int tpm2_pcr_extend(struct tpm_chip *chip, u32 pcr_idx, u32 count,
} }
} }
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0,
"attempting extend a PCR value"); "attempting extend a PCR value");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
@ -309,7 +309,7 @@ int tpm2_get_random(struct tpm_chip *chip, u8 *dest, size_t max)
do { do {
tpm_buf_reset(&buf, TPM2_ST_NO_SESSIONS, TPM2_CC_GET_RANDOM); tpm_buf_reset(&buf, TPM2_ST_NO_SESSIONS, TPM2_CC_GET_RANDOM);
tpm_buf_append_u16(&buf, num_bytes); tpm_buf_append_u16(&buf, num_bytes);
err = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, err = tpm_transmit_cmd(chip, NULL, &buf,
offsetof(struct tpm2_get_random_out, offsetof(struct tpm2_get_random_out,
buffer), buffer),
0, "attempting get random"); 0, "attempting get random");
@ -362,9 +362,7 @@ void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
tpm_buf_append_u32(&buf, handle); tpm_buf_append_u32(&buf, handle);
(void) tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, flags, tpm_transmit_cmd(chip, NULL, &buf, 0, flags, "flushing context");
"flushing context");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
} }
@ -478,8 +476,7 @@ int tpm2_seal_trusted(struct tpm_chip *chip,
goto out; goto out;
} }
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 4, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 4, 0, "sealing data");
"sealing data");
if (rc) if (rc)
goto out; goto out;
@ -561,8 +558,7 @@ static int tpm2_load_cmd(struct tpm_chip *chip,
goto out; goto out;
} }
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 4, flags, rc = tpm_transmit_cmd(chip, NULL, &buf, 4, flags, "loading blob");
"loading blob");
if (!rc) if (!rc)
*blob_handle = be32_to_cpup( *blob_handle = be32_to_cpup(
(__be32 *) &buf.data[TPM_HEADER_SIZE]); (__be32 *) &buf.data[TPM_HEADER_SIZE]);
@ -612,8 +608,7 @@ static int tpm2_unseal_cmd(struct tpm_chip *chip,
options->blobauth /* hmac */, options->blobauth /* hmac */,
TPM_DIGEST_SIZE); TPM_DIGEST_SIZE);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 6, flags, rc = tpm_transmit_cmd(chip, NULL, &buf, 6, flags, "unsealing");
"unsealing");
if (rc > 0) if (rc > 0)
rc = -EPERM; rc = -EPERM;
@ -703,7 +698,7 @@ ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id, u32 *value,
tpm_buf_append_u32(&buf, TPM2_CAP_TPM_PROPERTIES); tpm_buf_append_u32(&buf, TPM2_CAP_TPM_PROPERTIES);
tpm_buf_append_u32(&buf, property_id); tpm_buf_append_u32(&buf, property_id);
tpm_buf_append_u32(&buf, 1); tpm_buf_append_u32(&buf, 1);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, NULL); rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0, NULL);
if (!rc) { if (!rc) {
out = (struct tpm2_get_cap_out *) out = (struct tpm2_get_cap_out *)
&buf.data[TPM_HEADER_SIZE]; &buf.data[TPM_HEADER_SIZE];
@ -733,8 +728,7 @@ void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type)
if (rc) if (rc)
return; return;
tpm_buf_append_u16(&buf, shutdown_type); tpm_buf_append_u16(&buf, shutdown_type);
tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, tpm_transmit_cmd(chip, NULL, &buf, 0, 0, "stopping the TPM");
"stopping the TPM");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
} }
@ -763,7 +757,7 @@ static int tpm2_do_selftest(struct tpm_chip *chip)
return rc; return rc;
tpm_buf_append_u8(&buf, full); tpm_buf_append_u8(&buf, full);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0,
"attempting the self test"); "attempting the self test");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
@ -800,7 +794,7 @@ int tpm2_probe(struct tpm_chip *chip)
tpm_buf_append_u32(&buf, TPM2_CAP_TPM_PROPERTIES); tpm_buf_append_u32(&buf, TPM2_CAP_TPM_PROPERTIES);
tpm_buf_append_u32(&buf, TPM_PT_TOTAL_COMMANDS); tpm_buf_append_u32(&buf, TPM_PT_TOTAL_COMMANDS);
tpm_buf_append_u32(&buf, 1); tpm_buf_append_u32(&buf, 1);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, NULL); rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0, NULL);
/* We ignore TPM return codes on purpose. */ /* We ignore TPM return codes on purpose. */
if (rc >= 0) { if (rc >= 0) {
out = (struct tpm_output_header *)buf.data; out = (struct tpm_output_header *)buf.data;
@ -839,7 +833,7 @@ static ssize_t tpm2_get_pcr_allocation(struct tpm_chip *chip)
tpm_buf_append_u32(&buf, 0); tpm_buf_append_u32(&buf, 0);
tpm_buf_append_u32(&buf, 1); tpm_buf_append_u32(&buf, 1);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 9, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 9, 0,
"get tpm pcr allocation"); "get tpm pcr allocation");
if (rc) if (rc)
goto out; goto out;
@ -911,8 +905,7 @@ static int tpm2_get_cc_attrs_tbl(struct tpm_chip *chip)
tpm_buf_append_u32(&buf, TPM2_CC_FIRST); tpm_buf_append_u32(&buf, TPM2_CC_FIRST);
tpm_buf_append_u32(&buf, nr_commands); tpm_buf_append_u32(&buf, nr_commands);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, rc = tpm_transmit_cmd(chip, NULL, &buf, 9 + 4 * nr_commands, 0, NULL);
9 + 4 * nr_commands, 0, NULL);
if (rc) { if (rc) {
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);
goto out; goto out;
@ -969,7 +962,7 @@ static int tpm2_startup(struct tpm_chip *chip)
return rc; return rc;
tpm_buf_append_u16(&buf, TPM2_SU_CLEAR); tpm_buf_append_u16(&buf, TPM2_SU_CLEAR);
rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, 0,
"attempting to start the TPM"); "attempting to start the TPM");
tpm_buf_destroy(&buf); tpm_buf_destroy(&buf);

View File

@ -83,7 +83,7 @@ static int tpm2_load_context(struct tpm_chip *chip, u8 *buf,
body_size = sizeof(*ctx) + be16_to_cpu(ctx->blob_size); body_size = sizeof(*ctx) + be16_to_cpu(ctx->blob_size);
tpm_buf_append(&tbuf, &buf[*offset], body_size); tpm_buf_append(&tbuf, &buf[*offset], body_size);
rc = tpm_transmit_cmd(chip, NULL, tbuf.data, PAGE_SIZE, 4, rc = tpm_transmit_cmd(chip, NULL, &tbuf, 4,
TPM_TRANSMIT_NESTED, NULL); TPM_TRANSMIT_NESTED, NULL);
if (rc < 0) { if (rc < 0) {
dev_warn(&chip->dev, "%s: failed with a system error %d\n", dev_warn(&chip->dev, "%s: failed with a system error %d\n",
@ -132,7 +132,7 @@ static int tpm2_save_context(struct tpm_chip *chip, u32 handle, u8 *buf,
tpm_buf_append_u32(&tbuf, handle); tpm_buf_append_u32(&tbuf, handle);
rc = tpm_transmit_cmd(chip, NULL, tbuf.data, PAGE_SIZE, 0, rc = tpm_transmit_cmd(chip, NULL, &tbuf, 0,
TPM_TRANSMIT_NESTED, NULL); TPM_TRANSMIT_NESTED, NULL);
if (rc < 0) { if (rc < 0) {
dev_warn(&chip->dev, "%s: failed with a system error %d\n", dev_warn(&chip->dev, "%s: failed with a system error %d\n",

View File

@ -416,8 +416,7 @@ static int vtpm_proxy_request_locality(struct tpm_chip *chip, int locality)
proxy_dev->state |= STATE_DRIVER_COMMAND; proxy_dev->state |= STATE_DRIVER_COMMAND;
rc = tpm_transmit_cmd(chip, NULL, buf.data, tpm_buf_length(&buf), 0, rc = tpm_transmit_cmd(chip, NULL, &buf, 0, TPM_TRANSMIT_NESTED,
TPM_TRANSMIT_NESTED,
"attempting to set locality"); "attempting to set locality");
proxy_dev->state &= ~STATE_DRIVER_COMMAND; proxy_dev->state &= ~STATE_DRIVER_COMMAND;