qemu/tpm.c
<<
>>
Prefs
   1/*
   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 */
  14#include "config-host.h"
  15
  16#include "monitor/monitor.h"
  17#include "qapi/qmp/qerror.h"
  18#include "sysemu/tpm_backend.h"
  19#include "sysemu/tpm.h"
  20#include "qemu/config-file.h"
  21#include "qmp-commands.h"
  22
  23static QLIST_HEAD(, TPMBackend) tpm_backends =
  24    QLIST_HEAD_INITIALIZER(tpm_backends);
  25
  26
  27#define TPM_MAX_MODELS      1
  28#define TPM_MAX_DRIVERS     1
  29
  30static TPMDriverOps const *be_drivers[TPM_MAX_DRIVERS] = {
  31    NULL,
  32};
  33
  34static enum TpmModel tpm_models[TPM_MAX_MODELS] = {
  35    TPM_MODEL_MAX,
  36};
  37
  38int tpm_register_model(enum TpmModel model)
  39{
  40    int i;
  41
  42    for (i = 0; i < TPM_MAX_MODELS; i++) {
  43        if (tpm_models[i] == TPM_MODEL_MAX) {
  44            tpm_models[i] = model;
  45            return 0;
  46        }
  47    }
  48    error_report("Could not register TPM model");
  49    return 1;
  50}
  51
  52static bool tpm_model_is_registered(enum TpmModel model)
  53{
  54    int i;
  55
  56    for (i = 0; i < TPM_MAX_MODELS; i++) {
  57        if (tpm_models[i] == model) {
  58            return true;
  59        }
  60    }
  61    return false;
  62}
  63
  64const TPMDriverOps *tpm_get_backend_driver(const char *type)
  65{
  66    int i;
  67
  68    for (i = 0; i < TPM_MAX_DRIVERS && be_drivers[i] != NULL; i++) {
  69        if (!strcmp(TpmType_lookup[be_drivers[i]->type], type)) {
  70            return be_drivers[i];
  71        }
  72    }
  73
  74    return NULL;
  75}
  76
  77#ifdef CONFIG_TPM
  78
  79int tpm_register_driver(const TPMDriverOps *tdo)
  80{
  81    int i;
  82
  83    for (i = 0; i < TPM_MAX_DRIVERS; i++) {
  84        if (!be_drivers[i]) {
  85            be_drivers[i] = tdo;
  86            return 0;
  87        }
  88    }
  89    error_report("Could not register TPM driver");
  90    return 1;
  91}
  92
  93/*
  94 * Walk the list of available TPM backend drivers and display them on the
  95 * screen.
  96 */
  97static void tpm_display_backend_drivers(void)
  98{
  99    int i;
 100
 101    fprintf(stderr, "Supported TPM types (choose only one):\n");
 102
 103    for (i = 0; i < TPM_MAX_DRIVERS && be_drivers[i] != NULL; i++) {
 104        fprintf(stderr, "%12s   %s\n",
 105                TpmType_lookup[be_drivers[i]->type], be_drivers[i]->desc());
 106    }
 107    fprintf(stderr, "\n");
 108}
 109
 110/*
 111 * Find the TPM with the given Id
 112 */
 113TPMBackend *qemu_find_tpm(const char *id)
 114{
 115    TPMBackend *drv;
 116
 117    if (id) {
 118        QLIST_FOREACH(drv, &tpm_backends, list) {
 119            if (!strcmp(drv->id, id)) {
 120                return drv;
 121            }
 122        }
 123    }
 124
 125    return NULL;
 126}
 127
 128static int configure_tpm(QemuOpts *opts)
 129{
 130    const char *value;
 131    const char *id;
 132    const TPMDriverOps *be;
 133    TPMBackend *drv;
 134    Error *local_err = NULL;
 135
 136    if (!QLIST_EMPTY(&tpm_backends)) {
 137        error_report("Only one TPM is allowed.");
 138        return 1;
 139    }
 140
 141    id = qemu_opts_id(opts);
 142    if (id == NULL) {
 143        qerror_report(QERR_MISSING_PARAMETER, "id");
 144        return 1;
 145    }
 146
 147    value = qemu_opt_get(opts, "type");
 148    if (!value) {
 149        qerror_report(QERR_MISSING_PARAMETER, "type");
 150        tpm_display_backend_drivers();
 151        return 1;
 152    }
 153
 154    be = tpm_get_backend_driver(value);
 155    if (be == NULL) {
 156        qerror_report(QERR_INVALID_PARAMETER_VALUE, "type",
 157                      "a TPM backend type");
 158        tpm_display_backend_drivers();
 159        return 1;
 160    }
 161
 162    /* validate backend specific opts */
 163    qemu_opts_validate(opts, be->opts, &local_err);
 164    if (local_err) {
 165        error_report_err(local_err);
 166        return 1;
 167    }
 168
 169    drv = be->create(opts, id);
 170    if (!drv) {
 171        return 1;
 172    }
 173
 174    tpm_backend_open(drv, &local_err);
 175    if (local_err) {
 176        error_report_err(local_err);
 177        return 1;
 178    }
 179
 180    QLIST_INSERT_HEAD(&tpm_backends, drv, list);
 181
 182    return 0;
 183}
 184
 185static int tpm_init_tpmdev(QemuOpts *opts, void *dummy)
 186{
 187    return configure_tpm(opts);
 188}
 189
 190/*
 191 * Walk the list of TPM backend drivers that are in use and call their
 192 * destroy function to have them cleaned up.
 193 */
 194void tpm_cleanup(void)
 195{
 196    TPMBackend *drv, *next;
 197
 198    QLIST_FOREACH_SAFE(drv, &tpm_backends, list, next) {
 199        QLIST_REMOVE(drv, list);
 200        tpm_backend_destroy(drv);
 201    }
 202}
 203
 204/*
 205 * Initialize the TPM. Process the tpmdev command line options describing the
 206 * TPM backend.
 207 */
 208int tpm_init(void)
 209{
 210    if (qemu_opts_foreach(qemu_find_opts("tpmdev"),
 211                          tpm_init_tpmdev, NULL, 1) != 0) {
 212        return -1;
 213    }
 214
 215    atexit(tpm_cleanup);
 216
 217    return 0;
 218}
 219
 220/*
 221 * Parse the TPM configuration options.
 222 * To display all available TPM backends the user may use '-tpmdev help'
 223 */
 224int tpm_config_parse(QemuOptsList *opts_list, const char *optarg)
 225{
 226    QemuOpts *opts;
 227
 228    if (!strcmp(optarg, "help")) {
 229        tpm_display_backend_drivers();
 230        return -1;
 231    }
 232    opts = qemu_opts_parse(opts_list, optarg, 1);
 233    if (!opts) {
 234        return -1;
 235    }
 236    return 0;
 237}
 238
 239#endif /* CONFIG_TPM */
 240
 241static const TPMDriverOps *tpm_driver_find_by_type(enum TpmType type)
 242{
 243    int i;
 244
 245    for (i = 0; i < TPM_MAX_DRIVERS && be_drivers[i] != NULL; i++) {
 246        if (be_drivers[i]->type == type) {
 247            return be_drivers[i];
 248        }
 249    }
 250    return NULL;
 251}
 252
 253static TPMInfo *qmp_query_tpm_inst(TPMBackend *drv)
 254{
 255    TPMInfo *res = g_new0(TPMInfo, 1);
 256    TPMPassthroughOptions *tpo;
 257
 258    res->id = g_strdup(drv->id);
 259    res->model = drv->fe_model;
 260    res->options = g_new0(TpmTypeOptions, 1);
 261
 262    switch (drv->ops->type) {
 263    case TPM_TYPE_PASSTHROUGH:
 264        res->options->kind = TPM_TYPE_OPTIONS_KIND_PASSTHROUGH;
 265        tpo = g_new0(TPMPassthroughOptions, 1);
 266        res->options->passthrough = tpo;
 267        if (drv->path) {
 268            tpo->path = g_strdup(drv->path);
 269            tpo->has_path = true;
 270        }
 271        if (drv->cancel_path) {
 272            tpo->cancel_path = g_strdup(drv->cancel_path);
 273            tpo->has_cancel_path = true;
 274        }
 275        break;
 276    case TPM_TYPE_MAX:
 277        break;
 278    }
 279
 280    return res;
 281}
 282
 283/*
 284 * Walk the list of active TPM backends and collect information about them
 285 * following the schema description in qapi-schema.json.
 286 */
 287TPMInfoList *qmp_query_tpm(Error **errp)
 288{
 289    TPMBackend *drv;
 290    TPMInfoList *info, *head = NULL, *cur_item = NULL;
 291
 292    QLIST_FOREACH(drv, &tpm_backends, list) {
 293        if (!tpm_model_is_registered(drv->fe_model)) {
 294            continue;
 295        }
 296        info = g_new0(TPMInfoList, 1);
 297        info->value = qmp_query_tpm_inst(drv);
 298
 299        if (!cur_item) {
 300            head = cur_item = info;
 301        } else {
 302            cur_item->next = info;
 303            cur_item = info;
 304        }
 305    }
 306
 307    return head;
 308}
 309
 310TpmTypeList *qmp_query_tpm_types(Error **errp)
 311{
 312    unsigned int i = 0;
 313    TpmTypeList *head = NULL, *prev = NULL, *cur_item;
 314
 315    for (i = 0; i < TPM_TYPE_MAX; i++) {
 316        if (!tpm_driver_find_by_type(i)) {
 317            continue;
 318        }
 319        cur_item = g_new0(TpmTypeList, 1);
 320        cur_item->value = i;
 321
 322        if (prev) {
 323            prev->next = cur_item;
 324        }
 325        if (!head) {
 326            head = cur_item;
 327        }
 328        prev = cur_item;
 329    }
 330
 331    return head;
 332}
 333
 334TpmModelList *qmp_query_tpm_models(Error **errp)
 335{
 336    unsigned int i = 0;
 337    TpmModelList *head = NULL, *prev = NULL, *cur_item;
 338
 339    for (i = 0; i < TPM_MODEL_MAX; i++) {
 340        if (!tpm_model_is_registered(i)) {
 341            continue;
 342        }
 343        cur_item = g_new0(TpmModelList, 1);
 344        cur_item->value = i;
 345
 346        if (prev) {
 347            prev->next = cur_item;
 348        }
 349        if (!head) {
 350            head = cur_item;
 351        }
 352        prev = cur_item;
 353    }
 354
 355    return head;
 356}
 357