utils

Documentation

Overview

Package utils [general utility functions for the db1000n app]

Index

• Variables
• func BindToInterface(name string) func(network, address string, conn syscall.RawConn) error
• func Decode(input any, output any) error
• func Decrypt(cfg []byte) (result []byte, protected bool, err error)
• func GetEnvBoolDefault(key string, defaultValue bool) bool
• func GetEnvDurationDefault(key string, defaultValue time.Duration) time.Duration
• func GetEnvFloatDefault(key string, defaultValue float64) float64
• func GetEnvIntDefault(key string, defaultValue int) int
• func GetEnvStringDefault(key, defaultValue string) string
• func InfiniteRange[T any](ctx context.Context, input []T) chan T
• func IsEncrypted(cfg []byte) bool
• func Max[...](a, b T) T
• func NonNilOrDefault[T any](v *T, dflt T) T
• func PanicHandler(logger *zap.Logger)
• func Sleep(ctx context.Context, t time.Duration) bool
• func ToMiB(bytes uint64) uint64
• func Unmarshal(input []byte, output any, format string) error
• func UpdateRLimit() error
• type BackoffConfig
  • func DefaultBackoffConfig() BackoffConfig
• type BackoffController
  • func (c BackoffController) GetTimeout() time.Duration
  • func (c *BackoffController) Increment() *BackoffController
  • func (c *BackoffController) Reset()
• type Counter
  • func (c *Counter) Next() bool
• type Locker
  • func (m *Locker) Lock(key string) func()
• type ProxyFunc
  • func GetProxyFunc(ctx context.Context, params ProxyParams, protocol string) ProxyFunc
• type ProxyParams

Variables

var EncryptionKeys = `/45pB920B6DFNwCB/n4rYUio3AVMawrdtrFnjTSIzL4=`

EncryptionKeys random 32 byte key encoded into base64 string. Used by default for configs

var ProtectedKeys = ``

Functions

func BindToInterface

func BindToInterface(name string) func(network, address string, conn syscall.RawConn) error

func Decode

func Decode(input any, output any) error

Decode is an alias to a mapstructure.NewDecoder({Squash: true}).Decode() with WeaklyTypedInput set to true and MatchFunc that only compares aplhanumeric sequence in field names

func Decrypt

func Decrypt(cfg []byte) (result []byte, protected bool, err error)

Decrypt decrypts config using EncryptionKeys

func GetEnvBoolDefault

func GetEnvBoolDefault(key string, defaultValue bool) bool

GetEnvBoolDefault returns environment variable or default value if no env varible is present

func GetEnvDurationDefault

func GetEnvDurationDefault(key string, defaultValue time.Duration) time.Duration

GetEnvDurationDefault returns environment variable or default value if no env varible is present

func GetEnvFloatDefault

func GetEnvFloatDefault(key string, defaultValue float64) float64

GetEnvFloatDefault returns environment variable or default value if no env varible is present

func GetEnvIntDefault

func GetEnvIntDefault(key string, defaultValue int) int

GetEnvIntDefault returns environment variable or default value if no env varible is present

func GetEnvStringDefault

func GetEnvStringDefault(key, defaultValue string) string

GetEnvStringDefault returns environment variable or default value if no env varible is present

func InfiniteRange

func InfiniteRange[T any](ctx context.Context, input []T) chan T

It could've been more effective if go had yield but this should be close enough

func IsEncrypted

func IsEncrypted(cfg []byte) bool

IsEncrypted returns true if cfg encrypted with age tool (https://github.com/FiloSottile/age)

func Max

func Max[T int | int8 | int16 | int32 | int64 | uint | uint8 | uint16 | uint32 | uint64 | float32 | float64](a, b T) T

func NonNilOrDefault

func NonNilOrDefault[T any](v *T, dflt T) T

func PanicHandler

func PanicHandler(logger *zap.Logger)

PanicHandler just stub it in the beginning of every major module invocation to prevent single module failure from crashing the whole app

func Sleep

func Sleep(ctx context.Context, t time.Duration) bool

func ToMiB

func ToMiB(bytes uint64) uint64

func Unmarshal

func Unmarshal(input []byte, output any, format string) error

func UpdateRLimit

func UpdateRLimit() error

Types

type BackoffConfig

type BackoffConfig struct {
	Multiplier int
	Limit      int
	Timeout    time.Duration
}

func DefaultBackoffConfig

func DefaultBackoffConfig() BackoffConfig

type BackoffController

type BackoffController struct {
	BackoffConfig
	// contains filtered or unexported fields
}

func (BackoffController) GetTimeout

func (c BackoffController) GetTimeout() time.Duration

func (*BackoffController) Increment

func (c *BackoffController) Increment() *BackoffController

func (*BackoffController) Reset

func (c *BackoffController) Reset()

type Counter

type Counter struct {
	Count int
	// contains filtered or unexported fields
}

func (*Counter) Next

func (c *Counter) Next() bool

type Locker

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

func (*Locker) Lock

func (m *Locker) Lock(key string) func()

type ProxyFunc

type ProxyFunc func(network, addr string) (net.Conn, error)

func GetProxyFunc

func GetProxyFunc(ctx context.Context, params ProxyParams, protocol string) ProxyFunc

this won't work for udp payloads but if people use proxies they might not want to have their ip exposed so it's probably better to fail instead of routing the traffic directly

type ProxyParams

type ProxyParams struct {
	URLs         string
	DefaultProto string
	LocalAddr    string
	Interface    string
	Timeout      time.Duration
}