Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

utils

package

Go to main page

Versions in this module

v11

v11.3.3

Dec 13, 2022

Changes in this version

+ const Blue

+ const Bold

+ const CertExtensionAuthority

+ const CertExtensionRole

+ const CertTeleportClusterName

+ const CertTeleportUser

+ const CertTeleportUserCA

+ const CertTeleportUserCertificate

+ const DefaultCertTTL

+ const DefaultLRUCapacity

+ const ExtIntCertType

+ const ExtIntCertTypeHost

+ const ExtIntCertTypeUser

+ const Gray

+ const HostUUIDFile

+ const PortStartingNumber

+ const Red

+ const SelfSignedCertsMsg

+ const Yellow

+ var ErrFnCacheClosed = errors.New("fncache permanently closed")

+ var ErrLimitReached = &trace.LimitExceededError

+ var ErrUnsuccessfulLockTry = errors.New("could not acquire lock on the file at this time")

+ var FullJitter = retryutils.NewFullJitter()

+ var HalfJitter = retryutils.NewHalfJitter()

+ var KnownFormatFields = knownFormatFieldsMap

+ var SafeConfig = ...()

+ var SeventhJitter = retryutils.NewSeventhJitter()

+ func AllowNewlines(s string) string

+ func AsBool(v string) bool

+ func CalculateSPKI(cert *x509.Certificate) string

+ func CanUserWriteTo(path string) (bool, error)

+ func ChainStreamServerInterceptors(first grpc.StreamServerInterceptor, rest ...grpc.StreamServerInterceptor) grpc.StreamServerInterceptor

+ func ChainUnaryServerInterceptors(first grpc.UnaryServerInterceptor, rest ...grpc.UnaryServerInterceptor) grpc.UnaryServerInterceptor

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

+ func CheckSPKI(pins []string, certs []*x509.Certificate) error

+ func CheckVersion(currentVersion, minVersion string) error

+ func ChooseRandomString(slice []string) string

+ func CipherSuiteMapping(cipherSuites []string) ([]uint16, error)

+ func ClickableURL(in string) string

+ func ClientIPFromConn(conn net.Conn) (string, error)

+ func Color(color int, v interface{}) string

+ func CompressTarGzArchive(files []string, fileReader ReadStatFS) (*bytes.Buffer, error)

+ func Consolef(w io.Writer, log logrus.FieldLogger, component, msg string, ...)

+ func ContainsExpansion(val string) bool

+ func CopyStringsMap(in map[string]string) map[string]string

+ func CreateCertificate(principal string, certType uint32) (*ssh.Certificate, ssh.Signer, error)

+ func CreateEllipticCertificate(principal string, certType uint32) (*ssh.Certificate, ssh.Signer, error)

+ func CreateTLSConfiguration(certFile, keyFile string, cipherSuites []uint16) (*tls.Config, error)

+ func CryptoRandomHex(length int) (string, error)

+ func DNSName(hostport string) (string, error)

+ func DefaultCipherSuites() []uint16

+ func DualPipeNetConn(srcAddr net.Addr, dstAddr net.Addr) (*PipeNetConn, *PipeNetConn) — windows/amd64

+ func DualPipeNetConn(srcAddr net.Addr, dstAddr net.Addr) (net.Conn, net.Conn, error) — darwin/amd64, js/wasm, linux/amd64

+ func EnsureLocalPath(customPath string, defaultLocalDir, defaultLocalPath string) (string, error)

+ func EscapeControl(s string) string

+ func Extract(r io.Reader, dir string) error

+ func FSTryReadLock(filePath string) (unlock func() error, err error)

+ func FSTryReadLockTimeout(ctx context.Context, filePath string, timeout time.Duration) (unlock func() error, err error)

+ func FSTryWriteLock(filePath string) (unlock func() error, err error)

+ func FSTryWriteLockTimeout(ctx context.Context, filePath string, timeout time.Duration) (unlock func() error, err error)

+ func FastMarshal(v interface{}) ([]byte, error)

+ func FastMarshalIndent(v interface{}, prefix, indent string) ([]byte, error)

+ func FastUnmarshal(data []byte, v interface{}) error

+ func FatalError(err error)

+ func FileExists(fp string) bool

+ func FnCacheGet(ctx context.Context, cache *FnCache, key any, ...) (T, error)

+ func FormatAlert(alert types.ClusterAlert) string

+ func FormatErrorWithNewline(err error) string

+ func GRPCClientStreamErrorInterceptor(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, ...) (grpc.ClientStream, error)

+ func GRPCClientUnaryErrorInterceptor(ctx context.Context, method string, req, reply interface{}, ...) error

+ func GRPCServerStreamErrorInterceptor(srv interface{}, ss grpc.ServerStream, info *grpc.StreamServerInfo, ...) error

+ func GRPCServerUnaryErrorInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (interface{}, error)

+ func GenerateOTPURL(typ string, label string, parameters map[string][]byte) string

+ func GenerateQRCode(u string) ([]byte, error)

+ func GenerateSelfSignedSigningCert(entity pkix.Name, dnsNames []string, ttl time.Duration) ([]byte, []byte, error)

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

+ func GetEC2NodeID() (string, error)

+ func GetIterations() int

+ func GetListenerFile(listener net.Listener) (*os.File, error)

+ func GlobToRegexp(in string) string

+ func GuessHostIP() (ip net.IP, err error)

+ func HasBTF() error

+ func HasPrefixAny(prefix string, values []string) bool

+ func Host(hostname string) (string, error)

+ func HostUUIDExistsLocally(dataDir string) bool

+ func InitCLIParser(appName, appHelp string) (app *kingpin.Application)

+ func InitLogger(purpose LoggingPurpose, level logrus.Level, verbose ...bool)

+ func InitLoggerForTests()

+ func IsCertExpiredError(err error) bool

+ func IsConnectionRefused(err error) bool

+ func IsDir(path string) bool

+ func IsEC2NodeID(id string) bool

+ func IsExpiredCredentialError(err error) bool

+ func IsFailedToSendCloseNotifyError(err error) bool

+ func IsFile(path string) bool

+ func IsGroupMember(gid int) (bool, error)

+ func IsHandshakeFailedError(err error) bool

+ func IsLocalhost(host string) bool

+ func IsOKNetworkError(err error) bool

+ func IsPredicateError(err error) bool

+ func IsSelfSigned(certificateChain []*x509.Certificate) bool

+ func IsUntrustedCertErr(err error) bool

+ func IsUseOfClosedNetworkError(err error) bool

+ func IsValidHostname(hostname string) bool

+ func KernelVersion() (*semver.Version, error)

+ func MarshalPrivateKey(key crypto.Signer) ([]byte, []byte, error)

+ func MarshalPublicKey(signer crypto.Signer) ([]byte, error)

+ func MaxInt64(x, y int64) int64

+ func MinInt64(x, y int64) int64

+ func MinTTL(a, b time.Duration) time.Duration

+ func MinVerWithoutPreRelease(currentVersion, minVersion string) (bool, error)

+ func MkdirAll(targetDirectory string, mode os.FileMode) error

+ func MultiCloser(closers ...io.Closer) io.Closer

+ func NetAddrsToStrings(netAddrs []NetAddr) []string

+ func NewCertPoolFromPath(path string) (*x509.CertPool, error)

+ func NewDefaultLinear() *retryutils.Linear

+ func NewLogger() *logrus.Logger

+ func NewLoggerForTests() *logrus.Logger

+ func NewStdlogger(logger LeveledOutputFunc, component string) *stdlog.Logger

+ func NilCloser(r io.Closer) io.Closer

+ func NodeIDFromIID(iid *imds.InstanceIdentityDocument) string

+ func NopWriteCloser(r io.Writer) io.WriteCloser

+ func NormalizePath(path string) (string, error)

+ func OSRelease(rel io.Reader) (map[string]string, error)

+ func ObeyIdleTimeout(conn net.Conn, timeout time.Duration, ownerName string) net.Conn

+ func OpaqueAccessDenied(err error) error

+ func OpenFile(path string) (*os.File, error)

+ func ParseAdvertiseAddr(advertiseIP string) (string, string, error)

+ func ParseOnOff(parameterName, val string, defaultValue bool) (bool, error)

+ func ParsePrivateKey(bytes []byte) (crypto.Signer, error)

+ func ParsePrivateKeyDER(der []byte) (crypto.Signer, error)

+ func ParsePrivateKeyPEM(bytes []byte) (crypto.Signer, error)

+ func ParsePublicKey(bytes []byte) (crypto.PublicKey, error)

+ func PercentUsed(path string) (float64, error)

+ func PrintVersion()

+ func ProxyConn(ctx context.Context, client, server io.ReadWriteCloser) error

+ func RandomDuration(max time.Duration) time.Duration

+ func ReadAtMost(r io.Reader, limit int64) ([]byte, error)

+ func ReadCertificates(certificateChainBytes []byte) ([]*x509.Certificate, error)

+ func ReadCertificatesFromPath(path string) ([]*x509.Certificate, error)

+ func ReadEnvironmentFile(filename string) ([]string, error)

+ func ReadHostUUID(dataDir string) (string, error)

+ func ReadOrMakeHostUUID(dataDir string) (string, error)

+ func ReadPath(path string) ([]byte, error)

+ func ReadYAML(reader io.Reader) (interface{}, error)

+ func RegexpWithConfig(expression string, config RegexpConfig) (*regexp.Regexp, error)

+ func RemoveFromSlice(slice []string, values ...string) []string

+ func RemoveSecure(filePath string) error

+ func ReplaceInSlice(s []string, old string, new string) []string

+ func ReplaceLocalhost(addr, replaceWith string) string

+ func ReplaceRegexp(expression string, replaceWith string, input string) (string, error)

+ func ReplaceRegexpWith(expr *regexp.Regexp, replaceWith string, input string) (string, error)

+ func ReplaceUnspecifiedHost(addr *NetAddr, defaultPort int) string

+ func Round(x float64) float64

+ func Roundtrip(addr string) (string, error)

+ func RoundtripWithConn(conn net.Conn) (string, error)

+ func SetupTLSConfig(config *tls.Config, cipherSuites []uint16)

+ func SliceMatchesRegex(input string, expressions []string) (bool, error)

+ func SplitHostPort(hostname string) (string, string, error)

+ func SplitIdentifiers(s string) []string

+ func StatDir(path string) (os.FileInfo, error)

+ func StatFile(path string) (os.FileInfo, error)

+ func StoreErrorOf(f func() error, err *error)

+ func StringMapsEqual(a, b map[string]string) bool

+ func StringSliceSubset(a []string, b []string) error

+ func StringsSet(in []string) map[string]struct

+ func StringsSliceFromSet(in map[string]struct{}) []string

+ func SwitchLoggerToSyslog(logger *log.Logger) error — darwin/amd64, js/wasm, linux/amd64

+ func SwitchLoggingtoSyslog() error — darwin/amd64, js/wasm, linux/amd64

+ func TLSCertToX509(cert tls.Certificate) (*x509.Certificate, error)

+ func TLSConfig(cipherSuites []uint16) *tls.Config

+ func TLSDial(ctx context.Context, dial DialWithContextFunc, network, addr string, ...) (*tls.Conn, error)

+ func ThisFunction() string

+ func ToJSON(data []byte) ([]byte, error)

+ func ToTTL(c clockwork.Clock, tm time.Time) time.Duration

+ func TryReadValueAsFile(value string) (string, error)

+ func UintSliceSubset(a []uint16, b []uint16) error

+ func UpdateAppUsageTemplate(app *kingpin.Application, args []string)

+ func UserMessageFromError(err error) string

+ func VerifyCertificateChain(certificateChain []*x509.Certificate) error

+ func VerifyCertificateExpiry(c *x509.Certificate, clock clockwork.Clock) error

+ func VersionBeforeAlpha(version string) string

+ func WriteCloserWithContext(ctx context.Context, closer WriteContextCloser) io.WriteCloser

+ func WriteHostUUID(dataDir string, id string) error

+ func WriteJSON(w io.Writer, values interface{}) error

+ func WriteYAML(w io.Writer, values interface{}) error

+ type Anonymizer interface

+ Anonymize func(data []byte) string

+ AnonymizeString func(s string) string

+ type BufferSyncPool struct

+ func NewBufferSyncPool(size int64) *BufferSyncPool

+ func (b *BufferSyncPool) Get() *bytes.Buffer

+ func (b *BufferSyncPool) Put(buf *bytes.Buffer)

+ func (b *BufferSyncPool) Size() int64

+ type CaptureNBytesWriter struct

+ func NewCaptureNBytesWriter(max int) *CaptureNBytesWriter

+ func (w *CaptureNBytesWriter) Write(p []byte) (int, error)

+ func (w CaptureNBytesWriter) Bytes() []byte

+ type CircularBuffer struct

+ func NewCircularBuffer(size int) (*CircularBuffer, error)

+ func (t *CircularBuffer) Add(d float64)

+ func (t *CircularBuffer) Data(n int) []float64

+ type CloseBroadcaster struct

+ C chan struct{}

+ func NewCloseBroadcaster() *CloseBroadcaster

+ func (b *CloseBroadcaster) Close() error

+ type CloserConn struct

+ func NewCloserConn(conn net.Conn, closers ...io.Closer) *CloserConn

+ func (c *CloserConn) AddCloser(closer io.Closer)

+ func (c *CloserConn) Close() error

+ func (c *CloserConn) Context() context.Context

+ func (c *CloserConn) Wait()

+ type DialWithContextFunc func(ctx context.Context, network, addr string) (net.Conn, error)

+ type Fields map[string]interface

+ func (f Fields) GetInt(key string) int

+ func (f Fields) GetString(key string) string

+ func (f Fields) GetStrings(key string) []string

+ func (f Fields) GetTime(key string) time.Time

+ func (f Fields) HasField(key string) bool

+ type FieldsCondition func(Fields) bool

+ func ToFieldsCondition(expr *types.WhereExpr) (FieldsCondition, error)

+ type FileNode struct

+ Dir bool

+ Mode int64

+ Name string

+ Parent string

+ Size int64

+ type FnCache struct

+ func NewFnCache(cfg FnCacheConfig) (*FnCache, error)

+ type FnCacheConfig struct

+ CleanupInterval time.Duration

+ Clock clockwork.Clock

+ Context context.Context

+ ReloadOnErr bool

+ TTL time.Duration

+ func (c *FnCacheConfig) CheckAndSetDefaults() error

+ type HMACAnonymizer struct

+ func NewHMACAnonymizer(key string) (*HMACAnonymizer, error)

+ func (a *HMACAnonymizer) Anonymize(data []byte) string

+ func (a *HMACAnonymizer) AnonymizeString(s string) string

+ type InMemoryFile struct

+ func NewInMemoryFile(name string, mode fs.FileMode, modTime time.Time, content []byte) *InMemoryFile

+ func (fi *InMemoryFile) Content() []byte

+ func (fi *InMemoryFile) IsDir() bool

+ func (fi *InMemoryFile) ModTime() time.Time

+ func (fi *InMemoryFile) Mode() fs.FileMode

+ func (fi *InMemoryFile) Name() string

+ func (fi *InMemoryFile) Size() int64

+ func (fi *InMemoryFile) Sys() interface{}

+ type JSONFormatter struct

+ ExtraFields []string

+ func NewTestJSONFormatter() *JSONFormatter

+ func (j *JSONFormatter) CheckAndSetDefaults() error

+ func (j *JSONFormatter) Format(e *log.Entry) ([]byte, error)

+ type JumpHost struct

+ Addr NetAddr

+ Username string

+ func ParseProxyJump(in string) ([]JumpHost, error)

+ type KeyStore struct

+ func ParseKeyStorePEM(keyPEM, certPEM string) (*KeyStore, error)

+ func (ks *KeyStore) GetKeyPair() (*rsa.PrivateKey, []byte, error)

+ type LeveledOutputFunc func(args ...interface{})

+ type LoadBalancer struct

+ func NewLoadBalancer(ctx context.Context, frontend NetAddr, backends ...NetAddr) (*LoadBalancer, error)

+ func NewRandomLoadBalancer(ctx context.Context, frontend NetAddr, backends ...NetAddr) (*LoadBalancer, error)

+ func (l *LoadBalancer) AddBackend(b NetAddr)

+ func (l *LoadBalancer) Addr() net.Addr

+ func (l *LoadBalancer) Close() error

+ func (l *LoadBalancer) Listen() error

+ func (l *LoadBalancer) RemoveBackend(b NetAddr) error

+ func (l *LoadBalancer) Serve() error

+ func (l *LoadBalancer) Wait()

+ type Logger interface

+ GetLevel func() logrus.Level

+ SetLevel func(level logrus.Level)

+ func WrapLogger(logger *logrus.Entry) Logger

+ type LoggingPurpose int

+ const LoggingForCLI

+ const LoggingForDaemon

+ type NetAddr struct

+ Addr string

+ AddrNetwork string

+ Path string

+ func AddrsFromStrings(s apiutils.Strings, defaultPort int) ([]NetAddr, error)

+ func DialAddrFromListenAddr(listenAddr NetAddr) NetAddr

+ func FromAddr(a net.Addr) NetAddr

+ func JoinAddrSlices(a []NetAddr, b []NetAddr) []NetAddr

+ func MustParseAddr(a string) *NetAddr

+ func MustParseAddrList(aList ...string) []NetAddr

+ func ParseAddr(a string) (*NetAddr, error)

+ func ParseAddrs(addrs []string) (result []NetAddr, err error)

+ func ParseHostPortAddr(hostport string, defaultPort int) (*NetAddr, error)

+ func (a *NetAddr) FullAddress() string

+ func (a *NetAddr) Host() string

+ func (a *NetAddr) IsEmpty() bool

+ func (a *NetAddr) IsHostUnspecified() bool

+ func (a *NetAddr) IsLocal() bool

+ func (a *NetAddr) IsLoopback() bool

+ func (a *NetAddr) MarshalYAML() (interface{}, error)

+ func (a *NetAddr) Network() string

+ func (a *NetAddr) Port(defaultPort int) int

+ func (a *NetAddr) Set(s string) error

+ func (a *NetAddr) String() string

+ func (a *NetAddr) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type OpenFileWithFlagsFunc func(name string, flag int, perm os.FileMode) (*os.File, error)

+ type PipeNetConn struct

+ func NewPipeNetConn(reader io.Reader, writer io.Writer, closer io.Closer, fakelocalAddr net.Addr, ...) *PipeNetConn

+ func (nc *PipeNetConn) Close() error

+ func (nc *PipeNetConn) LocalAddr() net.Addr

+ func (nc *PipeNetConn) Read(buf []byte) (n int, e error)

+ func (nc *PipeNetConn) RemoteAddr() net.Addr

+ func (nc *PipeNetConn) SetDeadline(t time.Time) error

+ func (nc *PipeNetConn) SetReadDeadline(t time.Time) error

+ func (nc *PipeNetConn) SetWriteDeadline(t time.Time) error

+ func (nc *PipeNetConn) Write(buf []byte) (n int, e error)

+ type PortList struct

+ func GetFreeTCPPorts(n int, offset ...int) (PortList, error)

+ func (p *PortList) Pop() string

+ func (p *PortList) PopInt() int

+ func (p *PortList) PopIntSlice(num int) []int

+ type PredicateError struct

+ Err error

+ func (p PredicateError) Error() string

+ type ReadStatFS interface

+ type RegexpConfig struct

+ IgnoreCase bool

+ type RepeatReader struct

+ func NewRepeatReader(repeat byte, count int) *RepeatReader

+ func (r *RepeatReader) Read(data []byte) (int, error)

+ type SlicePool interface

+ Get func() []byte

+ Put func(b []byte)

+ Size func() int64

+ Zero func(b []byte)

+ type SliceSyncPool struct

+ func NewSliceSyncPool(sliceSize int64) *SliceSyncPool

+ func (s *SliceSyncPool) Get() []byte

+ func (s *SliceSyncPool) Put(b []byte)

+ func (s *SliceSyncPool) Size() int64

+ func (s *SliceSyncPool) Zero(b []byte)

+ type Stater interface

+ Stat func() (uint64, uint64)

+ type SyncBuffer struct

+ func NewSyncBuffer() *SyncBuffer

+ func (b *SyncBuffer) Bytes() []byte

+ func (b *SyncBuffer) Close() error

+ func (b *SyncBuffer) String() string

+ func (b *SyncBuffer) Write(data []byte) (n int, err error)

+ type SyncString struct

+ func (s *SyncString) Set(v string)

+ func (s *SyncString) Value() string

+ type SyncWriter struct

+ func NewSyncWriter(w io.Writer) *SyncWriter

+ func (sw *SyncWriter) Write(b []byte) (int, error)

+ type TLSConn interface

+ ConnectionState func() tls.ConnectionState

+ Handshake func() error

+ HandshakeContext func(context.Context) error

+ type TLSCredentials struct

+ Cert []byte

+ PrivateKey []byte

+ PublicKey []byte

+ func GenerateSelfSignedCert(hostNames []string) (*TLSCredentials, error)

+ type TextFormatter struct

+ ComponentPadding int

+ EnableColors bool

+ ExtraFields []string

+ FormatCaller func() (caller string)

+ func NewDefaultTextFormatter(enableColors bool) *TextFormatter

+ func (tf *TextFormatter) CheckAndSetDefaults() error

+ func (tf *TextFormatter) Format(e *log.Entry) ([]byte, error)

+ type TimedCounter struct

+ func NewTimedCounter(clock clockwork.Clock, timeout time.Duration) *TimedCounter

+ func (c *TimedCounter) Count() int

+ func (c *TimedCounter) Increment() int

+ type TimeoutConn struct

+ OwnerName string

+ TimeoutDuration time.Duration

+ func (tc *TimeoutConn) Read(p []byte) (n int, err error)

+ func (tc *TimeoutConn) Write(p []byte) (n int, err error)

+ type Tracer struct

+ Description string

+ Started time.Time

+ func NewTracer(description string) *Tracer

+ func (t *Tracer) Start() *Tracer

+ func (t *Tracer) Stop() *Tracer

+ type TrackingConn struct

+ func NewTrackingConn(conn net.Conn) *TrackingConn

+ func (s *TrackingConn) Read(b []byte) (n int, err error)

+ func (s *TrackingConn) Stat() (uint64, uint64)

+ func (s *TrackingConn) Write(b []byte) (n int, err error)

+ type TrackingReader struct

+ func NewTrackingReader(r io.Reader) *TrackingReader

+ func (r *TrackingReader) Count() uint64

+ func (r *TrackingReader) Read(b []byte) (int, error)

+ type TrackingWriter struct

+ func NewTrackingWriter(w io.Writer) *TrackingWriter

+ func (w *TrackingWriter) Count() uint64

+ func (w *TrackingWriter) Write(b []byte) (int, error)

+ type UID interface

+ New func() string

+ func NewFakeUID() UID

+ func NewRealUID() UID

+ type WebLinks struct

+ FirstPage string

+ LastPage string

+ NextPage string

+ PrevPage string

+ func ParseWebLinks(response *http.Response) WebLinks

+ type WriteContextCloser interface

+ Close func(ctx context.Context) error

Other modules containing this package

github.com/zmb3/teleport