src/shared/tpm2-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5
   6 #include "bitfield.h"
   7 #include "io-util.h"
   8 #include "json.h"
   9 #include "macro.h"
  10 #include "openssl-util.h"
  11 #include "sha256.h"
  12 #include "tpm2-pcr.h"
  13
  14 typedef enum TPM2Flags {
  15         TPM2_FLAGS_USE_PIN = 1 << 0,
  16 } TPM2Flags;
  17
  18 /* As per https://trustedcomputinggroup.org/wp-content/uploads/TCG_PCClient_PFP_r1p05_v23_pub.pdf a
  19  * TPM2 on a Client PC must have at least 24 PCRs. This hardcodes our expectation of 24. */
  20 #define TPM2_PCRS_MAX 24U
  21 #define TPM2_PCRS_MASK ((UINT32_C(1) << TPM2_PCRS_MAX) - 1)
  22
  23 /* The SRK handle is defined in the Provisioning Guidance document (see above) in the table "Reserved Handles
  24  * for TPM Provisioning Fundamental Elements". The SRK is useful because it is "shared", meaning it has no
  25  * authValue nor authPolicy set, and thus may be used by anyone on the system to generate derived keys or
  26  * seal secrets. This is useful if the TPM has an auth (password) set for the 'owner hierarchy', which would
  27  * prevent users from generating primary transient keys, unless they knew the owner hierarchy auth. See
  28  * the Provisioning Guidance document for more details. */
  29 #define TPM2_SRK_HANDLE UINT32_C(0x81000001)
  30
  31 static inline bool TPM2_PCR_INDEX_VALID(unsigned pcr) {
  32         return pcr < TPM2_PCRS_MAX;
  33 }
  34 static inline bool TPM2_PCR_MASK_VALID(uint32_t pcr_mask) {
  35         return pcr_mask <= TPM2_PCRS_MASK;
  36 }
  37
  38 #define FOREACH_PCR_IN_MASK(pcr, mask) BIT_FOREACH(pcr, mask)
  39
  40 #if HAVE_TPM2
  41
  42 #include <tss2/tss2_esys.h>
  43 #include <tss2/tss2_mu.h>
  44 #include <tss2/tss2_rc.h>
  45
  46 int dlopen_tpm2(void);
  47
  48 typedef struct {
  49         unsigned n_ref;
  50
  51         void *tcti_dl;
  52         TSS2_TCTI_CONTEXT *tcti_context;
  53         ESYS_CONTEXT *esys_context;
  54
  55         /* Some selected cached capabilities of the TPM */
  56         TPMS_ALG_PROPERTY *capability_algorithms;
  57         size_t n_capability_algorithms;
  58         TPMA_CC *capability_commands;
  59         size_t n_capability_commands;
  60         TPM2_ECC_CURVE *capability_ecc_curves;
  61         size_t n_capability_ecc_curves;
  62         TPML_PCR_SELECTION capability_pcrs;
  63 } Tpm2Context;
  64
  65 int tpm2_context_new(const char *device, Tpm2Context **ret_context);
  66 Tpm2Context *tpm2_context_ref(Tpm2Context *context);
  67 Tpm2Context *tpm2_context_unref(Tpm2Context *context);
  68 DEFINE_TRIVIAL_CLEANUP_FUNC(Tpm2Context*, tpm2_context_unref);
  69
  70 typedef struct {
  71         Tpm2Context *tpm2_context;
  72         ESYS_TR esys_handle;
  73
  74         bool flush;
  75 } Tpm2Handle;
  76
  77 #define _tpm2_handle(c, h) { .tpm2_context = (c), .esys_handle = (h), }
  78 static const Tpm2Handle TPM2_HANDLE_NONE = _tpm2_handle(NULL, ESYS_TR_NONE);
  79
  80 void Esys_Freep(void *p);
  81
  82 int tpm2_handle_new(Tpm2Context *context, Tpm2Handle **ret_handle);
  83 Tpm2Handle *tpm2_handle_free(Tpm2Handle *handle);
  84 DEFINE_TRIVIAL_CLEANUP_FUNC(Tpm2Handle*, tpm2_handle_free);
  85
  86 typedef struct {
  87         unsigned index;
  88         TPMI_ALG_HASH hash;
  89         TPM2B_DIGEST value;
  90 } Tpm2PCRValue;
  91
  92 #define TPM2_PCR_VALUE_MAKE(i, h, v)                                    \
  93         (Tpm2PCRValue) {                                                \
  94                 .index = (i),                                           \
  95                 .hash = (h),                                            \
  96                 .value = ((TPM2B_DIGEST) v),                            \
  97         }
  98
  99 bool tpm2_pcr_value_valid(const Tpm2PCRValue *pcr_value);
 100 bool tpm2_pcr_values_has_any_values(const Tpm2PCRValue *pcr_values, size_t n_pcr_values);
 101 bool tpm2_pcr_values_has_all_values(const Tpm2PCRValue *pcr_values, size_t n_pcr_values);
 102 int tpm2_pcr_value_from_string(const char *arg, Tpm2PCRValue *ret_pcr_value);
 103 char *tpm2_pcr_value_to_string(const Tpm2PCRValue *pcr_value);
 104
 105 bool tpm2_pcr_values_valid(const Tpm2PCRValue *pcr_values, size_t n_pcr_values);
 106 void tpm2_sort_pcr_values(Tpm2PCRValue *pcr_values, size_t n_pcr_values);
 107 int tpm2_pcr_values_from_mask(uint32_t mask, TPMI_ALG_HASH hash, Tpm2PCRValue **ret_pcr_values, size_t *ret_n_pcr_values);
 108 int tpm2_pcr_values_to_mask(const Tpm2PCRValue *pcr_values, size_t n_pcr_values, TPMI_ALG_HASH hash, uint32_t *ret_mask);
 109 int tpm2_pcr_values_from_string(const char *arg, Tpm2PCRValue **ret_pcr_values, size_t *ret_n_pcr_values);
 110 char *tpm2_pcr_values_to_string(const Tpm2PCRValue *pcr_values, size_t n_pcr_values);
 111 int tpm2_pcr_values_hash_count(const Tpm2PCRValue *pcr_values, size_t n_pcr_values, size_t *ret_count);
 112 int tpm2_tpml_pcr_selection_from_pcr_values(const Tpm2PCRValue *pcr_values, size_t n_pcr_values, TPML_PCR_SELECTION *ret_selection, TPM2B_DIGEST **ret_values, size_t *ret_n_values);
 113
 114 int tpm2_make_encryption_session(Tpm2Context *c, const Tpm2Handle *primary, const Tpm2Handle *bind_key, Tpm2Handle **ret_session);
 115
 116 int tpm2_create_primary(Tpm2Context *c, const Tpm2Handle *session, const TPM2B_PUBLIC *template, const TPM2B_SENSITIVE_CREATE *sensitive, TPM2B_PUBLIC **ret_public, Tpm2Handle **ret_handle);
 117 int tpm2_create(Tpm2Context *c, const Tpm2Handle *parent, const Tpm2Handle *session, const TPMT_PUBLIC *template, const TPMS_SENSITIVE_CREATE *sensitive, TPM2B_PUBLIC **ret_public, TPM2B_PRIVATE **ret_private);
 118 int tpm2_create_loaded(Tpm2Context *c, const Tpm2Handle *parent, const Tpm2Handle *session, const TPMT_PUBLIC *template, const TPMS_SENSITIVE_CREATE *sensitive, TPM2B_PUBLIC **ret_public, TPM2B_PRIVATE **ret_private, Tpm2Handle **ret_handle);
 119 int tpm2_load(Tpm2Context *c, const Tpm2Handle *parent, const Tpm2Handle *session, const TPM2B_PUBLIC *public, const TPM2B_PRIVATE *private, Tpm2Handle **ret_handle);
 120 int tpm2_marshal_private(const TPM2B_PRIVATE *private, void **ret, size_t *ret_size);
 121 int tpm2_unmarshal_private(const void *data, size_t size, TPM2B_PRIVATE *ret_private);
 122 int tpm2_marshal_public(const TPM2B_PUBLIC *public, void **ret, size_t *ret_size);
 123 int tpm2_unmarshal_public(const void *data, size_t size, TPM2B_PUBLIC *ret_public);
 124 int tpm2_marshal_nv_public(const TPM2B_NV_PUBLIC *nv_public, void **ret, size_t *ret_size);
 125 int tpm2_unmarshal_nv_public(const void *data, size_t size, TPM2B_NV_PUBLIC *ret_nv_public);
 126
 127 bool tpm2_supports_alg(Tpm2Context *c, TPM2_ALG_ID alg);
 128 bool tpm2_supports_command(Tpm2Context *c, TPM2_CC command);
 129 bool tpm2_supports_ecc_curve(Tpm2Context *c, TPM2_ECC_CURVE ecc_curve);
 130
 131 bool tpm2_test_parms(Tpm2Context *c, TPMI_ALG_PUBLIC alg, const TPMU_PUBLIC_PARMS *parms);
 132
 133 int tpm2_get_good_pcr_banks(Tpm2Context *c, uint32_t pcr_mask, TPMI_ALG_HASH **ret_banks);
 134 int tpm2_get_good_pcr_banks_strv(Tpm2Context *c, uint32_t pcr_mask, char ***ret);
 135 int tpm2_get_best_pcr_bank(Tpm2Context *c, uint32_t pcr_mask, TPMI_ALG_HASH *ret);
 136
 137 const char *tpm2_userspace_log_path(void);
 138 const char *tpm2_firmware_log_path(void);
 139
 140 typedef enum Tpm2UserspaceEventType {
 141         TPM2_EVENT_PHASE,
 142         TPM2_EVENT_FILESYSTEM,
 143         TPM2_EVENT_VOLUME_KEY,
 144         TPM2_EVENT_MACHINE_ID,
 145         _TPM2_USERSPACE_EVENT_TYPE_MAX,
 146         _TPM2_USERSPACE_EVENT_TYPE_INVALID = -EINVAL,
 147 } Tpm2UserspaceEventType;
 148
 149 const char* tpm2_userspace_event_type_to_string(Tpm2UserspaceEventType type) _const_;
 150 Tpm2UserspaceEventType tpm2_userspace_event_type_from_string(const char *s) _pure_;
 151
 152 int tpm2_extend_bytes(Tpm2Context *c, char **banks, unsigned pcr_index, const void *data, size_t data_size, const void *secret, size_t secret_size, Tpm2UserspaceEventType event, const char *description);
 153
 154 uint32_t tpm2_tpms_pcr_selection_to_mask(const TPMS_PCR_SELECTION *s);
 155 void tpm2_tpms_pcr_selection_from_mask(uint32_t mask, TPMI_ALG_HASH hash, TPMS_PCR_SELECTION *ret);
 156 bool tpm2_tpms_pcr_selection_has_mask(const TPMS_PCR_SELECTION *s, uint32_t mask);
 157 void tpm2_tpms_pcr_selection_add_mask(TPMS_PCR_SELECTION *s, uint32_t mask);
 158 void tpm2_tpms_pcr_selection_sub_mask(TPMS_PCR_SELECTION *s, uint32_t mask);
 159 void tpm2_tpms_pcr_selection_add(TPMS_PCR_SELECTION *a, const TPMS_PCR_SELECTION *b);
 160 void tpm2_tpms_pcr_selection_sub(TPMS_PCR_SELECTION *a, const TPMS_PCR_SELECTION *b);
 161 void tpm2_tpms_pcr_selection_move(TPMS_PCR_SELECTION *a, TPMS_PCR_SELECTION *b);
 162 char *tpm2_tpms_pcr_selection_to_string(const TPMS_PCR_SELECTION *s);
 163 size_t tpm2_tpms_pcr_selection_weight(const TPMS_PCR_SELECTION *s);
 164 #define tpm2_tpms_pcr_selection_is_empty(s) (tpm2_tpms_pcr_selection_weight(s) == 0)
 165
 166 uint32_t tpm2_tpml_pcr_selection_to_mask(const TPML_PCR_SELECTION *l, TPMI_ALG_HASH hash);
 167 void tpm2_tpml_pcr_selection_from_mask(uint32_t mask, TPMI_ALG_HASH hash, TPML_PCR_SELECTION *ret);
 168 bool tpm2_tpml_pcr_selection_has_mask(const TPML_PCR_SELECTION *l, TPMI_ALG_HASH hash, uint32_t mask);
 169 void tpm2_tpml_pcr_selection_add_mask(TPML_PCR_SELECTION *l, TPMI_ALG_HASH hash, uint32_t mask);
 170 void tpm2_tpml_pcr_selection_sub_mask(TPML_PCR_SELECTION *l, TPMI_ALG_HASH hash, uint32_t mask);
 171 void tpm2_tpml_pcr_selection_add_tpms_pcr_selection(TPML_PCR_SELECTION *l, const TPMS_PCR_SELECTION *s);
 172 void tpm2_tpml_pcr_selection_sub_tpms_pcr_selection(TPML_PCR_SELECTION *l, const TPMS_PCR_SELECTION *s);
 173 void tpm2_tpml_pcr_selection_add(TPML_PCR_SELECTION *a, const TPML_PCR_SELECTION *b);
 174 void tpm2_tpml_pcr_selection_sub(TPML_PCR_SELECTION *a, const TPML_PCR_SELECTION *b);
 175 char *tpm2_tpml_pcr_selection_to_string(const TPML_PCR_SELECTION *l);
 176 size_t tpm2_tpml_pcr_selection_weight(const TPML_PCR_SELECTION *l);
 177 #define tpm2_tpml_pcr_selection_is_empty(l) (tpm2_tpml_pcr_selection_weight(l) == 0)
 178
 179 int tpm2_digest_many(TPMI_ALG_HASH alg, TPM2B_DIGEST *digest, const struct iovec data[], size_t count, bool extend);
 180 static inline int tpm2_digest_buffer(TPMI_ALG_HASH alg, TPM2B_DIGEST *digest, const void *data, size_t len, bool extend) {
 181         return tpm2_digest_many(alg, digest, &IOVEC_MAKE((void*) data, len), 1, extend);
 182 }
 183 int tpm2_digest_many_digests(TPMI_ALG_HASH alg, TPM2B_DIGEST *digest, const TPM2B_DIGEST data[], size_t count, bool extend);
 184 static inline int tpm2_digest_rehash(TPMI_ALG_HASH alg, TPM2B_DIGEST *digest) {
 185         return tpm2_digest_many(alg, digest, NULL, 0, true);
 186 }
 187 static inline int tpm2_digest_init(TPMI_ALG_HASH alg, TPM2B_DIGEST *digest) {
 188         return tpm2_digest_many(alg, digest, NULL, 0, false);
 189 }
 190
 191 void tpm2_log_debug_tpml_pcr_selection(const TPML_PCR_SELECTION *l, const char *msg);
 192 void tpm2_log_debug_pcr_value(const Tpm2PCRValue *pcr_value, const char *msg);
 193 void tpm2_log_debug_buffer(const void *buffer, size_t size, const char *msg);
 194 void tpm2_log_debug_digest(const TPM2B_DIGEST *digest, const char *msg);
 195 void tpm2_log_debug_name(const TPM2B_NAME *name, const char *msg);
 196
 197 int tpm2_index_to_handle(Tpm2Context *c, TPM2_HANDLE index, const Tpm2Handle *session, TPM2B_PUBLIC **ret_public, TPM2B_NAME **ret_name, TPM2B_NAME **ret_qname, Tpm2Handle **ret_handle);
 198 int tpm2_index_from_handle(Tpm2Context *c, const Tpm2Handle *handle, TPM2_HANDLE *ret_index);
 199
 200 int tpm2_pcr_read(Tpm2Context *c, const TPML_PCR_SELECTION *pcr_selection, Tpm2PCRValue **ret_pcr_values, size_t *ret_n_pcr_values);
 201 int tpm2_pcr_read_missing_values(Tpm2Context *c, Tpm2PCRValue *pcr_values, size_t n_pcr_values);
 202
 203 int tpm2_get_pin_auth(TPMI_ALG_HASH hash, const char *pin, TPM2B_AUTH *ret_auth);
 204 int tpm2_set_auth(Tpm2Context *c, const Tpm2Handle *handle, const char *pin);
 205 int tpm2_set_auth_binary(Tpm2Context *c, const Tpm2Handle *handle, const TPM2B_AUTH *auth);
 206
 207 int tpm2_make_policy_session(Tpm2Context *c, const Tpm2Handle *primary, const Tpm2Handle *encryption_session, Tpm2Handle **ret_session);
 208 int tpm2_policy_auth_value(Tpm2Context *c, const Tpm2Handle *session, TPM2B_DIGEST **ret_policy_digest);
 209 int tpm2_policy_pcr(Tpm2Context *c, const Tpm2Handle *session, const TPML_PCR_SELECTION *pcr_selection, TPM2B_DIGEST **ret_policy_digest);
 210
 211 int tpm2_calculate_pubkey_name(const TPMT_PUBLIC *public, TPM2B_NAME *ret_name);
 212 int tpm2_calculate_nv_index_name(const TPMS_NV_PUBLIC *nvpublic, TPM2B_NAME *ret_name);
 213
 214 int tpm2_calculate_policy_auth_value(TPM2B_DIGEST *digest);
 215 int tpm2_calculate_policy_authorize(const TPM2B_PUBLIC *public, const TPM2B_DIGEST *policy_ref, TPM2B_DIGEST *digest);
 216 int tpm2_calculate_policy_pcr(const Tpm2PCRValue *pcr_values, size_t n_pcr_values, TPM2B_DIGEST *digest);
 217 int tpm2_calculate_sealing_policy(const Tpm2PCRValue *pcr_values, size_t n_pcr_values, const TPM2B_PUBLIC *public, bool use_pin, TPM2B_DIGEST *digest);
 218
 219 int tpm2_get_or_create_srk(Tpm2Context *c, const Tpm2Handle *session, TPM2B_PUBLIC **ret_public, TPM2B_NAME **ret_name, TPM2B_NAME **ret_qname, Tpm2Handle **ret_handle);
 220
 221 int tpm2_seal(Tpm2Context *c, uint32_t seal_key_handle, const TPM2B_DIGEST *policy, const char *pin, void **ret_secret, size_t *ret_secret_size, void **ret_blob, size_t *ret_blob_size, uint16_t *ret_primary_alg, void **ret_srk_buf, size_t *ret_srk_buf_size);
 222 int tpm2_unseal(Tpm2Context *c, uint32_t hash_pcr_mask, uint16_t pcr_bank, const void *pubkey, size_t pubkey_size, uint32_t pubkey_pcr_mask, JsonVariant *signature, const char *pin, uint16_t primary_alg, const void *blob, size_t blob_size, const void *policy_hash, size_t policy_hash_size, const void *srk_buf, size_t srk_buf_size, void **ret_secret, size_t *ret_secret_size);
 223
 224 #if HAVE_OPENSSL
 225 int tpm2_tpm2b_public_to_openssl_pkey(const TPM2B_PUBLIC *public, EVP_PKEY **ret);
 226 int tpm2_tpm2b_public_from_openssl_pkey(const EVP_PKEY *pkey, TPM2B_PUBLIC *ret);
 227 #endif
 228
 229 int tpm2_tpm2b_public_from_pem(const void *pem, size_t pem_size, TPM2B_PUBLIC *ret);
 230 int tpm2_tpm2b_public_to_fingerprint(const TPM2B_PUBLIC *public, void **ret_fingerprint, size_t *ret_fingerprint_size);
 231
 232 int tpm2_serialize(Tpm2Context *c, const Tpm2Handle *handle, void **ret_serialized, size_t *ret_serialized_size);
 233 int tpm2_deserialize(Tpm2Context *c, const void *serialized, size_t serialized_size, Tpm2Handle **ret_handle);
 234
 235 /* The tpm2-tss library has many structs that are simply a combination of an array (or object) and
 236  * size. These macros allow easily initializing or assigning instances of such structs from an existing
 237  * buffer/object and size, while also checking the size for safety with the struct buffer/object size. If the
 238  * provided buffer/object is NULL, the resulting struct's buffer/object will be 0s. If the provided size is
 239  * larger than the struct's buffer/object size, this results in assertion failure; to check the size, use one
 240  * of the TPM2B_*_CHECK_SIZE() macros. */
 241 #define TPM2B_AUTH_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_AUTH, buffer, size)
 242 #define TPM2B_DATA_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_DATA, buffer, size)
 243 #define TPM2B_DIGEST_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_DIGEST, buffer, size)
 244 #define TPM2B_ECC_PARAMETER_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_ECC_PARAMETER, buffer, size)
 245 #define TPM2B_ENCRYPTED_SECRET_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_ENCRYPTED_SECRET, secret, size)
 246 #define TPM2B_MAX_BUFFER_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_MAX_BUFFER, buffer, size)
 247 #define TPM2B_NAME_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_NAME, name, size)
 248 #define TPM2B_PRIVATE_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_PRIVATE, buffer, size)
 249 #define TPM2B_PRIVATE_KEY_RSA_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_PRIVATE_KEY_RSA, buffer, size)
 250 #define TPM2B_PUBLIC_KEY_RSA_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_PUBLIC_KEY_RSA, buffer, size)
 251 #define TPM2B_SENSITIVE_DATA_MAKE(b, s) TPM2B_BUF_SIZE_STRUCT_MAKE(b, s, TPM2B_SENSITIVE_DATA, buffer, size)
 252 #define TPM2B_BUF_SIZE_STRUCT_MAKE(buf, size, struct_type, buffer_field, size_field) \
 253         _TPM2B_BUF_SIZE_STRUCT_MAKE(buf, size, UNIQ, struct_type, buffer_field, size_field)
 254 #define _TPM2B_BUF_SIZE_STRUCT_MAKE(buf, size, uniq, struct_type, buffer_field, size_field) \
 255         ({                                                              \
 256                 typeof(buf) UNIQ_T(BUF, uniq) = (buf);                  \
 257                 typeof(size) UNIQ_T(SIZE, uniq) = (size);               \
 258                 struct_type UNIQ_T(STRUCT, uniq) = { .size_field = UNIQ_T(SIZE, uniq), }; \
 259                 assert(sizeof(UNIQ_T(STRUCT, uniq).buffer_field) >= (size_t) UNIQ_T(SIZE, uniq)); \
 260                 if (UNIQ_T(BUF, uniq))                                  \
 261                         memcpy_safe(UNIQ_T(STRUCT, uniq).buffer_field, UNIQ_T(BUF, uniq), UNIQ_T(SIZE, uniq)); \
 262                 UNIQ_T(STRUCT, uniq);                                   \
 263         })
 264
 265 /* Check if the size will fit in the TPM2B struct buffer. Returns 0 if the size will fit, otherwise this logs
 266  * a debug message and returns < 0. */
 267 #define TPM2B_AUTH_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_AUTH, buffer)
 268 #define TPM2B_DATA_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_DATA, buffer)
 269 #define TPM2B_DIGEST_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_DIGEST, buffer)
 270 #define TPM2B_ECC_PARAMETER_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_ECC_PARAMETER, buffer)
 271 #define TPM2B_ENCRYPTED_SECRET_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_ENCRYPTED_SECRET, buffer)
 272 #define TPM2B_MAX_BUFFER_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_MAX_BUFFER, buffer)
 273 #define TPM2B_NAME_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_NAME, name)
 274 #define TPM2B_PRIVATE_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_PRIVATE, buffer)
 275 #define TPM2B_PRIVATE_KEY_RSA_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_PRIVATE_KEY_RSA, buffer)
 276 #define TPM2B_PUBLIC_KEY_RSA_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_PUBLIC_KEY_RSA, buffer)
 277 #define TPM2B_SENSITIVE_DATA_CHECK_SIZE(s) TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(s, TPM2B_SENSITIVE_DATA, buffer)
 278 #define TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(size, struct_type, buffer_field) \
 279         _TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(size, UNIQ, struct_type, buffer_field)
 280 #define _TPM2B_BUF_SIZE_STRUCT_CHECK_SIZE(size, uniq, struct_type, buffer_field) \
 281         ({                                                              \
 282                 size_t UNIQ_T(SIZE, uniq) = (size_t) (size);            \
 283                 size_t UNIQ_T(BUFSIZE, uniq) = sizeof_field(struct_type, buffer_field); \
 284                 UNIQ_T(BUFSIZE, uniq) < UNIQ_T(SIZE, uniq) ?            \
 285                         log_debug_errno(SYNTHETIC_ERRNO(EINVAL),        \
 286                                         "Size %zu larger than " #struct_type " buffer size %zu.", \
 287                                         UNIQ_T(SIZE, uniq), UNIQ_T(BUFSIZE, uniq)) : \
 288                         0;                                              \
 289         })
 290
 291 #else /* HAVE_TPM2 */
 292 typedef struct {} Tpm2Context;
 293 typedef struct {} Tpm2Handle;
 294 typedef struct {} Tpm2PCRValue;
 295
 296 #define TPM2_PCR_VALUE_MAKE(i, h, v) (Tpm2PCRValue) {}
 297 #endif /* HAVE_TPM2 */
 298
 299 int tpm2_list_devices(void);
 300 int tpm2_find_device_auto(char **ret);
 301
 302 int tpm2_make_pcr_json_array(uint32_t pcr_mask, JsonVariant **ret);
 303 int tpm2_parse_pcr_json_array(JsonVariant *v, uint32_t *ret);
 304
 305 int tpm2_make_luks2_json(int keyslot, uint32_t hash_pcr_mask, uint16_t pcr_bank, const void *pubkey, size_t pubkey_size, uint32_t pubkey_pcr_mask, uint16_t primary_alg, const void *blob, size_t blob_size, const void *policy_hash, size_t policy_hash_size, const void *salt, size_t salt_size, const void *srk_buf, size_t srk_buf_size, TPM2Flags flags, JsonVariant **ret);
 306 int tpm2_parse_luks2_json(JsonVariant *v, int *ret_keyslot, uint32_t *ret_hash_pcr_mask, uint16_t *ret_pcr_bank, void **ret_pubkey, size_t *ret_pubkey_size, uint32_t *ret_pubkey_pcr_mask, uint16_t *ret_primary_alg, void **ret_blob, size_t *ret_blob_size, void **ret_policy_hash, size_t *ret_policy_hash_size, void **ret_salt, size_t *ret_salt_size, void **ret_srk_buf, size_t *ret_srk_buf_size, TPM2Flags *ret_flags);
 307
 308 /* Default to PCR 7 only */
 309 #define TPM2_PCR_INDEX_DEFAULT UINT32_C(7)
 310 #define TPM2_PCR_MASK_DEFAULT INDEX_TO_MASK(uint32_t, TPM2_PCR_INDEX_DEFAULT)
 311
 312 /* We want the helpers below to work also if TPM2 libs are not available, hence define these four defines if
 313  * they are missing. */
 314 #ifndef TPM2_ALG_SHA1
 315 #define TPM2_ALG_SHA1 0x4
 316 #endif
 317
 318 #ifndef TPM2_ALG_SHA256
 319 #define TPM2_ALG_SHA256 0xB
 320 #endif
 321
 322 #ifndef TPM2_ALG_SHA384
 323 #define TPM2_ALG_SHA384 0xC
 324 #endif
 325
 326 #ifndef TPM2_ALG_SHA512
 327 #define TPM2_ALG_SHA512 0xD
 328 #endif
 329
 330 #ifndef TPM2_ALG_ECC
 331 #define TPM2_ALG_ECC 0x23
 332 #endif
 333
 334 #ifndef TPM2_ALG_RSA
 335 #define TPM2_ALG_RSA 0x1
 336 #endif
 337
 338 int tpm2_hash_alg_to_size(uint16_t alg);
 339
 340 const char *tpm2_hash_alg_to_string(uint16_t alg) _const_;
 341 int tpm2_hash_alg_from_string(const char *alg) _pure_;
 342
 343 const char *tpm2_asym_alg_to_string(uint16_t alg) _const_;
 344 int tpm2_asym_alg_from_string(const char *alg) _pure_;
 345
 346 char *tpm2_pcr_mask_to_string(uint32_t mask);
 347
 348 typedef struct {
 349         uint32_t search_pcr_mask;
 350         const char *device;
 351         const char *signature_path;
 352 } systemd_tpm2_plugin_params;
 353
 354 typedef enum Tpm2Support {
 355         /* NOTE! The systemd-creds tool returns these flags 1:1 as exit status. Hence these flags are pretty
 356          * much ABI! Hence, be extra careful when changing/extending these definitions. */
 357         TPM2_SUPPORT_NONE      = 0,       /* no support */
 358         TPM2_SUPPORT_FIRMWARE  = 1 << 0,  /* firmware reports TPM2 was used */
 359         TPM2_SUPPORT_DRIVER    = 1 << 1,  /* the kernel has a driver loaded for it */
 360         TPM2_SUPPORT_SYSTEM    = 1 << 2,  /* we support it ourselves */
 361         TPM2_SUPPORT_SUBSYSTEM = 1 << 3,  /* the kernel has the tpm subsystem enabled */
 362         TPM2_SUPPORT_LIBRARIES = 1 << 4,  /* we can dlopen the tpm2 libraries */
 363         TPM2_SUPPORT_FULL      = TPM2_SUPPORT_FIRMWARE|TPM2_SUPPORT_DRIVER|TPM2_SUPPORT_SYSTEM|TPM2_SUPPORT_SUBSYSTEM|TPM2_SUPPORT_LIBRARIES,
 364 } Tpm2Support;
 365
 366 Tpm2Support tpm2_support(void);
 367
 368 int tpm2_parse_pcr_argument(const char *arg, Tpm2PCRValue **ret_pcr_values, size_t *ret_n_pcr_values);
 369 int tpm2_parse_pcr_argument_append(const char *arg, Tpm2PCRValue **ret_pcr_values, size_t *ret_n_pcr_values);
 370 int tpm2_parse_pcr_argument_to_mask(const char *arg, uint32_t *mask);
 371
 372 int tpm2_load_pcr_signature(const char *path, JsonVariant **ret);
 373 int tpm2_load_pcr_public_key(const char *path, void **ret_pubkey, size_t *ret_pubkey_size);
 374
 375 int tpm2_util_pbkdf2_hmac_sha256(const void *pass,
 376                     size_t passlen,
 377                     const void *salt,
 378                     size_t saltlen,
 379                     uint8_t res[static SHA256_DIGEST_SIZE]);
 380
 381 enum {
 382         /* Additional defines for the PCR index naming enum from "fundamental/tpm2-pcr.h" */
 383         _TPM2_PCR_INDEX_MAX_DEFINED = TPM2_PCRS_MAX,
 384         _TPM2_PCR_INDEX_INVALID     = -EINVAL,
 385 };
 386
 387 int tpm2_pcr_index_from_string(const char *s) _pure_;
 388 const char *tpm2_pcr_index_to_string(int pcr) _const_;