package
5.5.2+incompatible
Repository: https://github.com/keycase/client-fork.git
Documentation: pkg.go.dev

# Functions

DefaultV1 returns a default V1 config, which allows anonymous read to everything.
GenerateSHA256PasswordHash generates a SHA256 based password hash.
ParseConfig parses a config from reader, and initializes internal checker(s) in the config.

# Constants

DefaultConfigFilename is the default filename for Keybase Pages config file.
DefaultConfigFilepath is the default path for Keybase Pages config file under the site root, and is what's used in kbpagesd.
PermList is the list permission.
PermRead is the read permission.
PermReadAndList allows both read and list.
Version1 is version 1.
Version1Str is the string representation of Version1.
Version2 is version 2.
Version2Str is the string representation of Version2.
VersionUnknown defines an unknown config version.
VersionUnknownStr is the string representation of VUnknown.

# Structs

Common includes common fields that should appear in all versions of configs.
ErrACLsPerPathConfigsBothPresent is returned when we are parsing a ConfigV1 that has both ACLs and PerPathConfigs defined.
ErrDuplicatePerPathConfigPath is returned when multiple per-user configs are defined for the same path in config.
ErrInvalidConfig is returned when an invalid config is provided.
ErrInvalidPermissions is returned when an invalid permissions string appears in the config.
ErrInvalidVersion is returned when Version field of the config is invalid.
ErrUndefinedUsername is returned when a username appears in a per-path config but it's not defined in the config's Users section.
InvalidPasswordHash is the error that happens when there's an invalid password hash in the config.
PerPathConfigV1 defines a per-path configuration structure, including an access control list (ACL) for the V1 config.
V1 defines a V1 config.

# Interfaces

Config is a collection of methods for getting different configuration parameters.

# Type aliases

Version specifies the version of a config.