quic_qlog_test.c 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. /*
  2. * Copyright 2024 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. #include "internal/qlog.h"
  10. #include "testutil.h"
  11. /*
  12. * Unfortunately, this must be expressed as an array and not a string literal as
  13. * ANSI C only guarantees support for up to 509 characters in a string literal.
  14. */
  15. static const char expected[] = {
  16. 30, '{', '"', 'q', 'l', 'o', 'g', '_', 'v', 'e', 'r', 's', 'i', 'o', 'n',
  17. '"', ':', '"', '0', '.', '3', '"', ',', '"', 'q', 'l', 'o', 'g', '_', 'f',
  18. 'o', 'r', 'm', 'a', 't', '"', ':', '"', 'J', 'S', 'O', 'N', '-', 'S', 'E',
  19. 'Q', '"', ',', '"', 't', 'i', 't', 'l', 'e', '"', ':', '"', 't', 'e', 's',
  20. 't', ' ', 't', 'i', 't', 'l', 'e', '"', ',', '"', 'd', 'e', 's', 'c', 'r',
  21. 'i', 'p', 't', 'i', 'o', 'n', '"', ':', '"', 't', 'e', 's', 't', ' ', 'd',
  22. 'e', 's', 'c', 'r', 'i', 'p', 't', 'i', 'o', 'n', '"', ',', '"', 't', 'r',
  23. 'a', 'c', 'e', '"', ':', '{', '"', 'c', 'o', 'm', 'm', 'o', 'n', '_', 'f',
  24. 'i', 'e', 'l', 'd', 's', '"', ':', '{', '"', 't', 'i', 'm', 'e', '_', 'f',
  25. 'o', 'r', 'm', 'a', 't', '"', ':', '"', 'd', 'e', 'l', 't', 'a', '"', ',',
  26. '"', 'p', 'r', 'o', 't', 'o', 'c', 'o', 'l', '_', 't', 'y', 'p', 'e', '"',
  27. ':', '[', '"', 'Q', 'U', 'I', 'C', '"', ']', ',', '"', 'g', 'r', 'o', 'u',
  28. 'p', '_', 'i', 'd', '"', ':', '"', 't', 'e', 's', 't', ' ', 'g', 'r', 'o',
  29. 'u', 'p', ' ', 'I', 'D', '"', ',', '"', 's', 'y', 's', 't', 'e', 'm', '_',
  30. 'i', 'n', 'f', 'o', '"', ':', '{', '"', 'p', 'r', 'o', 'c', 'e', 's', 's',
  31. '_', 'i', 'd', '"', ':', '1', '2', '3', '}', '}', ',', '"', 'v', 'a', 'n',
  32. 't', 'a', 'g', 'e', '_', 'p', 'o', 'i', 'n', 't', '"', ':', '{', '"', 't',
  33. 'y', 'p', 'e', '"', ':', '"', 'c', 'l', 'i', 'e', 'n', 't', '"', ',', '"',
  34. 'n', 'a', 'm', 'e', '"', ':', '"', 'O', 'p', 'e', 'n', 'S', 'S', 'L', '/',
  35. 'x', '.', 'y', '.', 'z', '"', '}', '}', '}', 10, 30, '{', '"', 'n', 'a',
  36. 'm', 'e', '"', ':', '"', 't', 'r', 'a', 'n', 's', 'p', 'o', 'r', 't', ':',
  37. 'p', 'a', 'c', 'k', 'e', 't', '_', 's', 'e', 'n', 't', '"', ',', '"', 'd',
  38. 'a', 't', 'a', '"', ':', '{', '"', 'f', 'i', 'e', 'l', 'd', '1', '"', ':',
  39. '"', 'f', 'o', 'o', '"', ',', '"', 'f', 'i', 'e', 'l', 'd', '2', '"', ':',
  40. '"', 'b', 'a', 'r', '"', ',', '"', 'f', 'i', 'e', 'l', 'd', '3', '"', ':',
  41. '4', '2', ',', '"', 'f', 'i', 'e', 'l', 'd', '4', '"', ':', '"', '1', '1',
  42. '5', '2', '9', '2', '1', '5', '0', '4', '6', '0', '6', '8', '4', '6', '9',
  43. '7', '6', '"', ',', '"', 'f', 'i', 'e', 'l', 'd', '5', '"', ':', '"', '1',
  44. '8', '4', '4', '6', '7', '4', '4', '0', '7', '3', '7', '0', '9', '5', '5',
  45. '1', '6', '1', '5', '"', ',', '"', 'f', 'i', 'e', 'l', 'd', '6', '"', ':',
  46. 'f', 'a', 'l', 's', 'e', ',', '"', 'f', 'i', 'e', 'l', 'd', '7', '"', ':',
  47. 't', 'r', 'u', 'e', ',', '"', 'f', 'i', 'e', 'l', 'd', '8', '"', ':', '"',
  48. '0', '1', 'a', 'f', '"', ',', '"', 'f', 'i', 'e', 'l', 'd', '9', '"', ':',
  49. '"', '5', '5', '"', ',', '"', 's', 'u', 'b', 'g', 'r', 'o', 'u', 'p', '"',
  50. ':', '{', '"', 'f', 'i', 'e', 'l', 'd', '1', '0', '"', ':', '"', 'b', 'a',
  51. 'z', '"', '}', ',', '"', 'a', 'r', 'r', 'a', 'y', '"', ':', '[', '"', 'a',
  52. '"', ',', '"', 'b', '"', ']', '}', ',', '"', 't', 'i', 'm', 'e', '"', ':',
  53. '1', '7', '0', '6', '5', '3', '1', '1', '7', '0', '0', '0', '}', 10, 30,
  54. '{', '"', 'n', 'a', 'm', 'e', '"', ':', '"', 't', 'r', 'a', 'n', 's', 'p',
  55. 'o', 'r', 't', ':', 'p', 'a', 'c', 'k', 'e', 't', '_', 's', 'e', 'n', 't',
  56. '"', ',', '"', 'd', 'a', 't', 'a', '"', ':', '{', '"', 'f', 'i', 'e', 'l',
  57. 'd', '1', '"', ':', '"', 'b', 'a', 'r', '"', '}', ',', '"', 't', 'i', 'm',
  58. 'e', '"', ':', '1', '0', '0', '0', '}', 10
  59. };
  60. static const unsigned char bin_buf[] = {
  61. 0x01, 0xaf
  62. };
  63. static OSSL_TIME last_time;
  64. static OSSL_TIME now(void *arg)
  65. {
  66. OSSL_TIME t = last_time;
  67. last_time = ossl_time_add(t, ossl_ms2time(1000));
  68. return t;
  69. }
  70. static int test_qlog(void)
  71. {
  72. int testresult = 0;
  73. QLOG_TRACE_INFO qti = {0};
  74. QLOG *qlog;
  75. BIO *bio;
  76. char *buf = NULL;
  77. size_t buf_len = 0;
  78. last_time = ossl_time_from_time_t(170653117);
  79. qti.odcid.id_len = 1;
  80. qti.odcid.id[0] = 0x55;
  81. qti.title = "test title";
  82. qti.description = "test description";
  83. qti.group_id = "test group ID";
  84. qti.override_process_id = 123;
  85. qti.now_cb = now;
  86. qti.override_impl_name = "OpenSSL/x.y.z";
  87. if (!TEST_ptr(qlog = ossl_qlog_new(&qti)))
  88. goto err;
  89. if (!TEST_true(ossl_qlog_set_event_type_enabled(qlog, QLOG_EVENT_TYPE_transport_packet_sent, 1)))
  90. goto err;
  91. if (!TEST_ptr(bio = BIO_new(BIO_s_mem())))
  92. goto err;
  93. if (!TEST_true(ossl_qlog_set_sink_bio(qlog, bio)))
  94. goto err;
  95. QLOG_EVENT_BEGIN(qlog, transport, packet_sent)
  96. QLOG_STR("field1", "foo");
  97. QLOG_STR_LEN("field2", "bar", 3);
  98. QLOG_I64("field3", 42);
  99. QLOG_I64("field4", 1ULL << 60);
  100. QLOG_U64("field5", UINT64_MAX);
  101. QLOG_BOOL("field6", 0);
  102. QLOG_BOOL("field7", 1);
  103. QLOG_BIN("field8", bin_buf, sizeof(bin_buf));
  104. QLOG_CID("field9", &qti.odcid);
  105. QLOG_BEGIN("subgroup")
  106. QLOG_STR("field10", "baz");
  107. QLOG_END()
  108. QLOG_BEGIN_ARRAY("array")
  109. QLOG_STR(NULL, "a");
  110. QLOG_STR(NULL, "b");
  111. QLOG_END_ARRAY()
  112. QLOG_EVENT_END()
  113. /* not enabled */
  114. QLOG_EVENT_BEGIN(qlog, transport, packet_received)
  115. QLOG_STR("field1", "foo");
  116. QLOG_EVENT_END()
  117. /* test delta time calculation */
  118. QLOG_EVENT_BEGIN(qlog, transport, packet_sent)
  119. QLOG_STR("field1", "bar");
  120. QLOG_EVENT_END()
  121. if (!TEST_true(ossl_qlog_flush(qlog)))
  122. goto err;
  123. buf_len = BIO_get_mem_data(bio, &buf);
  124. if (!TEST_size_t_gt(buf_len, 0))
  125. goto err;
  126. if (!TEST_mem_eq(buf, buf_len, expected, sizeof(expected)))
  127. goto err;
  128. testresult = 1;
  129. err:
  130. ossl_qlog_free(qlog);
  131. return testresult;
  132. }
  133. struct filter_spec {
  134. const char *filter;
  135. int expect_ok;
  136. uint32_t expect_event_type;
  137. int expect_event_enable;
  138. };
  139. static const struct filter_spec filters[] = {
  140. { "*", 1,
  141. QLOG_EVENT_TYPE_transport_packet_sent, 1 },
  142. { "-*", 1,
  143. QLOG_EVENT_TYPE_transport_packet_sent, 0 },
  144. { "+*", 1,
  145. QLOG_EVENT_TYPE_transport_packet_sent, 1 },
  146. { "* *", 1,
  147. QLOG_EVENT_TYPE_transport_packet_received, 1 },
  148. { "-* +*", 1,
  149. QLOG_EVENT_TYPE_transport_packet_received, 1 },
  150. { "-* +* -*", 1,
  151. QLOG_EVENT_TYPE_transport_packet_received, 0 },
  152. { " *", 1,
  153. QLOG_EVENT_TYPE_transport_packet_sent, 1 },
  154. { " ", 1,
  155. QLOG_EVENT_TYPE_transport_packet_sent, 0 },
  156. { "", 1,
  157. QLOG_EVENT_TYPE_transport_packet_sent, 0 },
  158. { "transport:packet_sent", 1,
  159. QLOG_EVENT_TYPE_transport_packet_sent, 1 },
  160. { "transport:packet_sent", 1,
  161. QLOG_EVENT_TYPE_transport_packet_received, 0 },
  162. { "* -transport:packet_sent", 1,
  163. QLOG_EVENT_TYPE_transport_packet_received, 1 },
  164. { "* -transport:packet_sent", 1,
  165. QLOG_EVENT_TYPE_transport_packet_sent, 0 },
  166. { "unknown:event", 1,
  167. QLOG_EVENT_TYPE_transport_packet_sent, 0 },
  168. { "unknown:event +transport:packet_sent", 1,
  169. QLOG_EVENT_TYPE_transport_packet_sent, 1 },
  170. { "unknown:event transport:*", 1,
  171. QLOG_EVENT_TYPE_transport_packet_sent, 1 },
  172. { "unknown:event +transport:* -transport:packet_sent", 1,
  173. QLOG_EVENT_TYPE_transport_packet_received, 1 },
  174. { "unknown:event transport:* -transport:packet_sent", 1,
  175. QLOG_EVENT_TYPE_transport_packet_sent, 0 },
  176. { "* -transport:*", 1,
  177. QLOG_EVENT_TYPE_connectivity_connection_started, 1 },
  178. { "* -transport:*", 1,
  179. QLOG_EVENT_TYPE_transport_parameters_set, 0 },
  180. { "&", 0 },
  181. { "event_name_without_category", 0 },
  182. { "event_name_with_@badchar:foo", 0 },
  183. { "event_name_with_badchar:f@oo", 0 },
  184. { "category:", 0 },
  185. { ":name", 0 },
  186. { ":", 0 },
  187. { "**", 0 },
  188. { "foo:bar*", 0 },
  189. { "foo:*bar", 0 },
  190. { "foo*:bar", 0 },
  191. { "*foo:bar", 0 },
  192. };
  193. static int test_qlog_filter(int idx)
  194. {
  195. int testresult = 0;
  196. QLOG_TRACE_INFO qti = {0};
  197. QLOG *qlog;
  198. qti.odcid.id_len = 1;
  199. qti.odcid.id[0] = 0x55;
  200. if (!TEST_ptr(qlog = ossl_qlog_new(&qti)))
  201. goto err;
  202. if (!TEST_int_eq(ossl_qlog_set_filter(qlog, filters[idx].filter),
  203. filters[idx].expect_ok))
  204. goto err;
  205. if (filters[idx].expect_event_type != QLOG_EVENT_TYPE_NONE)
  206. if (!TEST_int_eq(ossl_qlog_enabled(qlog, filters[idx].expect_event_type),
  207. filters[idx].expect_event_enable))
  208. goto err;
  209. testresult = 1;
  210. err:
  211. ossl_qlog_free(qlog);
  212. return testresult;
  213. }
  214. int setup_tests(void)
  215. {
  216. ADD_TEST(test_qlog);
  217. ADD_ALL_TESTS(test_qlog_filter, OSSL_NELEM(filters));
  218. return 1;
  219. }