subspacerelaypb

type ConnectionType int32

type EmulationShortcut struct {

	// cAPDU headers to match each value must be exactly 4 bytes (CLA INS P1 P2)
	// if omitted will wildcard match any header
	CapduHeader [][]byte `protobuf:"bytes,1,rep,name=capdu_header,json=capduHeader,proto3" json:"capdu_header,omitempty"`
	// data to match
	// if omitted will wildcard any data value
	CapduData [][]byte `protobuf:"bytes,2,rep,name=capdu_data,json=capduData,proto3" json:"capdu_data,omitempty"`
	// rAPDU to respond to the matching shortcut cAPDU
	Rapdu []byte `protobuf:"bytes,3,opt,name=rapdu,proto3" json:"rapdu,omitempty"`
	// if false after the first match the shortcut is forgotten
	// if true it will remain until disconnect or reconnect is received
	// persistent should only be specified for non rpc replies
	// if the persistent flag is present on chained_next fields that set of shortcuts will persist until it no longer matches
	Persistent bool `protobuf:"varint,4,opt,name=persistent,proto3" json:"persistent,omitempty"`
	// if true shortcut will persist disconnect/reconnect cycles
	PersistReconnect bool `protobuf:"varint,7,opt,name=persist_reconnect,json=persistReconnect,proto3" json:"persist_reconnect,omitempty"`
	// if true the matching cAPDU received from the reader will be will be sent as a Payload back to the client
	SendCapdu bool `protobuf:"varint,5,opt,name=send_capdu,json=sendCapdu,proto3" json:"send_capdu,omitempty"`
	// expect the following as the immediate next shortcut to occur to enable response chaining
	// if the shortcut does not match the next cAPDU it is discarded
	ChainedNext []*EmulationShortcut `protobuf:"bytes,6,rep,name=chained_next,json=chainedNext,proto3" json:"chained_next,omitempty"`
	// contains filtered or unexported fields
}

type Log struct {
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type Message struct {

	// Types that are valid to be assigned to Message:
	//
	//	*Message_Payload
	//	*Message_EmulationShortcut
	//	*Message_RequestRelayInfo
	//	*Message_RelayInfo
	//	*Message_Log
	//	*Message_Reconnect
	//	*Message_Disconnect
	//	*Message_RequestRelayDiscovery
	//	*Message_RelayDiscoveryPlaintext
	//	*Message_RelayDiscoveryEncrypted
	Message isMessage_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

type Message_Disconnect struct {
	Disconnect *emptypb.Empty `protobuf:"bytes,6,opt,name=disconnect,proto3,oneof"`
}

type Message_EmulationShortcut struct {
	// Load an emulation shortcut config into a supported card emulation relay
	// Shortcuts preempt a cAPDU from the reader with a given rAPDU response to reduce round trip delays
	// if multiple shortcuts match precedence of which shortcut is used is determined by the following
	// 1. chained_next from the previously matched cAPDU
	// 2. non-persistent shortcuts are checked before persistent shortcuts
	// 3. chained_next fields containing multiple EmulationShortcuts will check earlier array entries first
	// 4. non-chained shortcuts with explicit cAPDU headers are checked before wildcard header matches
	// 5. non-chained shortcuts with explicit data matches are checked before wildcard data matches
	// 6. non-chained older shortcuts preferred over newer - this may not always hold true due to network conditions
	// shortcuts are flushed when disconnect or reconnect messages are received by a relay unless persist_reconnect is true
	EmulationShortcut *EmulationShortcut `protobuf:"bytes,7,opt,name=emulation_shortcut,json=emulationShortcut,proto3,oneof"`
}

type Message_Log struct {
	Log *Log `protobuf:"bytes,4,opt,name=log,proto3,oneof"`
}

type Message_Payload struct {
	// Payloads exchanged between a relay and a controller
	Payload *Payload `protobuf:"bytes,1,opt,name=payload,proto3,oneof"`
}

type Message_Reconnect struct {
	// most connections are established automatically, or are driven ia external means (eg cardhopper entering a field)
	// but some remote-driven interactions (eg emulating a card) are still initiated from the local side (eg BLE) or
	// require setup (cardhopper emulation)
	Reconnect *Reconnect `protobuf:"bytes,5,opt,name=reconnect,proto3,oneof"`
}

type Message_RelayDiscoveryEncrypted struct {
	RelayDiscoveryEncrypted *RelayDiscoveryEncrypted `protobuf:"bytes,10,opt,name=relay_discovery_encrypted,json=relayDiscoveryEncrypted,proto3,oneof"`
}

type Message_RelayDiscoveryPlaintext struct {
	// If a relay has discovery enabled it will emit a relay_discovery_plaintext or relay_discovery_encrypted broadcast
	// message on startup and in response to a received request_discovery message.
	// Supporting plaintext discovery removes the cryptographic guarantees that a malicious broker or anything that can
	// see the broker traffic can not view comms when cryptography using relay_ids is enabled.
	// A relay with discovery enabled  will support both plaintext and encrypted discovery unless a whitelisted public
	// key is specified at which point only encrypted discovery messages will be supported and the startup broadcast
	// will be encrypted with he provided public key
	RelayDiscoveryPlaintext *RelayDiscovery `protobuf:"bytes,9,opt,name=relay_discovery_plaintext,json=relayDiscoveryPlaintext,proto3,oneof"`
}

type Message_RelayInfo struct {
	RelayInfo *RelayInfo `protobuf:"bytes,3,opt,name=relay_info,json=relayInfo,proto3,oneof"`
}

type Message_RequestRelayDiscovery struct {
	// Controllers can broadcast a request_relay_discovery message and all connected relays with discovery enabled will
	// respond with a relay_discovery response.
	// Supporting discovery is opt-in and relays may choose to only support encrypted discovery and optionally whitelist
	// specific controller public keys
	RequestRelayDiscovery *RequestRelayDiscovery `protobuf:"bytes,8,opt,name=request_relay_discovery,json=requestRelayDiscovery,proto3,oneof"`
}

type Message_RequestRelayInfo struct {
	RequestRelayInfo *emptypb.Empty `protobuf:"bytes,2,opt,name=request_relay_info,json=requestRelayInfo,proto3,oneof"`
}

type Payload struct {
	Payload     []byte      `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	PayloadType PayloadType `` /* 129-byte string literal not displayed */
	Sequence    uint32      `protobuf:"varint,3,opt,name=sequence,proto3" json:"sequence,omitempty"`
	// control is used for PCSC control codes, only uint16 values are valid
	Control *uint32 `protobuf:"varint,4,opt,name=control,proto3,oneof" json:"control,omitempty"`
	// contains filtered or unexported fields
}

type PayloadType int32

type Reconnect struct {

	// uid may not be supported by all card emulators
	Uid []byte `protobuf:"bytes,2,opt,name=uid,proto3" json:"uid,omitempty"`
	// ats may not be supported by all card emulators
	Ats []byte `protobuf:"bytes,3,opt,name=ats,proto3" json:"ats,omitempty"`
	// some card emulator relays may need an explicit list of AIDs to register (eg Mobile HCE) or they will not be visible
	// if the relay does not have this requirement it will be ignored
	AidList [][]byte `protobuf:"bytes,4,rep,name=aid_list,json=aidList,proto3" json:"aid_list,omitempty"`
	// initial list of EmulationShortcuts to load
	Shortcuts []*EmulationShortcut `protobuf:"bytes,5,rep,name=shortcuts,proto3" json:"shortcuts,omitempty"`
	// force flush all shortcuts, even those with persist_reconnect set to true
	ForceFlushShortcuts bool `protobuf:"varint,6,opt,name=force_flush_shortcuts,json=forceFlushShortcuts,proto3" json:"force_flush_shortcuts,omitempty"`
	// contains filtered or unexported fields
}

type RelayDiscovery struct {
	RelayId   string     `protobuf:"bytes,1,opt,name=relay_id,json=relayId,proto3" json:"relay_id,omitempty"`
	RelayInfo *RelayInfo `protobuf:"bytes,2,opt,name=relay_info,json=relayInfo,proto3" json:"relay_info,omitempty"`
	// contains filtered or unexported fields
}

type RelayDiscoveryEncrypted struct {

	// controller public key must match the public key specified in the RequestRelayDiscovery message
	ControllerPublicKey []byte `protobuf:"bytes,1,opt,name=controller_public_key,json=controllerPublicKey,proto3" json:"controller_public_key,omitempty"`
	// the relay public key should be randomly generated each time a discovery request is received
	RelayPublicKey []byte `protobuf:"bytes,2,opt,name=relay_public_key,json=relayPublicKey,proto3" json:"relay_public_key,omitempty"`
	// encrypted_relay_discovery contains an encrypted RelayDiscovery message encrypted with AES128-GCM using keys
	// negotiated with ECDH X5519
	EncryptedRelayDiscovery []byte `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

type RelayInfo struct {
	SupportedPayloadTypes []PayloadType  `` /* 168-byte string literal not displayed */
	ConnectionType        ConnectionType `` /* 141-byte string literal not displayed */
	// atr is only present when PAYLOAD_TYPE_PCSC_READER is in supported_payload_types and supported by the reader
	Atr []byte `protobuf:"bytes,2,opt,name=atr,proto3" json:"atr,omitempty"`
	// device_name is only present when available, eg for PCSC readers or when connected to a BLE peripheral
	DeviceName string `protobuf:"bytes,3,opt,name=device_name,json=deviceName,proto3" json:"device_name,omitempty"`
	// device_address is only present when available, eg when connected to a BLE peripheral
	DeviceAddress []byte `protobuf:"bytes,4,opt,name=device_address,json=deviceAddress,proto3" json:"device_address,omitempty"`
	// rssi is only present when available, eg when connected to a BLE peripheral
	Rssi int32 `protobuf:"zigzag32,6,opt,name=rssi,proto3" json:"rssi,omitempty"`
	// true iff EmulationShortcut messages are supported
	SupportsShortcut bool `protobuf:"varint,7,opt,name=supports_shortcut,json=supportsShortcut,proto3" json:"supports_shortcut,omitempty"`
	// true iff card emulation requires an explicit list of AIDs in the Reconnect message
	RequiresAidList bool `protobuf:"varint,8,opt,name=requires_aid_list,json=requiresAidList,proto3" json:"requires_aid_list,omitempty"`
	// user agent is an optional name/version of the relay application
	UserAgent string `protobuf:"bytes,9,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// Optional parameters for NFC cards. May not always be populated, eg PCSC readers may require querying via pseudo APDUs
	Uid  []byte `protobuf:"bytes,10,opt,name=uid,proto3" json:"uid,omitempty"`
	Atqa []byte `protobuf:"bytes,11,opt,name=atqa,proto3" json:"atqa,omitempty"`
	Sak  []byte `protobuf:"bytes,12,opt,name=sak,proto3" json:"sak,omitempty"`
	Ats  []byte `protobuf:"bytes,13,opt,name=ats,proto3" json:"ats,omitempty"`
	// contains filtered or unexported fields
}

type RequestRelayDiscovery struct {

	// Optional X5519 public key of the controller that the relay should use to encrypt the discovery response with
	ControllerPublicKey []byte `protobuf:"bytes,1,opt,name=controller_public_key,json=controllerPublicKey,proto3" json:"controller_public_key,omitempty"`
	// Optional payload type the controller is looking for. If specified  relays should only respond if it supports the
	// provided payload type.
	PayloadTypes []PayloadType `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}