linux

Documentation

Overview

Package linux provides an interface for communicating with TPMs using a Linux TPM character device

Index

• Variables
• type Device
  • func (d *Device) MajorVersion() TPMMajorVersion
  • func (d *Device) Open() (tpm2.Transport, error)
  • func (d *Device) PartialReadSupported() bool
  • func (d *Device) Path() string
  • func (d *Device) String() string
  • func (d *Device) SysfsPath() string
• type RMDevice
  • func (d *RMDevice) RawDevice() *RawDevice
• type RawDevice
  • func DefaultTPM2Device() (*RawDevice, error)
  • func DefaultTPMDevice() (*RawDevice, error)
  • func ListTPM2Devices() (out []*RawDevice, err error)
  • func ListTPMDevices() (out []*RawDevice, err error)
  • func (d *RawDevice) PhysicalPresenceInterface() (ppi.PPI, error)
  • func (d *RawDevice) ResourceManagedDevice() (*RMDevice, error)
• type TPMDevice
• type TPMDeviceRM
• type TPMDeviceRaw
• type TPMMajorVersion
• type Tcti
• type TctiDevice
• type Transport
  • func OpenDevice(path string) (*Transport, error)
  • func (d *Transport) Close() error
  • func (d *Transport) Read(data []byte) (int, error)
  • func (d *Transport) Write(data []byte) (int, error)

Variables

var (
	// ErrDefaultNotTPM2Device indicates that the default device is not a TPM device.
	ErrDefaultNotTPM2Device = errors.New("the default TPM device is not a TPM2 device")

	// ErrNoPhysicalPresenceInterface indicates that there is no physical presence interface
	// available for a TPM device.
	ErrNoPhysicalPresenceInterface = errors.New("no physical presence interface available")

	// ErrNoResourceManagedDevice indicates that a TPM device has no corresponding resource
	// managed device.
	ErrNoResourceManagedDevice = errors.New("no resource managed TPM device available")

	// ErrNoTPMDevices indicates that there are no TPM devices.
	ErrNoTPMDevices = errors.New("no TPM devices are available")
)

Types

type Device

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

Device represents a Linux TPM character device.

func (*Device) MajorVersion

func (d *Device) MajorVersion() TPMMajorVersion

MajorVersion indicates the TPM version.

func (*Device) Open

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

Open implements tpm2.TPMDevice.Open.

func (*Device) PartialReadSupported

func (d *Device) PartialReadSupported() bool

PartialReadSupported indicates whether the TPM character device supports partial reads.

func (*Device) Path

func (d *Device) Path() string

Path returns the path of the character device.

func (*Device) String

func (d *Device) String() string

String implements fmt.Stringer.

func (*Device) SysfsPath

func (d *Device) SysfsPath() string

SysfsPath returns the path of the device in sysfs.

type RMDevice

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

RMDevice represents a Linux TPM character device that makes use of the kernel resource manager.

func (*RMDevice) RawDevice

func (d *RMDevice) RawDevice() *RawDevice

RawDevice returns the corresponding raw device.

type RawDevice

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

RawDevice represents a raw Linux TPM character device.

func DefaultTPM2Device

func DefaultTPM2Device() (*RawDevice, error)

DefaultTPM2Device returns the default TPM2 device. If there are no devices available, then ErrNoTPMDevices is returned. If the default TPM device is not a TPM2 device, then ErrDefaultNotTPM2Device is returned.

func DefaultTPMDevice

func DefaultTPMDevice() (*RawDevice, error)

DefaultTPMDevice returns the default TPM device. If there are no devices available, then ErrNoTPMDevices is returned.

func ListTPM2Devices

func ListTPM2Devices() (out []*RawDevice, err error)

ListTPMDevices returns a list of all TPM2 devices.

func ListTPMDevices

func ListTPMDevices() (out []*RawDevice, err error)

ListTPMDevices returns a list of all TPM devices. Note that this returns all devices, regardless of version.

func (*RawDevice) PhysicalPresenceInterface

func (d *RawDevice) PhysicalPresenceInterface() (ppi.PPI, error)

PhysicalPresenceInterface returns the physical presence interface associated with this device.

func (*RawDevice) ResourceManagedDevice

func (d *RawDevice) ResourceManagedDevice() (*RMDevice, error)

ResourceManagedDevice returns the corresponding resource managed device if one is available.

type TPMDevice

type TPMDevice = Device

TPMDevice represents a Linux TPM character device.

Deprecated: use Device.

type TPMDeviceRM

type TPMDeviceRM = RMDevice

TPMDeviceRM represents a Linux TPM character device that makes use of the kernel resource manager.

Deprecated: use RMDevice.

type TPMDeviceRaw

type TPMDeviceRaw = RawDevice

TPMDeviceRaw represents a raw Linux TPM character device.

Deprecated: use RawDevice.

type TPMMajorVersion

type TPMMajorVersion int

TPMMajorVersion describes the major version of a TPM device.

const (
	TPMVersion1 TPMMajorVersion = 1
	TPMVersion2 TPMMajorVersion = 2
)

type Tcti

type Tcti = Transport

Tcti represents a connection to a Linux TPM character device.

Deprecated: Use Transport.

type TctiDevice

type TctiDevice = Transport

TctiDevice represents a connection to a Linux TPM character device.

Deprecated: Use Transport

type Transport

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

Transport represents a connection to a Linux TPM character device.

func OpenDevice

func OpenDevice(path string) (*Transport, error)

OpenDevice attempts to open a connection to the Linux TPM character device at the specified path. If successful, it returns a new Transport instance which can be passed to tpm2.NewTPMContext. Failure to open the TPM character device will result in a *os.PathError being returned.

Deprecated: Use RawDevice and RMDevice.

func (*Transport) Close

func (d *Transport) Close() error

Close implements tpm2.Transport.Close.

func (*Transport) Read

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

Read implmements tpm2.Transport.

func (*Transport) Write

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

Write implmements tpm2.Transport.