-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathredact.go
More file actions
162 lines (136 loc) · 3.72 KB
/
Copy pathredact.go
File metadata and controls
162 lines (136 loc) · 3.72 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
package redact
import (
"path/filepath"
"regexp"
"strings"
)
const RedactedValue = "[REDACTED]"
var (
fullRedactFlags = map[string]struct{}{
"env": {},
"public-env": {},
"http-payload": {},
"public_key": {},
"ledger-derivation-path": {},
"config": {},
}
urlValueFlags = map[string]struct{}{
"rpc-url": {},
"wasm": {},
}
jwtSegmentPattern = regexp.MustCompile(`eyJ[A-Za-z0-9_-]+\.eyJ[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+`)
bearerPattern = regexp.MustCompile(`(?i)(Bearer\s+)[^\s]+`)
apikeyPattern = regexp.MustCompile(`(?i)(Apikey\s+)[^\s]+`)
envSecretPattern = regexp.MustCompile(`(?i)(CRE_API_KEY\s*=\s*)\S+`)
privateKeyPattern = regexp.MustCompile(`(?i)\b(?:0x)?[0-9a-f]{64}\b`)
urlPattern = regexp.MustCompile(`https?://[^\s"'<>]+`)
templateAddSensitivePattern = regexp.MustCompile(`(?i)(://|\?|ghp_[A-Za-z0-9]+|github_pat_[A-Za-z0-9_]+)`)
)
// Flag redacts a single CLI flag value based on flag name.
func Flag(name, value string) string {
if value == "" {
return value
}
if _, ok := fullRedactFlags[name]; ok {
return RedactedValue
}
if name == "limits" && !isNonSensitiveLimitsValue(value) {
return RedactedValue
}
if _, ok := urlValueFlags[name]; ok {
return redactURLFlagValue(name, value)
}
return value
}
func isNonSensitiveLimitsValue(value string) bool {
switch strings.ToLower(value) {
case "default", "none":
return true
default:
return false
}
}
func redactURLFlagValue(name, value string) string {
if name == "rpc-url" {
chainName, rpcURL, ok := strings.Cut(value, "=")
if !ok {
return RedactedValue
}
if !looksLikeURL(rpcURL) {
return value
}
return chainName + "=" + URL(rpcURL)
}
if looksLikeURL(value) {
return URL(value)
}
return value
}
func looksLikeURL(value string) bool {
return strings.HasPrefix(value, "http://") || strings.HasPrefix(value, "https://")
}
// Args applies command-specific redaction to positional arguments.
func Args(action, subcommand string, args []string) []string {
if len(args) == 0 {
return args
}
redacted := make([]string, len(args))
copy(redacted, args)
switch action {
case "secrets":
for i, arg := range redacted {
redacted[i] = filepath.Base(arg)
}
case "templates":
if subcommand == "add" {
for i, arg := range redacted {
if templateAddSensitivePattern.MatchString(arg) {
redacted[i] = RedactedValue
}
}
}
}
return redacted
}
// ErrorMessage scrubs known secret patterns from error strings before telemetry export.
func ErrorMessage(msg string) string {
if msg == "" {
return msg
}
msg = jwtSegmentPattern.ReplaceAllString(msg, RedactedValue)
msg = bearerPattern.ReplaceAllString(msg, "${1}"+RedactedValue)
msg = apikeyPattern.ReplaceAllString(msg, "${1}"+RedactedValue)
msg = envSecretPattern.ReplaceAllString(msg, "${1}"+RedactedValue)
msg = privateKeyPattern.ReplaceAllString(msg, RedactedValue)
msg = urlPattern.ReplaceAllStringFunc(msg, func(raw string) string {
return URL(raw)
})
return msg
}
// SafeJWTClaimsForLog returns an allowlisted subset of JWT claims safe for debug logging.
func SafeJWTClaimsForLog(claims map[string]interface{}) map[string]interface{} {
if len(claims) == 0 {
return nil
}
safe := make(map[string]interface{})
for key, value := range claims {
switch key {
case "org_id", "sub", "exp", "iat", "iss", "aud":
safe[key] = value
default:
if strings.HasSuffix(key, "organization_status") || strings.HasSuffix(key, "organization_roles") {
safe[claimLogKey(key)] = value
}
}
}
if len(safe) == 0 {
return nil
}
return safe
}
func claimLogKey(key string) string {
if idx := strings.LastIndex(key, "/"); idx >= 0 {
return key[idx+1:]
}
return key
}