mirror of
https://github.com/izzy2lost/xemu.git
synced 2026-07-06 00:20:22 -07:00
tpm: Added support for TPM emulator
This change introduces a new TPM backend driver that can communicate with
swtpm(software TPM emulator) using unix domain socket interface. QEMU talks to
the TPM emulator using QEMU's socket-based chardev backend device.
Swtpm uses two Unix sockets for communications, one for plain TPM commands and
responses, and one for out-of-band control messages. QEMU passes the data
socket to be used over the control channel.
The swtpm and associated tools can be found here:
https://github.com/stefanberger/swtpm
The swtpm's control channel protocol specification can be found here:
https://github.com/stefanberger/swtpm/wiki/Control-Channel-Specification
Usage:
# setup TPM state directory
mkdir /tmp/mytpm
chown -R tss:root /tmp/mytpm
/usr/bin/swtpm_setup --tpm-state /tmp/mytpm --createek
# Ask qemu to use TPM emulator with given tpm state directory
qemu-system-x86_64 \
[...] \
-chardev socket,id=chrtpm,path=/tmp/swtpm-sock \
-tpmdev emulator,id=tpm0,chardev=chrtpm \
-device tpm-tis,tpmdev=tpm0 \
[...]
Signed-off-by: Amarnath Valluri <amarnath.valluri@intel.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Tested-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
This commit is contained in:
Amarnath Valluri
committed by
Stefan Berger
Stefan Berger
parent
4a3d80980e
commit
f4ede81eed
@@ -3495,6 +3495,12 @@ else
|
||||
tpm_passthrough=no
|
||||
fi
|
||||
|
||||
# TPM emulator is for all posix systems
|
||||
if test "$mingw32" != "yes"; then
|
||||
tpm_emulator=$tpm
|
||||
else
|
||||
tpm_emulator=no
|
||||
fi
|
||||
##########################################
|
||||
# attr probe
|
||||
|
||||
@@ -5412,6 +5418,7 @@ echo "gcov enabled $gcov"
|
||||
echo "TPM support $tpm"
|
||||
echo "libssh2 support $libssh2"
|
||||
echo "TPM passthrough $tpm_passthrough"
|
||||
echo "TPM emulator $tpm_emulator"
|
||||
echo "QOM debugging $qom_cast_debug"
|
||||
echo "Live block migration $live_block_migration"
|
||||
echo "lzo support $lzo"
|
||||
@@ -6011,12 +6018,16 @@ if test "$live_block_migration" = "yes" ; then
|
||||
echo "CONFIG_LIVE_BLOCK_MIGRATION=y" >> $config_host_mak
|
||||
fi
|
||||
|
||||
# TPM passthrough support?
|
||||
if test "$tpm" = "yes"; then
|
||||
echo 'CONFIG_TPM=$(CONFIG_SOFTMMU)' >> $config_host_mak
|
||||
# TPM passthrough support?
|
||||
if test "$tpm_passthrough" = "yes"; then
|
||||
echo "CONFIG_TPM_PASSTHROUGH=y" >> $config_host_mak
|
||||
fi
|
||||
# TPM emulator support?
|
||||
if test "$tpm_emulator" = "yes"; then
|
||||
echo "CONFIG_TPM_EMULATOR=y" >> $config_host_mak
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "TRACE_BACKENDS=$trace_backends" >> $config_host_mak
|
||||
|
||||
@@ -1000,6 +1000,7 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
|
||||
Error *err = NULL;
|
||||
unsigned int c = 0;
|
||||
TPMPassthroughOptions *tpo;
|
||||
TPMEmulatorOptions *teo;
|
||||
|
||||
info_list = qmp_query_tpm(&err);
|
||||
if (err) {
|
||||
@@ -1029,6 +1030,10 @@ void hmp_info_tpm(Monitor *mon, const QDict *qdict)
|
||||
tpo->has_cancel_path ? ",cancel-path=" : "",
|
||||
tpo->has_cancel_path ? tpo->cancel_path : "");
|
||||
break;
|
||||
case TPM_TYPE_OPTIONS_KIND_EMULATOR:
|
||||
teo = ti->options->u.emulator.data;
|
||||
monitor_printf(mon, ",chardev=%s", teo->chardev);
|
||||
break;
|
||||
case TPM_TYPE_OPTIONS_KIND__MAX:
|
||||
break;
|
||||
}
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
common-obj-$(CONFIG_TPM_TIS) += tpm_tis.o
|
||||
common-obj-$(CONFIG_TPM_PASSTHROUGH) += tpm_passthrough.o tpm_util.o
|
||||
common-obj-$(CONFIG_TPM_EMULATOR) += tpm_emulator.o tpm_util.o
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,246 @@
|
||||
/*
|
||||
* tpm_ioctl.h
|
||||
*
|
||||
* (c) Copyright IBM Corporation 2014, 2015.
|
||||
*
|
||||
* This file is licensed under the terms of the 3-clause BSD license
|
||||
*/
|
||||
#ifndef _TPM_IOCTL_H_
|
||||
#define _TPM_IOCTL_H_
|
||||
|
||||
#include <stdint.h>
|
||||
#include <sys/uio.h>
|
||||
#include <sys/types.h>
|
||||
#include <sys/ioctl.h>
|
||||
|
||||
/*
|
||||
* Every response from a command involving a TPM command execution must hold
|
||||
* the ptm_res as the first element.
|
||||
* ptm_res corresponds to the error code of a command executed by the TPM.
|
||||
*/
|
||||
|
||||
typedef uint32_t ptm_res;
|
||||
|
||||
/* PTM_GET_TPMESTABLISHED: get the establishment bit */
|
||||
struct ptm_est {
|
||||
union {
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
unsigned char bit; /* TPM established bit */
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/* PTM_RESET_TPMESTABLISHED: reset establishment bit */
|
||||
struct ptm_reset_est {
|
||||
union {
|
||||
struct {
|
||||
uint8_t loc; /* locality to use */
|
||||
} req; /* request */
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/* PTM_INIT */
|
||||
struct ptm_init {
|
||||
union {
|
||||
struct {
|
||||
uint32_t init_flags; /* see definitions below */
|
||||
} req; /* request */
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/* above init_flags */
|
||||
#define PTM_INIT_FLAG_DELETE_VOLATILE (1 << 0)
|
||||
/* delete volatile state file after reading it */
|
||||
|
||||
/* PTM_SET_LOCALITY */
|
||||
struct ptm_loc {
|
||||
union {
|
||||
struct {
|
||||
uint8_t loc; /* locality to set */
|
||||
} req; /* request */
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/* PTM_HASH_DATA: hash given data */
|
||||
struct ptm_hdata {
|
||||
union {
|
||||
struct {
|
||||
uint32_t length;
|
||||
uint8_t data[4096];
|
||||
} req; /* request */
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/*
|
||||
* size of the TPM state blob to transfer; x86_64 can handle 8k,
|
||||
* ppc64le only ~7k; keep the response below a 4k page size
|
||||
*/
|
||||
#define PTM_STATE_BLOB_SIZE (3 * 1024)
|
||||
|
||||
/*
|
||||
* The following is the data structure to get state blobs from the TPM.
|
||||
* If the size of the state blob exceeds the PTM_STATE_BLOB_SIZE, multiple reads
|
||||
* with this ioctl and with adjusted offset are necessary. All bytes
|
||||
* must be transferred and the transfer is done once the last byte has been
|
||||
* returned.
|
||||
* It is possible to use the read() interface for reading the data; however, the
|
||||
* first bytes of the state blob will be part of the response to the ioctl(); a
|
||||
* subsequent read() is only necessary if the total length (totlength) exceeds
|
||||
* the number of received bytes. seek() is not supported.
|
||||
*/
|
||||
struct ptm_getstate {
|
||||
union {
|
||||
struct {
|
||||
uint32_t state_flags; /* may be: PTM_STATE_FLAG_DECRYPTED */
|
||||
uint32_t type; /* which blob to pull */
|
||||
uint32_t offset; /* offset from where to read */
|
||||
} req; /* request */
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
uint32_t state_flags; /* may be: PTM_STATE_FLAG_ENCRYPTED */
|
||||
uint32_t totlength; /* total length that will be transferred */
|
||||
uint32_t length; /* number of bytes in following buffer */
|
||||
uint8_t data[PTM_STATE_BLOB_SIZE];
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/* TPM state blob types */
|
||||
#define PTM_BLOB_TYPE_PERMANENT 1
|
||||
#define PTM_BLOB_TYPE_VOLATILE 2
|
||||
#define PTM_BLOB_TYPE_SAVESTATE 3
|
||||
|
||||
/* state_flags above : */
|
||||
#define PTM_STATE_FLAG_DECRYPTED 1 /* on input: get decrypted state */
|
||||
#define PTM_STATE_FLAG_ENCRYPTED 2 /* on output: state is encrypted */
|
||||
|
||||
/*
|
||||
* The following is the data structure to set state blobs in the TPM.
|
||||
* If the size of the state blob exceeds the PTM_STATE_BLOB_SIZE, multiple
|
||||
* 'writes' using this ioctl are necessary. The last packet is indicated
|
||||
* by the length being smaller than the PTM_STATE_BLOB_SIZE.
|
||||
* The very first packet may have a length indicator of '0' enabling
|
||||
* a write() with all the bytes from a buffer. If the write() interface
|
||||
* is used, a final ioctl with a non-full buffer must be made to indicate
|
||||
* that all data were transferred (a write with 0 bytes would not work).
|
||||
*/
|
||||
struct ptm_setstate {
|
||||
union {
|
||||
struct {
|
||||
uint32_t state_flags; /* may be PTM_STATE_FLAG_ENCRYPTED */
|
||||
uint32_t type; /* which blob to set */
|
||||
uint32_t length; /* length of the data;
|
||||
use 0 on the first packet to
|
||||
transfer using write() */
|
||||
uint8_t data[PTM_STATE_BLOB_SIZE];
|
||||
} req; /* request */
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
/*
|
||||
* PTM_GET_CONFIG: Data structure to get runtime configuration information
|
||||
* such as which keys are applied.
|
||||
*/
|
||||
struct ptm_getconfig {
|
||||
union {
|
||||
struct {
|
||||
ptm_res tpm_result;
|
||||
uint32_t flags;
|
||||
} resp; /* response */
|
||||
} u;
|
||||
};
|
||||
|
||||
#define PTM_CONFIG_FLAG_FILE_KEY 0x1
|
||||
#define PTM_CONFIG_FLAG_MIGRATION_KEY 0x2
|
||||
|
||||
|
||||
typedef uint64_t ptm_cap;
|
||||
typedef struct ptm_est ptm_est;
|
||||
typedef struct ptm_reset_est ptm_reset_est;
|
||||
typedef struct ptm_loc ptm_loc;
|
||||
typedef struct ptm_hdata ptm_hdata;
|
||||
typedef struct ptm_init ptm_init;
|
||||
typedef struct ptm_getstate ptm_getstate;
|
||||
typedef struct ptm_setstate ptm_setstate;
|
||||
typedef struct ptm_getconfig ptm_getconfig;
|
||||
|
||||
/* capability flags returned by PTM_GET_CAPABILITY */
|
||||
#define PTM_CAP_INIT (1)
|
||||
#define PTM_CAP_SHUTDOWN (1 << 1)
|
||||
#define PTM_CAP_GET_TPMESTABLISHED (1 << 2)
|
||||
#define PTM_CAP_SET_LOCALITY (1 << 3)
|
||||
#define PTM_CAP_HASHING (1 << 4)
|
||||
#define PTM_CAP_CANCEL_TPM_CMD (1 << 5)
|
||||
#define PTM_CAP_STORE_VOLATILE (1 << 6)
|
||||
#define PTM_CAP_RESET_TPMESTABLISHED (1 << 7)
|
||||
#define PTM_CAP_GET_STATEBLOB (1 << 8)
|
||||
#define PTM_CAP_SET_STATEBLOB (1 << 9)
|
||||
#define PTM_CAP_STOP (1 << 10)
|
||||
#define PTM_CAP_GET_CONFIG (1 << 11)
|
||||
#define PTM_CAP_SET_DATAFD (1 << 12)
|
||||
|
||||
enum {
|
||||
PTM_GET_CAPABILITY = _IOR('P', 0, ptm_cap),
|
||||
PTM_INIT = _IOWR('P', 1, ptm_init),
|
||||
PTM_SHUTDOWN = _IOR('P', 2, ptm_res),
|
||||
PTM_GET_TPMESTABLISHED = _IOR('P', 3, ptm_est),
|
||||
PTM_SET_LOCALITY = _IOWR('P', 4, ptm_loc),
|
||||
PTM_HASH_START = _IOR('P', 5, ptm_res),
|
||||
PTM_HASH_DATA = _IOWR('P', 6, ptm_hdata),
|
||||
PTM_HASH_END = _IOR('P', 7, ptm_res),
|
||||
PTM_CANCEL_TPM_CMD = _IOR('P', 8, ptm_res),
|
||||
PTM_STORE_VOLATILE = _IOR('P', 9, ptm_res),
|
||||
PTM_RESET_TPMESTABLISHED = _IOWR('P', 10, ptm_reset_est),
|
||||
PTM_GET_STATEBLOB = _IOWR('P', 11, ptm_getstate),
|
||||
PTM_SET_STATEBLOB = _IOWR('P', 12, ptm_setstate),
|
||||
PTM_STOP = _IOR('P', 13, ptm_res),
|
||||
PTM_GET_CONFIG = _IOR('P', 14, ptm_getconfig),
|
||||
PTM_SET_DATAFD = _IOR('P', 15, ptm_res),
|
||||
};
|
||||
|
||||
/*
|
||||
* Commands used by the non-CUSE TPMs
|
||||
*
|
||||
* All messages container big-endian data.
|
||||
*
|
||||
* The return messages only contain the 'resp' part of the unions
|
||||
* in the data structures above. Besides that the limits in the
|
||||
* buffers above (ptm_hdata:u.req.data and ptm_get_state:u.resp.data
|
||||
* and ptm_set_state:u.req.data) are 0xffffffff.
|
||||
*/
|
||||
enum {
|
||||
CMD_GET_CAPABILITY = 1,
|
||||
CMD_INIT,
|
||||
CMD_SHUTDOWN,
|
||||
CMD_GET_TPMESTABLISHED,
|
||||
CMD_SET_LOCALITY,
|
||||
CMD_HASH_START,
|
||||
CMD_HASH_DATA,
|
||||
CMD_HASH_END,
|
||||
CMD_CANCEL_TPM_CMD,
|
||||
CMD_STORE_VOLATILE,
|
||||
CMD_RESET_TPMESTABLISHED,
|
||||
CMD_GET_STATEBLOB,
|
||||
CMD_SET_STATEBLOB,
|
||||
CMD_STOP,
|
||||
CMD_GET_CONFIG,
|
||||
CMD_SET_DATAFD
|
||||
};
|
||||
|
||||
#endif /* _TPM_IOCTL_H */
|
||||
+18
-3
@@ -39,10 +39,12 @@
|
||||
# An enumeration of TPM types
|
||||
#
|
||||
# @passthrough: TPM passthrough type
|
||||
# @emulator: Software Emulator TPM type
|
||||
# Since: 2.11
|
||||
#
|
||||
# Since: 1.5
|
||||
##
|
||||
{ 'enum': 'TpmType', 'data': [ 'passthrough' ] }
|
||||
{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator' ] }
|
||||
|
||||
##
|
||||
# @query-tpm-types:
|
||||
@@ -56,7 +58,7 @@
|
||||
# Example:
|
||||
#
|
||||
# -> { "execute": "query-tpm-types" }
|
||||
# <- { "return": [ "passthrough" ] }
|
||||
# <- { "return": [ "passthrough", "emulator" ] }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-tpm-types', 'returns': ['TpmType'] }
|
||||
@@ -76,17 +78,30 @@
|
||||
{ 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
|
||||
'*cancel-path' : 'str'} }
|
||||
|
||||
##
|
||||
# @TPMEmulatorOptions:
|
||||
#
|
||||
# Information about the TPM emulator type
|
||||
#
|
||||
# @chardev: Name of a unix socket chardev
|
||||
#
|
||||
# Since: 2.11
|
||||
##
|
||||
{ 'struct': 'TPMEmulatorOptions', 'data': { 'chardev' : 'str' } }
|
||||
|
||||
##
|
||||
# @TpmTypeOptions:
|
||||
#
|
||||
# A union referencing different TPM backend types' configuration options
|
||||
#
|
||||
# @type: 'passthrough' The configuration options for the TPM passthrough type
|
||||
# 'emulator' The configuration options for TPM emulator backend type
|
||||
#
|
||||
# Since: 1.5
|
||||
##
|
||||
{ 'union': 'TpmTypeOptions',
|
||||
'data': { 'passthrough' : 'TPMPassthroughOptions' } }
|
||||
'data': { 'passthrough' : 'TPMPassthroughOptions',
|
||||
'emulator': 'TPMEmulatorOptions' } }
|
||||
|
||||
##
|
||||
# @TPMInfo:
|
||||
|
||||
+19
-3
@@ -3121,7 +3121,9 @@ DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
|
||||
"-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
|
||||
" use path to provide path to a character device; default is /dev/tpm0\n"
|
||||
" use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
|
||||
" not provided it will be searched for in /sys/class/misc/tpm?/device\n",
|
||||
" not provided it will be searched for in /sys/class/misc/tpm?/device\n"
|
||||
"-tpmdev emulator,id=id,chardev=dev\n"
|
||||
" configure the TPM device using chardev backend\n",
|
||||
QEMU_ARCH_ALL)
|
||||
STEXI
|
||||
|
||||
@@ -3130,8 +3132,8 @@ The general form of a TPM device option is:
|
||||
|
||||
@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
|
||||
@findex -tpmdev
|
||||
Backend type must be:
|
||||
@option{passthrough}.
|
||||
Backend type must be either one of the following:
|
||||
@option{passthrough}, @option{emulator}.
|
||||
|
||||
The specific backend type will determine the applicable options.
|
||||
The @code{-tpmdev} option creates the TPM backend and requires a
|
||||
@@ -3181,6 +3183,20 @@ To create a passthrough TPM use the following two options:
|
||||
Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
|
||||
@code{tpmdev=tpm0} in the device option.
|
||||
|
||||
@item -tpmdev emulator, id=@var{id}, chardev=@var{dev}
|
||||
|
||||
(Linux-host only) Enable access to a TPM emulator using Unix domain socket based
|
||||
chardev backend.
|
||||
|
||||
@option{chardev} specifies the unique ID of a character device backend that provides connection to the software TPM server.
|
||||
|
||||
To create a TPM emulator backend device with chardev socket backend:
|
||||
@example
|
||||
|
||||
-chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0
|
||||
|
||||
@end example
|
||||
|
||||
@end table
|
||||
|
||||
ETEXI
|
||||
|
||||
Reference in New Issue
Block a user