2017-08-25 03:14:03 +08:00
|
|
|
# -*- Mode: Python -*-
|
|
|
|
#
|
|
|
|
|
|
|
|
##
|
|
|
|
# = TPM (trusted platform module) devices
|
|
|
|
##
|
|
|
|
|
|
|
|
##
|
|
|
|
# @TpmModel:
|
|
|
|
#
|
|
|
|
# An enumeration of TPM models
|
|
|
|
#
|
|
|
|
# @tpm-tis: TPM TIS model
|
2018-01-30 02:33:07 +08:00
|
|
|
# @tpm-crb: TPM CRB model (since 2.12)
|
2017-08-25 03:14:03 +08:00
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
2018-01-30 02:33:07 +08:00
|
|
|
{ 'enum': 'TpmModel', 'data': [ 'tpm-tis', 'tpm-crb' ] }
|
2017-08-25 03:14:03 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-tpm-models:
|
|
|
|
#
|
|
|
|
# Return a list of supported TPM models
|
|
|
|
#
|
|
|
|
# Returns: a list of TpmModel
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-tpm-models" }
|
2018-01-30 02:33:07 +08:00
|
|
|
# <- { "return": [ "tpm-tis", "tpm-crb" ] }
|
2017-08-25 03:14:03 +08:00
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @TpmType:
|
|
|
|
#
|
|
|
|
# An enumeration of TPM types
|
|
|
|
#
|
|
|
|
# @passthrough: TPM passthrough type
|
2017-09-29 19:10:20 +08:00
|
|
|
# @emulator: Software Emulator TPM type
|
|
|
|
# Since: 2.11
|
2017-08-25 03:14:03 +08:00
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
2017-09-29 19:10:20 +08:00
|
|
|
{ 'enum': 'TpmType', 'data': [ 'passthrough', 'emulator' ] }
|
2017-08-25 03:14:03 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @query-tpm-types:
|
|
|
|
#
|
|
|
|
# Return a list of supported TPM types
|
|
|
|
#
|
|
|
|
# Returns: a list of TpmType
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-tpm-types" }
|
2017-09-29 19:10:20 +08:00
|
|
|
# <- { "return": [ "passthrough", "emulator" ] }
|
2017-08-25 03:14:03 +08:00
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-tpm-types', 'returns': ['TpmType'] }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @TPMPassthroughOptions:
|
|
|
|
#
|
|
|
|
# Information about the TPM passthrough type
|
|
|
|
#
|
|
|
|
# @path: string describing the path used for accessing the TPM device
|
|
|
|
#
|
|
|
|
# @cancel-path: string showing the TPM's sysfs cancel file
|
|
|
|
# for cancellation of TPM commands while they are executing
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
2018-12-08 19:16:04 +08:00
|
|
|
{ 'struct': 'TPMPassthroughOptions',
|
|
|
|
'data': { '*path': 'str',
|
|
|
|
'*cancel-path': 'str' } }
|
2017-08-25 03:14:03 +08:00
|
|
|
|
2017-09-29 19:10:20 +08:00
|
|
|
##
|
|
|
|
# @TPMEmulatorOptions:
|
|
|
|
#
|
|
|
|
# Information about the TPM emulator type
|
|
|
|
#
|
|
|
|
# @chardev: Name of a unix socket chardev
|
|
|
|
#
|
|
|
|
# Since: 2.11
|
|
|
|
##
|
|
|
|
{ 'struct': 'TPMEmulatorOptions', 'data': { 'chardev' : 'str' } }
|
|
|
|
|
2017-08-25 03:14:03 +08:00
|
|
|
##
|
|
|
|
# @TpmTypeOptions:
|
|
|
|
#
|
|
|
|
# A union referencing different TPM backend types' configuration options
|
|
|
|
#
|
|
|
|
# @type: 'passthrough' The configuration options for the TPM passthrough type
|
2017-09-29 19:10:20 +08:00
|
|
|
# 'emulator' The configuration options for TPM emulator backend type
|
2017-08-25 03:14:03 +08:00
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'union': 'TpmTypeOptions',
|
2017-09-29 19:10:20 +08:00
|
|
|
'data': { 'passthrough' : 'TPMPassthroughOptions',
|
|
|
|
'emulator': 'TPMEmulatorOptions' } }
|
2017-08-25 03:14:03 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @TPMInfo:
|
|
|
|
#
|
|
|
|
# Information about the TPM
|
|
|
|
#
|
|
|
|
# @id: The Id of the TPM
|
|
|
|
#
|
|
|
|
# @model: The TPM frontend model
|
|
|
|
#
|
|
|
|
# @options: The TPM (backend) type configuration options
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
##
|
|
|
|
{ 'struct': 'TPMInfo',
|
|
|
|
'data': {'id': 'str',
|
|
|
|
'model': 'TpmModel',
|
|
|
|
'options': 'TpmTypeOptions' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-tpm:
|
|
|
|
#
|
|
|
|
# Return information about the TPM device
|
|
|
|
#
|
|
|
|
# Returns: @TPMInfo on success
|
|
|
|
#
|
|
|
|
# Since: 1.5
|
|
|
|
#
|
|
|
|
# Example:
|
|
|
|
#
|
|
|
|
# -> { "execute": "query-tpm" }
|
|
|
|
# <- { "return":
|
|
|
|
# [
|
|
|
|
# { "model": "tpm-tis",
|
|
|
|
# "options":
|
|
|
|
# { "type": "passthrough",
|
|
|
|
# "data":
|
|
|
|
# { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
|
|
|
|
# "path": "/dev/tpm0"
|
|
|
|
# }
|
|
|
|
# },
|
|
|
|
# "id": "tpm0"
|
|
|
|
# }
|
|
|
|
# ]
|
|
|
|
# }
|
|
|
|
#
|
|
|
|
##
|
|
|
|
{ 'command': 'query-tpm', 'returns': ['TPMInfo'] }
|