api

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 27, 2024 License: Apache-2.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// http://pid.codes/1209/2702/
	VendorID  = 0x1209
	ProductID = 0x2702

	HIDUsagePage = 0xff00

	// Maximum Message size according to U2F HID standard (see formula in
	// [FIDO U2F // HID Protocol Specification, 2.4]).
	MaxMessageSize = 7609
)
View Source
const (
	// Status
	U2FHID_ARMORY_INF = iota + u2fhid.VendorCommandFirst
	// Trusted Applet configuration
	U2FHID_ARMORY_CFG
	// Obsolete
	U2FHID_ARMORY_OTA_UNUSED
	// Set HAB fuse to built-in SRK hash
	U2FHID_ARMORY_HAB
	// Fetch latest debug/console logs
	U2FHID_ARMORY_CONSOLE_LOGS
	// Fetch stored crash logs from most recent applet crash
	U2FHID_ARMORY_CRASH_LOGS
)

U2FHID vendor specific commands

Variables

View Source
var (
	ErrorCode_name = map[int32]string{
		0: "NONE",
		1: "GENERIC_ERROR",
	}
	ErrorCode_value = map[string]int32{
		"NONE":          0,
		"GENERIC_ERROR": 1,
	}
)

Enum value maps for ErrorCode.

Functions

func EmptyResponse

func EmptyResponse() []byte

EmptyResponse for when no relevant data is available.

func ErrorResponse

func ErrorResponse(err error) (res []byte)

ErrorResponse converts an error in an API Message.

Types

type Configuration

type Configuration struct {
	DHCP      bool   `protobuf:"varint,1,opt,name=DHCP,proto3" json:"DHCP,omitempty"`
	IP        string `protobuf:"bytes,2,opt,name=IP,proto3" json:"IP,omitempty"`
	Netmask   string `protobuf:"bytes,3,opt,name=Netmask,proto3" json:"Netmask,omitempty"`
	Gateway   string `protobuf:"bytes,4,opt,name=Gateway,proto3" json:"Gateway,omitempty"`
	Resolver  string `protobuf:"bytes,5,opt,name=Resolver,proto3" json:"Resolver,omitempty"`
	NTPServer string `protobuf:"bytes,6,opt,name=NTPServer,proto3" json:"NTPServer,omitempty"`
	// contains filtered or unexported fields
}

func (*Configuration) Bytes

func (p *Configuration) Bytes() (buf []byte)

Bytes serializes an API message.

func (*Configuration) Descriptor deprecated

func (*Configuration) Descriptor() ([]byte, []int)

Deprecated: Use Configuration.ProtoReflect.Descriptor instead.

func (*Configuration) GetDHCP

func (x *Configuration) GetDHCP() bool

func (*Configuration) GetGateway

func (x *Configuration) GetGateway() string

func (*Configuration) GetIP

func (x *Configuration) GetIP() string

func (*Configuration) GetNTPServer

func (x *Configuration) GetNTPServer() string

func (*Configuration) GetNetmask

func (x *Configuration) GetNetmask() string

func (*Configuration) GetResolver

func (x *Configuration) GetResolver() string

func (*Configuration) ProtoMessage

func (*Configuration) ProtoMessage()

func (*Configuration) ProtoReflect

func (x *Configuration) ProtoReflect() protoreflect.Message

func (*Configuration) Reset

func (x *Configuration) Reset()

func (*Configuration) String

func (x *Configuration) String() string

type ErrorCode

type ErrorCode int32
const (
	ErrorCode_NONE ErrorCode = 0
	// GENERIC_ERROR is returned in case of a generic error, in this case
	// Payload might contain the error string.
	ErrorCode_GENERIC_ERROR ErrorCode = 1
)

func (ErrorCode) Descriptor

func (ErrorCode) Descriptor() protoreflect.EnumDescriptor

func (ErrorCode) Enum

func (x ErrorCode) Enum() *ErrorCode

func (ErrorCode) EnumDescriptor deprecated

func (ErrorCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ErrorCode.Descriptor instead.

func (ErrorCode) Number

func (x ErrorCode) Number() protoreflect.EnumNumber

func (ErrorCode) String

func (x ErrorCode) String() string

func (ErrorCode) Type

type LogMessagesRequest

type LogMessagesRequest struct {
	Continue bool `protobuf:"varint,1,opt,name=Continue,proto3" json:"Continue,omitempty"`
	// contains filtered or unexported fields
}

func (*LogMessagesRequest) Descriptor deprecated

func (*LogMessagesRequest) Descriptor() ([]byte, []int)

Deprecated: Use LogMessagesRequest.ProtoReflect.Descriptor instead.

func (*LogMessagesRequest) GetContinue

func (x *LogMessagesRequest) GetContinue() bool

func (*LogMessagesRequest) ProtoMessage

func (*LogMessagesRequest) ProtoMessage()

func (*LogMessagesRequest) ProtoReflect

func (x *LogMessagesRequest) ProtoReflect() protoreflect.Message

func (*LogMessagesRequest) Reset

func (x *LogMessagesRequest) Reset()

func (*LogMessagesRequest) String

func (x *LogMessagesRequest) String() string

type LogMessagesResponse

type LogMessagesResponse struct {
	Payload []byte `protobuf:"bytes,1,opt,name=Payload,proto3" json:"Payload,omitempty"`
	More    bool   `protobuf:"varint,2,opt,name=More,proto3" json:"More,omitempty"`
	// contains filtered or unexported fields
}

func (*LogMessagesResponse) Descriptor deprecated

func (*LogMessagesResponse) Descriptor() ([]byte, []int)

Deprecated: Use LogMessagesResponse.ProtoReflect.Descriptor instead.

func (*LogMessagesResponse) GetMore

func (x *LogMessagesResponse) GetMore() bool

func (*LogMessagesResponse) GetPayload

func (x *LogMessagesResponse) GetPayload() []byte

func (*LogMessagesResponse) ProtoMessage

func (*LogMessagesResponse) ProtoMessage()

func (*LogMessagesResponse) ProtoReflect

func (x *LogMessagesResponse) ProtoReflect() protoreflect.Message

func (*LogMessagesResponse) Reset

func (x *LogMessagesResponse) Reset()

func (*LogMessagesResponse) String

func (x *LogMessagesResponse) String() string

type Response

type Response struct {
	Error   ErrorCode `protobuf:"varint,1,opt,name=Error,proto3,enum=api.ErrorCode" json:"Error,omitempty"`
	Payload []byte    `protobuf:"bytes,2,opt,name=Payload,proto3" json:"Payload,omitempty"`
	// contains filtered or unexported fields
}

func (*Response) Bytes

func (p *Response) Bytes() (buf []byte)

Bytes serializes an API message.

func (*Response) Descriptor deprecated

func (*Response) Descriptor() ([]byte, []int)

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetError

func (x *Response) GetError() ErrorCode

func (*Response) GetPayload

func (x *Response) GetPayload() []byte

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) ProtoReflect

func (x *Response) ProtoReflect() protoreflect.Message

func (*Response) Reset

func (x *Response) Reset()

func (*Response) String

func (x *Response) String() string

type Status

type Status struct {
	Serial   string         `protobuf:"bytes,1,opt,name=Serial,proto3" json:"Serial,omitempty"`
	HAB      bool           `protobuf:"varint,2,opt,name=HAB,proto3" json:"HAB,omitempty"`
	Revision string         `protobuf:"bytes,3,opt,name=Revision,proto3" json:"Revision,omitempty"`
	Build    string         `protobuf:"bytes,4,opt,name=Build,proto3" json:"Build,omitempty"`
	Version  string         `protobuf:"bytes,5,opt,name=Version,proto3" json:"Version,omitempty"`
	Runtime  string         `protobuf:"bytes,6,opt,name=Runtime,proto3" json:"Runtime,omitempty"`
	Link     bool           `protobuf:"varint,7,opt,name=Link,proto3" json:"Link,omitempty"`
	Witness  *WitnessStatus `protobuf:"bytes,8,opt,name=Witness,proto3" json:"Witness,omitempty"`
	// IdentityCounter is incremented when the device is recovered and the device
	// needs a new witness identity.
	IdentityCounter uint32 `protobuf:"varint,9,opt,name=IdentityCounter,proto3" json:"IdentityCounter,omitempty"`
	SRKHash         string `protobuf:"bytes,10,opt,name=SRKHash,proto3" json:"SRKHash,omitempty"`
	// contains filtered or unexported fields
}

Status information

The status information format is returned on any message sent with the `U2FHID_ARMORY_INF` vendor specific command.

func (*Status) Descriptor deprecated

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetBuild

func (x *Status) GetBuild() string

func (*Status) GetHAB

func (x *Status) GetHAB() bool

func (*Status) GetIdentityCounter

func (x *Status) GetIdentityCounter() uint32
func (x *Status) GetLink() bool

func (*Status) GetRevision

func (x *Status) GetRevision() string

func (*Status) GetRuntime

func (x *Status) GetRuntime() string

func (*Status) GetSRKHash

func (x *Status) GetSRKHash() string

func (*Status) GetSerial

func (x *Status) GetSerial() string

func (*Status) GetVersion

func (x *Status) GetVersion() string

func (*Status) GetWitness

func (x *Status) GetWitness() *WitnessStatus

func (*Status) Print

func (p *Status) Print() string

Print returns the Trusted OS status in textual format.

func (*Status) ProtoMessage

func (*Status) ProtoMessage()

func (*Status) ProtoReflect

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset

func (x *Status) Reset()

func (*Status) String

func (x *Status) String() string

type WitnessStatus

type WitnessStatus struct {

	// Identity is the note-formatted public key which can be used to verify
	// checkpoints cosigned by this witness.
	Identity string `protobuf:"bytes,1,opt,name=Identity,proto3" json:"Identity,omitempty"`
	// IP is a string representation of the witness applet's current IP address.
	IP string `protobuf:"bytes,2,opt,name=IP,proto3" json:"IP,omitempty"`
	// IDAttestKey is the stable public key from this device, used to attest to all derived witness identities.
	IDAttestPublicKey string `protobuf:"bytes,3,opt,name=IDAttestPublicKey,proto3" json:"IDAttestPublicKey,omitempty"`
	// AttestedID is a note-formatted signed attestation for the current witness identity.
	// This attestation note contains:
	//   "ArmoredWitness ID attestation v1"
	//   <Device serial>
	//   <Witness identity counter in decimal>
	//   <Witness identity as a note verifier string>
	AttestedID string `protobuf:"bytes,4,opt,name=AttestedID,proto3" json:"AttestedID,omitempty"`
	// contains filtered or unexported fields
}

WitnessStatus contains witness-applet specific status information.

This is embedded in the general Status message if the applet has provided this information to the OS.

func (*WitnessStatus) Descriptor deprecated

func (*WitnessStatus) Descriptor() ([]byte, []int)

Deprecated: Use WitnessStatus.ProtoReflect.Descriptor instead.

func (*WitnessStatus) GetAttestedID

func (x *WitnessStatus) GetAttestedID() string

func (*WitnessStatus) GetIDAttestPublicKey

func (x *WitnessStatus) GetIDAttestPublicKey() string

func (*WitnessStatus) GetIP

func (x *WitnessStatus) GetIP() string

func (*WitnessStatus) GetIdentity

func (x *WitnessStatus) GetIdentity() string

func (*WitnessStatus) ProtoMessage

func (*WitnessStatus) ProtoMessage()

func (*WitnessStatus) ProtoReflect

func (x *WitnessStatus) ProtoReflect() protoreflect.Message

func (*WitnessStatus) Reset

func (x *WitnessStatus) Reset()

func (*WitnessStatus) String

func (x *WitnessStatus) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL