src/dns/plugin_block_dns.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2013, 2017 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @file dns/plugin_block_dns.c
  23  * @brief block plugin for advertising a DNS exit service
  24  * @author Christian Grothoff
  25  *
  26  * Note that this plugin might more belong with EXIT and PT
  27  * as those two are using this type of block.  Still, this
  28  * might be a natural enough place for people to find the code...
  29  */
  30 #include "platform.h"
  31 #include "gnunet_block_plugin.h"
  32 #include "block_dns.h"
  33 #include "gnunet_signatures.h"
  34 #include "gnunet_block_group_lib.h"
  35
  36
  37 /**
  38  * Number of bits we set per entry in the bloomfilter.
  39  * Do not change!
  40  */
  41 #define BLOOMFILTER_K 16
  42
  43
  44 /**
  45  * Create a new block group.
  46  *
  47  * @param ctx block context in which the block group is created
  48  * @param type type of the block for which we are creating the group
  49  * @param nonce random value used to seed the group creation
  50  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
  51  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
  52  * @param va variable arguments specific to @a type
  53  * @return block group handle, NULL if block groups are not supported
  54  *         by this @a type of block (this is not an error)
  55  */
  56 static struct GNUNET_BLOCK_Group *
  57 block_plugin_dns_create_group(void *cls,
  58                               enum GNUNET_BLOCK_Type type,
  59                               uint32_t nonce,
  60                               const void *raw_data,
  61                               size_t raw_data_size,
  62                               va_list va)
  63 {
  64   unsigned int bf_size;
  65   const char *guard;
  66
  67   guard = va_arg(va, const char *);
  68   if (0 == strcmp(guard,
  69                   "seen-set-size"))
  70     bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size(va_arg(va, unsigned int),
  71                                                           BLOOMFILTER_K);
  72   else if (0 == strcmp(guard,
  73                        "filter-size"))
  74     bf_size = va_arg(va, unsigned int);
  75   else
  76     {
  77       GNUNET_break(0);
  78       bf_size = 8;
  79     }
  80   GNUNET_break(NULL == va_arg(va, const char *));
  81   return GNUNET_BLOCK_GROUP_bf_create(cls,
  82                                       bf_size,
  83                                       BLOOMFILTER_K,
  84                                       type,
  85                                       nonce,
  86                                       raw_data,
  87                                       raw_data_size);
  88 }
  89
  90
  91 /**
  92  * Function called to validate a reply or a request.  For
  93  * request evaluation, simply pass "NULL" for the reply_block.
  94  *
  95  * @param cls closure
  96  * @param ctx block context
  97  * @param type block type
  98  * @param bg group to evaluate against
  99  * @param eo control flags
 100  * @param query original query (hash)
 101  * @param xquery extended query data (can be NULL, depending on type)
 102  * @param xquery_size number of bytes in @a xquery
 103  * @param reply_block response to validate
 104  * @param reply_block_size number of bytes in @a reply_block
 105  * @return characterization of result
 106  */
 107 static enum GNUNET_BLOCK_EvaluationResult
 108 block_plugin_dns_evaluate(void *cls,
 109                           struct GNUNET_BLOCK_Context *ctx,
 110                           enum GNUNET_BLOCK_Type type,
 111                           struct GNUNET_BLOCK_Group *bg,
 112                           enum GNUNET_BLOCK_EvaluationOptions eo,
 113                           const struct GNUNET_HashCode * query,
 114                           const void *xquery,
 115                           size_t xquery_size,
 116                           const void *reply_block,
 117                           size_t reply_block_size)
 118 {
 119   const struct GNUNET_DNS_Advertisement *ad;
 120   struct GNUNET_HashCode phash;
 121
 122   switch (type)
 123     {
 124     case GNUNET_BLOCK_TYPE_DNS:
 125       if (0 != xquery_size)
 126         return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 127
 128       if (NULL == reply_block)
 129         return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 130
 131       if (sizeof(struct GNUNET_DNS_Advertisement) != reply_block_size)
 132         {
 133           GNUNET_break_op(0);
 134           return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 135         }
 136       ad = reply_block;
 137
 138       if (ntohl(ad->purpose.size) !=
 139           sizeof(struct GNUNET_DNS_Advertisement) -
 140           sizeof(struct GNUNET_CRYPTO_EddsaSignature))
 141         {
 142           GNUNET_break_op(0);
 143           return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 144         }
 145       if (0 ==
 146           GNUNET_TIME_absolute_get_remaining(GNUNET_TIME_absolute_ntoh
 147                                                (ad->expiration_time)).rel_value_us)
 148         {
 149           GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
 150                      "DNS advertisement has expired\n");
 151           return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 152         }
 153       if (GNUNET_OK !=
 154           GNUNET_CRYPTO_eddsa_verify(GNUNET_SIGNATURE_PURPOSE_DNS_RECORD,
 155                                      &ad->purpose,
 156                                      &ad->signature,
 157                                      &ad->peer.public_key))
 158         {
 159           GNUNET_break_op(0);
 160           return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 161         }
 162       GNUNET_CRYPTO_hash(reply_block,
 163                          reply_block_size,
 164                          &phash);
 165       if (GNUNET_YES ==
 166           GNUNET_BLOCK_GROUP_bf_test_and_set(bg,
 167                                              &phash))
 168         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 169       return GNUNET_BLOCK_EVALUATION_OK_MORE;
 170
 171     default:
 172       return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 173     }
 174 }
 175
 176
 177 /**
 178  * Function called to obtain the key for a block.
 179  *
 180  * @param cls closure
 181  * @param type block type
 182  * @param block block to get the key for
 183  * @param block_size number of bytes in @a block
 184  * @param key set to the key (query) for the given block
 185  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 186  *         (or if extracting a key from a block of this type does not work)
 187  */
 188 static int
 189 block_plugin_dns_get_key(void *cls,
 190                          enum GNUNET_BLOCK_Type type,
 191                          const void *block,
 192                          size_t block_size,
 193                          struct GNUNET_HashCode *key)
 194 {
 195   /* we cannot extract a key from a block of this type */
 196   return GNUNET_SYSERR;
 197 }
 198
 199
 200 /**
 201  * Entry point for the plugin.
 202  */
 203 void *
 204 libgnunet_plugin_block_dns_init(void *cls)
 205 {
 206   static enum GNUNET_BLOCK_Type types[] =
 207   {
 208     GNUNET_BLOCK_TYPE_DNS,
 209     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 210   };
 211   struct GNUNET_BLOCK_PluginFunctions *api;
 212
 213   api = GNUNET_new(struct GNUNET_BLOCK_PluginFunctions);
 214   api->evaluate = &block_plugin_dns_evaluate;
 215   api->get_key = &block_plugin_dns_get_key;
 216   api->create_group = &block_plugin_dns_create_group;
 217   api->types = types;
 218   return api;
 219 }
 220
 221
 222 /**
 223  * Exit point from the plugin.
 224  */
 225 void *
 226 libgnunet_plugin_block_dns_done(void *cls)
 227 {
 228   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 229
 230   GNUNET_free(api);
 231   return NULL;
 232 }
 233
 234 /* end of plugin_block_dns.c */