mgsproto

type AcknowledgeContent ¶

type AcknowledgeContent struct {
	MessageType         string `json:"AcknowledgedMessageType"`
	MessageId           string `json:"AcknowledgedMessageId"`
	SequenceNumber      int64  `json:"AcknowledgedMessageSequenceNumber"`
	IsSequentialMessage bool   `json:"IsSequentialMessage"`
}

AcknowledgeContent is used to inform the sender of an acknowledgment message that the message has been received. * MessageType is a 32 byte UTF-8 string containing the message type. * MessageId is a 40 byte UTF-8 string containing the UUID identifying this message being acknowledged. * SequenceNumber is an 8 byte integer containing the message sequence number for serialized message. * IsSequentialMessage is a boolean field representing whether the acknowledged message is part of a sequence, * it is always true for now.

type ActionStatus ¶

type ActionStatus int

const (
	Success     ActionStatus = 1
	Failed      ActionStatus = 2
	Unsupported ActionStatus = 3
)

type ActionType ¶

type ActionType string

const (
	KMSEncryption ActionType = "KMSEncryption"
	SessionType   ActionType = "SessionType"
)

type ChannelClosed ¶

type ChannelClosed struct {
	MessageId     string `json:"MessageId"`
	CreatedDate   string `json:"CreatedDate"`
	DestinationId string `json:"DestinationId"`
	SessionId     string `json:"SessionId"`
	MessageType   string `json:"MessageType"`
	SchemaVersion int    `json:"SchemaVersion"`
	Output        string `json:"Output"`
}

ChannelClosed is used to inform the client to close the channel * MessageId is a 40 byte UTF-8 string containing the UUID identifying this message. * CreatedDate is a string field containing the message create epoch millis in UTC. * DestinationId is a string field containing the session target. * SessionId is a string field representing which session to close. * MessageType is a 32 byte UTF-8 string containing the message type. * SchemaVersion is a 4 byte integer containing the message schema version number. * Output is a string field containing the error message for channel close.

type ClientMessage ¶

type ClientMessage struct {
	HeaderLength   uint32
	MessageType    string // 32 bytes
	SchemaVersion  uint32
	CreatedDate    uint64 // Unix time in milliseconds
	SequenceNumber int64
	Flags          ClientMessageFlag // uint64
	MessageId      uuid.UUID         // 16 bytes
	PayloadDigest  []byte            // 32 bytes (sha256)
	PayloadType    PayloadType       // uint32
	PayloadLength  uint32
	Payload        []byte // Variable length
}

ClientMessage represents a message for client to send/receive. ClientMessage Message in MGS is equivalent to MDS' InstanceMessage. All client messages are sent in this form to the MGS service.

• HL - HeaderLength is a 4 byte integer that represents the header length (not including the HL field itself)
• MessageType is a 32 byte UTF-8 string containing the message type.
• SchemaVersion is a 4 byte integer containing the message schema version number.
• CreatedDate is an 8 byte integer containing the message create epoch millis in UTC.
• SequenceNumber is an 8 byte integer containing the message sequence number for serialized message streams.
• Flags is an 8 byte unsigned integer containing a packed array of control flags:
• Bit 0 is SYN - SYN is set (1) when the recipient should consider Seq to be the first message number in the stream
• Bit 1 is FIN - FIN is set (1) when this message is the final message in the sequence.
• In practice, we only set Flags to SYN|FIN (3) for the `Acknowledge` and `ChannelClosed` messages.
• Everywhere else it's 0.
• MessageId is a 16 byte random UUID identifying this message. (AB: I fixed the incorrect definition)
• Payload digest is a 32 byte containing the SHA-256 hash of the payload.
• PayloadLength is a 4 byte unsigned integer containing the byte length of data in the Payload field. It's not a reliable field and appears to contain garbage for some message types.
• Payload is a variable length byte data.

The maximum payload length for streaming data appears to be 1024 bytes ¶

All numbers are sent as big-endian down the wire.

func DeserializeMGSClientMessage(data []byte) (*ClientMessage, error)

type ClientMessageFlag ¶

type ClientMessageFlag uint64

func (c ClientMessageFlag) String() string

type FlagMessage ¶

type FlagMessage uint32

const (
	DisconnectToPort   FlagMessage = 1
	TerminateSession   FlagMessage = 2
	ConnectToPortError FlagMessage = 3
)

type HandshakeRequestPayload ¶

type HandshakeRequestPayload struct {
	AgentVersion           string                  `json:"AgentVersion"`
	RequestedClientActions []RequestedClientAction `json:"RequestedClientActions"`
}

HandshakeRequestPayload payload sent by the agent to the session manager plugin

type HandshakeResponsePayload ¶

type HandshakeResponsePayload struct {
	ClientVersion          string                  `json:"ClientVersion"`
	ProcessedClientActions []ProcessedClientAction `json:"ProcessedClientActions"`
	Errors                 []string                `json:"Errors"`
}

HandshakeResponsePayload is sent by the plugin in response to the handshake request

type OpenDataChannelInput ¶

type OpenDataChannelInput struct {
	MessageSchemaVersion string `json:"MessageSchemaVersion" min:"1" type:"string" required:"true"`
	RequestId            string `json:"RequestId" min:"16" type:"string" required:"true"`
	TokenValue           string `json:"TokenValue" min:"1" type:"string" required:"true"`
	ClientId             string `json:"ClientId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

OpenDataChannelInput is sent as a WebSocket text message to initiate the SSM session. It must be the very first message sent over a newly opened WebSocket.

type PayloadType ¶

type PayloadType uint32

const (
	Output                       PayloadType = 1
	Error                        PayloadType = 2
	Size                         PayloadType = 3
	Parameter                    PayloadType = 4
	HandshakeRequestPayloadType  PayloadType = 5
	HandshakeResponsePayloadType PayloadType = 6
	HandshakeCompletePayloadType PayloadType = 7
	EncChallengeRequest          PayloadType = 8
	EncChallengeResponse         PayloadType = 9
	Flag                         PayloadType = 10
	StdErr                       PayloadType = 11
	ExitCode                     PayloadType = 12
)

func (t PayloadType) String() string

type ProcessedClientAction ¶

type ProcessedClientAction struct {
	ActionType   ActionType   `json:"ActionType"`
	ActionStatus ActionStatus `json:"ActionStatus"`
	ActionResult interface{}  `json:"ActionResult"`
	Error        string       `json:"Error"`
}

ProcessedClientAction The result of processing the action by the plugin

type RequestedClientAction ¶

type RequestedClientAction struct {
	ActionType       ActionType      `json:"ActionType"`
	ActionParameters json.RawMessage `json:"ActionParameters"`
}

RequestedClientAction an action requested by the agent to the plugin

type SessionTypeRequest ¶

type SessionTypeRequest struct {
	SessionType string      `json:"SessionType"`
	Properties  interface{} `json:"Properties"`
}

SessionTypeRequest request contains type of the session that needs to be launched and properties for plugin