conninfo

Documentation

Overview

Package conninfo provides access to connection-specific information.

Index

• func Ctx(ctx context.Context, connInfo *ConnInfo) context.Context
• type ConnInfo
  • func Get(ctx context.Context) *ConnInfo
  • func New() *ConnInfo
  • func (connInfo *ConnInfo) Auth() (username, password, mechanism string)
  • func (connInfo *ConnInfo) BypassBackendAuth() bool
  • func (connInfo *ConnInfo) Conv() *scram.ServerConversation
  • func (connInfo *ConnInfo) LocalPeer() bool
  • func (connInfo *ConnInfo) MetadataRecv() bool
  • func (connInfo *ConnInfo) SetAuth(username, password, mechanism string)
  • func (connInfo *ConnInfo) SetBypassBackendAuth()
  • func (connInfo *ConnInfo) SetConv(sc *scram.ServerConversation)
  • func (connInfo *ConnInfo) SetMetadataRecv()
  • func (connInfo *ConnInfo) Username() string

Functions

func Ctx

func Ctx(ctx context.Context, connInfo *ConnInfo) context.Context

Ctx returns a derived context with the given ConnInfo.

Types

type ConnInfo

type ConnInfo struct {
	Peer netip.AddrPort // invalid for Unix domain sockets
	// contains filtered or unexported fields
}

ConnInfo represents client connection information.

func Get

func Get(ctx context.Context) *ConnInfo

Get returns the ConnInfo value stored in ctx.

func New

func New() *ConnInfo

New returns a new ConnInfo.

func (*ConnInfo) Auth

func (connInfo *ConnInfo) Auth() (username, password, mechanism string)

Auth returns stored username, password and mechanism.

func (*ConnInfo) BypassBackendAuth

func (connInfo *ConnInfo) BypassBackendAuth() bool

BypassBackendAuth returns whether the connection requires backend authentication.

func (*ConnInfo) Conv

func (connInfo *ConnInfo) Conv() *scram.ServerConversation

Conv returns stored SCRAM server conversation.

func (*ConnInfo) LocalPeer

func (connInfo *ConnInfo) LocalPeer() bool

LocalPeer returns whether the peer is considered local (using Unix domain socket or loopback IP).

func (*ConnInfo) MetadataRecv

func (connInfo *ConnInfo) MetadataRecv() bool

MetadataRecv returns whatever client metadata was received already.

func (*ConnInfo) SetAuth

func (connInfo *ConnInfo) SetAuth(username, password, mechanism string)

SetAuth stores username, password.

func (*ConnInfo) SetBypassBackendAuth

func (connInfo *ConnInfo) SetBypassBackendAuth()

SetBypassBackendAuth marks the connection as not requiring backend authentication.

func (*ConnInfo) SetConv

func (connInfo *ConnInfo) SetConv(sc *scram.ServerConversation)

SetConv stores the SCRAM server conversation.

func (*ConnInfo) SetMetadataRecv

func (connInfo *ConnInfo) SetMetadataRecv()

SetMetadataRecv marks client metadata as received.

func (*ConnInfo) Username

func (connInfo *ConnInfo) Username() string

Username returns stored username.