test_hs_control.c 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /* Copyright (c) 2017-2018, The Tor Project, Inc. */
  2. /* See LICENSE for licensing information */
  3. /**
  4. * \file test_hs_control.c
  5. * \brief Unit tests for hidden service control port event and command.
  6. **/
  7. #define CONTROL_PRIVATE
  8. #include "core/or/or.h"
  9. #include "test/test.h"
  10. #include "feature/control/control.h"
  11. #include "app/config/config.h"
  12. #include "feature/hs/hs_common.h"
  13. #include "feature/hs/hs_control.h"
  14. #include "feature/nodelist/nodelist.h"
  15. #include "feature/nodelist/node_st.h"
  16. #include "feature/nodelist/routerstatus_st.h"
  17. #include "lib/crypt_ops/crypto_format.h"
  18. #include "test/test_helpers.h"
  19. /* mock ID digest and longname for node that's in nodelist */
  20. #define HSDIR_EXIST_ID \
  21. "\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA" \
  22. "\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA"
  23. #define STR_HSDIR_EXIST_LONGNAME \
  24. "$AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=TestDir"
  25. #define STR_HSDIR_NONE_EXIST_LONGNAME \
  26. "$BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"
  27. /* Helper global variable for hidden service descriptor event test.
  28. * It's used as a pointer to dynamically created message buffer in
  29. * send_control_event_string_replacement function, which mocks
  30. * send_control_event_string function.
  31. *
  32. * Always free it after use! */
  33. static char *received_msg = NULL;
  34. /** Mock function for send_control_event_string
  35. */
  36. static void
  37. queue_control_event_string_replacement(uint16_t event, char *msg)
  38. {
  39. (void) event;
  40. tor_free(received_msg);
  41. received_msg = msg;
  42. }
  43. /** Mock function for node_describe_longname_by_id, it returns either
  44. * STR_HSDIR_EXIST_LONGNAME or STR_HSDIR_NONE_EXIST_LONGNAME
  45. */
  46. static const char *
  47. node_describe_longname_by_id_replacement(const char *id_digest)
  48. {
  49. if (!strcmp(id_digest, HSDIR_EXIST_ID)) {
  50. return STR_HSDIR_EXIST_LONGNAME;
  51. } else {
  52. return STR_HSDIR_NONE_EXIST_LONGNAME;
  53. }
  54. }
  55. /* HSDir fetch index is a series of 'D' */
  56. #define HSDIR_INDEX_FETCH_HEX \
  57. "4343434343434343434343434343434343434343434343434343434343434343"
  58. #define HSDIR_INDEX_STORE_HEX \
  59. "4444444444444444444444444444444444444444444444444444444444444444"
  60. static const node_t *
  61. mock_node_get_by_id(const char *digest)
  62. {
  63. static node_t node;
  64. memcpy(node.identity, digest, DIGEST_LEN);
  65. memset(node.hsdir_index.fetch, 'C', DIGEST256_LEN);
  66. memset(node.hsdir_index.store_first, 'D', DIGEST256_LEN);
  67. return &node;
  68. }
  69. static void
  70. test_hs_desc_event(void *arg)
  71. {
  72. int ret;
  73. char *expected_msg = NULL;
  74. char onion_address[HS_SERVICE_ADDR_LEN_BASE32 + 1];
  75. ed25519_keypair_t identity_kp;
  76. ed25519_public_key_t blinded_pk;
  77. char base64_blinded_pk[ED25519_BASE64_LEN + 1];
  78. routerstatus_t hsdir_rs;
  79. hs_ident_dir_conn_t ident;
  80. (void) arg;
  81. MOCK(queue_control_event_string,
  82. queue_control_event_string_replacement);
  83. MOCK(node_describe_longname_by_id,
  84. node_describe_longname_by_id_replacement);
  85. MOCK(node_get_by_id, mock_node_get_by_id);
  86. /* Setup what we need for this test. */
  87. ed25519_keypair_generate(&identity_kp, 0);
  88. hs_build_address(&identity_kp.pubkey, HS_VERSION_THREE, onion_address);
  89. ret = hs_address_is_valid(onion_address);
  90. tt_int_op(ret, OP_EQ, 1);
  91. memset(&blinded_pk, 'B', sizeof(blinded_pk));
  92. memset(&hsdir_rs, 0, sizeof(hsdir_rs));
  93. memcpy(hsdir_rs.identity_digest, HSDIR_EXIST_ID, DIGEST_LEN);
  94. ret = ed25519_public_to_base64(base64_blinded_pk, &blinded_pk);
  95. tt_int_op(ret, OP_EQ, 0);
  96. memcpy(&ident.identity_pk, &identity_kp.pubkey,
  97. sizeof(ed25519_public_key_t));
  98. memcpy(&ident.blinded_pk, &blinded_pk, sizeof(blinded_pk));
  99. /* HS_DESC REQUESTED ... */
  100. hs_control_desc_event_requested(&identity_kp.pubkey, base64_blinded_pk,
  101. &hsdir_rs);
  102. tor_asprintf(&expected_msg, "650 HS_DESC REQUESTED %s NO_AUTH "
  103. STR_HSDIR_EXIST_LONGNAME " %s HSDIR_INDEX="
  104. HSDIR_INDEX_FETCH_HEX "\r\n",
  105. onion_address, base64_blinded_pk);
  106. tt_assert(received_msg);
  107. tt_str_op(received_msg, OP_EQ, expected_msg);
  108. tor_free(received_msg);
  109. tor_free(expected_msg);
  110. /* HS_DESC CREATED... */
  111. hs_control_desc_event_created(onion_address, &blinded_pk);
  112. tor_asprintf(&expected_msg, "650 HS_DESC CREATED %s UNKNOWN "
  113. "UNKNOWN %s\r\n",
  114. onion_address, base64_blinded_pk);
  115. tt_assert(received_msg);
  116. tt_str_op(received_msg, OP_EQ, expected_msg);
  117. tor_free(received_msg);
  118. tor_free(expected_msg);
  119. /* HS_DESC UPLOAD... */
  120. uint8_t hsdir_index_store[DIGEST256_LEN];
  121. memset(hsdir_index_store, 'D', sizeof(hsdir_index_store));
  122. hs_control_desc_event_upload(onion_address, HSDIR_EXIST_ID,
  123. &blinded_pk, hsdir_index_store);
  124. tor_asprintf(&expected_msg, "650 HS_DESC UPLOAD %s UNKNOWN "
  125. STR_HSDIR_EXIST_LONGNAME " %s "
  126. "HSDIR_INDEX=" HSDIR_INDEX_STORE_HEX "\r\n",
  127. onion_address, base64_blinded_pk);
  128. tt_assert(received_msg);
  129. tt_str_op(received_msg, OP_EQ, expected_msg);
  130. tor_free(received_msg);
  131. tor_free(expected_msg);
  132. /* HS_DESC FAILED... */
  133. hs_control_desc_event_failed(&ident, HSDIR_EXIST_ID, "BAD_DESC");
  134. tor_asprintf(&expected_msg, "650 HS_DESC FAILED %s NO_AUTH "
  135. STR_HSDIR_EXIST_LONGNAME " %s "
  136. "REASON=BAD_DESC\r\n",
  137. onion_address, base64_blinded_pk);
  138. tt_assert(received_msg);
  139. tt_str_op(received_msg, OP_EQ, expected_msg);
  140. tor_free(received_msg);
  141. tor_free(expected_msg);
  142. /* HS_DESC RECEIVED... */
  143. hs_control_desc_event_received(&ident, HSDIR_EXIST_ID);
  144. tor_asprintf(&expected_msg, "650 HS_DESC RECEIVED %s NO_AUTH "
  145. STR_HSDIR_EXIST_LONGNAME " %s\r\n",
  146. onion_address, base64_blinded_pk);
  147. tt_assert(received_msg);
  148. tt_str_op(received_msg, OP_EQ, expected_msg);
  149. tor_free(received_msg);
  150. tor_free(expected_msg);
  151. /* HS_DESC UPLOADED... */
  152. hs_control_desc_event_uploaded(&ident, HSDIR_EXIST_ID);
  153. tor_asprintf(&expected_msg, "650 HS_DESC UPLOADED %s UNKNOWN "
  154. STR_HSDIR_EXIST_LONGNAME "\r\n",
  155. onion_address);
  156. tt_assert(received_msg);
  157. tt_str_op(received_msg, OP_EQ, expected_msg);
  158. tor_free(received_msg);
  159. tor_free(expected_msg);
  160. done:
  161. UNMOCK(queue_control_event_string);
  162. UNMOCK(node_describe_longname_by_id);
  163. UNMOCK(node_get_by_id);
  164. tor_free(received_msg);
  165. tor_free(expected_msg);
  166. }
  167. struct testcase_t hs_control_tests[] = {
  168. { "hs_desc_event", test_hs_desc_event, TT_FORK,
  169. NULL, NULL },
  170. END_OF_TESTCASES
  171. };