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
  71                                                                    int),
  72                                                            BLOOMFILTER_K);
  73   else if (0 == strcmp (guard,
  74                         "filter-size"))
  75     bf_size = va_arg (va, unsigned int);
  76   else
  77   {
  78     GNUNET_break (0);
  79     bf_size = 8;
  80   }
  81   GNUNET_break (NULL == va_arg (va, const char *));
  82   return GNUNET_BLOCK_GROUP_bf_create (cls,
  83                                        bf_size,
  84                                        BLOOMFILTER_K,
  85                                        type,
  86                                        nonce,
  87                                        raw_data,
  88                                        raw_data_size);
  89 }
  90
  91
  92 /**
  93  * Function called to validate a reply or a request.  For
  94  * request evaluation, simply pass "NULL" for the reply_block.
  95  *
  96  * @param cls closure
  97  * @param ctx block context
  98  * @param type block type
  99  * @param bg group to evaluate against
 100  * @param eo control flags
 101  * @param query original query (hash)
 102  * @param xquery extended query data (can be NULL, depending on type)
 103  * @param xquery_size number of bytes in @a xquery
 104  * @param reply_block response to validate
 105  * @param reply_block_size number of bytes in @a reply_block
 106  * @return characterization of result
 107  */
 108 static enum GNUNET_BLOCK_EvaluationResult
 109 block_plugin_dns_evaluate (void *cls,
 110                            struct GNUNET_BLOCK_Context *ctx,
 111                            enum GNUNET_BLOCK_Type type,
 112                            struct GNUNET_BLOCK_Group *bg,
 113                            enum GNUNET_BLOCK_EvaluationOptions eo,
 114                            const struct GNUNET_HashCode *query,
 115                            const void *xquery,
 116                            size_t xquery_size,
 117                            const void *reply_block,
 118                            size_t reply_block_size)
 119 {
 120   const struct GNUNET_DNS_Advertisement *ad;
 121   struct GNUNET_HashCode phash;
 122
 123   switch (type)
 124   {
 125   case GNUNET_BLOCK_TYPE_DNS:
 126     if (0 != xquery_size)
 127       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 128
 129     if (NULL == reply_block)
 130       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 131
 132     if (sizeof(struct GNUNET_DNS_Advertisement) != reply_block_size)
 133     {
 134       GNUNET_break_op (0);
 135       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 136     }
 137     ad = reply_block;
 138
 139     if (ntohl (ad->purpose.size) !=
 140         sizeof(struct GNUNET_DNS_Advertisement)
 141         - sizeof(struct GNUNET_CRYPTO_EddsaSignature))
 142     {
 143       GNUNET_break_op (0);
 144       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 145     }
 146     if (0 ==
 147         GNUNET_TIME_absolute_get_remaining (GNUNET_TIME_absolute_ntoh
 148                                               (ad->expiration_time)).
 149         rel_value_us)
 150     {
 151       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 152                   "DNS advertisement has expired\n");
 153       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 154     }
 155     if (GNUNET_OK !=
 156         GNUNET_CRYPTO_eddsa_verify_ (GNUNET_SIGNATURE_PURPOSE_DNS_RECORD,
 157                                      &ad->purpose,
 158                                      &ad->signature,
 159                                      &ad->peer.public_key))
 160     {
 161       GNUNET_break_op (0);
 162       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 163     }
 164     GNUNET_CRYPTO_hash (reply_block,
 165                         reply_block_size,
 166                         &phash);
 167     if (GNUNET_YES ==
 168         GNUNET_BLOCK_GROUP_bf_test_and_set (bg,
 169                                             &phash))
 170       return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 171     return GNUNET_BLOCK_EVALUATION_OK_MORE;
 172
 173   default:
 174     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 175   }
 176 }
 177
 178
 179 /**
 180  * Function called to obtain the key for a block.
 181  *
 182  * @param cls closure
 183  * @param type block type
 184  * @param block block to get the key for
 185  * @param block_size number of bytes in @a block
 186  * @param key set to the key (query) for the given block
 187  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 188  *         (or if extracting a key from a block of this type does not work)
 189  */
 190 static int
 191 block_plugin_dns_get_key (void *cls,
 192                           enum GNUNET_BLOCK_Type type,
 193                           const void *block,
 194                           size_t block_size,
 195                           struct GNUNET_HashCode *key)
 196 {
 197   /* we cannot extract a key from a block of this type */
 198   return GNUNET_SYSERR;
 199 }
 200
 201
 202 /**
 203  * Entry point for the plugin.
 204  */
 205 void *
 206 libgnunet_plugin_block_dns_init (void *cls)
 207 {
 208   static enum GNUNET_BLOCK_Type types[] = {
 209     GNUNET_BLOCK_TYPE_DNS,
 210     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 211   };
 212   struct GNUNET_BLOCK_PluginFunctions *api;
 213
 214   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 215   api->evaluate = &block_plugin_dns_evaluate;
 216   api->get_key = &block_plugin_dns_get_key;
 217   api->create_group = &block_plugin_dns_create_group;
 218   api->types = types;
 219   return api;
 220 }
 221
 222
 223 /**
 224  * Exit point from the plugin.
 225  */
 226 void *
 227 libgnunet_plugin_block_dns_done (void *cls)
 228 {
 229   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 230
 231   GNUNET_free (api);
 232   return NULL;
 233 }
 234
 235
 236 /* end of plugin_block_dns.c */