apf

type APF_CHANNEL_CLOSE_MESSAGE ¶

type APF_CHANNEL_CLOSE_MESSAGE struct {
	MessageType      byte
	RecipientChannel uint32
}

*

• close channel message
• @MessageType - APF_CHANNEL_CLOSE
• @RecipientChannel - channel number given in the open request. *.

func ChannelClose(recipientChannel uint32) APF_CHANNEL_CLOSE_MESSAGE

func ProcessChannelClose(data []byte, session *Session) APF_CHANNEL_CLOSE_MESSAGE

type APF_CHANNEL_DATA_MESSAGE ¶

type APF_CHANNEL_DATA_MESSAGE struct {
	MessageType      byte
	RecipientChannel uint32
	DataLength       uint32
	Data             []byte
}

*

• used to send/receive data.
• @MessageType - APF_CHANNEL_DATA
• @RecipientChannel - channel number given in the open request
• @Length - Length of the data in the message
• @Data - The data in the message. *.

func ChannelData(recipientChannel uint32, buffer []byte) APF_CHANNEL_DATA_MESSAGE

type APF_CHANNEL_OPEN_CONFIRMATION_MESSAGE ¶

type APF_CHANNEL_OPEN_CONFIRMATION_MESSAGE struct {
	MessageType       byte
	RecipientChannel  uint32
	SenderChannel     uint32
	InitialWindowSize uint32
	Reserved          uint32
}

*

• response to ChannelOpen when channel open succeed
• @MessageType - APF_CHANNEL_OPEN_CONFIRMATION
• @RecipientChannel - channel number given in the open request
• @SenderChannel - channel number assigned by the sender
• @InitialWindowSize - Number of bytes in the window
• @Reserved - Reserved. *.

func ChannelOpenReplySuccess(recipientChannel, senderChannel uint32) APF_CHANNEL_OPEN_CONFIRMATION_MESSAGE

type APF_CHANNEL_OPEN_FAILURE_MESSAGE ¶

type APF_CHANNEL_OPEN_FAILURE_MESSAGE struct {
	MessageType      byte
	RecipientChannel uint32
	ReasonCode       uint32
	Reserved         uint32
	Reserved2        uint32
}

*

• response to ChannelOpen when a channel open failed
• @MessageType - APF_CHANNEL_OPEN_FAILURE
• @RecipientChannel - channel number given in the open request
• @ReasonCode - code for the reason channel could not be open
• @Reserved - Reserved. *.

func ChannelOpenReplyFailure(recipientChannel, reason uint32) APF_CHANNEL_OPEN_FAILURE_MESSAGE

type APF_CHANNEL_OPEN_MESSAGE ¶

type APF_CHANNEL_OPEN_MESSAGE struct {
	MessageType               byte
	ChannelTypeLength         uint32
	ChannelType               [15]uint8
	SenderChannel             uint32
	InitialWindowSize         uint32
	Reserved                  uint32
	ConnectedAddressLength    uint32
	ConnectedAddress          [3]uint8
	ConnectedPort             uint32
	OriginatorIPAddressLength uint32
	OriginatorIPAddress       [3]uint8
	OriginatorPort            uint32
}

type APF_CHANNEL_WINDOW_ADJUST_MESSAGE ¶

type APF_CHANNEL_WINDOW_ADJUST_MESSAGE struct {
	MessageType      byte
	RecipientChannel uint32
	BytesToAdd       uint32
}

*

• used to adjust receive window size.
• @MessageType - APF_WINDOW_ADJUST
• @RecipientChannel - channel number given in the open request
• @BytesToAdd - number of bytes to add to current window size value. *.

func ChannelWindowAdjust(recipientChannel, l uint32) APF_CHANNEL_WINDOW_ADJUST_MESSAGE

type APF_DISCONNECT_MESSAGE ¶

type APF_DISCONNECT_MESSAGE struct {
	MessageType byte
	ReasonCode  uint32
	Reserved    uint // short32
}

*

• This message causes immediate termination of the connection with AMT.
• @ReasonCode - A Reason code for the disconnection event
• @Reserved - Reserved must be set to 0. *.

type APF_GENERIC_HEADER ¶

type APF_GENERIC_HEADER struct {
	MessageType  byte
	StringLength uint32
	String       string
}

type APF_KEEPALIVE_OPTIONS_REQUEST_MESSAGE ¶ added in v2.33.0

type APF_KEEPALIVE_OPTIONS_REQUEST_MESSAGE struct {
	MessageType     byte
	IntervalSeconds uint32
	TimeoutSeconds  uint32
}

func KeepAliveOptionsRequest(keepAliveTime, timeout uint32) APF_KEEPALIVE_OPTIONS_REQUEST_MESSAGE

type APF_KEEPALIVE_REPLY_MESSAGE ¶ added in v2.33.0

type APF_KEEPALIVE_REPLY_MESSAGE struct {
	MessageType byte
	Cookie      uint32
}

type APF_MESSAGE_HEADER ¶

type APF_MESSAGE_HEADER struct {
	MessageType byte
}

type APF_PROTOCOL_VERSION_MESSAGE ¶

type APF_PROTOCOL_VERSION_MESSAGE struct {
	MessageType   byte
	MajorVersion  uint32
	MinorVersion  uint32
	TriggerReason uint32
	UUID          [16]byte
	Reserved      [64]byte
}

*

• holds the protocol major and minor version implemented by AMT.
• @MajorVersion - Protocol's Major version
• @MinorVersion - Protocol's Minor version
• @Trigger - The open session reason
• @UUID - System Id. *.

func ProcessProtocolVersion(data []byte) APF_PROTOCOL_VERSION_MESSAGE

func ProtocolVersion(majorversion, minorversion, triggerreason uint32) APF_PROTOCOL_VERSION_MESSAGE

func ProtocolVersionWithUUID(majorversion, minorversion, triggerreason uint32, uuid [16]byte) APF_PROTOCOL_VERSION_MESSAGE

type APF_SERVICE_ACCEPT_MESSAGE ¶

type APF_SERVICE_ACCEPT_MESSAGE struct {
	MessageType       byte
	ServiceNameLength uint32
	ServiceName       [18]byte
}

*

• Used to send a service accept identified by name
• @ServiceNameLength - The length of the service name string.
• @ServiceName - The name of the service being requested. *.

func ProcessServiceRequest(data []byte) APF_SERVICE_ACCEPT_MESSAGE

func ServiceAccept(serviceName string) APF_SERVICE_ACCEPT_MESSAGE

type APF_SERVICE_REQUEST_MESSAGE ¶

type APF_SERVICE_REQUEST_MESSAGE struct {
	MessageType       byte
	ServiceNameLength uint32
	ServiceName       string
}

*

• Used to request a service identified by name
• @ServiceNameLength - The length of the service name string.
• @ServiceName - The name of the service being requested. *.

type APF_TCP_FORWARD_REPLY_MESSAGE ¶

type APF_TCP_FORWARD_REPLY_MESSAGE struct {
	MessageType byte
	PortBound   uint32
}

*

• TCP forward reply message
• @MessageType - Protocol's Major version
• @PortBound - the TCP port was bound on the server. *.

func TcpForwardReplySuccess(port uint32) APF_TCP_FORWARD_REPLY_MESSAGE

type APF_TCP_FORWARD_REQUEST ¶

type APF_TCP_FORWARD_REQUEST struct {
	WantReply     uint8
	AddressLength uint32
	Address       string
	Port          uint32
}

type APF_USERAUTH_FAILURE_MESSAGE ¶ added in v2.33.0

type APF_USERAUTH_FAILURE_MESSAGE struct {
	MessageType                          byte
	AuthenticationsThatCanContinueLength uint32
	AuthenticationsThatCanContinue       [8]byte
	PartialSuccess                       byte
}

*

• holds the user authentication request failure response.
• @MessageType - APF_USERAUTH_FAILURE
• @AuthenticationsThatCanContinueLength - length of the methods string
• @AuthenticationsThatCanContinue - methods that can continue (e.g., "password")
• @PartialSuccess - 0 for no partial success.

type APF_USERAUTH_SUCCESS_MESSAGE ¶

type APF_USERAUTH_SUCCESS_MESSAGE struct {
	MessageType byte
}

*

• holds the user authentication request success response. *.

type AuthRequest ¶ added in v2.33.0

type AuthRequest struct {
	Username    string
	ServiceName string
	MethodName  string
	Password    string // Only populated when MethodName == "password"
}

AuthRequest contains the decoded fields from an APF_USERAUTH_REQUEST message.

type AuthResponse ¶ added in v2.33.0

type AuthResponse struct {
	Authenticated bool
}

AuthResponse indicates whether authentication succeeded.

type DefaultHandler ¶ added in v2.33.0

type DefaultHandler struct{}

DefaultHandler provides a no-op implementation of Handler. This maintains backward compatibility - existing code that doesn't need callbacks can continue to work unchanged.

func (h DefaultHandler) OnAuthRequest(request AuthRequest) AuthResponse

func (h DefaultHandler) OnGlobalRequest(request GlobalRequest) bool

func (h DefaultHandler) OnProtocolVersion(info ProtocolVersionInfo) error

type GlobalRequest ¶ added in v2.33.0

type GlobalRequest struct {
	RequestType string // "tcpip-forward" or "cancel-tcpip-forward"
	Address     string
	Port        uint32
}

GlobalRequest contains the decoded fields from an APF_GLOBAL_REQUEST message.

func ProcessGlobalRequest(data []byte) (GlobalRequest, interface{})

type Handler ¶ added in v2.33.0

type Handler interface {
	// OnProtocolVersion is called when an APF_PROTOCOLVERSION message is received.
	// The application can use the UUID to identify the device.
	// Returns an error if the device should be rejected.
	OnProtocolVersion(info ProtocolVersionInfo) error

	// OnAuthRequest is called when an APF_USERAUTH_REQUEST message is received.
	// The application should validate the credentials and return an AuthResponse.
	// The library will generate the appropriate success/failure response message.
	OnAuthRequest(request AuthRequest) AuthResponse

	// OnGlobalRequest is called when an APF_GLOBAL_REQUEST message is received.
	// The application can use this to track TCP forwarding requests.
	// Returns true if the application wants to send a keep-alive options request
	// after the response (caller is responsible for sending it separately).
	OnGlobalRequest(request GlobalRequest) bool
}

Handler is the interface that applications must implement to receive APF protocol events and provide application-specific decisions.

Methods are called synchronously during message processing. The library handles protocol encoding/decoding; the application handles business logic (authentication, device registration, etc.).

type Processor ¶ added in v2.33.0

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

Processor handles APF protocol messages with optional callbacks.

func NewProcessor(handler Handler) *Processor

func (p *Processor) Process(data []byte, session *Session) bytes.Buffer

type ProtocolVersionInfo ¶ added in v2.33.0

type ProtocolVersionInfo struct {
	MajorVersion  uint32
	MinorVersion  uint32
	TriggerReason uint32
	UUID          string   // Formatted as GUID string (e.g., "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
	RawUUID       [16]byte // Raw UUID bytes
}

ProtocolVersionInfo contains the decoded fields from an APF_PROTOCOL_VERSION_MESSAGE.

type Session ¶

type Session struct {
	SenderChannel    uint32
	RecipientChannel uint32
	TXWindow         uint32
	RXWindow         uint32
	Tempdata         []byte
	DataBuffer       chan []byte
	ErrorBuffer      chan error
	Status           chan bool
	Timer            *time.Timer
	WaitGroup        *sync.WaitGroup
}