message

type ChannelID *uint64

type ConnectionID string

type DocField struct {
	Name     string
	DataType string
	Comment  string
	Embedded *DocStruct
}

type DocStruct struct {
	Name        string
	Description string
	Fields      []DocField
}

type DocType struct {
	Type

	Description string
}

type Documentation struct {
	// Message is the main message object
	Message DocStruct
	// Payloads is a map for payload codes to struct docs
	Payloads map[DocType]*DocStruct
}

type KeyboardInteractiveAnswer struct {
	Question string `json:"question" yaml:"question"` // The question text sent to the user.
	Answer   string `json:"answer" yaml:"question"`   // The response from the user.
}

type KeyboardInteractiveQuestion struct {
	Question string `json:"question" yaml:"question"` // The question text sent to the user.
	Echo     bool   `json:"echo" yaml:"echo"`         // True if the input was visible on the screen.
}

type Message struct {
	ConnectionID ConnectionID `json:"connectionId" yaml:"connectionId"` // ConnectionID is an opaque ID of the connection.
	Timestamp    int64        `json:"timestamp" yaml:"timestamp"`       // Timestamp is a nanosecond timestamp when the message was created.
	MessageType  Type         `json:"type" yaml:"type"`                 // Type of the Payload object.
	Payload      Payload      `json:"payload" yaml:"payload"`           // Payload is always a pointer to a payload object.
	ChannelID    ChannelID    `json:"channelId" yaml:"channelId"`       // ChannelID is a identifier for an SSH channel, if applicable. -1 otherwise.
}

type Payload interface {
	// Equals compares if the current payload is identical to the provided other payload.
	Equals(payload Payload) bool
}

type PayloadAuthKeyboardInteractiveAnswer struct {
	Username string                      `json:"username" yaml:"username"`
	Answers  []KeyboardInteractiveAnswer `json:"answers" yaml:"answers"`
}

type PayloadAuthKeyboardInteractiveBackendError struct {
	Username string `json:"username" yaml:"username"`
	Reason   string `json:"reason" yaml:"reason"`
}

type PayloadAuthKeyboardInteractiveChallenge struct {
	Username    string                        `json:"username" yaml:"username"`
	Instruction string                        `json:"instruction" yaml:"instruction"`
	Questions   []KeyboardInteractiveQuestion `json:"questions" yaml:"questions"`
}

type PayloadAuthKeyboardInteractiveFailed struct {
	Username string
}

type PayloadAuthPassword struct {
	Username string `json:"username" yaml:"username"`
	Password []byte `json:"password" yaml:"password"`
}

type PayloadAuthPasswordBackendError struct {
	Username string `json:"username" yaml:"username"`
	Password []byte `json:"password" yaml:"password"`
	Reason   string `json:"reason" yaml:"reason"`
}

type PayloadAuthPubKey struct {
	Username string `json:"username" yaml:"username"`
	Key      string `json:"key" yaml:"key"`
}

type PayloadAuthPubKeyBackendError struct {
	Username string `json:"username" yaml:"username"`
	Key      string `json:"key" yaml:"key"`
	Reason   string `json:"reason" yaml:"reason"`
}

type PayloadChannelRequestDecodeFailed struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	RequestType string `json:"requestType" yaml:"requestType"`
	Payload     []byte `json:"payload" yaml:"payload"`
	Reason      string `json:"reason" yaml:"reason"`
}

type PayloadChannelRequestExec struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	Program string `json:"program" yaml:"program"`
}

type PayloadChannelRequestPty struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	Term     string `json:"term" yaml:"term"`
	Columns  uint32 `json:"columns" yaml:"columns"`
	Rows     uint32 `json:"rows" yaml:"rows"`
	Width    uint32 `json:"width" yaml:"width"`
	Height   uint32 `json:"height" yaml:"height"`
	ModeList []byte `json:"modelist" yaml:"modelist"`
}

type PayloadChannelRequestSetEnv struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	Name  string `json:"name" yaml:"name"`
	Value string `json:"value" yaml:"value"`
}

type PayloadChannelRequestShell struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`
}

type PayloadChannelRequestSignal struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	Signal string `json:"signal" yaml:"signal"`
}

type PayloadChannelRequestSubsystem struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	Subsystem string `json:"subsystem" yaml:"subsystem"`
}

type PayloadChannelRequestUnknownType struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`

	RequestType string `json:"requestType" yaml:"requestType"`
	Payload     []byte `json:"payload" yaml:"payload"`
}

type PayloadChannelRequestWindow struct {
	RequestID uint64 `json:"requestId" yaml:"requestId"`
	Columns   uint32 `json:"columns" yaml:"columns"`
	Rows      uint32 `json:"rows" yaml:"rows"`
	Width     uint32 `json:"width" yaml:"width"`
	Height    uint32 `json:"height" yaml:"height"`
}

type PayloadConnect struct {
	RemoteAddr string `json:"remoteAddr" yaml:"remoteAddr"` // RemoteAddr contains the IP address of the connecting user.
	Country    string `json:"country" yaml:"country"`       // Country contains the country code looked up from the IP address. Contains "XX" if the lookup failed.
}

type PayloadExit struct {
	ExitStatus uint32 `json:"exitStatus" yaml:"exitStatus"`
}

type PayloadExitSignal struct {
	Signal       string `json:"signal" yaml:"signal"`
	CoreDumped   bool   `json:"coreDumped" yaml:"coreDumped"`
	ErrorMessage string `json:"errorMessage" yaml:"errorMessage"`
	LanguageTag  string `json:"languageTag" yaml:"languageTag"`
}

type PayloadGlobalRequestUnknown struct {
	RequestType string `json:"requestType" yaml:"requestType"`
}

type PayloadHandshakeFailed struct {
	Reason string `json:"reason" yaml:"reason"`
}

type PayloadHandshakeSuccessful struct {
	Username string `json:"username" yaml:"username"`
}

type PayloadIO struct {
	Stream Stream `json:"stream" yaml:"stream"` // 0 = stdin, 1 = stdout, 2 = stderr
	Data   []byte `json:"data" yaml:"data"`
}

type PayloadNewChannel struct {
	ChannelType string `json:"channelType" yaml:"channelType"`
}

type PayloadNewChannelFailed struct {
	ChannelType string `json:"channelType" yaml:"channelType"`
	Reason      string `json:"reason" yaml:"reason"`
}

type PayloadNewChannelSuccessful struct {
	ChannelType string `json:"channelType" yaml:"channelType"`
}

type PayloadRequestFailed struct {
	RequestID uint64 `json:"requestId" yaml:"reason"`
	Reason    string `json:"reason" yaml:"reason"`
}

type Stream uint

type Type int32