aws

Documentation

Index

• Constants
• Variables
• func SerializeMessage(message *Message) ([]byte, error)
• type BinaryReader
  • func NewBReaderFromWSReader(wsReader WebSocketReader) BinaryReader
• type Message
  • func (*Message) Descriptor() ([]byte, []int)
  • func (x *Message) GetAvailableServiceIds() []string
  • func (x *Message) GetIgnorable() bool
  • func (x *Message) GetPayload() []byte
  • func (x *Message) GetServiceId() string
  • func (x *Message) GetStreamId() int32
  • func (x *Message) GetType() Message_Type
  • func (*Message) ProtoMessage()
  • func (x *Message) ProtoReflect() protoreflect.Message
  • func (x *Message) Reset()
  • func (x *Message) String() string
• type MessageReader
  • func NewMessageReader(binReader BinaryReader) MessageReader
• type Message_Type
  • func (Message_Type) Descriptor() protoreflect.EnumDescriptor
  • func (x Message_Type) Enum() *Message_Type
  • func (Message_Type) EnumDescriptor() ([]byte, []int)
  • func (x Message_Type) Number() protoreflect.EnumNumber
  • func (x Message_Type) String() string
  • func (Message_Type) Type() protoreflect.EnumType
• type MockWebSocketReader
  • func NewMockWebSocketReader() *MockWebSocketReader
  • func (mock *MockWebSocketReader) ReadMessage() (messageType int, p []byte, err error)
• type Mode
  • func OtherMode(mode Mode) Mode
• type WebSocketReader

Constants

const (
	QueryKeyProxyMode        = "local-proxy-mode"
	SubProtocolV2            = "aws.iot.securetunneling-2.0"
	HeaderKeyAccessToken     = "access-token"
	HeaderKeyClientToken     = "client-token"
	HeaderKeyStatusReason    = "X-Status-Reason"
	StatusReasonTunnelClosed = "Tunnel is closed"
	SizeOfMessageSize        = 2
	MaxWebSocketFrameSize    = 131076
)

Variables

var (
	Message_Type_name = map[int32]string{
		0: "UNKNOWN",
		1: "DATA",
		2: "STREAM_START",
		3: "STREAM_RESET",
		4: "SESSION_RESET",
		5: "SERVICE_IDS",
	}
	Message_Type_value = map[string]int32{
		"UNKNOWN":       0,
		"DATA":          1,
		"STREAM_START":  2,
		"STREAM_RESET":  3,
		"SESSION_RESET": 4,
		"SERVICE_IDS":   5,
	}
)

Enum value maps for Message_Type.

var (
	//lint:ignore ST1005 user message use alone.
	ErrTunnelClosed = errors.New("Tunnel is closed")

	SubProtocols = []string{
		SubProtocolV2,
	}
)

var File_Message_proto protoreflect.FileDescriptor

Functions

func SerializeMessage

func SerializeMessage(message *Message) ([]byte, error)

SerializeMessage returns serialized binary data.

Types

type BinaryReader

type BinaryReader interface {
	ReadMessage() ([]byte, error)
}

BinaryReader is an interface for reading binary data.

func NewBReaderFromWSReader

func NewBReaderFromWSReader(wsReader WebSocketReader) BinaryReader

NewBReaderFromWSReader returns BinaryReader from WebSocketReader.

type Message

type Message struct {
	Type                Message_Type `protobuf:"varint,1,opt,name=type,proto3,enum=com.amazonaws.iot.securedtunneling.Message_Type" json:"type,omitempty"`
	StreamId            int32        `protobuf:"varint,2,opt,name=streamId,proto3" json:"streamId,omitempty"`
	Ignorable           bool         `protobuf:"varint,3,opt,name=ignorable,proto3" json:"ignorable,omitempty"`
	Payload             []byte       `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	ServiceId           string       `protobuf:"bytes,5,opt,name=serviceId,proto3" json:"serviceId,omitempty"`
	AvailableServiceIds []string     `protobuf:"bytes,6,rep,name=availableServiceIds,proto3" json:"availableServiceIds,omitempty"`
	// contains filtered or unexported fields
}

func (*Message) Descriptor

func (*Message) Descriptor() ([]byte, []int)

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetAvailableServiceIds

func (x *Message) GetAvailableServiceIds() []string

func (*Message) GetIgnorable

func (x *Message) GetIgnorable() bool

func (*Message) GetPayload

func (x *Message) GetPayload() []byte

func (*Message) GetServiceId

func (x *Message) GetServiceId() string

func (*Message) GetStreamId

func (x *Message) GetStreamId() int32

func (*Message) GetType

func (x *Message) GetType() Message_Type

func (*Message) ProtoMessage

func (*Message) ProtoMessage()

func (*Message) ProtoReflect

func (x *Message) ProtoReflect() protoreflect.Message

func (*Message) Reset

func (x *Message) Reset()

func (*Message) String

func (x *Message) String() string

type MessageReader

type MessageReader interface {
	// Read websocket frames, and return deserialized Message.
	Read() (*Message, error)
}

MessageReader is an interface for reading secure tunneling messages.

func NewMessageReader

func NewMessageReader(binReader BinaryReader) MessageReader

NewMessageReader returns a instance implements MessageReader interface.

type Message_Type

type Message_Type int32

const (
	Message_UNKNOWN       Message_Type = 0
	Message_DATA          Message_Type = 1
	Message_STREAM_START  Message_Type = 2
	Message_STREAM_RESET  Message_Type = 3
	Message_SESSION_RESET Message_Type = 4
	Message_SERVICE_IDS   Message_Type = 5
)

func (Message_Type) Descriptor

func (Message_Type) Descriptor() protoreflect.EnumDescriptor

func (Message_Type) Enum

func (x Message_Type) Enum() *Message_Type

func (Message_Type) EnumDescriptor

func (Message_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Message_Type.Descriptor instead.

func (Message_Type) Number

func (x Message_Type) Number() protoreflect.EnumNumber

func (Message_Type) String

func (x Message_Type) String() string

func (Message_Type) Type

func (Message_Type) Type() protoreflect.EnumType

type MockWebSocketReader

type MockWebSocketReader struct {
	MockRead func() (messageType int, p []byte, err error)
}

func NewMockWebSocketReader

func NewMockWebSocketReader() *MockWebSocketReader

func (*MockWebSocketReader) ReadMessage

func (mock *MockWebSocketReader) ReadMessage() (messageType int, p []byte, err error)

type Mode

type Mode string

Mode represents local proxy mode.

const (
	// ModeSource represents source mode.
	ModeSource Mode = "source"
	// ModeDestination represents destination mode.
	ModeDestination Mode = "destination"
	// ModeUnknown represents unknown mode.
	ModeUnknown Mode = ""
)

func OtherMode

func OtherMode(mode Mode) Mode

type WebSocketReader

type WebSocketReader interface {
	ReadMessage() (messageType int, p []byte, err error)
}

WebSocketReader is an interface for reading websocket frames. Actually, it refers to gorilla/websocket.Conn.ReadMessage().