prehook

package

v0.16.0 Latest Latest Go to latest Published: Apr 14, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/la5nta/pat

Links

Open Source Insights

Documentation ¶

Overview ¶

Package prehook implements a connection prehook mechanism, to handle any pre-negotiation required by a remote node before the B2F protocol can commence (e.g. packet node traversal).

Index ¶

Variables
func Verify(file string) error
type Conn
- func Wrap(conn net.Conn) *Conn
- func (p *Conn) Execute(ctx context.Context, script Script) error
- func (p *Conn) Read(b []byte) (int, error)
type Script
- func (s Script) Execute(ctx context.Context, conn net.Conn) error

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrConnNotWrapped = errors.New("connection not wrapped for prehook")

Functions ¶

func Verify ¶

func Verify(file string) error

Verify returns nil if the given script file is found and valid.

Types ¶

type Conn ¶

type Conn struct {
	net.Conn
	// contains filtered or unexported fields
}

func Wrap ¶

func Wrap(conn net.Conn) *Conn

Wrap returns a wrapped connection with the ability to execute a prehook.

The returned Conn implements the net.Conn interface, and should be used in place of the original throughout the lifetime of the connection once the prehook script is executed.

func (*Conn) Execute ¶

func (p *Conn) Execute(ctx context.Context, script Script) error

Execute executes the prehook script, returning nil if the process terminated successfully (exit code 0).

func (*Conn) Read ¶

func (p *Conn) Read(b []byte) (int, error)

type Script ¶

type Script struct {
	File string
	Args []string
	Env  []string
}

func (Script) Execute ¶

func (s Script) Execute(ctx context.Context, conn net.Conn) error

Execute executes the prehook script on a wrapped connection.

ErrConnNotWrapped is returned if conn is not wrapped.

Source Files ¶

View all Source files

prehook.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL