Documentation ¶
Index ¶
- Constants
- Variables
- func EmptyResponse() []byte
- func ErrorResponse(err error) (res []byte)
- type Configuration
- func (p *Configuration) Bytes() (buf []byte)
- func (*Configuration) Descriptor() ([]byte, []int)deprecated
- func (x *Configuration) GetDHCP() bool
- func (x *Configuration) GetGateway() string
- func (x *Configuration) GetIP() string
- func (x *Configuration) GetNTPServer() string
- func (x *Configuration) GetNetmask() string
- func (x *Configuration) GetResolver() string
- func (*Configuration) ProtoMessage()
- func (x *Configuration) ProtoReflect() protoreflect.Message
- func (x *Configuration) Reset()
- func (x *Configuration) String() string
- type ErrorCode
- type LogMessagesRequest
- func (*LogMessagesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *LogMessagesRequest) GetContinue() bool
- func (*LogMessagesRequest) ProtoMessage()
- func (x *LogMessagesRequest) ProtoReflect() protoreflect.Message
- func (x *LogMessagesRequest) Reset()
- func (x *LogMessagesRequest) String() string
- type LogMessagesResponse
- func (*LogMessagesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *LogMessagesResponse) GetMore() bool
- func (x *LogMessagesResponse) GetPayload() []byte
- func (*LogMessagesResponse) ProtoMessage()
- func (x *LogMessagesResponse) ProtoReflect() protoreflect.Message
- func (x *LogMessagesResponse) Reset()
- func (x *LogMessagesResponse) String() string
- type Response
- func (p *Response) Bytes() (buf []byte)
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetError() ErrorCode
- func (x *Response) GetPayload() []byte
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- type Status
- func (*Status) Descriptor() ([]byte, []int)deprecated
- func (x *Status) GetBuild() string
- func (x *Status) GetHAB() bool
- func (x *Status) GetIdentityCounter() uint32
- func (x *Status) GetLink() bool
- func (x *Status) GetRevision() string
- func (x *Status) GetRuntime() string
- func (x *Status) GetSRKHash() string
- func (x *Status) GetSerial() string
- func (x *Status) GetVersion() string
- func (x *Status) GetWitness() *WitnessStatus
- func (p *Status) Print() string
- func (*Status) ProtoMessage()
- func (x *Status) ProtoReflect() protoreflect.Message
- func (x *Status) Reset()
- func (x *Status) String() string
- type WitnessStatus
- func (*WitnessStatus) Descriptor() ([]byte, []int)deprecated
- func (x *WitnessStatus) GetAttestedID() string
- func (x *WitnessStatus) GetIDAttestPublicKey() string
- func (x *WitnessStatus) GetIP() string
- func (x *WitnessStatus) GetIdentity() string
- func (*WitnessStatus) ProtoMessage()
- func (x *WitnessStatus) ProtoReflect() protoreflect.Message
- func (x *WitnessStatus) Reset()
- func (x *WitnessStatus) String() string
Constants ¶
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 )
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 ¶
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.
var File_api_proto protoreflect.FileDescriptor
Functions ¶
func EmptyResponse ¶
func EmptyResponse() []byte
EmptyResponse for when no relevant data is available.
func ErrorResponse ¶
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
func (ErrorCode) Descriptor ¶
func (ErrorCode) Descriptor() protoreflect.EnumDescriptor
func (ErrorCode) EnumDescriptor
deprecated
func (ErrorCode) Number ¶
func (x ErrorCode) Number() protoreflect.EnumNumber
func (ErrorCode) Type ¶
func (ErrorCode) Type() protoreflect.EnumType
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) Descriptor
deprecated
func (*Response) GetPayload ¶
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
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) GetIdentityCounter ¶
func (*Status) GetRevision ¶
func (*Status) GetRuntime ¶
func (*Status) GetSRKHash ¶
func (*Status) GetVersion ¶
func (*Status) GetWitness ¶
func (x *Status) GetWitness() *WitnessStatus
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) ProtoReflect ¶
func (x *Status) ProtoReflect() protoreflect.Message
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