sanitiser

README

Sanitiser

This package provides contextual scrubbing of data based on tags.

Usage

type User struct {
  Name     string
  Password string `sanitise:"*"`
  Hash     []byte `sanitise:"api"`
}

Calling sanitiser.Sanitise() with an instance of the User struct will return a copy with the Password field scrubbed (set to the zero value) in any context, the Hash field in the api context, and will always leave Name untouched.

When used on objects that are getting serialised together with the omitempty directive, the serialised representation will be completely clean of any sensitive data.

TODO

• Support list of contexts in call to Sanitise()
• Improve debug messages

Documentation

Index

• func Sanitise(obj interface{}, context string) interface{}
• func SetLogger(f Logger)
• type Logger
• type Sanitiser

Functions

func Sanitise

func Sanitise(obj interface{}, context string) interface{}

func SetLogger

func SetLogger(f Logger)

Types

type Logger

type Logger func(format string, v ...interface{})

type Sanitiser

type Sanitiser interface {
	Sanitise(context string)
}