redact

package module

v0.1.0 Latest Latest Go to latest Published: May 9, 2024 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var MASKED = "[MASKED]"

func ProtectPhrase(phrase string)

ProtectPhrase will cause the provided phrase to be redacted (also base64 encoded values)

func Redact(input string) string

Redact redacts all protected phrases in the input string (replace with ***)

type FileProxyWriter struct {
	// contains filtered or unexported fields
}

func NewProtectedWriter(file *os.File, writer io.Writer, mutex *sync.Mutex, redactor *Redactor) *FileProxyWriter

NewProtectedWriter proxies all output to stdout/stderr to omit/remove any kind of credentials from all logs

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

type Redactor struct {
	// contains filtered or unexported fields
}

func NewRedactor(phrases []string) *Redactor

func (r *Redactor) ProtectPhrase(phrase string)

func (r *Redactor) ProtectedPhraseCount() int

func (r *Redactor) Redact(input string) string

func (r *Redactor) Reset()

func (r *Redactor) SetMaskValue(maskValue string)