/
eventsdbmodule.go
193 lines (170 loc) · 6.7 KB
/
eventsdbmodule.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
package keycloakb
import (
"context"
"errors"
"regexp"
"strings"
errorhandler "github.com/cloudtrust/common-service/errors"
"github.com/cloudtrust/common-service/database"
api "github.com/cloudtrust/keycloak-bridge/api/events"
)
// EventsDBModule is the interface of the audit events module.
type EventsDBModule interface {
GetEventsCount(context.Context, map[string]string) (int, error)
GetEvents(context.Context, map[string]string) ([]api.AuditRepresentation, error)
GetEventsSummary(context.Context) (api.EventSummaryRepresentation, error)
GetLastConnection(context.Context, string) (int64, error)
GetTotalConnectionsCount(context.Context, string, string) (int64, error)
}
type eventsDBModule struct {
db database.CloudtrustDB
}
// NewEventsDBModule returns an events database module.
func NewEventsDBModule(db database.CloudtrustDB) EventsDBModule {
return &eventsDBModule{
db: db,
}
}
type selectAuditEventsParameters struct {
origin interface{}
realm interface{}
userID interface{}
ctEventType interface{}
dateFrom interface{}
dateTo interface{}
first interface{}
max interface{}
exclude interface{}
}
const (
whereAuditEvents = `
WHERE origin = IFNULL(?, origin)
AND realm_name = IFNULL(?, realm_name)
AND user_id = IFNULL(?, user_id)
AND ct_event_type = IFNULL(?, ct_event_type)
AND unix_timestamp(audit_time) between IFNULL(?, unix_timestamp(audit_time)) and IFNULL(?, unix_timestamp(audit_time))
AND ct_event_type <> IFNULL(?, 'not-a-ct-event-type')
`
selectAuditEventsStmt = `SELECT audit_id, unix_timestamp(audit_time), origin, realm_name, agent_user_id, agent_username, agent_realm_name,
user_id, username, ct_event_type, kc_event_type, kc_operation_type, client_id, additional_info
FROM audit ` + whereAuditEvents + `
ORDER BY audit_time DESC
LIMIT ?, ?;
`
selectCountAuditEventsStmt = `SELECT count(1) FROM audit ` + whereAuditEvents
selectLastConnectionTimeStmt = `SELECT ifnull(unix_timestamp(max(audit_time)), 0) FROM audit WHERE realm_name=? AND ct_event_type='LOGON_OK'`
selectConnectionsCount = `SELECT count(1) FROM audit WHERE realm_name=? AND ct_event_type='LOGON_OK' AND date_add(audit_time, INTERVAL ##INTERVAL##)>now()`
selectAuditSummaryRealmStmt = `SELECT distinct realm_name FROM audit;`
selectAuditSummaryOriginStmt = `SELECT distinct origin FROM audit;`
selectAuditSummaryCtEventTypeStmt = `SELECT distinct ct_event_type FROM audit;`
)
func createAuditEventsParametersFromMap(m map[string]string) (selectAuditEventsParameters, error) {
res := selectAuditEventsParameters{
origin: getSQLParam(m, "origin", nil),
realm: getSQLParam(m, "realm", nil),
userID: getSQLParam(m, "userID", nil),
ctEventType: getSQLParam(m, "ctEventType", nil),
dateFrom: getSQLParam(m, "dateFrom", nil),
dateTo: getSQLParam(m, "dateTo", nil),
first: getSQLParam(m, "first", 0),
max: getSQLParam(m, "max", 500),
exclude: getSQLParam(m, "exclude", nil),
}
if res.exclude != nil && strings.Contains(res.exclude.(string), ",") {
// Multiple values are not supported yet
return res, errorhandler.CreateInvalidQueryParameterError(Exclude)
}
return res, nil
}
// GetEvents gets the count of events matching some criterias (dateFrom, dateTo, realm, ...)
func (cm *eventsDBModule) GetEventsCount(_ context.Context, m map[string]string) (int, error) {
params, err := createAuditEventsParametersFromMap(m)
if err != nil {
return 0, err
}
var count int
row := cm.db.QueryRow(selectCountAuditEventsStmt, params.origin, params.realm, params.userID, params.ctEventType, params.dateFrom, params.dateTo, params.exclude)
err = row.Scan(&count)
if err != nil {
return 0, err
}
return count, nil
}
// GetEvents gets the events matching some criterias (dateFrom, dateTo, realm, ...)
func (cm *eventsDBModule) GetEvents(_ context.Context, m map[string]string) ([]api.AuditRepresentation, error) {
var res = []api.AuditRepresentation{}
params, errParams := createAuditEventsParametersFromMap(m)
if errParams != nil {
return nil, errParams
}
rows, err := cm.db.Query(selectAuditEventsStmt, params.origin, params.realm, params.userID, params.ctEventType, params.dateFrom, params.dateTo, params.exclude, params.first, params.max)
if err != nil {
return res, err
}
defer rows.Close()
for rows.Next() {
var dba api.DbAuditRepresentation
err = rows.Scan(&dba.AuditID, &dba.AuditTime, &dba.Origin, &dba.RealmName, &dba.AgentUserID, &dba.AgentUsername, &dba.AgentRealmName,
&dba.UserID, &dba.Username, &dba.CtEventType, &dba.KcEventType, &dba.KcOperationType, &dba.ClientID, &dba.AdditionalInfo)
if err != nil {
return res, err
}
res = append(res, dba.ToAuditRepresentation())
}
// Return an error from rows if any error was encountered by Rows.Scan
return res, rows.Err()
}
// GetEventsSummary gets all available values for Origins, Realms and CtEventTypes
func (cm *eventsDBModule) GetEventsSummary(_ context.Context) (api.EventSummaryRepresentation, error) {
var res api.EventSummaryRepresentation
var err error
// Get realms
res.Realms, err = cm.queryStringArray(selectAuditSummaryRealmStmt)
if err == nil {
// Get origins
res.Origins, err = cm.queryStringArray(selectAuditSummaryOriginStmt)
}
if err == nil {
// Get ct_event_types
res.CtEventTypes, err = cm.queryStringArray(selectAuditSummaryCtEventTypeStmt)
}
return res, err
}
// GetLastConnection gets the time of last connection for the given realm
func (cm *eventsDBModule) GetLastConnection(_ context.Context, realmName string) (int64, error) {
var res = int64(0)
var row = cm.db.QueryRow(selectLastConnectionTimeStmt, realmName)
var err = row.Scan(&res)
return res, err
}
// GetTotalConnectionsCount gets the number of connection for the given realm during the specified duration
func (cm *eventsDBModule) GetTotalConnectionsCount(_ context.Context, realmName string, durationLabel string) (int64, error) {
var matched, err = regexp.MatchString(`^\d+ [A-Za-z]+$`, durationLabel)
if !matched || err != nil {
return 0, errors.New(MsgErrInvalidParam + "." + DurationLabel)
}
var res = int64(0)
var row = cm.db.QueryRow(strings.ReplaceAll(selectConnectionsCount, "##INTERVAL##", durationLabel), realmName)
err = row.Scan(&res)
return res, err
}
func getSQLParam(m map[string]string, name string, defaultValue interface{}) interface{} {
if value, ok := m[name]; ok {
return value
}
return defaultValue
}
func (cm *eventsDBModule) queryStringArray(request string) ([]string, error) {
var res []string
rows, err := cm.db.Query(request)
if err != nil {
return res, err
}
defer rows.Close()
for rows.Next() {
var value string
rows.Scan(&value)
res = append(res, value)
}
return res, nil
}