Documentation
¶
Index ¶
- type ClientTransport
- func (t *ClientTransport) GetDstPort(seed []byte) (uint16, error)
- func (t *ClientTransport) GetParams() (proto.Message, error)
- func (*ClientTransport) ID() pb.TransportType
- func (*ClientTransport) Name() string
- func (t ClientTransport) ParseParams(data *anypb.Any) (any, error)
- func (t *ClientTransport) Prepare(ctx context.Context, ...) error
- func (t *ClientTransport) PrepareKeys(pubkey [32]byte, sharedSecret []byte, dRand io.Reader) error
- func (t *ClientTransport) SetParams(p any) error
- func (t *ClientTransport) SetSessionParams(incoming *anypb.Any, unchecked ...bool) error
- func (*ClientTransport) String() string
- func (t *ClientTransport) WrapConn(conn net.Conn) (net.Conn, error)
- type Transport
- func (Transport) GetDstPort(libVersion uint, seed []byte, params any) (uint16, error)
- func (Transport) GetIdentifier(d transports.Registration) string
- func (Transport) GetProto() pb.IPProto
- func (Transport) LogPrefix() string
- func (Transport) Name() string
- func (t Transport) ParamStrings(p any) []string
- func (Transport) ParseParams(libVersion uint, data *anypb.Any) (any, error)
- func (Transport) WrapConnection(data *bytes.Buffer, c net.Conn, originalDst net.IP, ...) (transports.Registration, net.Conn, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientTransport ¶
type ClientTransport struct {
// Parameters are fields that will be shared with the station in the registration. This object
// should be considered immutable after initialization otherwise changes will persist across
// subsequent dials.
Parameters *pb.GenericTransportParams
// contains filtered or unexported fields
}
ClientTransport implements the client side transport interface for the Min transport. The significant difference is that there is an instance of this structure per client session, where the station side Transport struct has one instance to be re-used for all sessions.
func (*ClientTransport) GetDstPort ¶
func (t *ClientTransport) GetDstPort(seed []byte) (uint16, error)
GetDstPort returns the destination port that the client should open the phantom connection to
func (*ClientTransport) GetParams ¶
func (t *ClientTransport) GetParams() (proto.Message, error)
GetParams returns a generic protobuf with any parameters from both the registration and the transport.
func (*ClientTransport) ID ¶
func (*ClientTransport) ID() pb.TransportType
ID provides an identifier that will be sent to the conjure station during the registration so that the station knows what transport to expect connecting to the chosen phantom.
func (*ClientTransport) Name ¶
func (*ClientTransport) Name() string
Name returns a string identifier for the Transport for logging
func (ClientTransport) ParseParams ¶
func (t ClientTransport) ParseParams(data *anypb.Any) (any, error)
ParseParams gives the specific transport an option to parse a generic object into parameters provided by the station in the registration response during registration.
func (*ClientTransport) PrepareKeys ¶
PrepareKeys provides an opportunity for the transport to integrate the station public key as well as bytes from the deterministic random generator associated with the registration that this ClientTransport is attached t
func (*ClientTransport) SetParams ¶
func (t *ClientTransport) SetParams(p any) error
SetParams allows the caller to set parameters associated with the transport, returning an error if the provided generic message is not compatible.
func (*ClientTransport) SetSessionParams ¶ added in v0.7.5
func (t *ClientTransport) SetSessionParams(incoming *anypb.Any, unchecked ...bool) error
SetSessionParams allows the session to apply updated params that are only used within an individual dial, returning an error if the provided generic message is not compatible. the variadic bool parameter is used to indicate whether the client should sanity check the params or just apply them. This is useful in cases where the registrar may provide options to the client that it is able to handle, but are outside of the clients sanity checks. (see prefix transport for an example)
func (*ClientTransport) String ¶
func (*ClientTransport) String() string
String returns a string identifier for the Transport for logging (including string formatters)
type Transport ¶
type Transport struct{}
Transport provides a struct implementing the Transport, WrappingTransport, PortRandomizingTransport, and FixedPortTransport interfaces.
func (Transport) GetDstPort ¶
GetDstPort Given the library version, a seed, and a generic object containing parameters the transport should be able to return the destination port that a clients phantom connection will attempt to reach
func (Transport) GetIdentifier ¶
func (Transport) GetIdentifier(d transports.Registration) string
GetIdentifier takes in a registration and returns an identifier for it. This identifier should be unique for each registration on a given phantom; registrations on different phantoms can have the same identifier.
func (Transport) GetProto ¶
GetProto returns the next layer protocol that the transport uses. Implements the Transport interface.
func (Transport) LogPrefix ¶
LogPrefix returns the prefix used when including this transport in logs, implementing the Transport interface.
func (Transport) Name ¶
Name returns the human-friendly name of the transport, implementing the Transport interface..
func (Transport) ParamStrings ¶
ParamStrings returns an array of tag string that will be added to tunStats when a proxy session is closed. For now, no params of interest.
func (Transport) ParseParams ¶
ParseParams gives the specific transport an option to parse a generic object into parameters provided by the client during registration.
func (Transport) WrapConnection ¶
func (Transport) WrapConnection(data *bytes.Buffer, c net.Conn, originalDst net.IP, regManager transports.RegManager) (transports.Registration, net.Conn, error)
WrapConnection attempts to wrap the given connection in the transport. It takes the information gathered so far on the connection in data, attempts to identify itself, and if it positively identifies itself wraps the connection in the transport, returning a connection that's ready to be used by others.
If the returned error is nil or non-nil and non-{ transports.ErrTryAgain, transports.ErrNotTransport }, the caller may no longer use data or conn.
Source Files