SPB Git

Repository Public

redact.go 3.9 KB 120 lines go

1// Package redact masks text that looks like a secret. It is applied twice to2// command output: by the agent before anything leaves the node, and again by3// the ingest service before storage. It is deliberately conservative: a false4// positive hides a harmless token-like string; a false negative leaks a secret.5package redact67import (8	"regexp"9	"strings"10)1112// Mask replaces a redacted value.13const Mask = "[redacted]"1415var (16	rePEMBlock = regexp.MustCompile(`(?s)-----BEGIN [A-Z0-9 ]+-----.*?-----END [A-Z0-9 ]+-----`)17	rePEMEdge  = regexp.MustCompile(`-----(BEGIN|END) [A-Z0-9 ]+-----`)18	reAuth     = regexp.MustCompile(`(?i)\b(bearer|basic)(\s+)[A-Za-z0-9._~+/=-]{8,}`)19	reAuthHdr  = regexp.MustCompile(`(?i)\b((?:proxy-)?authorization|cookie|set-cookie|x-api-key|x-mcc-enroll-token)(\s*:\s*)\S.*`)20	// NAME=value, NAME: value, "name": "value" where the name suggests a secret.21	reAssign  = regexp.MustCompile(`(?i)(["']?[A-Za-z0-9_.-]*(?:passw(?:or)?d|pwd|secret|token|api[_-]?key|apikey|access[_-]?key|private[_-]?key|credential|auth)[A-Za-z0-9_.-]*["']?)(\s*[=:]\s*)("(?:[^"\\]|\\.)*"|'[^']*'|[^\s,;&]+)`)22	reURLUser = regexp.MustCompile(`([A-Za-z][A-Za-z0-9+.-]*://)[^/\s:@]*(?::[^/\s@]*)?@`)23	// //user:password@host/share, as printed by mount for SMB shares.24	reUNCUser = regexp.MustCompile(`(^|[\s="'])//[^/\s:@]+(?::[^/\s@]*)?@`)25	reHex     = regexp.MustCompile(`\b[A-Fa-f0-9]{32,}\b`)26	reB64     = regexp.MustCompile(`[A-Za-z0-9+/_-]{40,}={0,2}`)27	// Flags such as --password hunter2 / --token=abc.28	reFlag = regexp.MustCompile(`(?i)(--?[A-Za-z0-9-]*(?:passw(?:or)?d|secret|token|api-?key|credential)[A-Za-z0-9-]*)([= ]+)(\S+)`)29)3031// String masks secret-looking substrings of s.32func String(s string) string {33	if s == "" {34		return s35	}36	s = rePEMBlock.ReplaceAllString(s, "[redacted:pem]")37	s = rePEMEdge.ReplaceAllString(s, "[redacted:pem]")38	s = reAuthHdr.ReplaceAllString(s, "${1}${2}"+Mask)39	s = reAuth.ReplaceAllString(s, "${1}${2}"+Mask)40	s = reURLUser.ReplaceAllString(s, "${1}"+Mask+"@")41	s = reUNCUser.ReplaceAllString(s, "${1}//"+Mask+"@")42	s = reFlag.ReplaceAllString(s, "${1}${2}"+Mask)43	s = reAssign.ReplaceAllString(s, "${1}${2}"+Mask)44	s = reHex.ReplaceAllString(s, "[redacted:hex]")45	s = reB64.ReplaceAllStringFunc(s, func(m string) string {46		if looksRandom(m) {47			return "[redacted:blob]"48		}49		return m50	})51	return s52}5354// looksRandom separates base64-like blobs from long paths and identifiers:55// a blob mixes lower case, upper case and digits.56func looksRandom(m string) bool {57	var lower, upper, digit bool58	for i := 0; i < len(m); i++ {59		c := m[i]60		switch {61		case c >= 'a' && c <= 'z':62			lower = true63		case c >= 'A' && c <= 'Z':64			upper = true65		case c >= '0' && c <= '9':66			digit = true67		}68	}69	return lower && upper && digit70}7172// Stream redacts line by line and remembers being inside a PEM block, so the73// body of a multi-line key is masked even when its lines are short.74type Stream struct{ inPEM bool }7576// Line returns the redacted form of one line (without its newline).77func (st *Stream) Line(line string) string {78	begin := strings.Contains(line, "-----BEGIN ")79	end := strings.Contains(line, "-----END ")80	switch {81	case st.inPEM:82		if end {83			st.inPEM = false84		}85		return "[redacted:pem]"86	case begin && !end:87		st.inPEM = true88		return "[redacted:pem]"89	}90	return String(line)91}9293// Value redacts every string inside a decoded JSON value, and masks whole94// values whose key name suggests a secret.95func Value(v any) any {96	switch t := v.(type) {97	case string:98		return String(t)99	case map[string]any:100		out := make(map[string]any, len(t))101		for k, val := range t {102			if secretKey.MatchString(k) {103				out[k] = Mask104			} else {105				out[k] = Value(val)106			}107		}108		return out109	case []any:110		out := make([]any, len(t))111		for i := range t {112			out[i] = Value(t[i])113		}114		return out115	}116	return v117}118119var secretKey = regexp.MustCompile(`(?i)(passw(or)?d|secret|token|api[_-]?key|private|credential|authorization|cookie)`)120
Files main
Menu

Theme