package socks

Import Path
	golang.org/x/net/internal/socks (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	    client.go
	  d socks.go
		Package socks provides a SOCKS version 5 client implementation.
		
		SOCKS protocol version 5 is defined in RFC 1928.
		Username/Password authentication for SOCKS version 5 is defined in
		RFC 1929.
Package-Level Type Names (total 7, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Addr (struct)
		An Addr represents a SOCKS-specific address.
		Either Name or IP is used exclusively.

		Fields (total 3, all are exported)
			IP net.IP
			Name string
				// fully-qualified domain name

			Port int
		Methods (total 2, both are exported)
			(*Addr) Network() string
			(*Addr) String() string
		Implements (at least 4, in which 2 are exported)
			*Addr : fmt.Stringer
			*Addr : net.Addr
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*Addr : context.stringer
			*Addr : runtime.stringer

	 type AuthMethod int (basic type)
		An AuthMethod represents a SOCKS authentication method.

		As Inputs Of (at least one exported)
			func (*UsernamePassword).Authenticate(ctx context.Context, rw io.ReadWriter, auth AuthMethod) error
		As Types Of (total 3, all are exported)
			const AuthMethodNoAcceptableMethods
			const AuthMethodNotRequired
			const AuthMethodUsernamePassword

	 type Command int (basic type)
		A Command represents a SOCKS command.

		Methods (only one, which is exported)
			( Command) String() string
		Implements (at least 3, in which 1 is exported)
			 Command : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Command : context.stringer
			 Command : runtime.stringer
		As Types Of (total 2, in which 1 is exported)
			const CmdConnect
			/* one unexported ... *//* one unexported: */
			const cmdBind

	 type Conn (struct)
		A Conn represents a forward proxy connection.

		Fields (total 2, in which 1 is exported)
			Conn net.Conn
			/* one unexported ... *//* one unexported: */
			boundAddr net.Addr
		Methods (total 9, all are exported)
			(*Conn) BoundAddr() net.Addr
				BoundAddr returns the address assigned by the proxy server for
				connecting to the command target address from the proxy server.

			( Conn) Close() error
				Close closes the connection.
				Any blocked Read or Write operations will be unblocked and return errors.

			( Conn) LocalAddr() net.Addr
				LocalAddr returns the local network address, if known.

			( Conn) Read(b []byte) (n int, err error)
				Read reads data from the connection.
				Read can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetReadDeadline.

			( Conn) RemoteAddr() net.Addr
				RemoteAddr returns the remote network address, if known.

			( Conn) SetDeadline(t time.Time) error
				SetDeadline sets the read and write deadlines associated
				with the connection. It is equivalent to calling both
				SetReadDeadline and SetWriteDeadline.
				
				A deadline is an absolute time after which I/O operations
				fail instead of blocking. The deadline applies to all future
				and pending I/O, not just the immediately following call to
				Read or Write. After a deadline has been exceeded, the
				connection can be refreshed by setting a deadline in the future.
				
				If the deadline is exceeded a call to Read or Write or to other
				I/O methods will return an error that wraps os.ErrDeadlineExceeded.
				This can be tested using errors.Is(err, os.ErrDeadlineExceeded).
				The error's Timeout method will return true, but note that there
				are other possible errors for which the Timeout method will
				return true even if the deadline has not been exceeded.
				
				An idle timeout can be implemented by repeatedly extending
				the deadline after successful Read or Write calls.
				
				A zero value for t means I/O operations will not time out.

			( Conn) SetReadDeadline(t time.Time) error
				SetReadDeadline sets the deadline for future Read calls
				and any currently-blocked Read call.
				A zero value for t means Read will not time out.

			( Conn) SetWriteDeadline(t time.Time) error
				SetWriteDeadline sets the deadline for future Write calls
				and any currently-blocked Write call.
				Even if write times out, it may return n > 0, indicating that
				some of the data was successfully written.
				A zero value for t means Write will not time out.

			( Conn) Write(b []byte) (n int, err error)
				Write writes data to the connection.
				Write can be made to time out and return an error after a fixed
				time limit; see SetDeadline and SetWriteDeadline.

		Implements (at least 10, in which 9 are exported)
			 Conn : internal/bisect.Writer
			 Conn : io.Closer
			 Conn : io.ReadCloser
			 Conn : io.Reader
			 Conn : io.ReadWriteCloser
			 Conn : io.ReadWriter
			 Conn : io.WriteCloser
			 Conn : io.Writer
			 Conn : net.Conn
			/* at least one unexported ... *//* at least one unexported: */
			 Conn : crypto/tls.transcriptHash

	 type Dialer (struct)
		A Dialer holds SOCKS-specific options.

		Fields (total 6, in which 3 are exported)
			AuthMethods []AuthMethod
				AuthMethods specifies the list of request authentication
				methods.
				If empty, SOCKS client requests only AuthMethodNotRequired.

			Authenticate func(context.Context, io.ReadWriter, AuthMethod) error
				Authenticate specifies the optional authentication
				function. It must be non-nil when AuthMethods is not empty.
				It must return an error when the authentication is failed.

			ProxyDial func(context.Context, string, string) (net.Conn, error)
				ProxyDial specifies the optional dial function for
				establishing the transport connection.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			cmd Command
				// either CmdConnect or cmdBind

			proxyAddress string
				// proxy server address

			proxyNetwork string
				// network between a proxy server and a client

		Methods (total 6, in which 3 are exported)
			(*Dialer) Dial(network, address string) (net.Conn, error)
				Dial connects to the provided address on the provided network.
				
				Unlike DialContext, it returns a raw transport connection instead
				of a forward proxy connection.
				
				Deprecated: Use DialContext or DialWithConn instead.

			(*Dialer) DialContext(ctx context.Context, network, address string) (net.Conn, error)
				DialContext connects to the provided address on the provided
				network.
				
				The returned error value may be a net.OpError. When the Op field of
				net.OpError contains "socks", the Source field contains a proxy
				server address and the Addr field contains a command target
				address.
				
				See func Dial of the net package of standard library for a
				description of the network and address parameters.

			(*Dialer) DialWithConn(ctx context.Context, c net.Conn, network, address string) (net.Addr, error)
				DialWithConn initiates a connection from SOCKS server to the target
				network and address using the connection c that is already
				connected to the SOCKS server.
				
				It returns the connection's local address assigned by the SOCKS
				server.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*Dialer) connect(ctx context.Context, c net.Conn, address string) (_ net.Addr, ctxErr error)
			(*Dialer) pathAddrs(address string) (proxy, dst net.Addr, err error)
			(*Dialer) validateTarget(network, address string) error
		Implements (at least 2, both are exported)
			*Dialer : golang.org/x/net/proxy.ContextDialer
			*Dialer : golang.org/x/net/proxy.Dialer
		As Outputs Of (at least one exported)
			func NewDialer(network, address string) *Dialer

	 type Reply int (basic type)
		A Reply represents a SOCKS command reply code.

		Methods (only one, which is exported)
			( Reply) String() string
		Implements (at least 3, in which 1 is exported)
			 Reply : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Reply : context.stringer
			 Reply : runtime.stringer
		As Types Of (only one, which is exported)
			const StatusSucceeded

	 type UsernamePassword (struct)
		UsernamePassword are the credentials for the username/password
		authentication method.

		Fields (total 2, both are exported)
			Password string
			Username string
		Methods (only one, which is exported)
			(*UsernamePassword) Authenticate(ctx context.Context, rw io.ReadWriter, auth AuthMethod) error
				Authenticate authenticates a pair of username and password with the
				proxy server.



Package-Level Functions (total 2, in which 1 is exported)

	 func NewDialer(network, address string) *Dialer
		NewDialer returns a new Dialer that dials through the provided
		proxy server's network and address.

	/* one unexported ... *//* one unexported: */
	 func splitHostPort(address string) (string, int, error)
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var aLongTimeAgo time.Time
	  var noDeadline time.Time
Package-Level Constants (total 12, in which 9 are exported)

	const AddrTypeFQDN = 3
		Wire protocol constants.

	const AddrTypeIPv4 = 1
		Wire protocol constants.

	const AddrTypeIPv6 = 4
		Wire protocol constants.

	const AuthMethodNoAcceptableMethods AuthMethod = 255 // no acceptable authentication methods
		Wire protocol constants.

	const AuthMethodNotRequired AuthMethod = 0 // no authentication required
		Wire protocol constants.

	const AuthMethodUsernamePassword AuthMethod = 2 // use username/password
		Wire protocol constants.

	const CmdConnect Command = 1 // establishes an active-open forward proxy connection
		Wire protocol constants.

	const StatusSucceeded Reply = 0
		Wire protocol constants.

	const Version5 = 5
		Wire protocol constants.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	const authStatusSucceeded = 0
	const authUsernamePasswordVersion = 1
	const cmdBind Command = 2 // establishes a passive-open forward proxy connection
		Wire protocol constants.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.