maskedlog

README

go-maskedlog

A logger on built on top of zerolog that can mask sensitive values in the output.

Installation

go get github.com/chiselwright/go-maskedlog

Getting Started

package main

import (
	"fmt"

	"github.com/chiselwright/go-maskedlog"
)

func main() {
	logger := maskedlog.GetSingleton()

	val := "MySekritWurd"
	logger.AddSensitiveValue(val)

	logger.LogWarn(fmt.Sprintf("Failed to authenticate with password: %q", val))
}

will result in something similar to:

❯ go run .
{"level":"warn","time":"2021-01-06T21:25:19Z","message":"Failed to authenticate with password: \"MySexxxxWurd\""}

Documentation

Index

• func SafeString(s string) string
• func Stringify(z interface{}) string
• type MaskLog
  • func GetSingleton() MaskLog
  • func (ml *MaskLog) AddSensitiveValue(s string)
  • func (ml MaskLog) LogFatal(v ...interface{})
  • func (ml MaskLog) LogVerbose(v ...interface{})
  • func (ml MaskLog) LogWarn(v ...interface{})
  • func (ml MaskLog) PrepareMessage(v interface{}) string
  • func (ml *MaskLog) Reset()
  • func (ml MaskLog) SanitizeInterfaceValues(z interface{})
• type MaskStrings

Functions

func SafeString

func SafeString(s string) string

SafeString ...

func Stringify

func Stringify(z interface{}) string

Stringify ... turns things into strings

Types

type MaskLog

type MaskLog struct {
	SensitiveStrings *MaskStrings
	Opts             interface{}
}

MaskLog is a structure to hold "useful" state

func GetSingleton

func GetSingleton() MaskLog

GetSingleton ...

func (*MaskLog) AddSensitiveValue

func (ml *MaskLog) AddSensitiveValue(s string)

AddSensitiveValue adds a new token/password value to mask in any log output

func (MaskLog) LogFatal

func (ml MaskLog) LogFatal(v ...interface{})

LogFatal does cool things

func (MaskLog) LogVerbose

func (ml MaskLog) LogVerbose(v ...interface{})

LogVerbose does other things

func (MaskLog) LogWarn

func (ml MaskLog) LogWarn(v ...interface{})

LogWarn does, uhm, warnings?

func (MaskLog) PrepareMessage

func (ml MaskLog) PrepareMessage(v interface{}) string

PrepareMessage ...

func (*MaskLog) Reset

func (ml *MaskLog) Reset()

Reset ...

func (MaskLog) SanitizeInterfaceValues

func (ml MaskLog) SanitizeInterfaceValues(z interface{})

SanitizeInterfaceValues will mask sensitive values in output

type MaskStrings

type MaskStrings []string

MaskStrings is a convenience type for the list of sensitive values to hide away