util

Documentation

Index

• Constants
• Variables
• func AppVersion() string
• func DefaultTLSConfig() *tls.Config
• func FilterGlob(g string, values []string) []string
• func FilterGlobNotMatches(g string, values []string) []string
• func GetFreeListenAddr() (string, error)
• func GetFreePort() (int, error)
• func HashPB(h Hashable, ignore map[string]struct{}) uint64
• func HashStr(s string) uint64
• func IsHidden(fileName string) bool
• func IsJSONFileTypeExt(fileName string) bool
• func IsSupportedFileType(fileName string) bool
• func IsSupportedFileTypeExt(fileName string) (string, bool)
• func IsSupportedTestFile(fileName string) bool
• func LoadFromJSONOrYAML(fsys fs.FS, path string, dest proto.Message) error
• func MatchesGlob(globExpr, val string) bool
• func OpenOneOfSupportedFiles(fsys fs.FS, fileName string) (fs.File, error)
• func ParseListenAddress(listenAddr string) (network, addr string, err error)
• func ReadJSONOrYAML(src io.Reader, dest proto.Message) error
• func RelativeSchemaPath(path string) (string, bool)
• func ToStructPB(v any) (*structpb.Value, error)
• func WriteYAML(dest io.Writer, data proto.Message) error
• type Hashable
• type IndexedFileType
  • func FileType(path string) IndexedFileType

Constants

const SchemasDirectory = "_schemas"

SchemasDirectory is the name of the special directory containing schemas. It is defined here to avoid an import loop.

const TestDataDirectory = "testdata"

TestDataDirectory is the name of the special directory containing test fixtures. It is defined here to avoid an import loop.

Variables

var (
	AppName   = "cerbos"
	BuildDate = "unknown"
	Commit    = "unknown"
	Version   = "unknown"
)

var (
	ErrMultipleYAMLDocs = errors.New("more than one YAML document detected")
)

var ErrNoMatchingFiles = errors.New("no matching files")

Functions

func AppVersion

func AppVersion() string

func DefaultTLSConfig

func DefaultTLSConfig() *tls.Config

DefaultTLSConfig returns the default TLS configuration.

func FilterGlob

func FilterGlob(g string, values []string) []string

FilterGlob returns the set of values that match the given glob.

func FilterGlobNotMatches

func FilterGlobNotMatches(g string, values []string) []string

FilterGlobNotMatches returns the set of values that do not match the given glob.

func GetFreeListenAddr

func GetFreeListenAddr() (string, error)

func GetFreePort

func GetFreePort() (int, error)

func HashPB

func HashPB(h Hashable, ignore map[string]struct{}) uint64

func HashStr

func HashStr(s string) uint64

func IsHidden

func IsHidden(fileName string) bool

func IsJSONFileTypeExt

func IsJSONFileTypeExt(fileName string) bool

IsJSONFileTypeExt returns true if the given file has a json file extension.

func IsSupportedFileType

func IsSupportedFileType(fileName string) bool

IsSupportedFileType returns true if the given file has a supported file extension.

func IsSupportedFileTypeExt

func IsSupportedFileTypeExt(fileName string) (string, bool)

IsSupportedFileTypeExt returns true and a file extension if the given file has a supported file extension.

func IsSupportedTestFile

func IsSupportedTestFile(fileName string) bool

IsSupportedTestFile return true if the given file is a supported test file name, i.e. "*_test.{yaml,yml,json}".

func LoadFromJSONOrYAML

func LoadFromJSONOrYAML(fsys fs.FS, path string, dest proto.Message) error

LoadFromJSONOrYAML reads a JSON or YAML encoded protobuf from the given path.

func MatchesGlob

func MatchesGlob(globExpr, val string) bool

MatchesGlob returns true if the given glob expression matches the given string.

func OpenOneOfSupportedFiles

func OpenOneOfSupportedFiles(fsys fs.FS, fileName string) (fs.File, error)

OpenOneOfSupportedFiles attempts to open a fileName adding supported extensions.

func ParseListenAddress

func ParseListenAddress(listenAddr string) (network, addr string, err error)

ParseListenAddress parses an address and returns the network type and the address to dial. inspired by https://github.com/ghostunnel/ghostunnel/blob/6e58c75c8762fe371c1134e89dd55033a6d577a4/socket/net.go#L31

func ReadJSONOrYAML

func ReadJSONOrYAML(src io.Reader, dest proto.Message) error

func RelativeSchemaPath

func RelativeSchemaPath(path string) (string, bool)

RelativeSchemaPath returns the given path within the top-level schemas directory, and a flag to indicate whether the path was actually contained in that directory. The path must be "/"-separated and relative to the root policies directory.

func ToStructPB

func ToStructPB(v any) (*structpb.Value, error)

func WriteYAML

func WriteYAML(dest io.Writer, data proto.Message) error

Types

type Hashable

type Hashable interface {
	HashPB(hash.Hash, map[string]struct{})
}

type IndexedFileType

type IndexedFileType uint8

const (
	FileTypeNotIndexed IndexedFileType = iota
	FileTypePolicy
	FileTypeSchema
)

func FileType

func FileType(path string) IndexedFileType

FileType categorizes the given path according to how it will be treated by the index. The path must be "/"-separated and relative to the root policies directory.