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