portal

Documentation

Index

• Variables
• func SecureCompare(want, have string) bool
• type Config
  • func (c *Config) ParseCredentials() (*url.Userinfo, error)
• type Portal
  • func New(c *Config, db *dao.DAO, l log.Logger) (*Portal, error)
  • func (p *Portal) Dump(w io.Writer) error
  • func (p *Portal) Error(msg string) *response.Root
  • func (p *Portal) Process(r *Request) (*response.Root, error)
  • func (p *Portal) Success() *response.Root
  • func (p *Portal) TrustLevel() TrustLevel
• type Request
  • func NewRequest(ctx context.Context, client *netip.Addr) *Request
  • func (r *Request) Client() *netip.Addr
  • func (r *Request) CompareCredentials(c *url.Userinfo) bool
  • func (r *Request) Context() context.Context
• type TrustLevel
  • func (t *TrustLevel) Set(s string) error
  • func (t TrustLevel) String() string

Variables

var TrustLevelValues = []string{"proxy", "client", "connection"}

Functions

func SecureCompare

func SecureCompare(want, have string) bool

SecureCompare performs a constant time compare of two strings to limit timing attacks. https://go.dev/play/p/NU5uTaB-sp

Types

type Config

type Config struct {
	PushInterval     time.Duration
	LogInterval      time.Duration
	AutoPushDelay    time.Duration
	TrustLevel       TrustLevel
	AuthUsername     string
	AuthPassword     string
	AuthPasswordFile string
}

func (*Config) ParseCredentials

func (c *Config) ParseCredentials() (*url.Userinfo, error)

type Portal

type Portal struct {
	// contains filtered or unexported fields
}

func New

func New(c *Config, db *dao.DAO, l log.Logger) (*Portal, error)

func (*Portal) Dump

func (p *Portal) Dump(w io.Writer) error

func (*Portal) Error

func (p *Portal) Error(msg string) *response.Root

func (*Portal) Process

func (p *Portal) Process(r *Request) (*response.Root, error)

func (*Portal) Success

func (p *Portal) Success() *response.Root

func (*Portal) TrustLevel

func (p *Portal) TrustLevel() TrustLevel

type Request

type Request struct {
	Credentials *url.Userinfo
	Payload     *request.Root
	// contains filtered or unexported fields
}

func NewRequest

func NewRequest(ctx context.Context, client *netip.Addr) *Request

func (*Request) Client

func (r *Request) Client() *netip.Addr

func (*Request) CompareCredentials

func (r *Request) CompareCredentials(c *url.Userinfo) bool

func (*Request) Context

func (r *Request) Context() context.Context

type TrustLevel

type TrustLevel string

const (
	ProxyTrustLevel      TrustLevel = "proxy"
	ClientTrustLevel     TrustLevel = "client"
	ConnectionTrustLevel TrustLevel = "connection"
)

func (*TrustLevel) Set

func (t *TrustLevel) Set(s string) error

Set updates the value of the trust level.

func (TrustLevel) String

func (t TrustLevel) String() string