/
report.go
230 lines (201 loc) · 6.1 KB
/
report.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
// This file is subject to the terms and conditions defined in
// file 'LICENSE.txt', which is part of this source code package.
package cmd
import (
"context"
"errors"
"reflect"
"sort"
"strconv"
"time"
"github.com/rs/zerolog/log"
"github.com/trustero/api/go/receptor_sdk"
"github.com/trustero/api/go/receptor_v1"
"google.golang.org/protobuf/types/known/timestamppb"
)
func report(rc receptor_v1.ReceptorClient, credentials interface{}) (err error) {
// Report discovered evidence to Trustero
var finding receptor_v1.Finding
// Discover service entities
if finding.Entities, err = receptorImpl.Discover(credentials); err != nil {
return
}
// Discover evidence
var evidences []*receptor_sdk.Evidence
if evidences, err = receptorImpl.Report(credentials); err != nil {
return
}
finding.ReceptorType = GetParsedReceptorType()
finding.ServiceProviderAccount = serviceProviderAccount
// Convert and append discovered evidences to reported evidences
for _, evidence := range evidences {
reportStruct := receptor_v1.Struct{
Rows: []*receptor_v1.Row{},
ColDisplayNames: map[string]string{},
ColDisplayOrder: []string{},
ColTags: map[string]string{},
}
reportEvidence := receptor_v1.Evidence{
Caption: evidence.Caption,
Description: evidence.Description,
ServiceName: evidence.ServiceName,
EntityType: evidence.EntityType,
Sources: evidence.Sources,
ServiceAccountId: evidence.ServiceAccountId,
EvidenceType: &receptor_v1.Evidence_Struct{Struct: &reportStruct},
}
// Convert rows
var entityIdFieldName string
var rowFieldNames []string
for idx, row := range evidence.Rows {
if idx == 0 {
if entityIdFieldName, rowFieldNames, err = ExtractMetaData(row, &reportStruct); err != nil {
return // fail to extract metadata, likely an invalid row type
}
}
reportStruct.Rows = append(reportStruct.Rows, RowToStructRow(row, entityIdFieldName, rowFieldNames))
}
// Append to Finding
finding.Evidences = append(finding.Evidences, &reportEvidence)
}
// Report evidence findings to Trustero
_, err = rc.Report(context.Background(), &finding)
return
}
// ExtractMetaData Extracts tag information from struct
func ExtractMetaData(row interface{}, reportStruct *receptor_v1.Struct) (entityIdFieldName string, rowFieldNames []string, err error) {
rowFieldNames = []string{}
rowType := reflect.TypeOf(row)
if err = assertStruct(rowType); err != nil {
return
}
fieldOrder := map[int]string{}
fieldOrderKeys := []int{}
for i := 0; i < rowType.NumField(); i++ {
field := rowType.Field(i)
tags := expandFieldTag(field)
rowFieldNames = append(rowFieldNames, field.Name)
// Is it the id field?
if _, ok := tags[idField]; ok {
entityIdFieldName = field.Name
}
// Get the field order
if val, ok := tags[orderField]; ok {
if i, err := strconv.Atoi(val); err == nil {
fieldOrder[i] = field.Name
fieldOrderKeys = append(fieldOrderKeys, i)
}
}
// Get display name
if val, ok := tags[displayField]; ok {
reportStruct.ColDisplayNames[field.Name] = val
} else {
reportStruct.ColDisplayNames[field.Name] = field.Name
}
// Get the check
if val, ok := tags[controlTestField]; ok {
reportStruct.ColTags[val] = field.Name
}
}
// order the display columns
sort.Ints(fieldOrderKeys)
for _, key := range fieldOrderKeys {
reportStruct.ColDisplayOrder = append(reportStruct.ColDisplayOrder, fieldOrder[key])
}
return
}
// RowToStructRow Builds structured row of evidence
func RowToStructRow(row interface{}, entityIdFieldName string, rowFieldNames []string) (reportRow *receptor_v1.Row) {
reportRow = &receptor_v1.Row{
EntityInstanceId: getField(row, entityIdFieldName),
Cols: map[string]*receptor_v1.Value{},
}
rowValue := reflect.Indirect(reflect.ValueOf(row))
for _, fieldName := range rowFieldNames {
v := rowValue.FieldByName(fieldName)
if dateTime, ok := v.Interface().(time.Time); ok {
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_TimestampValue{
TimestampValue: timestamppb.New(dateTime),
},
}
continue
}
dateTime, ok := v.Interface().(*time.Time)
if ok {
reportRow.Cols[fieldName] = &receptor_v1.Value{}
if dateTime != nil {
reportRow.Cols[fieldName].ValueType = &receptor_v1.Value_TimestampValue{
TimestampValue: timestamppb.New(*dateTime),
}
}
continue
}
switch v.Kind() {
case reflect.Bool:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_BoolValue{
BoolValue: v.Bool(),
},
}
break
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_Int32Value{
Int32Value: int32(v.Int()),
},
}
break
case reflect.Int64:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_Int64Value{
Int64Value: v.Int(),
},
}
break
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_Uint32Value{
Uint32Value: uint32(v.Uint()),
},
}
break
case reflect.Uint64:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_Uint64Value{
Uint64Value: v.Uint(),
},
}
break
case reflect.Float32, reflect.Float64:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_DoubleValue{
DoubleValue: v.Float(),
},
}
break
case reflect.String:
reportRow.Cols[fieldName] = &receptor_v1.Value{
ValueType: &receptor_v1.Value_StringValue{
StringValue: v.String(),
},
}
break
default:
log.Warn().Msg("unsupported evidence row field (" + fieldName + ") type")
break
}
}
return
}
func getField(v interface{}, field string) string {
r := reflect.ValueOf(v)
f := reflect.Indirect(r).FieldByName(field)
return f.String()
}
func assertStruct(rowType reflect.Type) (err error) {
if rowType.Kind() != reflect.Struct {
err = errors.New("evidence row must be a struct. " + rowType.String())
}
return
}