- new program_run and run_2
[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_size == 0)
81     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
82     
83   nrb = (struct GNSNameRecordBlock *)reply_block;
84   name = (char*)&nrb[1];
85   GNUNET_CRYPTO_hash(&nrb->public_key,
86                      sizeof(nrb->public_key),
87                      &pkey_hash);
88
89   GNUNET_CRYPTO_hash(name, strlen(name), &name_hash);
90
91   GNUNET_CRYPTO_hash_xor(&pkey_hash, &name_hash, &query_key);
92   
93   struct GNUNET_CRYPTO_HashAsciiEncoded xor_exp;
94   struct GNUNET_CRYPTO_HashAsciiEncoded xor_got;
95   GNUNET_CRYPTO_hash_to_enc (&query_key, &xor_exp);
96   GNUNET_CRYPTO_hash_to_enc (query, &xor_got);
97
98   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
99              "BLOCK_TEST for %s got %s expected %s\n",
100              name, (char*) &xor_got, (char*) &xor_exp);
101
102   /* Check query key against public key */
103   if (0 != GNUNET_CRYPTO_hash_cmp(query, &query_key))
104     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
105   
106   record_match = 0;
107   rd_count = ntohl(nrb->rd_count);
108   rd_data = (char*)&nrb[1];
109   rd_data += strlen(name) + 1;
110   rd_len = reply_block_size - (strlen(name) + 1
111                                + sizeof(struct GNSNameRecordBlock));
112   {
113     struct GNUNET_NAMESTORE_RecordData rd[rd_count];
114     unsigned int i;
115     struct GNUNET_TIME_Absolute exp = GNUNET_TIME_absolute_get_forever();
116     
117     if (GNUNET_SYSERR == GNUNET_NAMESTORE_records_deserialize (rd_len,
118                                                                rd_data,
119                                                                rd_count,
120                                                                rd))
121     {
122       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
123                  "Data invalid (%d bytes, %d records)\n", rd_len, rd_count);
124       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
125     }
126
127     if (xquery_size < sizeof(uint32_t))
128       record_xquery = 0;
129     else
130       record_xquery = ntohl(*((uint32_t*)xquery));
131     
132     for (i=0; i<rd_count; i++)
133     {
134       
135       exp = GNUNET_TIME_absolute_min (exp, rd[i].expiration);
136       
137       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
138                  "Got record of size %d\n", rd[i].data_size);
139
140       if ((record_xquery != 0)
141           && (rd[i].record_type == record_xquery))
142       {
143         record_match++;
144       }
145     }
146     
147     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
148                "Verifying signature of %d records for name %s\n",
149                rd_count, name);
150
151     if (GNUNET_OK != GNUNET_NAMESTORE_verify_signature (&nrb->public_key,
152                                                         exp,
153                                                         name,
154                                                         rd_count,
155                                                         rd,
156                                                         &nrb->signature))
157     {
158       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Signature invalid\n");
159       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
160     }
161   }
162   
163   if ((record_xquery != 0) && (record_match == 0))
164   {
165     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
166                "No record matches query!\n");
167     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
168   }
169
170   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Records match\n");
171   
172   if (NULL != bf)
173   {
174     GNUNET_CRYPTO_hash(reply_block, reply_block_size, &chash);
175     GNUNET_BLOCK_mingle_hash(&chash, bf_mutator, &mhash);
176     if (NULL != *bf)
177     {
178       GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Check BF\n");
179       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test(*bf, &mhash))
180         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
181     }
182     else
183     {
184       *bf = GNUNET_CONTAINER_bloomfilter_init(NULL, 8, BLOOMFILTER_K);
185     }
186     GNUNET_CONTAINER_bloomfilter_add(*bf, &mhash);
187   }
188   return GNUNET_BLOCK_EVALUATION_OK_MORE;
189 }
190
191
192 /**
193  * Function called to obtain the key for a block.
194  *
195  * @param cls closure
196  * @param type block type
197  * @param block block to get the key for
198  * @param block_size number of bytes in block
199  * @param key set to the key (query) for the given block
200  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
201  *         (or if extracting a key from a block of this type does not work)
202  */
203 static int
204 block_plugin_gns_get_key (void *cls, enum GNUNET_BLOCK_Type type,
205                          const void *block, size_t block_size,
206                          GNUNET_HashCode * key)
207 {
208   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
209     return GNUNET_SYSERR;
210   GNUNET_HashCode name_hash;
211   GNUNET_HashCode pkey_hash;
212   struct GNSNameRecordBlock *nrb = (struct GNSNameRecordBlock *)block;
213
214   GNUNET_CRYPTO_hash(&nrb[1], strlen((char*)&nrb[1]), &name_hash);
215   GNUNET_CRYPTO_hash(&nrb->public_key,
216                      sizeof(struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
217                      &pkey_hash);
218
219   GNUNET_CRYPTO_hash_xor(&name_hash, &pkey_hash, key);
220   
221   return GNUNET_OK;
222 }
223
224
225 /**
226  * Entry point for the plugin.
227  */
228 void *
229 libgnunet_plugin_block_gns_init (void *cls)
230 {
231   static enum GNUNET_BLOCK_Type types[] =
232   {
233     GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
234     GNUNET_BLOCK_TYPE_ANY       /* end of list */
235   };
236   struct GNUNET_BLOCK_PluginFunctions *api;
237
238   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
239   api->evaluate = &block_plugin_gns_evaluate;
240   api->get_key = &block_plugin_gns_get_key;
241   api->types = types;
242   return api;
243 }
244
245
246 /**
247  * Exit point from the plugin.
248  */
249 void *
250 libgnunet_plugin_block_gns_done (void *cls)
251 {
252   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
253
254   GNUNET_free (api);
255   return NULL;
256 }
257
258 /* end of plugin_block_gns.c */