/* * Copyright (C) 2011 Sansar Choinyambuu * HSR Hochschule fuer Technik Rapperswil * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the * Free Software Foundation; either version 2 of the License, or (at your * option) any later version. See . * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * for more details. */ /** * @defgroup pts pts * @{ @ingroup pts */ #ifndef PTS_H_ #define PTS_H_ typedef struct pts_t pts_t; typedef struct pcr_entry_t pcr_entry_t; #include "pts_error.h" #include "pts_proto_caps.h" #include "pts_meas_algo.h" #include "pts_file_meas.h" #include "pts_file_meta.h" #include "pts_dh_group.h" #include #include /** * UTF-8 encoding of the character used to delimiter the filename */ #define SOLIDUS_UTF 0x2F #define REVERSE_SOLIDUS_UTF 0x5C /** * Length of the generated nonce used for calculation of shared secret */ #define ASSESSMENT_SECRET_LEN 20 /** * Maximum number of PCR's of TPM, TPM Spec 1.2 */ #define MAX_NUM_PCR 24 /** * Number of bytes that can be saved in a PCR of TPM, TPM Spec 1.2 */ #define PCR_LEN 20 /** * Lenght of the TPM_QUOTE_INFO structure, TPM Spec 1.2 */ #define TPM_QUOTE_INFO_LEN 48 /** * Bitmask Lenght for PCR Composite structure */ #define PCR_MASK_LEN MAX_NUM_PCR / 8 /** * PCR Entry structure which contains PCR number and current value */ struct pcr_entry_t { u_int32_t pcr_number; char pcr_value[PCR_LEN]; }; /** * Class implementing the TCG Platform Trust Service (PTS) * */ struct pts_t { /** * Get PTS Protocol Capabilities * * @return Protocol capabilities flags */ pts_proto_caps_flag_t (*get_proto_caps)(pts_t *this); /** * Set PTS Protocol Capabilities * * @param flags Protocol capabilities flags */ void (*set_proto_caps)(pts_t *this, pts_proto_caps_flag_t flags); /** * Get PTS Measurement Algorithm * * @return PTS measurement algorithm */ pts_meas_algorithms_t (*get_meas_algorithm)(pts_t *this); /** * Set PTS Measurement Algorithm * * @param algorithm PTS measurement algorithm */ void (*set_meas_algorithm)(pts_t *this, pts_meas_algorithms_t algorithm); /** * Get DH Hash Algorithm * * @return DH hash algorithm */ pts_meas_algorithms_t (*get_dh_hash_algorithm)(pts_t *this); /** * Set DH Hash Algorithm * * @param algorithm DH hash algorithm */ void (*set_dh_hash_algorithm)(pts_t *this, pts_meas_algorithms_t algorithm); /** * Create PTS Diffie-Hellman object and nonce * * @param group PTS DH group * @param nonce_len Nonce length * @return TRUE if creation was successful * */ bool (*create_dh_nonce)(pts_t *this, pts_dh_group_t group, int nonce_len); /** * Get my Diffie-Hellman public value * * @param value My public DH value * @param nonce My DH nonce */ void (*get_my_public_value)(pts_t *this, chunk_t *value, chunk_t *nonce); /** * Set peer Diffie.Hellman public value * * @param value Peer public DH value * @param nonce Peer DH nonce */ void (*set_peer_public_value) (pts_t *this, chunk_t value, chunk_t nonce); /** * Calculates secret assessment value to be used for TPM Quote as ExternalData * * @return TRUE unless both DH public values * and nonces are set */ bool (*calculate_secret) (pts_t *this); /** * Get Platform and OS Info * * @return Platform and OS info */ char* (*get_platform_info)(pts_t *this); /** * Set Platform and OS Info * * @param info Platform and OS info */ void (*set_platform_info)(pts_t *this, char *info); /** * Get TPM 1.2 Version Info * * @param info chunk containing a TPM_CAP_VERSION_INFO struct * @return TRUE if TPM Version Info available */ bool (*get_tpm_version_info)(pts_t *this, chunk_t *info); /** * Set TPM 1.2 Version Info * * @param info chunk containing a TPM_CAP_VERSION_INFO struct */ void (*set_tpm_version_info)(pts_t *this, chunk_t info); /** * Get Attestation Identity Certificate or Public Key * * @return AIK Certificate or Public Key */ certificate_t* (*get_aik)(pts_t *this); /** * Set Attestation Identity Certificate or Public Key * * @param aik AIK Certificate or Public Key */ void (*set_aik)(pts_t *this, certificate_t *aik); /** * Check whether path is valid file/directory on filesystem * * @param path Absolute path * @param error_code Output variable for PTS error code * @return TRUE if path is valid or file/directory * doesn't exist or path is invalid * FALSE if local error occured within stat function */ bool (*is_path_valid)(pts_t *this, char *path, pts_error_code_t *error_code); /** * Compute a hash over a file * @param hasher Hasher to be used * @param pathname Absolute path of a file * @param hash Buffer to keep hash output * @return TRUE if path is valid and hashing succeeded */ bool (*hash_file)(pts_t *this, hasher_t *hasher, char *pathname, u_char *hash); /** * Do PTS File Measurements * * @param request_id ID of PTS File Measurement Request * @param pathname Absolute pathname of file to be measured * @param is_directory TRUE if directory contents are measured * @return PTS File Measurements of NULL if FAILED */ pts_file_meas_t* (*do_measurements)(pts_t *this, u_int16_t request_id, char *pathname, bool is_directory); /** * Obtain file metadata * * @param pathname Absolute pathname of file/directory * @param is_directory TRUE if directory contents are requested * @return PTS File Metadata or NULL if FAILED */ pts_file_meta_t* (*get_metadata)(pts_t *this, char *pathname, bool is_directory); /** * Reads given PCR value and returns it * Expects owner secret to be WELL_KNOWN_SECRET * * @param pcr_num Number of PCR to read * @param pcr_value Chunk to save pcr read output * @return NULL in case of TSS error, PCR value otherwise */ bool (*read_pcr)(pts_t *this, u_int32_t pcr_num, chunk_t *pcr_value); /** * Extends given PCR with given value * Expects owner secret to be WELL_KNOWN_SECRET * * @param pcr_num Number of PCR to extend * @param input Value to extend * @param output Chunk to save PCR value after extension * @return FALSE in case of TSS error, TRUE otherwise */ bool (*extend_pcr)(pts_t *this, u_int32_t pcr_num, chunk_t input, chunk_t *output); /** * Quote over PCR's * Expects owner and SRK secret to be WELL_KNOWN_SECRET and no password set for AIK * * @param pcrs Array of PCR's to make quotation over * @param num_of_pcrs Number of elements in pcrs array * @param pcr_composite Chunk to save pcr composite structure * @param quote_signature Chunk to save quote operation output * without external data (anti-replay protection) * @return FALSE in case of TSS error, TRUE otherwise */ bool (*quote_tpm)(pts_t *this, u_int32_t *pcrs, u_int32_t num_of_pcrs, chunk_t *pcr_composite, chunk_t *quote_signature); /** * Add extended PCR with its corresponding value * * @return FALSE in case of any error or non-match, TRUE otherwise */ void (*add_pcr_entry)(pts_t *this, pcr_entry_t *entry); /** * Constructs and returns TPM Quote Info structure expected from IMC * * @param pcr_composite Output variable to store PCR Composite * @param quote_info Output variable to store TPM Quote Info * @return FALSE in case of any error, TRUE otherwise */ bool (*get_quote_info)(pts_t *this, chunk_t *pcr_composite, chunk_t *quote_info); /** * Constructs and returns PCR Quote Digest structure expected from IMC * * @param data Calculated TPM Quote Digest * @param signature TPM Quote Signature received from IMC * @return FALSE in case signature is not verified, TRUE otherwise */ bool (*verify_quote_signature)(pts_t *this, chunk_t data, chunk_t signature); /** * Destroys a pts_t object. */ void (*destroy)(pts_t *this); }; /** * Creates an pts_t object * * @param is_imc TRUE if running on an IMC */ pts_t* pts_create(bool is_imc); #endif /** PTS_H_ @}*/