-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommand.go
More file actions
218 lines (184 loc) · 5.56 KB
/
command.go
File metadata and controls
218 lines (184 loc) · 5.56 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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
package main
import (
"bufio"
"errors"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"sort"
"strings"
"sync"
"github.com/spf13/cobra"
)
const maxSecretLength = 4096
func cmdMaskPreRun(cmd *cobra.Command, args []string) error {
// Ensure at least one flag is set
if !cmd.Flags().Changed("secrets-dir") && !cmd.Flags().Changed("all-env-vars") && !cmd.Flags().Changed("env-vars") {
return errors.New("at least one flag is required")
}
return nil
}
func cmdMask(cmd *cobra.Command, args []string) error {
// do not show hind after initial validation
cmd.SilenceUsage = true
// Collect secrets to mask
var masks []string
// Read secrets from files in directory if provided
if secretsDir, _ := cmd.Flags().GetString("secrets-dir"); secretsDir != "" {
secretsFromFiles, err := readSecretsFromDir(secretsDir)
if err != nil {
return fmt.Errorf("error reading secrets from directory: %v", err)
}
masks = append(masks, secretsFromFiles...)
}
// Treat all environment variables values as secrets
if allEnv, _ := cmd.Flags().GetBool("all-env-vars"); allEnv != false {
masks = append(masks, collectAllEnvValues()...)
}
// Treat certain environment variables values as secrets
if env, _ := cmd.Flags().GetString("env-vars"); env != "" {
masks = append(masks, collectEnvValues(env)...)
}
if len(masks) == 0 {
return fmt.Errorf("no secrets defined")
}
// Sort masks by string length (longest first) - to tacke overlapping secrets
sort.Slice(masks, func(i, j int) bool {
return len(masks[i]) > len(masks[j])
})
// check for overlapping secrets
checkForOverlappingSecrets(cmd, masks)
// Run external command
cmdToRun := exec.Command(args[0], args[1:]...)
// Capture stdout and stderr
stdout, err := cmdToRun.StdoutPipe()
if err != nil {
return fmt.Errorf("error getting stdout: %v", err)
}
stderr, err := cmdToRun.StderrPipe()
if err != nil {
return fmt.Errorf("error getting stderr: %v", err)
}
// Start the command
if err := cmdToRun.Start(); err != nil {
return fmt.Errorf("error starting command: %v", err)
}
// Process output in real-time
var wg sync.WaitGroup
wg.Add(2)
go streamOutput(stdout, masks, cmd.OutOrStdout(), cmd.ErrOrStderr(), &wg)
go streamOutput(stderr, masks, cmd.ErrOrStderr(), cmd.ErrOrStderr(), &wg)
wg.Wait()
// Wait for the command to complete and capture its exit code
if err := cmdToRun.Wait(); err != nil {
if cmdExit, ok := err.(*exec.ExitError); ok {
return &ExitCodeError{Code: cmdExit.ExitCode()} // Return the same exit code as the original command
}
return fmt.Errorf("command execution failed: %v", err)
}
return nil
}
func checkForOverlappingSecrets(cmd *cobra.Command, masks []string) {
seen := make(map[string]bool)
for i := 0; i < len(masks); i++ {
for j := i + 1; j < len(masks); j++ {
if strings.Contains(masks[i], masks[j]) || strings.Contains(masks[j], masks[i]) {
// Create a unique key for this pair to avoid duplicate warnings
key := masks[i] + "|" + masks[j]
if seen[key] {
continue
}
seen[key] = true
m1 := masks[i]
m2 := masks[j]
if len(m1) > 2 {
m1 = fmt.Sprintf("%c%s%c", m1[0], strings.Repeat("*", len(m1)-2), m1[len(m1)-1])
}
if len(m2) > 2 {
m2 = fmt.Sprintf("%c%s%c", m2[0], strings.Repeat("*", len(m2)-2), m2[len(m2)-1])
}
fmt.Fprintf(cmd.ErrOrStderr(), "Warning: overlapping secrets detected: %s and %s\n", m1, m2)
}
}
}
}
func collectEnvValues(envVars string) []string {
var secrets []string
envVarsList := strings.Split(envVars, ",")
for _, envVar := range envVarsList {
envVar = strings.TrimSpace(envVar)
if envVar == "" {
continue
}
value := os.Getenv(envVar)
if value != "" {
secrets = append(secrets, value)
}
}
return secrets
}
func collectAllEnvValues() []string {
var secrets []string
envVars := os.Environ()
for _, envVar := range envVars {
parts := strings.SplitN(envVar, "=", 2)
if len(parts) == 2 && parts[1] != "" {
secrets = append(secrets, parts[1])
}
}
return secrets
}
// maskLine replaces sensitive substrings in a given line.
func maskLine(line string, masks []string) string {
for _, mask := range masks {
if len(mask) > len(line) {
continue
}
line = strings.ReplaceAll(line, mask, "*****")
}
return line
}
// streamOutput reads from the reader, masks sensitive data, and writes to the output writer.
func streamOutput(reader io.ReadCloser, masks []string, writer io.Writer, errWriter io.Writer, wg *sync.WaitGroup) {
defer wg.Done()
scanner := bufio.NewScanner(reader)
for scanner.Scan() {
maskedLine := maskLine(scanner.Text(), masks)
fmt.Fprintln(writer, maskedLine)
}
if err := scanner.Err(); err != nil {
fmt.Fprintf(errWriter, "Error reading output: %v\n", err)
}
}
// readSecretsFromDir recursively reads all files in a directory and returns their contents as a slice of strings.
func readSecretsFromDir(dirPath string) ([]string, error) {
var secrets []string
err := filepath.Walk(dirPath, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
// Resolve symlinks
resolvedInfo, err := os.Lstat(path)
if err != nil {
return err // skip broken symlinks or inaccessible files
}
if !resolvedInfo.Mode().IsRegular() || info.Mode()&os.ModeSymlink != 0 {
return nil
}
if info.Size() > maxSecretLength {
return fmt.Errorf("secret file %s is too large (above %dkb)", path, maxSecretLength/1024)
}
secret, err := os.ReadFile(path)
if err != nil {
return err
}
secrets = append(secrets, strings.TrimSpace(string(secret)))
return nil
})
if err != nil {
return nil, err
}
return secrets, nil
}