sockproxy

Documentation

Overview

Package sockproxy will provide a tcp forwarding proxy as a buildkit session Attachable. This can be used to provide a tcp protocol bridge to the buildkit built-in unix protocol forwarding.

Index

• func NewProvider(confs []AgentConfig) (session.Attachable, error)
• func Run(l net.Listener, dialer func() (net.Conn, error)) error
• type AgentConfig

Functions

func NewProvider

func NewProvider(confs []AgentConfig) (session.Attachable, error)

NewProvider creates a session provider for arbitrary socket forwarding by piggy-backing off the SSH forwarding protocol.

func Run

func Run(l net.Listener, dialer func() (net.Conn, error)) error

Run will start the proxy. This must be done before using the session.Attachable in a buildkit solve request. To release resources you MUST Close the provided listener when done using the proxy.

Types

type AgentConfig

type AgentConfig struct {
	// ID should be a digest string that uniquely identifies this config.
	ID string
	// Path is the list of paths to forward.  If empty, SSH_AUTH_SOCK will be
	// used unless SSH is false.
	Paths []string
	// SSH when true will fall back to forward the file located at the
	// SSH_AUTH_SOCK environment variable.
	SSH bool
}

AgentConfig holds data necessary for to create a tcp forwarding agent.