-fix
[oweals/gnunet.git] / src / gns / plugin_block_gns.c
1 /*
2      This file is part of GNUnet
3      (C) 2010 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      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      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file gns/plugin_block_gns.c
23  * @brief blocks used for GNS records
24  * @author Martin Schanzenbach
25  */
26
27 #include "platform.h"
28 #include "gnunet_block_plugin.h"
29 #include "gnunet_namestore_service.h"
30 #include "block_gns.h"
31 #include "gnunet_signatures.h"
32
33 /**
34  * Number of bits we set per entry in the bloomfilter.
35  * Do not change! -from fs
36  */
37 #define BLOOMFILTER_K 16
38
39 /**
40  * Function called to validate a reply or a request.  For
41  * request evaluation, simply pass "NULL" for the reply_block.
42  * Note that it is assumed that the reply has already been
43  * matched to the key (and signatures checked) as it would
44  * be done with the "get_key" function.
45  *
46  * @param cls closure
47  * @param type block type
48  * @param query original query (hash)
49  * @param bf pointer to bloom filter associated with query; possibly updated (!)
50  * @param bf_mutator mutation value for bf
51  * @param xquery extrended query data (can be NULL, depending on type)
52  * @param xquery_size number of bytes in xquery
53  * @param reply_block response to validate
54  * @param reply_block_size number of bytes in reply block
55  * @return characterization of result
56  */
57 static enum GNUNET_BLOCK_EvaluationResult
58 block_plugin_gns_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
59                           const GNUNET_HashCode * query,
60                           struct GNUNET_CONTAINER_BloomFilter **bf,
61                           int32_t bf_mutator, const void *xquery,
62                           size_t xquery_size, const void *reply_block,
63                           size_t reply_block_size)
64 {
65   char* name;
66   GNUNET_HashCode pkey_hash;
67   GNUNET_HashCode query_key;
68   GNUNET_HashCode name_hash;
69   GNUNET_HashCode mhash;
70   GNUNET_HashCode chash;
71   struct GNSNameRecordBlock *nrb;
72   uint32_t rd_count;
73   char* rd_data = NULL;
74   int rd_len;
75   uint32_t record_xquery;
76   unsigned int record_match;
77
78   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
79     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
80   if (reply_block == NULL)
81   {
82     /**
83      *  check if request is valid
84      *  FIXME we could check for the record types here
85      **/
86     if (xquery_size < sizeof(uint32_t))
87       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
88     else
89       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
90   }
91   
92   /* this is a reply */
93
94   nrb = (struct GNSNameRecordBlock *)reply_block;
95   name = (char*)&nrb[1];
96   GNUNET_CRYPTO_hash(&nrb->public_key,
97                      sizeof(nrb->public_key),
98                      &pkey_hash);
99
100   GNUNET_CRYPTO_hash(name, strlen(name), &name_hash);
101
102   GNUNET_CRYPTO_hash_xor(&pkey_hash, &name_hash, &query_key);
103   
104   struct GNUNET_CRYPTO_HashAsciiEncoded xor_exp;
105   struct GNUNET_CRYPTO_HashAsciiEncoded xor_got;
106   GNUNET_CRYPTO_hash_to_enc (&query_key, &xor_exp);
107   GNUNET_CRYPTO_hash_to_enc (query, &xor_got);
108
109   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
110              "BLOCK_TEST for %s got %s expected %s\n",
111              name, (char*) &xor_got, (char*) &xor_exp);
112
113   /* Check query key against public key */
114   if (0 != GNUNET_CRYPTO_hash_cmp(query, &query_key))
115     return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
116   
117   record_match = 0;
118   rd_count = ntohl(nrb->rd_count);
119   rd_data = (char*)&nrb[1];
120   rd_data += strlen(name) + 1;
121   rd_len = reply_block_size - (strlen(name) + 1
122                                + sizeof(struct GNSNameRecordBlock));
123   {
124     struct GNUNET_NAMESTORE_RecordData rd[rd_count];
125     unsigned int i;
126     struct GNUNET_TIME_Absolute exp = GNUNET_TIME_absolute_get_forever();
127     
128     if (GNUNET_SYSERR == GNUNET_NAMESTORE_records_deserialize (rd_len,
129                                                                rd_data,
130                                                                rd_count,
131                                                                rd))
132     {
133       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
134                  "Data invalid (%d bytes, %d records)\n", rd_len, rd_count);
135       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
136     }
137
138     if (xquery_size < sizeof(uint32_t))
139       record_xquery = 0;
140     else
141       record_xquery = ntohl(*((uint32_t*)xquery));
142     
143     for (i=0; i<rd_count; i++)
144     {
145       
146       exp = GNUNET_TIME_absolute_min (exp, rd[i].expiration);
147       
148       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
149                  "Got record of size %d\n", rd[i].data_size);
150
151       if ((record_xquery != 0)
152           && (rd[i].record_type == record_xquery))
153       {
154         record_match++;
155       }
156     }
157     
158     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
159                "Verifying signature of %d records for name %s\n",
160                rd_count, name);
161
162     if (GNUNET_OK != GNUNET_NAMESTORE_verify_signature (&nrb->public_key,
163                                                         exp,
164                                                         name,
165                                                         rd_count,
166                                                         rd,
167                                                         &nrb->signature))
168     {
169       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Signature invalid\n");
170       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
171     }
172   }
173   
174   if (NULL != bf)
175   {
176     GNUNET_CRYPTO_hash(reply_block, reply_block_size, &chash);
177     GNUNET_BLOCK_mingle_hash(&chash, bf_mutator, &mhash);
178     if (NULL != *bf)
179     {
180       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Check BF\n");
181       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test(*bf, &mhash))
182         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
183     }
184     else
185     {
186       *bf = GNUNET_CONTAINER_bloomfilter_init(NULL, 8, BLOOMFILTER_K);
187     }
188     GNUNET_CONTAINER_bloomfilter_add(*bf, &mhash);
189   }
190   return GNUNET_BLOCK_EVALUATION_OK_MORE;
191 }
192
193
194 /**
195  * Function called to obtain the key for a block.
196  *
197  * @param cls closure
198  * @param type block type
199  * @param block block to get the key for
200  * @param block_size number of bytes in block
201  * @param key set to the key (query) for the given block
202  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
203  *         (or if extracting a key from a block of this type does not work)
204  */
205 static int
206 block_plugin_gns_get_key (void *cls, enum GNUNET_BLOCK_Type type,
207                          const void *block, size_t block_size,
208                          GNUNET_HashCode * key)
209 {
210   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
211     return GNUNET_SYSERR;
212   GNUNET_HashCode name_hash;
213   GNUNET_HashCode pkey_hash;
214   struct GNSNameRecordBlock *nrb = (struct GNSNameRecordBlock *)block;
215
216   GNUNET_CRYPTO_hash(&nrb[1], strlen((char*)&nrb[1]), &name_hash);
217   GNUNET_CRYPTO_hash(&nrb->public_key,
218                      sizeof(struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
219                      &pkey_hash);
220
221   GNUNET_CRYPTO_hash_xor(&name_hash, &pkey_hash, key);
222   
223   return GNUNET_OK;
224 }
225
226
227 /**
228  * Entry point for the plugin.
229  */
230 void *
231 libgnunet_plugin_block_gns_init (void *cls)
232 {
233   static enum GNUNET_BLOCK_Type types[] =
234   {
235     GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
236     GNUNET_BLOCK_TYPE_ANY       /* end of list */
237   };
238   struct GNUNET_BLOCK_PluginFunctions *api;
239
240   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
241   api->evaluate = &block_plugin_gns_evaluate;
242   api->get_key = &block_plugin_gns_get_key;
243   api->types = types;
244   return api;
245 }
246
247
248 /**
249  * Exit point from the plugin.
250  */
251 void *
252 libgnunet_plugin_block_gns_done (void *cls)
253 {
254   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
255
256   GNUNET_free (api);
257   return NULL;
258 }
259
260 /* end of plugin_block_gns.c */