masker

README

json-masker

Opinionated Json masker package, allowing masking using json paths

How to use:

	jsonRaw := `{
		"name": "John Doe",
		"age": 30,
		"jobs": [{
			"id": 1,
			"name": "Software Engineer",
			"list": ["task1", "task2"]
		},
		{
			"id": 2,
			"name": "DevOps Engineer",
			"list": ["task1", "task2"]
		}]
	}`

	maskedPaths := []string{
		"$.name",
		"$.jobs[].name",
		"$.jobs[].list[]",
	}
	masker := masker.NewMasker(maskPaths, withFixedMaskString("[REDACTED]"), withDebugMode())
	masked, err := masker.Mask(jsonRaw, maskedPaths)
	if err != nil {
		panic(err)
	}
	println(masked)

    // Output:
    // {
    //     "age": 30,
    //     "name": "[REDACTED]",
    //     "jobs": [
    //         {
    //             "id": 1,
    //             "list": [
    //                 "[REDACTED]",
    //                 "[REDACTED]"
    //             ],
    //             "name": "[REDACTED]"
    //         },
    //         {
    //             "id": 2,
    //             "list": [
    //                 "[REDACTED]",
    //                 "[REDACTED]"
    //             ],
    //             "name": "[REDACTED]"
    //         }
    // }

Documentation

Index

• func WithDebugMode() option
• func WithFixedMaskString(maskStr string) option
• func WithMaskFunc(maskFunc func(field any) string) option
• type Masker
  • func NewMasker(maskPaths []string, opts ...option) Masker

Functions

func WithDebugMode

func WithDebugMode() option

func WithFixedMaskString

func WithFixedMaskString(maskStr string) option

func WithMaskFunc

func WithMaskFunc(maskFunc func(field any) string) option

Types

type Masker

type Masker interface {
	Mask(data string, maskPaths []string) (string, error)
	// contains filtered or unexported methods
}

func NewMasker

func NewMasker(maskPaths []string, opts ...option) Masker