Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

env

package module

Go to main page

Versions in this module

v1

v1.1.0

Mar 22, 2026

Changes in this version

+ var ErrValidateRequiredUnsupported = errors.New(...)

+ func ForceRegisterParser(format FileFormat, factory ParserFactory) error

+ func LoadWithConfig(cfg Config) error

+ type ComponentConfig struct

+ AuditEnabled bool

+ AuditHandler AuditHandler

+ CustomAuditor AuditLogger

+ CustomExpander VariableExpander

+ CustomValidator Validator

+ FileSystem FileSystem

+ Prefix string

type ComponentFactory

+ func (f *ComponentFactory) Expander() VariableExpander

+ func (f *ComponentFactory) LineParserAuditor() internal.LineAuditLogger

+ func (f *ComponentFactory) LineParserExpander() internal.LineExpander

+ func (f *ComponentFactory) LineParserValidator() internal.LineKeyValidator

type Config

+ func (c *Config) IsZero() bool

+ type FileConfig struct

+ AutoApply bool

+ FailOnMissingFile bool

+ Filenames []string

+ OverwriteExisting bool

+ type FullAuditLogger interface

+ Close func() error

+ Log func(action AuditAction, key, reason string, success bool) error

+ LogWithDuration func(action AuditAction, key, reason string, success bool, duration time.Duration) error

+ LogWithFile func(action AuditAction, key, file, reason string, success bool) error

+ type JSONConfig struct

+ JSONBoolAsString bool

+ JSONMaxDepth int

+ JSONNullAsEmpty bool

+ JSONNumberAsString bool

+ type LimitsConfig struct

+ MaxExpansionDepth int

+ MaxFileSize int64

+ MaxKeyLength int

+ MaxLineLength int

+ MaxValueLength int

+ MaxVariables int

+ type ParsingConfig struct

+ AllowExportPrefix bool

+ AllowYamlSyntax bool

+ ExpandVariables bool

+ type RequiredValidator interface

+ ValidateRequired func(keys map[string]bool) error

+ type ValidationConfig struct

+ AllowedKeys []string

+ ForbiddenKeys []string

+ KeyPattern *regexp.Regexp

+ RequiredKeys []string

+ ValidateUTF8 bool

+ ValidateValues bool

+ type YAMLConfig struct

+ YAMLBoolAsString bool

+ YAMLMaxDepth int

+ YAMLNullAsEmpty bool

+ YAMLNumberAsString bool

v1.0.1

Mar 19, 2026

v1.0.0

Mar 19, 2026

Changes in this version

+ const DefaultMaxExpansionDepth

+ const DefaultMaxFileSize

+ const DefaultMaxKeyLength

+ const DefaultMaxLineLength

+ const DefaultMaxValueLength

+ const DefaultMaxVariables

+ const HardMaxExpansionDepth

+ const HardMaxFileSize

+ const HardMaxKeyLength

+ const HardMaxLineLength

+ const HardMaxValueLength

+ const HardMaxVariables

+ var DefaultForbiddenKeys = map[string]bool

+ var DefaultKeyPattern *regexp.Regexp = nil

+ var ErrAlreadyInitialized = errors.New("default loader already initialized")

+ var ErrClosed = errors.New("loader has been closed")

+ var ErrControlChar = errors.New("control character detected in input")

+ var ErrDuplicateKey = errors.New("duplicate key encountered")

+ var ErrExpansionDepth = errors.New("variable expansion depth exceeded")

+ var ErrFileNotFound = errors.New("file not found")

+ var ErrFileTooLarge = ierrors.ErrFileTooLarge

+ var ErrForbiddenKey = errors.New("key is forbidden for security reasons")

+ var ErrInvalidConfig = errors.New("invalid configuration")

+ var ErrInvalidKey = errors.New("invalid key format")

+ var ErrInvalidValue = ierrors.ErrInvalidValue

+ var ErrLineTooLong = ierrors.ErrLineTooLong

+ var ErrMaxVariables = errors.New("maximum number of variables exceeded")

+ var ErrMissingRequired = errors.New("required key is missing")

+ var ErrNullByte = errors.New("null byte detected in input")

+ var ErrSecurityViolation = ierrors.ErrSecurityViolation

+ var SensitiveKeyPatterns = internal.Patterns

+ func All() map[string]string

+ func ClearBytes(b []byte)

+ func Delete(key string) error

+ func GetBool(key string, defaultValue ...bool) bool

+ func GetDuration(key string, defaultValue ...time.Duration) time.Duration

+ func GetInt(key string, defaultValue ...int64) int64

+ func GetSliceFrom[T sliceElement](loader *Loader, key string, defaultValue ...[]T) []T

+ func GetSlice[T sliceElement](key string, defaultValue ...[]T) []T

+ func GetString(key string, defaultValue ...string) string

+ func IsMarshalError(err error) bool

+ func IsMemoryLockEnabled() bool

+ func IsMemoryLockStrict() bool

+ func IsMemoryLockSupported() bool

+ func IsSensitiveKey(key string) bool

+ func Keys() []string

+ func Len() int

+ func Load(filenames ...string) error

+ func Lookup(key string) (string, bool)

+ func Marshal(data interface{}, format ...FileFormat) (string, error)

+ func MarshalStruct(v interface{}) (map[string]string, error)

+ func MaskKey(key string) string

+ func MaskSensitiveInString(s string) string

+ func MaskValue(key, value string) string

+ func ParseInto(v interface{}) error

+ func RegisterParser(format FileFormat, factory ParserFactory) error

+ func ResetDefaultLoader() error

+ func SanitizeForLog(s string) string

+ func Set(key, value string) error

+ func SetMemoryLockEnabled(enabled bool)

+ func SetMemoryLockStrict(strict bool)

+ func UnmarshalInto(data map[string]string, v interface{}) error

+ func UnmarshalMap(data string, format ...FileFormat) (map[string]string, error)

+ func UnmarshalStruct(data string, v interface{}, format ...FileFormat) error

+ func Validate() error

+ type AuditAction = internal.Action

+ const ActionDelete

+ const ActionError

+ const ActionExpand

+ const ActionFileAccess

+ const ActionGet

+ const ActionLoad

+ const ActionParse

+ const ActionSecurity

+ const ActionSet

+ const ActionValidate

+ type AuditEvent = internal.Event

+ type AuditHandler = internal.Handler

+ type AuditLogger interface

+ Close func() error

+ Log func(action AuditAction, key, reason string, success bool) error

+ LogError func(action AuditAction, key, errMsg string) error

+ LogWithDuration func(action AuditAction, key, reason string, success bool, duration time.Duration) error

+ LogWithFile func(action AuditAction, key, file, reason string, success bool) error

+ type ChannelAuditHandler = internal.ChannelHandler

+ func NewChannelAuditHandler(ch chan<- AuditEvent) *ChannelAuditHandler

+ type ComponentFactory struct

+ func (f *ComponentFactory) Auditor() AuditLogger

+ func (f *ComponentFactory) Close() error

+ func (f *ComponentFactory) IsClosed() bool

+ func (f *ComponentFactory) Validator() Validator

+ type Config struct

+ AllowExportPrefix bool

+ AllowYamlSyntax bool

+ AllowedKeys []string

+ AuditEnabled bool

+ AuditHandler AuditHandler

+ AutoApply bool

+ ExpandVariables bool

+ FailOnMissingFile bool

+ FileSystem FileSystem

+ Filenames []string

+ ForbiddenKeys []string

+ JSONBoolAsString bool

+ JSONMaxDepth int

+ JSONNullAsEmpty bool

+ JSONNumberAsString bool

+ KeyPattern *regexp.Regexp

+ MaxExpansionDepth int

+ MaxFileSize int64

+ MaxKeyLength int

+ MaxLineLength int

+ MaxValueLength int

+ MaxVariables int

+ OverwriteExisting bool

+ Prefix string

+ RequiredKeys []string

+ ValidateValues bool

+ YAMLBoolAsString bool

+ YAMLMaxDepth int

+ YAMLNullAsEmpty bool

+ YAMLNumberAsString bool

+ func DefaultConfig() Config

+ func DevelopmentConfig() Config

+ func ProductionConfig() Config

+ func TestingConfig() Config

+ func (c *Config) Validate() error

+ type EnvApplicator interface

+ Apply func() error

+ type EnvCloser interface

+ Close func() error

+ type EnvFileLoader interface

+ LoadFiles func(filenames ...string) error

+ type EnvGetter interface

+ All func() map[string]string

+ GetString func(key string, defaultValue ...string) string

+ Keys func() []string

+ Lookup func(key string) (string, bool)

+ type EnvLoader interface

+ type EnvParser interface

+ Parse func(r io.Reader, filename string) (map[string]string, error)

+ type EnvSetter interface

+ Delete func(key string) error

+ Set func(key, value string) error

+ type EnvStorage interface

+ Clear func()

+ Delete func(key string)

+ Get func(key string) (string, bool)

+ Keys func() []string

+ Len func() int

+ Set func(key, value string)

+ ToMap func() map[string]string

+ type ExpansionError = ierrors.ExpansionError

+ type File interface

+ Stat func() (os.FileInfo, error)

+ Sync func() error

+ type FileError = ierrors.FileError

+ type FileFormat int

+ const FormatAuto

+ const FormatEnv

+ const FormatJSON

+ const FormatYAML

+ func DetectFormat(filename string) FileFormat

+ func (f FileFormat) String() string

+ type FileSystem interface

+ Getenv func(key string) string

+ LookupEnv func(key string) (string, bool)

+ MkdirAll func(path string, perm os.FileMode) error

+ Open func(name string) (File, error)

+ OpenFile func(name string, flag int, perm os.FileMode) (File, error)

+ Remove func(name string) error

+ Rename func(oldpath, newpath string) error

+ Setenv func(key, value string) error

+ Stat func(name string) (os.FileInfo, error)

+ Unsetenv func(key string) error

+ var DefaultFileSystem FileSystem = OSFileSystem{}

+ type JSONAuditHandler = internal.JSONHandler

+ func NewJSONAuditHandler(w io.Writer) *JSONAuditHandler

+ type JSONError = ierrors.JSONError

+ type KeyValidator interface

+ ValidateKey func(key string) error

+ type Loader struct

+ func New(cfg ...Config) (*Loader, error)

+ func (l *Loader) All() map[string]string

+ func (l *Loader) Apply() error

+ func (l *Loader) Close() error

+ func (l *Loader) Config() Config

+ func (l *Loader) Delete(key string) error

+ func (l *Loader) GetBool(key string, defaultValue ...bool) bool

+ func (l *Loader) GetDuration(key string, defaultValue ...time.Duration) time.Duration

+ func (l *Loader) GetInt(key string, defaultValue ...int64) int64

+ func (l *Loader) GetSecure(key string) *SecureValue

+ func (l *Loader) GetString(key string, defaultValue ...string) string

+ func (l *Loader) IsApplied() bool

+ func (l *Loader) IsClosed() bool

+ func (l *Loader) Keys() []string

+ func (l *Loader) Len() int

+ func (l *Loader) LoadFiles(filenames ...string) error

+ func (l *Loader) LoadTime() time.Time

+ func (l *Loader) Lookup(key string) (string, bool)

+ func (l *Loader) ParseInto(v interface{}) error

+ func (l *Loader) Set(key, value string) error

+ func (l *Loader) Validate() error

+ type LogAuditHandler = internal.LogHandler

+ func NewLogAuditHandler(logger *log.Logger) *LogAuditHandler

+ type MarshalError = ierrors.MarshalError

+ type Marshaler interface

+ MarshalEnv func() ([]byte, error)

+ type MemoryLockConfig struct

+ type NopAuditHandler = internal.NopHandler

+ func NewNopAuditHandler() *NopAuditHandler

+ type OSFileSystem struct

+ func (OSFileSystem) Getenv(key string) string

+ func (OSFileSystem) LookupEnv(key string) (string, bool)

+ func (OSFileSystem) MkdirAll(path string, perm os.FileMode) error

+ func (OSFileSystem) Open(name string) (File, error)

+ func (OSFileSystem) OpenFile(name string, flag int, perm os.FileMode) (File, error)

+ func (OSFileSystem) Remove(name string) error

+ func (OSFileSystem) Rename(oldpath, newpath string) error

+ func (OSFileSystem) Setenv(key, value string) error

+ func (OSFileSystem) Stat(name string) (os.FileInfo, error)

+ func (OSFileSystem) Unsetenv(key string) error

+ type ParseError = ierrors.ParseError

+ type ParserFactory func(cfg Config, factory *ComponentFactory) (EnvParser, error)

+ type SecureValue struct

+ func GetSecure(key string) *SecureValue

+ func NewSecureValue(value string) *SecureValue

+ func NewSecureValueStrict(value string) (*SecureValue, error)

+ func (sv *SecureValue) Bytes() []byte

+ func (sv *SecureValue) Close() error

+ func (sv *SecureValue) IsClosed() bool

+ func (sv *SecureValue) IsMemoryLocked() bool

+ func (sv *SecureValue) Length() int

+ func (sv *SecureValue) Masked() string

+ func (sv *SecureValue) MemoryLockError() error

+ func (sv *SecureValue) Release()

+ func (sv *SecureValue) String() string

+ type SecurityError = ierrors.SecurityError

+ type Unmarshaler interface

+ UnmarshalEnv func(map[string]string) error

+ type ValidationError = ierrors.ValidationError

+ type Validator interface

+ ValidateRequired func(keys map[string]bool) error

+ type ValueValidator interface

+ ValidateValue func(value string) error

+ type VariableExpander interface

+ Expand func(s string) (string, error)

+ type YAMLError = ierrors.YAMLError