]>
Commit | Line | Data |
---|---|---|
00b27f33 HL |
1 | /* |
2 | * Copyright 2023 The OpenSSL Project Authors. All Rights Reserved. | |
3 | * | |
4 | * Licensed under the Apache License 2.0 (the "License"). You may not use | |
5 | * this file except in compliance with the License. You can obtain a copy | |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
8 | */ | |
9 | ||
10 | #include "internal/qlog.h" | |
11 | #include "internal/json_enc.h" | |
12 | #include "internal/common.h" | |
13 | #include "internal/cryptlib.h" | |
ba8b093b | 14 | #include "crypto/ctype.h" |
00b27f33 | 15 | |
ba8b093b HL |
16 | #define BITS_PER_WORD (sizeof(size_t) * 8) |
17 | #define NUM_ENABLED_W ((QLOG_EVENT_TYPE_NUM + BITS_PER_WORD - 1) / BITS_PER_WORD) | |
00b27f33 HL |
18 | |
19 | static ossl_unused ossl_inline int bit_get(const size_t *p, uint32_t bit_no) | |
20 | { | |
21 | return p[bit_no / BITS_PER_WORD] & (((size_t)1) << (bit_no % BITS_PER_WORD)); | |
22 | } | |
23 | ||
24 | static ossl_unused ossl_inline void bit_set(size_t *p, uint32_t bit_no, int enable) | |
25 | { | |
26 | size_t mask = (((size_t)1) << (bit_no % BITS_PER_WORD)); | |
27 | ||
28 | if (enable) | |
29 | p[bit_no / BITS_PER_WORD] |= mask; | |
30 | else | |
0e6eb431 | 31 | p[bit_no / BITS_PER_WORD] &= ~mask; |
00b27f33 HL |
32 | } |
33 | ||
00b27f33 HL |
34 | struct qlog_st { |
35 | QLOG_TRACE_INFO info; | |
36 | ||
b3706fd7 HL |
37 | BIO *bio; |
38 | size_t enabled[NUM_ENABLED_W]; | |
39 | uint32_t event_type; | |
40 | const char *event_cat, *event_name, *event_combined_name; | |
41 | OSSL_TIME event_time, prev_event_time; | |
42 | OSSL_JSON_ENC json; | |
43 | int header_done, first_event_done; | |
00b27f33 HL |
44 | }; |
45 | ||
46 | static OSSL_TIME default_now(void *arg) | |
47 | { | |
48 | return ossl_time_now(); | |
49 | } | |
50 | ||
51 | /* | |
52 | * Construction | |
53 | * ============ | |
54 | */ | |
55 | QLOG *ossl_qlog_new(const QLOG_TRACE_INFO *info) | |
56 | { | |
57 | QLOG *qlog = OPENSSL_zalloc(sizeof(QLOG)); | |
58 | ||
59 | if (qlog == NULL) | |
60 | return NULL; | |
61 | ||
6cb0026c HL |
62 | qlog->info.odcid = info->odcid; |
63 | qlog->info.is_server = info->is_server; | |
64 | qlog->info.now_cb = info->now_cb; | |
65 | qlog->info.now_cb_arg = info->now_cb_arg; | |
66 | qlog->info.override_process_id = info->override_process_id; | |
00b27f33 HL |
67 | |
68 | if (info->title != NULL | |
69 | && (qlog->info.title = OPENSSL_strdup(info->title)) == NULL) | |
70 | goto err; | |
71 | ||
72 | if (info->description != NULL | |
73 | && (qlog->info.description = OPENSSL_strdup(info->description)) == NULL) | |
74 | goto err; | |
75 | ||
76 | if (info->group_id != NULL | |
77 | && (qlog->info.group_id = OPENSSL_strdup(info->group_id)) == NULL) | |
78 | goto err; | |
79 | ||
b3706fd7 HL |
80 | if (!ossl_json_init(&qlog->json, NULL, |
81 | OSSL_JSON_FLAG_IJSON | OSSL_JSON_FLAG_SEQ)) | |
00b27f33 HL |
82 | goto err; |
83 | ||
84 | if (qlog->info.now_cb == NULL) | |
85 | qlog->info.now_cb = default_now; | |
86 | ||
87 | return qlog; | |
88 | ||
89 | err: | |
90 | if (qlog != NULL) { | |
91 | OPENSSL_free((char *)qlog->info.title); | |
92 | OPENSSL_free((char *)qlog->info.description); | |
93 | OPENSSL_free((char *)qlog->info.group_id); | |
94 | OPENSSL_free(qlog); | |
95 | } | |
96 | return NULL; | |
97 | } | |
98 | ||
99 | QLOG *ossl_qlog_new_from_env(const QLOG_TRACE_INFO *info) | |
100 | { | |
29bd1e2d | 101 | QLOG *qlog = NULL; |
00b27f33 | 102 | const char *qlogdir = ossl_safe_getenv("QLOGDIR"); |
9dcad797 | 103 | const char *qfilter = ossl_safe_getenv("OSSL_QFILTER"); |
00b27f33 HL |
104 | char qlogdir_sep, *filename = NULL; |
105 | size_t i, l, strl; | |
106 | ||
29bd1e2d | 107 | if (info == NULL || qlogdir == NULL) |
00b27f33 HL |
108 | return NULL; |
109 | ||
110 | l = strlen(qlogdir); | |
29bd1e2d HL |
111 | if (l == 0) |
112 | return NULL; | |
113 | ||
00b27f33 HL |
114 | qlogdir_sep = ossl_determine_dirsep(qlogdir); |
115 | ||
ba8b093b HL |
116 | /* dir; [sep]; ODCID; _; strlen("client" / "server"); strlen(".sqlog"); NUL */ |
117 | strl = l + 1 + info->odcid.id_len * 2 + 1 + 6 + 6 + 1; | |
118 | filename = OPENSSL_malloc(strl); | |
00b27f33 HL |
119 | if (filename == NULL) |
120 | return NULL; | |
121 | ||
122 | memcpy(filename, qlogdir, l); | |
123 | if (qlogdir_sep != '\0') | |
124 | filename[l++] = qlogdir_sep; | |
125 | ||
126 | for (i = 0; i < info->odcid.id_len; ++i) | |
127 | l += sprintf(filename + l, "%02x", info->odcid.id[i]); | |
128 | ||
29bd1e2d | 129 | l += snprintf(filename + l, strl - l, "_%s.sqlog", |
00b27f33 HL |
130 | info->is_server ? "server" : "client"); |
131 | ||
132 | qlog = ossl_qlog_new(info); | |
29bd1e2d HL |
133 | if (qlog == NULL) |
134 | goto err; | |
00b27f33 | 135 | |
29bd1e2d HL |
136 | if (!ossl_qlog_set_sink_filename(qlog, filename)) |
137 | goto err; | |
00b27f33 | 138 | |
a7066585 | 139 | if (qfilter == NULL || qfilter[0] == '\0') |
9dcad797 HL |
140 | qfilter = "*"; |
141 | ||
142 | if (!ossl_qlog_set_filter(qlog, qfilter)) | |
29bd1e2d | 143 | goto err; |
00b27f33 HL |
144 | |
145 | OPENSSL_free(filename); | |
146 | return qlog; | |
29bd1e2d HL |
147 | |
148 | err: | |
149 | OPENSSL_free(filename); | |
150 | ossl_qlog_free(qlog); | |
151 | return NULL; | |
00b27f33 HL |
152 | } |
153 | ||
154 | void ossl_qlog_free(QLOG *qlog) | |
155 | { | |
156 | if (qlog == NULL) | |
157 | return; | |
158 | ||
3c067dcb | 159 | ossl_json_flush(&qlog->json); |
00b27f33 HL |
160 | ossl_json_cleanup(&qlog->json); |
161 | BIO_free_all(qlog->bio); | |
162 | OPENSSL_free((char *)qlog->info.title); | |
163 | OPENSSL_free((char *)qlog->info.description); | |
164 | OPENSSL_free((char *)qlog->info.group_id); | |
165 | OPENSSL_free(qlog); | |
166 | } | |
167 | ||
168 | /* | |
169 | * Configuration | |
170 | * ============= | |
171 | */ | |
172 | int ossl_qlog_set_sink_bio(QLOG *qlog, BIO *bio) | |
173 | { | |
174 | if (qlog == NULL) | |
175 | return 0; | |
176 | ||
177 | ossl_qlog_flush(qlog); /* best effort */ | |
178 | BIO_free_all(qlog->bio); | |
179 | qlog->bio = bio; | |
39b93452 | 180 | ossl_json_set0_sink(&qlog->json, bio); |
00b27f33 HL |
181 | return 1; |
182 | } | |
183 | ||
184 | #ifndef OPENSSL_NO_STDIO | |
185 | ||
186 | int ossl_qlog_set_sink_file(QLOG *qlog, FILE *f, int close_flag) | |
187 | { | |
188 | BIO *bio; | |
189 | ||
190 | if (qlog == NULL) | |
191 | return 0; | |
192 | ||
193 | bio = BIO_new_fp(f, BIO_CLOSE); | |
194 | if (bio == NULL) | |
195 | return 0; | |
196 | ||
197 | if (!ossl_qlog_set_sink_bio(qlog, bio)) { | |
198 | BIO_free_all(bio); | |
199 | return 0; | |
200 | } | |
201 | ||
202 | return 1; | |
203 | } | |
204 | ||
205 | #endif | |
206 | ||
207 | int ossl_qlog_set_sink_filename(QLOG *qlog, const char *filename) | |
208 | { | |
209 | BIO *bio; | |
210 | ||
211 | if (qlog == NULL) | |
212 | return 0; | |
213 | ||
214 | /* | |
215 | * We supply our own text encoding as JSON requires UTF-8, so disable any | |
216 | * OS-specific processing here. | |
217 | */ | |
218 | bio = BIO_new_file(filename, "wb"); | |
219 | if (bio == NULL) | |
220 | return 0; | |
221 | ||
222 | if (!ossl_qlog_set_sink_bio(qlog, bio)) { | |
223 | BIO_free_all(bio); | |
224 | return 0; | |
225 | } | |
226 | ||
227 | return 1; | |
228 | } | |
229 | ||
230 | int ossl_qlog_flush(QLOG *qlog) | |
231 | { | |
232 | if (qlog == NULL) | |
233 | return 1; | |
234 | ||
235 | return ossl_json_flush(&qlog->json); | |
236 | } | |
237 | ||
238 | int ossl_qlog_set_event_type_enabled(QLOG *qlog, uint32_t event_type, | |
239 | int enabled) | |
240 | { | |
241 | if (qlog == NULL || event_type >= QLOG_EVENT_TYPE_NUM) | |
242 | return 0; | |
243 | ||
244 | bit_set(qlog->enabled, event_type, enabled); | |
245 | return 1; | |
246 | } | |
247 | ||
248 | int ossl_qlog_enabled(QLOG *qlog, uint32_t event_type) | |
249 | { | |
250 | if (qlog == NULL) | |
251 | return 0; | |
252 | ||
6cb0026c | 253 | return bit_get(qlog->enabled, event_type) != 0; |
00b27f33 HL |
254 | } |
255 | ||
256 | /* | |
257 | * Event Lifecycle | |
258 | * =============== | |
259 | */ | |
260 | static void write_str_once(QLOG *qlog, const char *key, char **p) | |
261 | { | |
262 | if (*p == NULL) | |
263 | return; | |
264 | ||
265 | ossl_json_key(&qlog->json, key); | |
266 | ossl_json_str(&qlog->json, *p); | |
267 | ||
268 | OPENSSL_free(*p); | |
269 | *p = NULL; | |
270 | } | |
271 | ||
272 | static void qlog_event_seq_header(QLOG *qlog) | |
273 | { | |
274 | if (qlog->header_done) | |
275 | return; | |
276 | ||
277 | ossl_json_object_begin(&qlog->json); | |
278 | { | |
279 | ossl_json_key(&qlog->json, "qlog_version"); | |
280 | ossl_json_str(&qlog->json, "0.3"); | |
281 | ||
282 | ossl_json_key(&qlog->json, "qlog_format"); | |
283 | ossl_json_str(&qlog->json, "JSON-SEQ"); | |
284 | ||
285 | write_str_once(qlog, "title", (char **)&qlog->info.title); | |
286 | write_str_once(qlog, "description", (char **)&qlog->info.description); | |
287 | ||
288 | ossl_json_key(&qlog->json, "trace"); | |
289 | ossl_json_object_begin(&qlog->json); | |
290 | { | |
291 | ossl_json_key(&qlog->json, "common_fields"); | |
292 | ossl_json_object_begin(&qlog->json); | |
293 | { | |
294 | ossl_json_key(&qlog->json, "time_format"); | |
295 | ossl_json_str(&qlog->json, "delta"); | |
296 | ||
297 | ossl_json_key(&qlog->json, "protocol_type"); | |
298 | ossl_json_array_begin(&qlog->json); | |
299 | { | |
300 | ossl_json_str(&qlog->json, "QUIC"); | |
29bd1e2d | 301 | } /* protocol_type */ |
00b27f33 HL |
302 | ossl_json_array_end(&qlog->json); |
303 | ||
304 | write_str_once(qlog, "group_id", (char **)&qlog->info.group_id); | |
305 | ||
306 | ossl_json_key(&qlog->json, "system_info"); | |
307 | ossl_json_object_begin(&qlog->json); | |
308 | { | |
6cb0026c HL |
309 | if (qlog->info.override_process_id != 0) { |
310 | ossl_json_key(&qlog->json, "process_id"); | |
311 | ossl_json_u64(&qlog->json, qlog->info.override_process_id); | |
312 | } else { | |
ba8b093b | 313 | #if defined(OPENSSL_SYS_UNIX) || defined(OPENSSL_SYS_WINDOWS) |
6cb0026c HL |
314 | ossl_json_key(&qlog->json, "process_id"); |
315 | ossl_json_u64(&qlog->json, (uint64_t)getpid()); | |
ba8b093b | 316 | #endif |
6cb0026c | 317 | } |
29bd1e2d | 318 | } /* system_info */ |
00b27f33 | 319 | ossl_json_object_end(&qlog->json); |
29bd1e2d | 320 | } /* common_fields */ |
00b27f33 HL |
321 | ossl_json_object_end(&qlog->json); |
322 | ||
323 | ossl_json_key(&qlog->json, "vantage_point"); | |
324 | ossl_json_object_begin(&qlog->json); | |
325 | { | |
326 | ossl_json_key(&qlog->json, "type"); | |
327 | ossl_json_str(&qlog->json, qlog->info.is_server | |
ba8b093b | 328 | ? "server" : "client"); |
29bd1e2d | 329 | } /* vantage_point */ |
00b27f33 | 330 | ossl_json_object_end(&qlog->json); |
29bd1e2d | 331 | } /* trace */ |
00b27f33 HL |
332 | ossl_json_object_end(&qlog->json); |
333 | } | |
334 | ossl_json_object_end(&qlog->json); | |
335 | ||
336 | qlog->header_done = 1; | |
337 | } | |
338 | ||
339 | static void qlog_event_prologue(QLOG *qlog) | |
340 | { | |
341 | qlog_event_seq_header(qlog); | |
342 | ||
343 | ossl_json_object_begin(&qlog->json); | |
344 | ||
345 | ossl_json_key(&qlog->json, "name"); | |
346 | ossl_json_str(&qlog->json, qlog->event_combined_name); | |
347 | ||
348 | ossl_json_key(&qlog->json, "data"); | |
349 | ossl_json_object_begin(&qlog->json); | |
350 | } | |
351 | ||
352 | static void qlog_event_epilogue(QLOG *qlog) | |
353 | { | |
354 | ossl_json_object_end(&qlog->json); | |
355 | ||
356 | ossl_json_key(&qlog->json, "time"); | |
357 | if (!qlog->first_event_done) { | |
358 | ossl_json_u64(&qlog->json, ossl_time2ms(qlog->event_time)); | |
359 | qlog->prev_event_time = qlog->event_time; | |
360 | qlog->first_event_done = 1; | |
361 | } else { | |
362 | OSSL_TIME delta = ossl_time_subtract(qlog->event_time, | |
363 | qlog->prev_event_time); | |
364 | ||
365 | ossl_json_u64(&qlog->json, ossl_time2ms(delta)); | |
366 | qlog->prev_event_time = qlog->event_time; | |
367 | } | |
368 | ||
369 | ossl_json_object_end(&qlog->json); | |
370 | } | |
371 | ||
372 | int ossl_qlog_event_try_begin(QLOG *qlog, | |
373 | uint32_t event_type, | |
374 | const char *event_cat, | |
375 | const char *event_name, | |
376 | const char *event_combined_name) | |
377 | { | |
378 | if (qlog == NULL) | |
379 | return 0; | |
380 | ||
381 | if (!ossl_assert(qlog->event_type == QLOG_EVENT_TYPE_NONE) | |
382 | || !ossl_qlog_enabled(qlog, event_type)) | |
383 | return 0; | |
384 | ||
385 | qlog->event_type = event_type; | |
386 | qlog->event_cat = event_cat; | |
387 | qlog->event_name = event_name; | |
388 | qlog->event_combined_name = event_combined_name; | |
389 | qlog->event_time = qlog->info.now_cb(qlog->info.now_cb_arg); | |
390 | ||
391 | qlog_event_prologue(qlog); | |
392 | return 1; | |
393 | } | |
394 | ||
29bd1e2d | 395 | void ossl_qlog_event_end(QLOG *qlog) |
00b27f33 HL |
396 | { |
397 | if (!ossl_assert(qlog != NULL && qlog->event_type != QLOG_EVENT_TYPE_NONE)) | |
398 | return; | |
399 | ||
400 | qlog_event_epilogue(qlog); | |
401 | qlog->event_type = QLOG_EVENT_TYPE_NONE; | |
402 | } | |
403 | ||
00b27f33 HL |
404 | /* |
405 | * Field Generators | |
406 | * ================ | |
407 | */ | |
408 | void ossl_qlog_group_begin(QLOG *qlog, const char *name) | |
409 | { | |
410 | if (name != NULL) | |
411 | ossl_json_key(&qlog->json, name); | |
412 | ||
413 | ossl_json_object_begin(&qlog->json); | |
414 | } | |
415 | ||
416 | void ossl_qlog_group_end(QLOG *qlog) | |
417 | { | |
418 | ossl_json_object_end(&qlog->json); | |
419 | } | |
420 | ||
421 | void ossl_qlog_array_begin(QLOG *qlog, const char *name) | |
422 | { | |
423 | if (name != NULL) | |
424 | ossl_json_key(&qlog->json, name); | |
425 | ||
426 | ossl_json_array_begin(&qlog->json); | |
427 | } | |
428 | ||
429 | void ossl_qlog_array_end(QLOG *qlog) | |
430 | { | |
431 | ossl_json_array_end(&qlog->json); | |
432 | } | |
433 | ||
434 | void ossl_qlog_override_time(QLOG *qlog, OSSL_TIME event_time) | |
435 | { | |
436 | qlog->event_time = event_time; | |
437 | } | |
438 | ||
439 | void ossl_qlog_str(QLOG *qlog, const char *name, const char *value) | |
440 | { | |
441 | if (name != NULL) | |
442 | ossl_json_key(&qlog->json, name); | |
443 | ||
444 | ossl_json_str(&qlog->json, value); | |
445 | } | |
446 | ||
447 | void ossl_qlog_str_len(QLOG *qlog, const char *name, | |
448 | const char *value, size_t value_len) | |
449 | { | |
450 | if (name != NULL) | |
451 | ossl_json_key(&qlog->json, name); | |
452 | ||
453 | ossl_json_str_len(&qlog->json, value, value_len); | |
454 | } | |
455 | ||
456 | void ossl_qlog_u64(QLOG *qlog, const char *name, uint64_t value) | |
457 | { | |
458 | if (name != NULL) | |
459 | ossl_json_key(&qlog->json, name); | |
460 | ||
461 | ossl_json_u64(&qlog->json, value); | |
462 | } | |
463 | ||
464 | void ossl_qlog_i64(QLOG *qlog, const char *name, int64_t value) | |
465 | { | |
466 | if (name != NULL) | |
467 | ossl_json_key(&qlog->json, name); | |
468 | ||
469 | ossl_json_i64(&qlog->json, value); | |
470 | } | |
471 | ||
472 | void ossl_qlog_bool(QLOG *qlog, const char *name, int value) | |
473 | { | |
474 | if (name != NULL) | |
475 | ossl_json_key(&qlog->json, name); | |
476 | ||
477 | ossl_json_bool(&qlog->json, value); | |
478 | } | |
479 | ||
480 | void ossl_qlog_bin(QLOG *qlog, const char *name, | |
481 | const void *value, size_t value_len) | |
482 | { | |
483 | if (name != NULL) | |
484 | ossl_json_key(&qlog->json, name); | |
485 | ||
486 | ossl_json_str_hex(&qlog->json, value, value_len); | |
487 | } | |
488 | ||
489 | /* | |
490 | * Filter Parsing | |
491 | * ============== | |
492 | */ | |
493 | struct lexer { | |
494 | const char *p, *term_end, *end; | |
495 | }; | |
496 | ||
497 | static ossl_inline int is_term_sep_ws(char c) | |
498 | { | |
499 | return c == ' ' || c == '\r' || c == '\n' || c == '\t'; | |
500 | } | |
501 | ||
502 | static ossl_inline int is_name_char(char c) | |
503 | { | |
ba8b093b | 504 | return ossl_isalpha(c) || ossl_isdigit(c) || c == '_' || c == '-'; |
00b27f33 HL |
505 | } |
506 | ||
507 | static int lex_init(struct lexer *lex, const char *in, size_t in_len) | |
508 | { | |
509 | if (in == NULL) | |
510 | return 0; | |
511 | ||
512 | lex->p = in; | |
513 | lex->term_end = in; | |
514 | lex->end = in + in_len; | |
515 | return 1; | |
516 | } | |
517 | ||
518 | static int lex_do(struct lexer *lex) | |
519 | { | |
520 | const char *p = lex->term_end, *end = lex->end, *term_end; | |
521 | ||
522 | for (; is_term_sep_ws(*p) && p < end; ++p); | |
523 | ||
524 | if (p == end) { | |
525 | lex->p = end; | |
526 | lex->term_end = end; | |
527 | return 0; | |
528 | } | |
529 | ||
530 | for (term_end = p; !is_term_sep_ws(*term_end) && term_end < end; ++term_end); | |
531 | ||
532 | lex->p = p; | |
533 | lex->term_end = term_end; | |
534 | return 1; | |
535 | } | |
536 | ||
537 | static int lex_eot(struct lexer *lex) | |
538 | { | |
539 | return lex->p == lex->term_end; | |
540 | } | |
541 | ||
542 | static int lex_peek_char(struct lexer *lex) | |
543 | { | |
544 | return lex_eot(lex) ? -1 : *lex->p; | |
545 | } | |
546 | ||
547 | static int lex_skip_char(struct lexer *lex) | |
548 | { | |
549 | if (lex_eot(lex)) | |
550 | return 0; | |
551 | ||
552 | ++lex->p; | |
553 | return 1; | |
554 | } | |
555 | ||
556 | static int lex_match(struct lexer *lex, const char *s, size_t s_len) | |
557 | { | |
558 | if ((size_t)(lex->term_end - lex->p) != s_len) | |
559 | return 0; | |
560 | ||
561 | if (memcmp(lex->p, s, s_len)) | |
562 | return 0; | |
563 | ||
564 | return 1; | |
565 | } | |
566 | ||
567 | static void lex_get_rest(struct lexer *lex, const char **str, size_t *str_l) | |
568 | { | |
569 | *str = lex->p; | |
570 | *str_l = lex->term_end - lex->p; | |
571 | } | |
572 | ||
573 | static int lex_extract_to(struct lexer *lex, char c, | |
574 | const char **str, size_t *str_l) | |
575 | { | |
576 | const char *p = lex->p, *term_end = lex->term_end, *s; | |
577 | ||
578 | for (s = p; s < term_end && *s != c; ++s); | |
579 | if (s == term_end) | |
580 | return 0; | |
581 | ||
582 | *str = p; | |
3c067dcb | 583 | *str_l = s - p; |
00b27f33 HL |
584 | lex->p = ++s; |
585 | return 1; | |
586 | } | |
587 | ||
588 | static int ossl_unused filter_match_event(const char *cat, size_t cat_l, | |
589 | const char *event, size_t event_l, | |
590 | const char *expect_cat, | |
591 | const char *expect_event) | |
592 | { | |
593 | size_t expect_cat_l = strlen(expect_cat); | |
594 | size_t expect_event_l = strlen(expect_event); | |
595 | ||
596 | if ((cat != NULL && cat_l != expect_cat_l) | |
597 | || (event != NULL && event_l != expect_event_l) | |
598 | || (cat != NULL && memcmp(cat, expect_cat, expect_cat_l)) | |
599 | || (event != NULL && memcmp(event, expect_event, expect_event_l))) | |
600 | return 0; | |
601 | ||
602 | return 1; | |
603 | } | |
604 | ||
605 | /* | |
606 | * enabled: event enablement bitmask Array of size NUM_ENABLED_W. | |
607 | * add: 1 to enable an event, 0 to disable. | |
608 | * cat: Category name/length. Not necessarily zero terminated. | |
609 | * NULL to match any. | |
610 | * event: Event name/length. Not necessarily zero terminated. | |
611 | * NULL to match any. | |
612 | */ | |
613 | static void filter_apply(size_t *enabled, int add, | |
614 | const char *cat, size_t cat_l, | |
615 | const char *event, size_t event_l) | |
616 | { | |
617 | /* Find events which match the given filters. */ | |
618 | # define QLOG_EVENT(e_cat, e_name) \ | |
619 | if (filter_match_event(cat, cat_l, event, event_l, \ | |
620 | #e_cat, #e_name)) \ | |
621 | bit_set(enabled, QLOG_EVENT_TYPE_##e_cat##_##e_name, add); | |
622 | # include "internal/qlog_events.h" | |
623 | # undef QLOG_EVENT | |
624 | } | |
625 | ||
626 | static int lex_fail(struct lexer *lex, const char *msg) | |
627 | { | |
29bd1e2d | 628 | /* |
ba8b093b HL |
629 | * TODO(QLOG FUTURE): Determine how to print log messages about bad filter |
630 | * strings | |
29bd1e2d | 631 | */ |
00b27f33 HL |
632 | lex->p = lex->term_end = lex->end; |
633 | return 0; | |
634 | } | |
635 | ||
636 | static int validate_name(const char **p, size_t *l) | |
637 | { | |
638 | const char *p_ = *p; | |
639 | size_t i, l_ = *l; | |
640 | ||
641 | if (l_ == 1 && *p_ == '*') { | |
642 | *p = NULL; | |
643 | *l = 0; | |
644 | return 1; | |
645 | } | |
646 | ||
647 | if (l_ == 0) | |
648 | return 0; | |
649 | ||
650 | for (i = 0; i < l_; ++i) | |
651 | if (!is_name_char(p_[i])) | |
652 | return 0; | |
653 | ||
654 | return 1; | |
655 | } | |
656 | ||
657 | int ossl_qlog_set_filter(QLOG *qlog, const char *filter) | |
658 | { | |
659 | struct lexer lex = {0}; | |
660 | char c; | |
661 | const char *cat, *event; | |
662 | size_t cat_l, event_l, enabled[NUM_ENABLED_W]; | |
663 | int add; | |
664 | ||
665 | memcpy(enabled, qlog->enabled, sizeof(enabled)); | |
666 | ||
667 | if (!lex_init(&lex, filter, strlen(filter))) | |
668 | return 0; | |
669 | ||
670 | while (lex_do(&lex)) { | |
671 | c = lex_peek_char(&lex); | |
672 | if (c == '+' || c == '-') { | |
673 | add = (c == '+'); | |
674 | lex_skip_char(&lex); | |
675 | ||
676 | c = lex_peek_char(&lex); | |
677 | if (!is_name_char(c) && c != '*') | |
678 | return lex_fail(&lex, "expected alphanumeric name or '*'" | |
679 | " after +/-"); | |
680 | } else if (!is_name_char(c) && c != '*') { | |
681 | return lex_fail(&lex, "expected +/- or alphanumeric name or '*'"); | |
682 | } else { | |
683 | add = 1; | |
684 | } | |
685 | ||
686 | if (lex_match(&lex, "*", 1)) { | |
687 | filter_apply(enabled, add, NULL, 0, NULL, 0); | |
688 | continue; | |
689 | } | |
690 | ||
691 | if (!lex_extract_to(&lex, ':', &cat, &cat_l)) | |
692 | return lex_fail(&lex, "expected ':' after category name"); | |
693 | ||
694 | lex_get_rest(&lex, &event, &event_l); | |
695 | if (!validate_name(&cat, &cat_l)) | |
696 | return lex_fail(&lex, "expected alphanumeric category name or '*'"); | |
697 | if (!validate_name(&event, &event_l)) | |
698 | return lex_fail(&lex, "expected alphanumeric event name or '*'"); | |
699 | ||
700 | filter_apply(enabled, add, cat, cat_l, event, event_l); | |
701 | } | |
702 | ||
703 | memcpy(qlog->enabled, enabled, sizeof(enabled)); | |
704 | return 1; | |
705 | } |