forked from johnjohnsp1/capsule8
-
Notifications
You must be signed in to change notification settings - Fork 1
/
syscall.go
371 lines (339 loc) · 10.8 KB
/
syscall.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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
// Copyright 2017 Capsule8, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package sensor
import (
"fmt"
"sync/atomic"
api "github.com/capsule8/capsule8/api/v0"
"github.com/capsule8/capsule8/pkg/expression"
"github.com/capsule8/capsule8/pkg/sys"
"github.com/capsule8/capsule8/pkg/sys/perf"
"google.golang.org/genproto/googleapis/rpc/code"
)
var syscallEnterEventTypes = expression.FieldTypeMap{
"id": expression.ValueTypeSignedInt64,
"arg0": expression.ValueTypeUnsignedInt64,
"arg1": expression.ValueTypeUnsignedInt64,
"arg2": expression.ValueTypeUnsignedInt64,
"arg3": expression.ValueTypeUnsignedInt64,
"arg4": expression.ValueTypeUnsignedInt64,
"arg5": expression.ValueTypeUnsignedInt64,
}
var syscallExitEventTypes = expression.FieldTypeMap{
"id": expression.ValueTypeSignedInt64,
"ret": expression.ValueTypeSignedInt64,
}
type syscallFilter struct {
sensor *Sensor
}
func (f *syscallFilter) decodeDummySysEnter(sample *perf.SampleRecord, data perf.TraceEventSampleData) (interface{}, error) {
return nil, nil
}
func (f *syscallFilter) decodeSyscallTraceEnter(sample *perf.SampleRecord, data perf.TraceEventSampleData) (interface{}, error) {
ev := f.sensor.NewEventFromSample(sample, data)
if ev == nil {
return nil, nil
}
ev.Event = &api.TelemetryEvent_Syscall{
Syscall: &api.SyscallEvent{
Type: api.SyscallEventType_SYSCALL_EVENT_TYPE_ENTER,
Id: data["id"].(int64),
Arg0: data["arg0"].(uint64),
Arg1: data["arg1"].(uint64),
Arg2: data["arg2"].(uint64),
Arg3: data["arg3"].(uint64),
Arg4: data["arg4"].(uint64),
Arg5: data["arg5"].(uint64),
},
}
return ev, nil
}
func (f *syscallFilter) decodeSysExit(sample *perf.SampleRecord, data perf.TraceEventSampleData) (interface{}, error) {
ev := f.sensor.NewEventFromSample(sample, data)
if ev == nil {
return nil, nil
}
ev.Event = &api.TelemetryEvent_Syscall{
Syscall: &api.SyscallEvent{
Type: api.SyscallEventType_SYSCALL_EVENT_TYPE_EXIT,
Id: data["id"].(int64),
Ret: data["ret"].(int64),
},
}
return ev, nil
}
func containsIDFilter(expr *api.Expression) bool {
if expr == nil {
return false
}
switch expr.GetType() {
case api.Expression_LOGICAL_AND:
operands := expr.GetBinaryOp()
return containsIDFilter(operands.Lhs) ||
containsIDFilter(operands.Rhs)
case api.Expression_LOGICAL_OR:
operands := expr.GetBinaryOp()
return containsIDFilter(operands.Lhs) &&
containsIDFilter(operands.Rhs)
case api.Expression_EQ:
operands := expr.GetBinaryOp()
if operands.Lhs.GetType() != api.Expression_IDENTIFIER {
return false
}
if operands.Lhs.GetIdentifier() != "id" {
return false
}
return true
}
return false
}
func rewriteSyscallEventFilter(sef *api.SyscallEventFilter) {
if sef.Id != nil {
newExpr := expression.Equal(
expression.Identifier("id"),
expression.Value(sef.Id.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Id = nil
}
if sef.Type == api.SyscallEventType_SYSCALL_EVENT_TYPE_ENTER {
if sef.Arg0 != nil {
newExpr := expression.Equal(
expression.Identifier("arg0"),
expression.Value(sef.Arg0.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Arg0 = nil
}
if sef.Arg1 != nil {
newExpr := expression.Equal(
expression.Identifier("arg1"),
expression.Value(sef.Arg1.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Arg1 = nil
}
if sef.Arg2 != nil {
newExpr := expression.Equal(
expression.Identifier("arg2"),
expression.Value(sef.Arg2.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Arg2 = nil
}
if sef.Arg3 != nil {
newExpr := expression.Equal(
expression.Identifier("arg3"),
expression.Value(sef.Arg3.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Arg3 = nil
}
if sef.Arg4 != nil {
newExpr := expression.Equal(
expression.Identifier("arg4"),
expression.Value(sef.Arg4.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Arg4 = nil
}
if sef.Arg5 != nil {
newExpr := expression.Equal(
expression.Identifier("arg5"),
expression.Value(sef.Arg5.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Arg5 = nil
}
} else if sef.Type == api.SyscallEventType_SYSCALL_EVENT_TYPE_EXIT {
if sef.Ret != nil {
newExpr := expression.Equal(
expression.Identifier("ret"),
expression.Value(sef.Ret.Value))
sef.FilterExpression = expression.LogicalAnd(
newExpr, sef.FilterExpression)
sef.Ret = nil
}
}
}
const (
syscallNewEnterKprobeAddress string = "syscall_trace_enter_phase1"
syscallOldEnterKprobeAddress string = "syscall_trace_enter"
// These offsets index into the x86_64 version of struct pt_regs
// in the kernel. This is a stable structure.
syscallEnterKprobeFetchargs string = "id=+120(%di):s64 " + // orig_ax
"arg0=+112(%di):u64 " + // di
"arg1=+104(%di):u64 " + // si
"arg2=+96(%di):u64 " + // dx
"arg3=+56(%di):u64 " + // r10
"arg4=+72(%di):u64 " + // r8
"arg5=+64(%di):u64" // r9
)
func registerSyscallEvents(
sensor *Sensor,
subscr *subscription,
events []*api.SyscallEventFilter,
) {
var enterFilter, exitFilter *api.Expression
for _, sef := range events {
// Translate deprecated fields into an expression
rewriteSyscallEventFilter(sef)
if !containsIDFilter(sef.FilterExpression) {
// No wildcard filters for now
subscr.logStatus(
code.Code_INVALID_ARGUMENT,
"Wildcard syscall filter ignored")
continue
}
switch sef.Type {
case api.SyscallEventType_SYSCALL_EVENT_TYPE_ENTER:
enterFilter = expression.LogicalOr(enterFilter,
sef.FilterExpression)
case api.SyscallEventType_SYSCALL_EVENT_TYPE_EXIT:
exitFilter = expression.LogicalOr(exitFilter,
sef.FilterExpression)
default:
subscr.logStatus(
code.Code_INVALID_ARGUMENT,
fmt.Sprintf("SyscallEventType %d is invalid", sef.Type))
continue
}
}
f := syscallFilter{
sensor: sensor,
}
if enterFilter != nil {
// Create the dummy syscall event. This event is needed to put
// the kernel into a mode where it'll make the function calls
// needed to make the kprobe we'll add fire. Add the tracepoint,
// but make sure it never adds events into the ringbuffer by
// using a filter that will never evaluate true. It also never
// gets enabled, but just creating it is enough.
//
// For kernels older than 3.x, create this dummy event in all
// event groups, because we cannot remove it when we don't need
// it anymore due to bugs in CentOS 6.x kernels (2.6.32).
var (
err error
eventID uint64
)
eventName := "raw_syscalls/sys_enter"
major, _, _ := sys.KernelVersion()
if major < 3 {
eventID, err = sensor.Monitor.RegisterTracepoint(
eventName, f.decodeDummySysEnter,
perf.WithEventGroup(subscr.eventGroupID),
perf.WithFilter("id == 0x7fffffff"))
if err != nil {
eventName = "syscalls/sys_enter"
eventID, err = sensor.Monitor.RegisterTracepoint(
eventName, f.decodeDummySysEnter,
perf.WithEventGroup(subscr.eventGroupID),
perf.WithFilter("id == 0x7fffffff"))
}
if err != nil {
subscr.logStatus(
code.Code_UNKNOWN,
fmt.Sprintf("Could not register dummy syscall event %s: %v", eventName, err))
}
} else if atomic.AddInt64(&sensor.dummySyscallEventCount, 1) == 1 {
eventID, err = sensor.Monitor.RegisterTracepoint(
eventName, f.decodeDummySysEnter,
perf.WithEventGroup(0),
perf.WithFilter("id == 0x7fffffff"))
if err != nil {
subscr.logStatus(
code.Code_UNKNOWN,
fmt.Sprintf("Could not register dummy syscall event %s: %v", eventName, err))
atomic.AddInt64(&sensor.dummySyscallEventCount, -1)
} else {
sensor.dummySyscallEventID = eventID
}
}
// There are two possible kprobes. Newer kernels (>= 4.1) have
// refactored syscall entry code, so syscall_trace_enter_phase1
// is the right one, but for older kernels syscall_trace_enter
// is the right one. Both have the same signature, so the
// fetchargs doesn't have to change. Try the new probe first,
// because the old probe will also set in the newer kernels,
// but it won't fire.
kprobeSymbol := syscallNewEnterKprobeAddress
eventID, err = sensor.RegisterKprobe(
kprobeSymbol, false,
syscallEnterKprobeFetchargs,
f.decodeSyscallTraceEnter,
perf.WithEventGroup(subscr.eventGroupID))
if err != nil {
kprobeSymbol = syscallOldEnterKprobeAddress
eventID, err = sensor.RegisterKprobe(
kprobeSymbol, false,
syscallEnterKprobeFetchargs,
f.decodeSyscallTraceEnter,
perf.WithEventGroup(subscr.eventGroupID))
}
if err != nil {
subscr.logStatus(
code.Code_UNKNOWN,
fmt.Sprintf("Could not register syscall enter kprobe %s: %v", kprobeSymbol, err))
} else {
es, err := subscr.addEventSink(eventID, enterFilter,
syscallEnterEventTypes)
if err != nil {
subscr.logStatus(
code.Code_UNKNOWN,
fmt.Sprintf("Invalid filter expression for syscall enter filter: %v", err))
sensor.Monitor.UnregisterEvent(eventID)
if major >= 3 {
eventID = sensor.dummySyscallEventID
if atomic.AddInt64(&sensor.dummySyscallEventCount, -1) == 0 {
sensor.Monitor.UnregisterEvent(sensor.dummySyscallEventID)
}
}
} else if major >= 3 {
es.unregister = func(*eventSink) {
eventID := sensor.dummySyscallEventID
if atomic.AddInt64(&sensor.dummySyscallEventCount, -1) == 0 {
sensor.Monitor.UnregisterEvent(eventID)
}
}
}
}
}
if exitFilter != nil {
eventName := "raw_syscalls/sys_exit"
eventID, err := sensor.Monitor.RegisterTracepoint(eventName,
f.decodeSysExit,
perf.WithEventGroup(subscr.eventGroupID))
if err != nil {
eventName = "syscalls/sys_exit"
eventID, err = sensor.Monitor.RegisterTracepoint(eventName,
f.decodeSysExit,
perf.WithEventGroup(subscr.eventGroupID))
}
if err != nil {
subscr.logStatus(
code.Code_UNKNOWN,
fmt.Sprintf("Could not register tracepoint %s: %v", eventName, err))
} else {
_, err = subscr.addEventSink(eventID, exitFilter,
syscallExitEventTypes)
if err != nil {
subscr.logStatus(
code.Code_UNKNOWN,
fmt.Sprintf("Invalid filter expression for syscall exit filter: %v", err))
sensor.Monitor.UnregisterEvent(eventID)
}
}
}
}