blob: 7164ea7ff198ce9b3d4a0ece686dda855aa92792 [file] [log] [blame]
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05001/*
2 * TPM configuration
3 *
4 * Copyright (C) 2011-2013 IBM Corporation
5 *
6 * Authors:
7 * Stefan Berger <stefanb@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
11 *
12 * Based on net.c
13 */
Markus Armbrustere688df62018-02-01 12:18:31 +010014
Peter Maydelld38ea872016-01-29 17:50:05 +000015#include "qemu/osdep.h"
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050016
Markus Armbrustere688df62018-02-01 12:18:31 +010017#include "qapi/error.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010018#include "qapi/qapi-commands-tpm.h"
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050019#include "qapi/qmp/qerror.h"
Paolo Bonzinidccfcd02013-04-08 16:55:25 +020020#include "sysemu/tpm_backend.h"
Paolo Bonzinibdee56f2013-04-02 18:28:41 +020021#include "sysemu/tpm.h"
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050022#include "qemu/config-file.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010023#include "qemu/error-report.h"
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050024
25static QLIST_HEAD(, TPMBackend) tpm_backends =
26 QLIST_HEAD_INITIALIZER(tpm_backends);
27
Marc-André Lureaud31076b2017-10-10 00:55:49 +020028static const TPMBackendClass *
29tpm_be_find_by_type(enum TpmType type)
Marc-André Lureauf3faa1d2017-10-10 00:55:45 +020030{
31 ObjectClass *oc;
Marc-André Lureauf3faa1d2017-10-10 00:55:45 +020032 char *typename = g_strdup_printf("tpm-%s", TpmType_str(type));
33
34 oc = object_class_by_name(typename);
35 g_free(typename);
36
37 if (!object_class_dynamic_cast(oc, TYPE_TPM_BACKEND)) {
38 return NULL;
39 }
40
Marc-André Lureaud31076b2017-10-10 00:55:49 +020041 return TPM_BACKEND_CLASS(oc);
Marc-André Lureauf3faa1d2017-10-10 00:55:45 +020042}
43
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050044/*
45 * Walk the list of available TPM backend drivers and display them on the
46 * screen.
47 */
Paolo Bonzinibdee56f2013-04-02 18:28:41 +020048static void tpm_display_backend_drivers(void)
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050049{
Markus Armbruster5a6791c2020-07-23 13:58:45 +020050 bool got_one = false;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050051 int i;
52
Marc-André Lureaua9a72ae2017-08-24 10:45:58 +020053 for (i = 0; i < TPM_TYPE__MAX; i++) {
Marc-André Lureaud31076b2017-10-10 00:55:49 +020054 const TPMBackendClass *bc = tpm_be_find_by_type(i);
55 if (!bc) {
Marc-André Lureaua9a72ae2017-08-24 10:45:58 +020056 continue;
57 }
Markus Armbruster5a6791c2020-07-23 13:58:45 +020058 if (!got_one) {
59 error_printf("Supported TPM types (choose only one):\n");
60 got_one = true;
61 }
62 error_printf("%12s %s\n", TpmType_str(i), bc->desc);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050063 }
Markus Armbruster5a6791c2020-07-23 13:58:45 +020064 if (!got_one) {
65 error_printf("No TPM backend types are available\n");
66 }
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050067}
68
69/*
70 * Find the TPM with the given Id
71 */
Marc-André Lureaud36e7db2017-11-06 19:39:14 +010072TPMBackend *qemu_find_tpm_be(const char *id)
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050073{
74 TPMBackend *drv;
75
76 if (id) {
77 QLIST_FOREACH(drv, &tpm_backends, list) {
78 if (!strcmp(drv->id, id)) {
79 return drv;
80 }
81 }
82 }
83
84 return NULL;
85}
86
Marc-André Lureau76ae76b2017-10-10 00:55:51 +020087static int tpm_init_tpmdev(void *dummy, QemuOpts *opts, Error **errp)
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050088{
Markus Armbrusterd64072c02020-07-23 13:58:44 +020089 /*
90 * Use of error_report() in a function with an Error ** parameter
91 * is suspicious. It is okay here. The parameter only exists to
92 * make the function usable with qemu_opts_foreach(). It is not
93 * actually used.
94 */
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050095 const char *value;
96 const char *id;
Marc-André Lureaud31076b2017-10-10 00:55:49 +020097 const TPMBackendClass *be;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -050098 TPMBackend *drv;
Markus Armbrusterd64072c02020-07-23 13:58:44 +020099 Error *local_err = NULL;
Marc-André Lureaud91a7a52017-10-10 00:55:46 +0200100 int i;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500101
102 if (!QLIST_EMPTY(&tpm_backends)) {
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200103 error_report("Only one TPM is allowed.");
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500104 return 1;
105 }
106
107 id = qemu_opts_id(opts);
108 if (id == NULL) {
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200109 error_report(QERR_MISSING_PARAMETER, "id");
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500110 return 1;
111 }
112
113 value = qemu_opt_get(opts, "type");
114 if (!value) {
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200115 error_report(QERR_MISSING_PARAMETER, "type");
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500116 tpm_display_backend_drivers();
117 return 1;
118 }
119
Marc-André Lureaud91a7a52017-10-10 00:55:46 +0200120 i = qapi_enum_parse(&TpmType_lookup, value, -1, NULL);
Marc-André Lureaud31076b2017-10-10 00:55:49 +0200121 be = i >= 0 ? tpm_be_find_by_type(i) : NULL;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500122 if (be == NULL) {
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200123 error_report(QERR_INVALID_PARAMETER_VALUE,
124 "type", "a TPM backend type");
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500125 tpm_display_backend_drivers();
126 return 1;
127 }
128
Stefan Bergerbb716232013-04-22 10:41:39 -0400129 /* validate backend specific opts */
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200130 if (!qemu_opts_validate(opts, be->opts, &local_err)) {
131 error_report_err(local_err);
Stefan Bergerbb716232013-04-22 10:41:39 -0400132 return 1;
133 }
134
Marc-André Lureau9f7c0ef2017-11-06 19:39:09 +0100135 drv = be->create(opts);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500136 if (!drv) {
137 return 1;
138 }
139
Marc-André Lureau9f7c0ef2017-11-06 19:39:09 +0100140 drv->id = g_strdup(id);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500141 QLIST_INSERT_HEAD(&tpm_backends, drv, list);
142
143 return 0;
144}
145
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500146/*
147 * Walk the list of TPM backend drivers that are in use and call their
148 * destroy function to have them cleaned up.
149 */
150void tpm_cleanup(void)
151{
152 TPMBackend *drv, *next;
153
154 QLIST_FOREACH_SAFE(drv, &tpm_backends, list, next) {
155 QLIST_REMOVE(drv, list);
Amarnath Vallurif35fe5c2017-09-29 14:10:15 +0300156 object_unref(OBJECT(drv));
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500157 }
158}
159
160/*
161 * Initialize the TPM. Process the tpmdev command line options describing the
162 * TPM backend.
163 */
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200164int tpm_init(void)
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500165{
Markus Armbrusterd64072c02020-07-23 13:58:44 +0200166 if (qemu_opts_foreach(qemu_find_opts("tpmdev"),
167 tpm_init_tpmdev, NULL, NULL)) {
168 return -1;
169 }
170
171 return 0;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500172}
173
174/*
175 * Parse the TPM configuration options.
176 * To display all available TPM backends the user may use '-tpmdev help'
177 */
Philippe Mathieu-Daudéfcd9a352023-10-04 14:00:18 +0200178int tpm_config_parse(QemuOptsList *opts_list, const char *optstr)
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500179{
180 QemuOpts *opts;
181
Philippe Mathieu-Daudéfcd9a352023-10-04 14:00:18 +0200182 if (!strcmp(optstr, "help")) {
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500183 tpm_display_backend_drivers();
184 return -1;
185 }
Philippe Mathieu-Daudéfcd9a352023-10-04 14:00:18 +0200186 opts = qemu_opts_parse_noisily(opts_list, optstr, true);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500187 if (!opts) {
188 return -1;
189 }
190 return 0;
191}
192
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500193/*
Markus Armbrustereb815e22018-02-11 10:36:05 +0100194 * Walk the list of active TPM backends and collect information about them.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500195 */
196TPMInfoList *qmp_query_tpm(Error **errp)
197{
198 TPMBackend *drv;
Eric Blake95b3a8c2021-01-13 16:10:13 -0600199 TPMInfoList *head = NULL, **tail = &head;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500200
201 QLIST_FOREACH(drv, &tpm_backends, list) {
Marc-André Lureau191adc92017-11-06 19:39:04 +0100202 if (!drv->tpmif) {
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500203 continue;
204 }
Marc-André Lureau191adc92017-11-06 19:39:04 +0100205
Eric Blake95b3a8c2021-01-13 16:10:13 -0600206 QAPI_LIST_APPEND(tail, tpm_backend_query_tpm(drv));
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500207 }
208
209 return head;
210}
211
212TpmTypeList *qmp_query_tpm_types(Error **errp)
213{
214 unsigned int i = 0;
Eric Blake95b3a8c2021-01-13 16:10:13 -0600215 TpmTypeList *head = NULL, **tail = &head;
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500216
Eric Blake7fb1cf12015-11-18 01:52:57 -0700217 for (i = 0; i < TPM_TYPE__MAX; i++) {
Marc-André Lureaud31076b2017-10-10 00:55:49 +0200218 if (!tpm_be_find_by_type(i)) {
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500219 continue;
220 }
Eric Blake95b3a8c2021-01-13 16:10:13 -0600221 QAPI_LIST_APPEND(tail, i);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500222 }
223
224 return head;
225}
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500226TpmModelList *qmp_query_tpm_models(Error **errp)
227{
Eric Blake95b3a8c2021-01-13 16:10:13 -0600228 TpmModelList *head = NULL, **tail = &head;
Marc-André Lureaud3fd9532017-11-06 19:39:25 +0100229 GSList *e, *l = object_class_get_list(TYPE_TPM_IF, false);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500230
Marc-André Lureaud3fd9532017-11-06 19:39:25 +0100231 for (e = l; e; e = e->next) {
232 TPMIfClass *c = TPM_IF_CLASS(e->data);
233
Eric Blake95b3a8c2021-01-13 16:10:13 -0600234 QAPI_LIST_APPEND(tail, c->model);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500235 }
Marc-André Lureaud3fd9532017-11-06 19:39:25 +0100236 g_slist_free(l);
Stefan Bergerd1a0cf72013-02-27 12:47:49 -0500237
238 return head;
239}