forked from couchbase/kv_engine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mcaudit.cc
365 lines (322 loc) · 12.3 KB
/
mcaudit.cc
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
/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
* Copyright 2017 Couchbase, 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.
*/
#include "config.h"
#include "mcaudit.h"
#include "buckets.h"
#include "connection.h"
#include "debug_helpers.h"
#include "log_macros.h"
#include "logger/logger.h"
#include "memcached.h"
#include "memcached_audit_events.h"
#include "runtime.h"
#include "settings.h"
#include <cJSON.h>
#include <logger/logger.h>
#include <memcached/audit_interface.h>
#include <memcached/isotime.h>
static cb::audit::UniqueAuditPtr auditHandle;
static std::atomic_bool audit_enabled{false};
static const int First = MEMCACHED_AUDIT_OPENED_DCP_CONNECTION;
static const int Last = MEMCACHED_AUDIT_SELECT_BUCKET;
static std::array<std::atomic_bool, Last - First + 1> events;
static bool isEnabled(uint32_t id) {
if (!audit_enabled.load(std::memory_order_consume)) {
// Global switch is off.. All events are disabled
return false;
}
if (id >= First && id <= Last) {
// This is one of ours
return events[id - First].load(std::memory_order_consume);
}
// we don't have information about this id... let the underlying event
// framework deal with it
return true;
}
void setEnabled(uint32_t id, bool enable) {
bool expected = !enable;
if (id == 0) {
if (audit_enabled.compare_exchange_strong(expected, enable)) {
LOG_INFO("Audit changed from: {} to: {}",
!enable ? "enabled" : "disabled",
enable ? "enabled" : "disabled");
}
}
if (id >= First && id <= Last) {
if (events[id - First].compare_exchange_strong(expected, enable)) {
LOG_INFO("Audit descriptor {} changed from: {} to: {}",
id,
expected ? "enabled" : "disabled",
enable ? "enabled" : "disabled");
}
}
}
/**
* Create the typical memcached audit object. It constists of a
* timestamp, the socket endpoints and the creds. Then each audit event
* may add event-specific content.
*
* @param c the connection object
* @return the cJSON object containing the basic information
*/
static unique_cJSON_ptr create_memcached_audit_object(const Connection* c) {
cJSON *root = cJSON_CreateObject();
std::string timestamp = ISOTime::generatetimestamp();
cJSON_AddStringToObject(root, "timestamp", timestamp.c_str());
cJSON_AddStringToObject(root, "peername", c->getPeername().c_str());
cJSON_AddStringToObject(root, "sockname", c->getSockname().c_str());
cJSON *domain = cJSON_CreateObject();
cJSON_AddStringToObject(domain, "domain", "memcached");
cJSON_AddStringToObject(domain, "user", c->getUsername());
cJSON_AddItemToObject(root, "real_userid", domain);
return unique_cJSON_ptr(root);
}
/**
* Convert the JSON object to text and send it to the audit framework
*
* @param c the connection object requesting the call
* @param id the audit identifier
* @param event the payload of the audit description
* @param warn what to log if we're failing to put the audit event
*/
static void do_audit(const Connection* c,
uint32_t id,
unique_cJSON_ptr& event,
const char* warn) {
auto text = to_string(event, false);
if (!auditHandle->put_event(id, text)) {
LOG_WARNING("{}: {}", warn, text);
}
}
void audit_auth_failure(const Connection* c, const char* reason) {
if (!isEnabled(MEMCACHED_AUDIT_AUTHENTICATION_FAILED)) {
return;
}
auto root = create_memcached_audit_object(c);
cJSON_AddStringToObject(root.get(), "reason", reason);
do_audit(c, MEMCACHED_AUDIT_AUTHENTICATION_FAILED, root,
"Failed to send AUTH FAILED audit event");
}
void audit_auth_success(const Connection* c) {
if (!isEnabled(MEMCACHED_AUDIT_AUTHENTICATION_SUCCEEDED)) {
return;
}
auto root = create_memcached_audit_object(c);
do_audit(c, MEMCACHED_AUDIT_AUTHENTICATION_SUCCEEDED, root,
"Failed to send AUTH SUCCESS audit event");
}
void audit_bucket_selection(const Connection& c) {
if (!isEnabled(MEMCACHED_AUDIT_SELECT_BUCKET)) {
return;
}
const auto& bucket = c.getBucket();
// Don't audit that we're jumping into the "no bucket"
if (bucket.type != BucketType::NoBucket) {
auto root = create_memcached_audit_object(&c);
cJSON_AddStringToObject(root.get(), "bucket", c.getBucket().name);
do_audit(&c,
MEMCACHED_AUDIT_SELECT_BUCKET,
root,
"Failed to send SELECT BUCKET audit event");
}
}
void audit_bucket_flush(const Connection* c, const char* bucket) {
if (!isEnabled(MEMCACHED_AUDIT_EXTERNAL_MEMCACHED_BUCKET_FLUSH)) {
return;
}
auto root = create_memcached_audit_object(c);
cJSON_AddStringToObject(root.get(), "bucket", bucket);
do_audit(c, MEMCACHED_AUDIT_EXTERNAL_MEMCACHED_BUCKET_FLUSH, root,
"Failed to send EXTERNAL_MEMCACHED_BUCKET_FLUSH audit event");
}
void audit_dcp_open(const Connection* c) {
if (!isEnabled(MEMCACHED_AUDIT_OPENED_DCP_CONNECTION)) {
return;
}
if (c->isInternal()) {
LOG_INFO("Open DCP stream with admin credentials");
} else {
auto root = create_memcached_audit_object(c);
cJSON_AddStringToObject(root.get(), "bucket", getBucketName(c));
do_audit(c, MEMCACHED_AUDIT_OPENED_DCP_CONNECTION, root,
"Failed to send DCP open connection "
"audit event to audit daemon");
}
}
void audit_set_privilege_debug_mode(const Connection* c, bool enable) {
if (!isEnabled(MEMCACHED_AUDIT_PRIVILEGE_DEBUG_CONFIGURED)) {
return;
}
auto root = create_memcached_audit_object(c);
cJSON_AddBoolToObject(root.get(), "enable", enable);
do_audit(c, MEMCACHED_AUDIT_PRIVILEGE_DEBUG_CONFIGURED, root,
"Failed to send modifications in privilege debug state "
"audit event to audit daemon");
}
void audit_privilege_debug(const Connection* c,
const std::string& command,
const std::string& bucket,
const std::string& privilege,
const std::string& context) {
if (!isEnabled(MEMCACHED_AUDIT_PRIVILEGE_DEBUG)) {
return;
}
auto root = create_memcached_audit_object(c);
cJSON_AddStringToObject(root.get(), "command", command.c_str());
cJSON_AddStringToObject(root.get(), "bucket", bucket.c_str());
cJSON_AddStringToObject(root.get(), "privilege", privilege.c_str());
cJSON_AddStringToObject(root.get(), "context", context.c_str());
do_audit(c, MEMCACHED_AUDIT_PRIVILEGE_DEBUG, root,
"Failed to send privilege debug audit event to audit daemon");
}
void audit_command_access_failed(const Cookie& cookie) {
if (!isEnabled(MEMCACHED_AUDIT_COMMAND_ACCESS_FAILURE)) {
return;
}
const auto& connection = cookie.getConnection();
auto root = create_memcached_audit_object(&connection);
char buffer[256];
memset(buffer, 0, sizeof(buffer));
const auto packet = cookie.getPacket();
// Deliberately ignore failure of bytes_to_output_string
// We'll either have a partial string or no string.
bytes_to_output_string(buffer,
sizeof(buffer),
connection.getId(),
true,
"Access to command is not allowed:",
reinterpret_cast<const char*>(packet.data()),
packet.size());
cJSON_AddStringToObject(root.get(), "packet", buffer);
do_audit(&connection, MEMCACHED_AUDIT_COMMAND_ACCESS_FAILURE, root, buffer);
}
void audit_invalid_packet(const Cookie& cookie) {
if (!isEnabled(MEMCACHED_AUDIT_INVALID_PACKET)) {
return;
}
const auto& connection = cookie.getConnection();
auto root = create_memcached_audit_object(&connection);
char buffer[256];
memset(buffer, 0, sizeof(buffer));
const auto packet = cookie.getPacket();
// Deliberately ignore failure of bytes_to_output_string
// We'll either have a partial string or no string.
bytes_to_output_string(buffer,
sizeof(buffer),
connection.getId(),
true,
"Invalid Packet:",
reinterpret_cast<const char*>(packet.data()),
packet.size());
cJSON_AddStringToObject(root.get(), "packet", buffer);
do_audit(&connection, MEMCACHED_AUDIT_INVALID_PACKET, root, buffer);
}
bool mc_audit_event(uint32_t audit_eventid, cb::const_byte_buffer payload) {
if (!audit_enabled) {
return true;
}
cb::const_char_buffer buffer{reinterpret_cast<const char*>(payload.data()),
payload.size()};
return auditHandle->put_event(audit_eventid, buffer);
}
namespace cb {
namespace audit {
namespace document {
void add(const Cookie& cookie, Operation operation) {
uint32_t id = 0;
switch (operation) {
case Operation::Read:
id = MEMCACHED_AUDIT_DOCUMENT_READ;
break;
case Operation::Lock:
id = MEMCACHED_AUDIT_DOCUMENT_LOCKED;
break;
case Operation::Modify:
id = MEMCACHED_AUDIT_DOCUMENT_MODIFY;
break;
case Operation::Delete:
id = MEMCACHED_AUDIT_DOCUMENT_DELETE;
break;
}
if (id == 0) {
throw std::invalid_argument(
"cb::audit::document::add: Invalid operation");
}
if (!isEnabled(id)) {
return;
}
const auto& connection = cookie.getConnection();
auto root = create_memcached_audit_object(&connection);
cJSON_AddStringToObject(root.get(), "bucket", connection.getBucket().name);
cJSON_AddStringToObject(
root.get(), "key", cookie.getPrintableRequestKey().c_str());
switch (operation) {
case Operation::Read:
do_audit(&connection,
MEMCACHED_AUDIT_DOCUMENT_READ,
root,
"Failed to send document read audit event to audit daemon");
break;
case Operation::Lock:
do_audit(&connection,
MEMCACHED_AUDIT_DOCUMENT_LOCKED,
root,
"Failed to send document locked audit event to audit daemon");
break;
case Operation::Modify:
do_audit(&connection,
MEMCACHED_AUDIT_DOCUMENT_MODIFY,
root,
"Failed to send document modify audit event to audit daemon");
break;
case Operation::Delete:
do_audit(&connection,
MEMCACHED_AUDIT_DOCUMENT_DELETE,
root,
"Failed to send document delete audit event to audit daemon");
break;
}
}
} // namespace documnent
} // namespace audit
} // namespace cb
static void event_state_listener(uint32_t id, bool enabled) {
setEnabled(id, enabled);
}
void initialize_audit() {
/* Start the audit daemon */
auditHandle = cb::audit::create_audit_daemon(settings.getAuditFile(),
get_server_api()->cookie);
if (!auditHandle) {
FATAL_ERROR(EXIT_FAILURE, "FATAL: Failed to start audit daemon");
}
auditHandle->add_event_state_listener(event_state_listener);
auditHandle->notify_all_event_states();
}
void shutdown_audit() {
auditHandle.reset();
}
ENGINE_ERROR_CODE reconfigure_audit(Cookie& cookie) {
if (auditHandle->configure_auditdaemon(settings.getAuditFile(),
static_cast<void*>(&cookie))) {
return ENGINE_EWOULDBLOCK;
}
return ENGINE_FAILED;
}
void stats_audit(ADD_STAT add_stats, Cookie& cookie) {
auditHandle->stats(add_stats, &cookie);
}