-
-
Notifications
You must be signed in to change notification settings - Fork 687
/
app.go
329 lines (276 loc) · 10.2 KB
/
app.go
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
//go:build linux
// +build linux
package sensor
import (
"bytes"
"context"
"encoding/json"
"errors"
"flag"
"fmt"
"os"
"path/filepath"
"time"
log "github.com/sirupsen/logrus"
"github.com/slimtoolkit/slim/pkg/app"
"github.com/slimtoolkit/slim/pkg/app/sensor/artifact"
"github.com/slimtoolkit/slim/pkg/app/sensor/controlled"
"github.com/slimtoolkit/slim/pkg/app/sensor/execution"
"github.com/slimtoolkit/slim/pkg/app/sensor/monitor"
"github.com/slimtoolkit/slim/pkg/app/sensor/standalone"
"github.com/slimtoolkit/slim/pkg/app/sensor/standalone/control"
"github.com/slimtoolkit/slim/pkg/appbom"
"github.com/slimtoolkit/slim/pkg/ipc/event"
"github.com/slimtoolkit/slim/pkg/mondel"
"github.com/slimtoolkit/slim/pkg/report"
"github.com/slimtoolkit/slim/pkg/sysenv"
"github.com/slimtoolkit/slim/pkg/system"
"github.com/slimtoolkit/slim/pkg/util/errutil"
"github.com/slimtoolkit/slim/pkg/version"
)
const (
// Execution modes
sensorModeControlled = "controlled"
sensorModeStandalone = "standalone"
// Flags
getAppBomFlagUsage = "get sensor application BOM"
getAppBomFlagDefault = false
enableDebugFlagUsage = "enable debug logging"
enableDebugFlagDefault = false
logLevelFlagUsage = "set the logging level ('debug', 'info', 'warn', 'error', 'fatal', 'panic')"
logLevelFlagDefault = "info"
logFormatFlagUsage = "set the logging format ('text', or 'json')"
logFormatFlagDefault = "text"
logFileFlagUsage = "enable logging redirection to a file (allowing to keep sensor's output separate from the target app's output)"
logFileFlagDefault = ""
sensorModeFlagUsage = "set the sensor execution mode ('controlled' when sensor expect the driver 'slim' app to manipulate its lifecycle; or 'standalone' when sensor depends on nothing but the target app"
sensorModeFlagDefault = sensorModeControlled
commandsFileFlagUsage = "provide a JSONL-encoded file with one ore more sensor commands (standalone mode only)"
commandsFileFlagDefault = "/opt/_slim/commands.json"
lifecycleHookCommandFlagUsage = "set path to an executable that'll be invoked at various sensor lifecycle events (post-start, pre-shutdown, etc)"
lifecycleHookCommandFlagDefault = ""
// Should stopSignal and stopGracePeriod become StartMonitor
// command's fields instead? Hypothetically, in a multi-command
// monitoring run, these two params may have different values.
stopSignalFlagUsage = "set the signal to stop the target app (and, eventually, the sensor)"
stopSignalFlagDefault = "TERM"
stopGracePeriodFlagUsage = "set the time to wait for the graceful termination of the target app (before sensor SIGKILL's it)"
stopGracePeriodFlagDefault = 5 * time.Second
artifactsDirFlagUsage = "output director for all sensor artifacts"
artifactsDirFlagDefault = app.DefaultArtifactsDirPath
enableMondelFlagUsage = "enable monitor data event logging"
enableMondelFlagDefault = false
)
var (
getAppBom *bool = flag.Bool("appbom", getAppBomFlagDefault, getAppBomFlagUsage)
enableDebug *bool = flag.Bool("debug", enableDebugFlagDefault, enableDebugFlagUsage)
logLevel *string = flag.String("log-level", logLevelFlagDefault, logLevelFlagUsage)
logFormat *string = flag.String("log-format", logFormatFlagDefault, logFormatFlagUsage)
logFile *string = flag.String("log-file", logFileFlagDefault, logFileFlagUsage)
sensorMode *string = flag.String("mode", sensorModeFlagDefault, sensorModeFlagUsage)
commandsFile *string = flag.String("command-file", commandsFileFlagDefault, commandsFileFlagUsage)
artifactsDir *string = flag.String("artifacts-dir", artifactsDirFlagDefault, artifactsDirFlagUsage)
lifecycleHookCommand *string = flag.String("lifecycle-hook", lifecycleHookCommandFlagDefault, lifecycleHookCommandFlagUsage)
stopSignal *string = flag.String("stop-signal", stopSignalFlagDefault, stopSignalFlagUsage)
stopGracePeriod *time.Duration = flag.Duration("stop-grace-period", stopGracePeriodFlagDefault, stopGracePeriodFlagUsage)
enableMondel *bool = flag.Bool("mondel", enableMondelFlagDefault, enableMondelFlagUsage)
errUnknownMode = errors.New("unknown sensor mode")
)
func eventsFilePath() string {
return filepath.Join(*artifactsDir, "events.json")
}
func init() {
flag.BoolVar(getAppBom, "b", getAppBomFlagDefault, getAppBomFlagUsage)
flag.BoolVar(enableDebug, "d", enableDebugFlagDefault, enableDebugFlagUsage)
flag.StringVar(logLevel, "l", logLevelFlagDefault, logLevelFlagUsage)
flag.StringVar(logFormat, "f", logFormatFlagDefault, logFormatFlagUsage)
flag.StringVar(logFile, "o", logFileFlagDefault, logFileFlagUsage)
flag.StringVar(sensorMode, "m", sensorModeFlagDefault, sensorModeFlagUsage)
flag.StringVar(commandsFile, "c", commandsFileFlagDefault, commandsFileFlagUsage)
flag.StringVar(artifactsDir, "e", artifactsDirFlagDefault, artifactsDirFlagUsage)
flag.StringVar(lifecycleHookCommand, "a", lifecycleHookCommandFlagDefault, lifecycleHookCommandFlagUsage)
flag.StringVar(stopSignal, "s", stopSignalFlagDefault, stopSignalFlagUsage)
flag.DurationVar(stopGracePeriod, "w", stopGracePeriodFlagDefault, stopGracePeriodFlagUsage)
flag.BoolVar(enableMondel, "n", enableMondelFlagDefault, enableMondelFlagUsage)
}
// Run starts the sensor app
func Run() {
flag.Parse()
if *getAppBom {
dumpAppBom()
return
}
errutil.FailOn(configureLogger(*enableDebug, *logLevel, *logFormat, *logFile))
ctx := context.Background()
if len(os.Args) > 1 && os.Args[1] == "control" {
if err := runControlCommand(ctx); err != nil {
fmt.Fprintln(os.Stderr, "Control command failed: "+err.Error())
os.Exit(1)
}
return
}
activeCaps, maxCaps, err := sysenv.Capabilities(0)
errutil.WarnOn(err)
sr := &report.SensorReport{
Version: version.Current(),
Args: os.Args,
}
log.Infof("sensor: ver=%v", sr.Version)
log.Debugf("sensor: args => %#v", sr.Args)
log.Tracef("sensor: uid=%v euid=%v", os.Getuid(), os.Geteuid())
log.Tracef("sensor: privileged => %v", sysenv.IsPrivileged())
log.Tracef("sensor: active capabilities => %#v", activeCaps)
log.Tracef("sensor: max capabilities => %#v", maxCaps)
log.Tracef("sensor: sysinfo => %#v", system.GetSystemInfo())
log.Tracef("sensor: kernel flags => %#v", system.DefaultKernelFeatures.Raw)
var artifactsExtra []string
if len(*commandsFile) > 0 {
artifactsExtra = append(artifactsExtra, *commandsFile)
}
if len(*logFile) > 0 {
artifactsExtra = append(artifactsExtra, *logFile)
}
artifactor := artifact.NewProcessor(sr, *artifactsDir, artifactsExtra)
exe, err := newExecution(
ctx,
*sensorMode,
*commandsFile,
eventsFilePath(),
*lifecycleHookCommand,
)
if err != nil {
errutil.WarnOn(artifactor.Archive())
errutil.FailOn(err) // calls os.Exit(1)
}
mondelFile := filepath.Join(*artifactsDir, report.DefaultMonDelFileName)
del := mondel.NewPublisher(ctx, *enableMondel, mondelFile)
sen, err := newSensor(ctx, exe, *sensorMode, artifactor, del, *artifactsDir)
if err != nil {
exe.Close()
errutil.WarnOn(artifactor.Archive())
errutil.FailOn(err) // calls os.Exit(1)
}
if err := sen.Run(); err != nil {
log.WithError(err).Error("sensor: run finished with error")
if errors.Is(err, monitor.ErrInsufficientPermissions) {
log.Info("sensor: Instrumented containers require root and ALL capabilities enabled. Example: `docker run --user root --cap-add ALL app:v1-instrumented`")
}
} else {
log.Info("sensor: run finished succesfully")
}
exe.Close()
log.Info("sensor: exiting...")
}
func newExecution(
ctx context.Context,
mode string,
commandsFile string,
eventsFile string,
lifecycleHookCommand string,
) (execution.Interface, error) {
switch mode {
case sensorModeControlled:
return execution.NewControlled(ctx, lifecycleHookCommand)
case sensorModeStandalone:
return execution.NewStandalone(
ctx,
commandsFile,
eventsFile,
lifecycleHookCommand,
)
}
return nil, errUnknownMode
}
type sensor interface {
Run() error
}
func newSensor(
ctx context.Context,
exe execution.Interface,
mode string,
artifactor artifact.Processor,
del mondel.Publisher,
artifactsDir string,
) (sensor, error) {
workDir, err := os.Getwd()
errutil.WarnOn(err)
log.Debugf("sensor: cwd => %s", workDir)
mountPoint := "/"
log.Debugf("sensor: mount point => %s", mountPoint)
switch mode {
case sensorModeControlled:
ctx, cancel := context.WithCancel(ctx)
// To preserve the backward compatibility, don't forward
// signals to the target app in the default (controlled) mode.
startSystemSignalsMonitor(func() {
cancel()
time.Sleep(2 * time.Second)
})
return controlled.NewSensor(
ctx,
exe,
monitor.NewCompositeMonitor,
del,
artifactor,
workDir,
mountPoint,
), nil
case sensorModeStandalone:
return standalone.NewSensor(
ctx,
exe,
monitor.NewCompositeMonitor,
del,
artifactor,
workDir,
mountPoint,
signalFromString(*stopSignal),
*stopGracePeriod,
), nil
}
exe.PubEvent(event.StartMonitorFailed,
&event.StartMonitorFailedData{
Component: event.ComSensorConstructor,
State: event.StateSensorTypeCreating,
Context: map[string]string{
event.CtxSensorType: mode,
},
Errors: []string{errUnknownMode.Error()},
})
return nil, errUnknownMode
}
func dumpAppBom() {
info := appbom.Get()
if info == nil {
return
}
var out bytes.Buffer
encoder := json.NewEncoder(&out)
encoder.SetEscapeHTML(false)
encoder.SetIndent(" ", " ")
_ = encoder.Encode(info)
fmt.Printf("%s\n", out.String())
}
// sensor control <stop-target-app|wait-for-event|change-log-level|...>
func runControlCommand(ctx context.Context) error {
if len(os.Args) < 3 {
return errors.New("missing command")
}
cmd := control.Command(os.Args[2])
switch cmd {
case control.StopTargetAppCommand:
if err := control.ExecuteStopTargetAppCommand(ctx, *commandsFile); err != nil {
return fmt.Errorf("error stopping target app: %w", err)
}
case control.WaitForEventCommand:
if len(os.Args) < 4 {
return errors.New("missing event name")
}
if err := control.ExecuteWaitEvenCommand(ctx, eventsFilePath(), event.Type(os.Args[3])); err != nil {
return fmt.Errorf("error waiting for sensor event: %w", err)
}
default:
return fmt.Errorf("unknown command: %s", cmd)
}
return nil
}