mssim

Documentation

Overview

Package mssim provides an interface for communicating with a TPM simulator

Index

• Constants
• type Device
  • func NewDevice(host string, port uint) *Device
  • func NewLocalDevice(port uint) *Device
  • func (d *Device) Host() string
  • func (d *Device) Open() (tpm2.Transport, error)
  • func (d *Device) Port() uint
  • func (d *Device) String() string
• type PlatformCommandError
  • func (e *PlatformCommandError) Error() string
• type Tcti
• type Transport
  • func OpenConnection(host string, port uint) (*Transport, error)
  • func (t *Transport) Close() (err error)
  • func (t *Transport) Read(data []byte) (int, error)
  • func (t *Transport) Reset() error
  • func (t *Transport) SetLocality(locality uint8) uint8
  • func (t *Transport) Stop() (out error)
  • func (t *Transport) Write(data []byte) (int, error)

Constants

const (
	DefaultPort uint = 2321
)

Types

type Device

type Device struct {
	// contains filtered or unexported fields
}

Device describes a TPM simulator device.

var (
	DefaultDevice *Device = &Device{port: DefaultPort}
)

func NewDevice

func NewDevice(host string, port uint) *Device

NewDevice returns a new device structure for the specified host and port.

func NewLocalDevice

func NewLocalDevice(port uint) *Device

NewLocalDevice returns a new device structure for the specified port on the local machine.

func (*Device) Host

func (d *Device) Host() string

Host is the host that the TPM simulator is running on.

func (*Device) Open

func (d *Device) Open() (tpm2.Transport, error)

Open implements tpm2.TPMDevice.Open.

The returned transport will automatically retry commands that fail with TPM_RC_RETRY or TPM_RC_YIELDED. It will also retry commands that fail with TPM_RC_TESTING if the command wasn't TPM_CC_SELF_TEST.

func (*Device) Port

func (d *Device) Port() uint

Port is the port number of the TPM simulator's command channel. Its platform channel runs on the next port number.

func (*Device) String

func (d *Device) String() string

String implements fmt.Stringer.

type PlatformCommandError

type PlatformCommandError struct {
	Code uint32
	// contains filtered or unexported fields
}

PlatformCommandError corresponds to an error code in response to a platform command executed on a TPM simulator.

Deprecated: This never returned.

func (*PlatformCommandError) Error

func (e *PlatformCommandError) Error() string

type Tcti

type Tcti = Transport

Tcti represents a connection to a TPM simulator that implements the Microsoft TPM2 simulator interface.

Deprecated: Use Transport.

type Transport

type Transport struct {
	// contains filtered or unexported fields
}

Transport represents a connection to a TPM simulator that implements the Microsoft TPM2 simulator interface.

func OpenConnection

func OpenConnection(host string, port uint) (*Transport, error)

OpenConnection attempts to open a connection to a TPM simulator on the specified host and port. The port argument corresponds to the TPM command server. The simulator will also provide a platform server on port+1. If host is an empty string, it defaults to "localhost".

If successful, it returns a new Transport instance which can be passed to tpm2.NewTPMContext.

Deprecated: Use NewDevice, NewLocalDevice or DefaultDevice.

func (*Transport) Close

func (t *Transport) Close() (err error)

Close implements tpm2.Transport.Close.

func (*Transport) Read

func (t *Transport) Read(data []byte) (int, error)

Read implements tpm2.Transport.Read.

func (*Transport) Reset

func (t *Transport) Reset() error

Reset submits the reset command on the platform connection, which initiates a reset of the TPM simulator and results in the execution of _TPM_Init().

func (*Transport) SetLocality

func (t *Transport) SetLocality(locality uint8) uint8

SetLocality sets the locality for subsequent commands. The supplied value is the numeric locality rather than the TPMA_LOCALITY representation. It returns the currently set locality. Localities between 5 and 31 are invalid and the behaviour of the simulator is not defined in this case.

func (*Transport) Stop

func (t *Transport) Stop() (out error)

Stop submits a stop command on both the TPM command and platform channels, which initiates a shutdown of the TPM simulator.

func (*Transport) Write

func (t *Transport) Write(data []byte) (int, error)

Write implements tpm2.Transport.Write.