util

Documentation

Index

• Constants
• Variables
• func AbsolutePathFromConfigPath(path string) string
• func CheckForFQDNRules(name string) error
• func ConvertWithFQDNRules(name string) string
• func EnsureDir(dir string) error
• func GenerateIPv4DNSRootDomain(ipPrefix netip.Prefix) []dnsname.FQDN
• func GenerateIPv6DNSRootDomain(ipPrefix netip.Prefix) []dnsname.FQDN
• func GenerateRandomBytes(n int) ([]byte, error)
• func GenerateRandomStringDNSSafe(size int) (string, error)
• func GenerateRandomStringURLSafe(n int) (string, error)
• func GetFileMode(key string) fs.FileMode
• func GetIPPrefixEndpoints(na netip.Prefix) (netip.Addr, netip.Addr)
• func GrpcSocketDialer(ctx context.Context, addr string) (net.Conn, error)
• func LogErr(err error, msg string)
• func NormalizeToFQDNRules(name string, stripEmailDomain bool) (string, error)
• func ParseIPSet(arg string, bits *int) (*netipx.IPSet, error)
• func ParseLoginURLFromCLILogin(output string) (*url.URL, error)
• func StringToIPPrefix(prefixes []string) ([]netip.Prefix, error)
• func TSLogfWrapper() logger.Logf
• func TailMapResponseToString(resp tailcfg.MapResponse) string
• func TailNodesToString(nodes []*tailcfg.Node) string
• func TailscaleVersionNewerOrEqual(minimum, toCheck string) bool
• func ValidateUsername(username string) error
• type DBLogWrapper
  • func NewDBLogWrapper(origin *zerolog.Logger, slowThreshold time.Duration, ...) *DBLogWrapper
  • func (l *DBLogWrapper) Error(ctx context.Context, msg string, data ...interface{})
  • func (l *DBLogWrapper) Info(ctx context.Context, msg string, data ...interface{})
  • func (l *DBLogWrapper) LogMode(gormLogger.LogLevel) gormLogger.Interface
  • func (l *DBLogWrapper) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})
  • func (l *DBLogWrapper) Trace(ctx context.Context, begin time.Time, ...)
  • func (l *DBLogWrapper) Warn(ctx context.Context, msg string, data ...interface{})
• type DBLogWrapperOption

Constants

const (
	RegisterMethodAuthKey = "authkey"
	RegisterMethodOIDC    = "oidc"
	RegisterMethodCLI     = "cli"
)

const (
	ByteSize = 8

	// value related to RFC 1123 and 952.
	LabelHostnameLength = 63
)

const (
	Base8              = 8
	Base10             = 10
	BitSize16          = 16
	BitSize32          = 32
	BitSize64          = 64
	PermissionFallback = 0o700
)

Variables

var (
	ErrCannotDecryptResponse = errors.New("cannot decrypt response")
	ZstdCompression          = "zstd"
)

var AddrPortComparer = cmp.Comparer(func(x, y netip.AddrPort) bool {
	return x == y
})

var Comparers []cmp.Option = []cmp.Option{
	IPComparer, PrefixComparer, AddrPortComparer, MkeyComparer, NkeyComparer, DkeyComparer, ViewSliceIPProtoComparer,
}

var DkeyComparer = cmp.Comparer(func(x, y key.DiscoPublic) bool {
	return x.String() == y.String()
})

var ErrInvalidUserName = errors.New("invalid user name")

var IPComparer = cmp.Comparer(func(x, y netip.Addr) bool {
	return x.Compare(y) == 0
})

var MkeyComparer = cmp.Comparer(func(x, y key.MachinePublic) bool {
	return x.String() == y.String()
})

var NkeyComparer = cmp.Comparer(func(x, y key.NodePublic) bool {
	return x.String() == y.String()
})

var PrefixComparer = cmp.Comparer(func(x, y netip.Prefix) bool {
	return x == y
})

var ViewSliceIPProtoComparer = cmp.Comparer(func(a, b views.Slice[ipproto.Proto]) bool { return views.SliceEqual(a, b) })

Functions

func AbsolutePathFromConfigPath

func AbsolutePathFromConfigPath(path string) string

func CheckForFQDNRules

func CheckForFQDNRules(name string) error

func ConvertWithFQDNRules

func ConvertWithFQDNRules(name string) string

func EnsureDir

func EnsureDir(dir string) error

func GenerateIPv4DNSRootDomain

func GenerateIPv4DNSRootDomain(ipPrefix netip.Prefix) []dnsname.FQDN

From the netmask we can find out the wildcard bits (the bits that are not set in the netmask). This allows us to then calculate the subnets included in the subsequent class block and generate the entries.

func GenerateIPv6DNSRootDomain

func GenerateIPv6DNSRootDomain(ipPrefix netip.Prefix) []dnsname.FQDN

From the netmask we can find out the wildcard bits (the bits that are not set in the netmask). This allows us to then calculate the subnets included in the subsequent class block and generate the entries.

func GenerateRandomBytes

func GenerateRandomBytes(n int) ([]byte, error)

GenerateRandomBytes returns securely generated random bytes. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func GenerateRandomStringDNSSafe

func GenerateRandomStringDNSSafe(size int) (string, error)

GenerateRandomStringDNSSafe returns a DNS-safe securely generated random string. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func GenerateRandomStringURLSafe

func GenerateRandomStringURLSafe(n int) (string, error)

GenerateRandomStringURLSafe returns a URL-safe, base64 encoded securely generated random string. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func GetFileMode

func GetFileMode(key string) fs.FileMode

func GetIPPrefixEndpoints

func GetIPPrefixEndpoints(na netip.Prefix) (netip.Addr, netip.Addr)

func GrpcSocketDialer

func GrpcSocketDialer(ctx context.Context, addr string) (net.Conn, error)

func LogErr

func LogErr(err error, msg string)

func NormalizeToFQDNRules

func NormalizeToFQDNRules(name string, stripEmailDomain bool) (string, error)

TODO(kradalby): Reintroduce when strip_email_domain is removed after #2170 is cleaned up DEPRECATED: DO NOT USE NormalizeToFQDNRules will replace forbidden chars in user it can also return an error if the user doesn't respect RFC 952 and 1123.

func ParseIPSet

func ParseIPSet(arg string, bits *int) (*netipx.IPSet, error)

parseIPSet parses arg as one:

• an IP address (IPv4 or IPv6)
• the string "*" to match everything (both IPv4 & IPv6)
• a CIDR (e.g. "192.168.0.0/16")
• a range of two IPs, inclusive, separated by hyphen ("2eff::1-2eff::0800")

bits, if non-nil, is the legacy SrcBits CIDR length to make a IP address (without a slash) treated as a CIDR of *bits length. nolint

func ParseLoginURLFromCLILogin

func ParseLoginURLFromCLILogin(output string) (*url.URL, error)

ParseLoginURLFromCLILogin parses the output of the tailscale up command to extract the login URL. It returns an error if not exactly one URL is found.

func StringToIPPrefix

func StringToIPPrefix(prefixes []string) ([]netip.Prefix, error)

func TSLogfWrapper

func TSLogfWrapper() logger.Logf

func TailMapResponseToString

func TailMapResponseToString(resp tailcfg.MapResponse) string

func TailNodesToString

func TailNodesToString(nodes []*tailcfg.Node) string

func TailscaleVersionNewerOrEqual

func TailscaleVersionNewerOrEqual(minimum, toCheck string) bool

func ValidateUsername

func ValidateUsername(username string) error

ValidateUsername checks if a username is valid. It must be at least 2 characters long, start with a letter, and contain only letters, numbers, hyphens, dots, and underscores. It cannot contain more than one '@'. It cannot contain invalid characters.

Types

type DBLogWrapper

type DBLogWrapper struct {
	Logger                *zerolog.Logger
	Level                 zerolog.Level
	Event                 *zerolog.Event
	SlowThreshold         time.Duration
	SkipErrRecordNotFound bool
	ParameterizedQueries  bool
}

func NewDBLogWrapper

func NewDBLogWrapper(origin *zerolog.Logger, slowThreshold time.Duration, skipErrRecordNotFound bool, parameterizedQueries bool) *DBLogWrapper

func (*DBLogWrapper) Error

func (l *DBLogWrapper) Error(ctx context.Context, msg string, data ...interface{})

func (*DBLogWrapper) Info

func (l *DBLogWrapper) Info(ctx context.Context, msg string, data ...interface{})

func (*DBLogWrapper) LogMode

func (l *DBLogWrapper) LogMode(gormLogger.LogLevel) gormLogger.Interface

func (*DBLogWrapper) ParamsFilter

func (l *DBLogWrapper) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})

func (*DBLogWrapper) Trace

func (l *DBLogWrapper) Trace(ctx context.Context, begin time.Time, fc func() (sql string, rowsAffected int64), err error)

func (*DBLogWrapper) Warn

func (l *DBLogWrapper) Warn(ctx context.Context, msg string, data ...interface{})

type DBLogWrapperOption

type DBLogWrapperOption func(*DBLogWrapper)