test_channeltls.c 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. /* Copyright (c) 2014-2016, The Tor Project, Inc. */
  2. /* See LICENSE for licensing information */
  3. #include <math.h>
  4. #define TOR_CHANNEL_INTERNAL_
  5. #include "or.h"
  6. #include "address.h"
  7. #include "buffers.h"
  8. #include "channel.h"
  9. #include "channeltls.h"
  10. #include "connection_or.h"
  11. #include "config.h"
  12. /* For init/free stuff */
  13. #include "scheduler.h"
  14. #include "tortls.h"
  15. /* Test suite stuff */
  16. #include "test.h"
  17. #include "fakechans.h"
  18. /* The channeltls unit tests */
  19. static void test_channeltls_create(void *arg);
  20. static void test_channeltls_num_bytes_queued(void *arg);
  21. static void test_channeltls_overhead_estimate(void *arg);
  22. /* Mocks used by channeltls unit tests */
  23. static size_t tlschan_buf_datalen_mock(const buf_t *buf);
  24. static or_connection_t * tlschan_connection_or_connect_mock(
  25. const tor_addr_t *addr,
  26. uint16_t port,
  27. const char *digest,
  28. const ed25519_public_key_t *ed_id,
  29. channel_tls_t *tlschan);
  30. static int tlschan_is_local_addr_mock(const tor_addr_t *addr);
  31. /* Fake close method */
  32. static void tlschan_fake_close_method(channel_t *chan);
  33. /* Flags controlling behavior of channeltls unit test mocks */
  34. static int tlschan_local = 0;
  35. static const buf_t * tlschan_buf_datalen_mock_target = NULL;
  36. static size_t tlschan_buf_datalen_mock_size = 0;
  37. /* Thing to cast to fake tor_tls_t * to appease assert_connection_ok() */
  38. static int fake_tortls = 0; /* Bleh... */
  39. static void
  40. test_channeltls_create(void *arg)
  41. {
  42. tor_addr_t test_addr;
  43. channel_t *ch = NULL;
  44. const char test_digest[DIGEST_LEN] = {
  45. 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a,
  46. 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14 };
  47. (void)arg;
  48. /* Set up a fake address to fake-connect to */
  49. test_addr.family = AF_INET;
  50. test_addr.addr.in_addr.s_addr = htonl(0x01020304);
  51. /* For this test we always want the address to be treated as non-local */
  52. tlschan_local = 0;
  53. /* Install is_local_addr() mock */
  54. MOCK(is_local_addr, tlschan_is_local_addr_mock);
  55. /* Install mock for connection_or_connect() */
  56. MOCK(connection_or_connect, tlschan_connection_or_connect_mock);
  57. /* Try connecting */
  58. ch = channel_tls_connect(&test_addr, 567, test_digest, NULL);
  59. tt_assert(ch != NULL);
  60. done:
  61. if (ch) {
  62. MOCK(scheduler_release_channel, scheduler_release_channel_mock);
  63. /*
  64. * Use fake close method that doesn't try to do too much to fake
  65. * orconn
  66. */
  67. ch->close = tlschan_fake_close_method;
  68. channel_mark_for_close(ch);
  69. free_fake_channel(ch);
  70. UNMOCK(scheduler_release_channel);
  71. }
  72. UNMOCK(connection_or_connect);
  73. UNMOCK(is_local_addr);
  74. return;
  75. }
  76. static void
  77. test_channeltls_num_bytes_queued(void *arg)
  78. {
  79. tor_addr_t test_addr;
  80. channel_t *ch = NULL;
  81. const char test_digest[DIGEST_LEN] = {
  82. 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a,
  83. 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14 };
  84. channel_tls_t *tlschan = NULL;
  85. size_t len;
  86. int fake_outbuf = 0, n;
  87. (void)arg;
  88. /* Set up a fake address to fake-connect to */
  89. test_addr.family = AF_INET;
  90. test_addr.addr.in_addr.s_addr = htonl(0x01020304);
  91. /* For this test we always want the address to be treated as non-local */
  92. tlschan_local = 0;
  93. /* Install is_local_addr() mock */
  94. MOCK(is_local_addr, tlschan_is_local_addr_mock);
  95. /* Install mock for connection_or_connect() */
  96. MOCK(connection_or_connect, tlschan_connection_or_connect_mock);
  97. /* Try connecting */
  98. ch = channel_tls_connect(&test_addr, 567, test_digest, NULL);
  99. tt_assert(ch != NULL);
  100. /*
  101. * Next, we have to test ch->num_bytes_queued, which is
  102. * channel_tls_num_bytes_queued_method. We can't mock
  103. * connection_get_outbuf_len() directly because it's static inline
  104. * in connection.h, but we can mock buf_datalen().
  105. */
  106. tt_assert(ch->num_bytes_queued != NULL);
  107. tlschan = BASE_CHAN_TO_TLS(ch);
  108. tt_assert(tlschan != NULL);
  109. if (TO_CONN(tlschan->conn)->outbuf == NULL) {
  110. /* We need an outbuf to make sure buf_datalen() gets called */
  111. fake_outbuf = 1;
  112. TO_CONN(tlschan->conn)->outbuf = buf_new();
  113. }
  114. tlschan_buf_datalen_mock_target = TO_CONN(tlschan->conn)->outbuf;
  115. tlschan_buf_datalen_mock_size = 1024;
  116. MOCK(buf_datalen, tlschan_buf_datalen_mock);
  117. len = ch->num_bytes_queued(ch);
  118. tt_int_op(len, ==, tlschan_buf_datalen_mock_size);
  119. /*
  120. * We also cover num_cells_writeable here; since wide_circ_ids = 0 on
  121. * the fake tlschans, cell_network_size returns 512, and so with
  122. * tlschan_buf_datalen_mock_size == 1024, we should be able to write
  123. * ceil((OR_CONN_HIGHWATER - 1024) / 512) = ceil(OR_CONN_HIGHWATER / 512)
  124. * - 2 cells.
  125. */
  126. n = ch->num_cells_writeable(ch);
  127. tt_int_op(n, ==, CEIL_DIV(OR_CONN_HIGHWATER, 512) - 2);
  128. UNMOCK(buf_datalen);
  129. tlschan_buf_datalen_mock_target = NULL;
  130. tlschan_buf_datalen_mock_size = 0;
  131. if (fake_outbuf) {
  132. buf_free(TO_CONN(tlschan->conn)->outbuf);
  133. TO_CONN(tlschan->conn)->outbuf = NULL;
  134. }
  135. done:
  136. if (ch) {
  137. MOCK(scheduler_release_channel, scheduler_release_channel_mock);
  138. /*
  139. * Use fake close method that doesn't try to do too much to fake
  140. * orconn
  141. */
  142. ch->close = tlschan_fake_close_method;
  143. channel_mark_for_close(ch);
  144. free_fake_channel(ch);
  145. UNMOCK(scheduler_release_channel);
  146. }
  147. UNMOCK(connection_or_connect);
  148. UNMOCK(is_local_addr);
  149. return;
  150. }
  151. static void
  152. test_channeltls_overhead_estimate(void *arg)
  153. {
  154. tor_addr_t test_addr;
  155. channel_t *ch = NULL;
  156. const char test_digest[DIGEST_LEN] = {
  157. 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a,
  158. 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14 };
  159. double r;
  160. channel_tls_t *tlschan = NULL;
  161. (void)arg;
  162. /* Set up a fake address to fake-connect to */
  163. test_addr.family = AF_INET;
  164. test_addr.addr.in_addr.s_addr = htonl(0x01020304);
  165. /* For this test we always want the address to be treated as non-local */
  166. tlschan_local = 0;
  167. /* Install is_local_addr() mock */
  168. MOCK(is_local_addr, tlschan_is_local_addr_mock);
  169. /* Install mock for connection_or_connect() */
  170. MOCK(connection_or_connect, tlschan_connection_or_connect_mock);
  171. /* Try connecting */
  172. ch = channel_tls_connect(&test_addr, 567, test_digest, NULL);
  173. tt_assert(ch != NULL);
  174. /* First case: silly low ratios should get clamped to 1.0 */
  175. tlschan = BASE_CHAN_TO_TLS(ch);
  176. tt_assert(tlschan != NULL);
  177. tlschan->conn->bytes_xmitted = 128;
  178. tlschan->conn->bytes_xmitted_by_tls = 64;
  179. r = ch->get_overhead_estimate(ch);
  180. tt_assert(fabs(r - 1.0) < 1E-12);
  181. tlschan->conn->bytes_xmitted_by_tls = 127;
  182. r = ch->get_overhead_estimate(ch);
  183. tt_assert(fabs(r - 1.0) < 1E-12);
  184. /* Now middle of the range */
  185. tlschan->conn->bytes_xmitted_by_tls = 192;
  186. r = ch->get_overhead_estimate(ch);
  187. tt_assert(fabs(r - 1.5) < 1E-12);
  188. /* Now above the 2.0 clamp */
  189. tlschan->conn->bytes_xmitted_by_tls = 257;
  190. r = ch->get_overhead_estimate(ch);
  191. tt_assert(fabs(r - 2.0) < 1E-12);
  192. tlschan->conn->bytes_xmitted_by_tls = 512;
  193. r = ch->get_overhead_estimate(ch);
  194. tt_assert(fabs(r - 2.0) < 1E-12);
  195. done:
  196. if (ch) {
  197. MOCK(scheduler_release_channel, scheduler_release_channel_mock);
  198. /*
  199. * Use fake close method that doesn't try to do too much to fake
  200. * orconn
  201. */
  202. ch->close = tlschan_fake_close_method;
  203. channel_mark_for_close(ch);
  204. free_fake_channel(ch);
  205. UNMOCK(scheduler_release_channel);
  206. }
  207. UNMOCK(connection_or_connect);
  208. UNMOCK(is_local_addr);
  209. return;
  210. }
  211. static size_t
  212. tlschan_buf_datalen_mock(const buf_t *buf)
  213. {
  214. if (buf != NULL && buf == tlschan_buf_datalen_mock_target) {
  215. return tlschan_buf_datalen_mock_size;
  216. } else {
  217. return buf_datalen__real(buf);
  218. }
  219. }
  220. static or_connection_t *
  221. tlschan_connection_or_connect_mock(const tor_addr_t *addr,
  222. uint16_t port,
  223. const char *digest,
  224. const ed25519_public_key_t *ed_id,
  225. channel_tls_t *tlschan)
  226. {
  227. or_connection_t *result = NULL;
  228. (void) ed_id; // XXXX Not yet used.
  229. tt_assert(addr != NULL);
  230. tt_assert(port != 0);
  231. tt_assert(digest != NULL);
  232. tt_assert(tlschan != NULL);
  233. /* Make a fake orconn */
  234. result = tor_malloc_zero(sizeof(*result));
  235. result->base_.magic = OR_CONNECTION_MAGIC;
  236. result->base_.state = OR_CONN_STATE_OPEN;
  237. result->base_.type = CONN_TYPE_OR;
  238. result->base_.socket_family = addr->family;
  239. result->base_.address = tor_strdup("<fake>");
  240. memcpy(&(result->base_.addr), addr, sizeof(tor_addr_t));
  241. result->base_.port = port;
  242. memcpy(result->identity_digest, digest, DIGEST_LEN);
  243. result->chan = tlschan;
  244. memcpy(&(result->real_addr), addr, sizeof(tor_addr_t));
  245. result->tls = (tor_tls_t *)((void *)(&fake_tortls));
  246. done:
  247. return result;
  248. }
  249. static void
  250. tlschan_fake_close_method(channel_t *chan)
  251. {
  252. channel_tls_t *tlschan = NULL;
  253. tt_assert(chan != NULL);
  254. tt_int_op(chan->magic, ==, TLS_CHAN_MAGIC);
  255. tlschan = BASE_CHAN_TO_TLS(chan);
  256. tt_assert(tlschan != NULL);
  257. /* Just free the fake orconn */
  258. tor_free(tlschan->conn->base_.address);
  259. tor_free(tlschan->conn);
  260. channel_closed(chan);
  261. done:
  262. return;
  263. }
  264. static int
  265. tlschan_is_local_addr_mock(const tor_addr_t *addr)
  266. {
  267. tt_assert(addr != NULL);
  268. done:
  269. return tlschan_local;
  270. }
  271. struct testcase_t channeltls_tests[] = {
  272. { "create", test_channeltls_create, TT_FORK, NULL, NULL },
  273. { "num_bytes_queued", test_channeltls_num_bytes_queued,
  274. TT_FORK, NULL, NULL },
  275. { "overhead_estimate", test_channeltls_overhead_estimate,
  276. TT_FORK, NULL, NULL },
  277. END_OF_TESTCASES
  278. };