GNUnet  0.11.x
gnunet-service-fs_indexing.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009, 2010 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 
26 #include "platform.h"
27 #include <float.h>
28 #include "gnunet_core_service.h"
30 #include "gnunet_peer_lib.h"
31 #include "gnunet_protocols.h"
32 #include "gnunet_signatures.h"
33 #include "gnunet_util_lib.h"
34 #include "gnunet-service-fs.h"
36 #include "fs.h"
37 
42 struct IndexInfo
43 {
47  struct IndexInfo *next;
48 
52  struct IndexInfo *prev;
53 
58  const char *filename;
59 
64  struct GNUNET_SERVER_TransmitContext *tc;
65 
70 
75 };
76 
77 
83 
88 
95 
99 static const struct GNUNET_CONFIGURATION_Handle *cfg;
100 
106 
107 
111 static void
113 {
114  struct GNUNET_BIO_WriteHandle *wh;
115  char *fn;
116  struct IndexInfo *pos;
117 
118  if (GNUNET_OK !=
119  GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
120  {
122  "fs",
123  "INDEXDB");
124  return;
125  }
126  wh = GNUNET_BIO_write_open_file (fn);
127  if (NULL == wh)
128  {
130  _ ("Could not open `%s'.\n"),
131  fn);
132  GNUNET_free (fn);
133  return;
134  }
135  for (pos = indexed_files_head; NULL != pos; pos = pos->next)
136  if ((GNUNET_OK != GNUNET_BIO_write (wh,
137  "fs-indexing-file-id",
138  &pos->file_id,
139  sizeof(struct GNUNET_HashCode))) ||
141  "fs-indexing-filename",
142  pos->filename)))
143  break;
144  if (GNUNET_OK != GNUNET_BIO_write_close (wh, NULL))
145  {
147  _ ("Error writing `%s'.\n"),
148  fn);
149  GNUNET_free (fn);
150  return;
151  }
152  GNUNET_free (fn);
153 }
154 
155 
159 static void
161 {
162  struct GNUNET_BIO_ReadHandle *rh;
163  char *fn;
164  struct IndexInfo *pos;
165  char *fname;
166  struct GNUNET_HashCode hc;
167  size_t slen;
168  char *emsg;
169 
170  if (GNUNET_OK !=
171  GNUNET_CONFIGURATION_get_value_filename (cfg, "FS", "INDEXDB", &fn))
172  {
174  "fs",
175  "INDEXDB");
176  return;
177  }
178  if (GNUNET_NO == GNUNET_DISK_file_test (fn))
179  {
180  /* no index info yet */
181  GNUNET_free (fn);
182  return;
183  }
184  rh = GNUNET_BIO_read_open_file (fn);
185  if (NULL == rh)
186  {
188  _ ("Could not open `%s'.\n"),
189  fn);
190  GNUNET_free (fn);
191  return;
192  }
193  while (
194  (GNUNET_OK == GNUNET_BIO_read (rh,
195  "Hash of indexed file",
196  &hc,
197  sizeof(struct GNUNET_HashCode))) &&
198  (GNUNET_OK ==
199  GNUNET_BIO_read_string (rh, "Name of indexed file", &fname, 1024 * 16)) &&
200  (fname != NULL))
201  {
202  slen = strlen (fname) + 1;
203  pos = GNUNET_malloc (sizeof(struct IndexInfo) + slen);
204  pos->file_id = hc;
205  pos->filename = (const char *) &pos[1];
206  GNUNET_memcpy (&pos[1], fname, slen);
208  ifm,
209  &pos->file_id,
210  pos,
212  {
213  GNUNET_free (pos);
214  }
215  else
216  {
217  GNUNET_CONTAINER_DLL_insert (indexed_files_head, indexed_files_tail, pos);
218  }
219  GNUNET_free (fname);
220  }
221  if (GNUNET_OK != GNUNET_BIO_read_close (rh, &emsg))
222  GNUNET_free (emsg);
223  GNUNET_free (fn);
224 }
225 
226 
236 static void
237 remove_cont (void *cls,
238  int success,
240  const char *msg)
241 {
242  if (GNUNET_OK != success)
244  _ ("Failed to delete bogus block: %s\n"),
245  msg);
246 }
247 
248 
269 int
271  uint32_t size,
272  const void *data,
273  enum GNUNET_BLOCK_Type type,
274  uint32_t priority,
275  uint32_t anonymity,
276  uint32_t replication,
278  uint64_t uid,
280  void *cont_cls)
281 {
282  const struct OnDemandBlock *odb;
283  struct GNUNET_HashCode nkey;
286  struct GNUNET_HashCode query;
287  ssize_t nsize;
288  char ndata[DBLOCK_SIZE];
289  char edata[DBLOCK_SIZE];
290  const char *fn;
291  struct GNUNET_DISK_FileHandle *fh;
292  uint64_t off;
293  struct IndexInfo *ii;
294 
295  if (size != sizeof(struct OnDemandBlock))
296  {
297  GNUNET_break (0);
298  GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1, &remove_cont, NULL);
299  return GNUNET_SYSERR;
300  }
301  odb = (const struct OnDemandBlock *) data;
302  off = GNUNET_ntohll (odb->offset);
303  ii = GNUNET_CONTAINER_multihashmap_get (ifm, &odb->file_id);
304  if (NULL == ii)
305  {
306  GNUNET_break (0);
308  "Failed to find index %s\n",
309  GNUNET_h2s (&odb->file_id));
310  return GNUNET_SYSERR;
311  }
312  fn = ii->filename;
313  if ((NULL == fn) || (0 != access (fn, R_OK)))
314  {
316  GSF_stats,
317  gettext_noop ("# index blocks removed: original file inaccessible"),
318  1,
319  GNUNET_YES);
320  GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1, &remove_cont, NULL);
321  return GNUNET_SYSERR;
322  }
323  if ((NULL == (fh = GNUNET_DISK_file_open (fn,
326  (off != GNUNET_DISK_file_seek (fh, off, GNUNET_DISK_SEEK_SET)) ||
327  (-1 == (nsize = GNUNET_DISK_file_read (fh, ndata, sizeof(ndata)))))
328  {
330  _ (
331  "Could not access indexed file `%s' (%s) at offset %llu: %s\n"),
332  GNUNET_h2s (&odb->file_id),
333  fn,
334  (unsigned long long) off,
335  (fn == NULL) ? _ ("not indexed") : strerror (errno));
336  if (fh != NULL)
338  GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1, &remove_cont, NULL);
339  return GNUNET_SYSERR;
340  }
342  GNUNET_CRYPTO_hash (ndata, nsize, &nkey);
343  GNUNET_CRYPTO_hash_to_aes_key (&nkey, &skey, &iv);
344  GNUNET_CRYPTO_symmetric_encrypt (ndata, nsize, &skey, &iv, edata);
345  GNUNET_CRYPTO_hash (edata, nsize, &query);
346  if (0 != memcmp (&query, key, sizeof(struct GNUNET_HashCode)))
347  {
349  _ ("Indexed file `%s' changed at offset %llu\n"),
350  fn,
351  (unsigned long long) off);
352  GNUNET_DATASTORE_remove (dsh, key, size, data, -1, -1, &remove_cont, NULL);
353  return GNUNET_SYSERR;
354  }
356  "On-demand encoded block for query `%s'\n",
357  GNUNET_h2s (key));
358  cont (cont_cls,
359  key,
360  nsize,
361  edata,
363  priority,
364  anonymity,
365  replication,
366  expiration,
367  uid);
368  return GNUNET_OK;
369 }
370 
371 
377 void
379 {
380  struct GNUNET_MQ_Envelope *env;
381  struct IndexInfoMessage *iim;
382  struct GNUNET_MessageHeader *iem;
383  size_t slen;
384  const char *fn;
385  struct IndexInfo *pos;
386 
387  for (pos = indexed_files_head; NULL != pos; pos = pos->next)
388  {
389  fn = pos->filename;
390  slen = strlen (fn) + 1;
391  if (slen + sizeof(struct IndexInfoMessage) >= GNUNET_MAX_MESSAGE_SIZE)
392  {
393  GNUNET_break (0);
394  break;
395  }
396  env =
398  iim->reserved = 0;
399  iim->file_id = pos->file_id;
400  GNUNET_memcpy (&iim[1], fn, slen);
401  GNUNET_MQ_send (mq, env);
402  }
404  GNUNET_MQ_send (mq, env);
405 }
406 
407 
414 int
416 {
417  struct IndexInfo *pos;
418 
419  for (pos = indexed_files_head; NULL != pos; pos = pos->next)
420  {
421  if (0 == memcmp (&pos->file_id, fid, sizeof(struct GNUNET_HashCode)))
422  {
423  GNUNET_CONTAINER_DLL_remove (indexed_files_head, indexed_files_tail, pos);
424  GNUNET_break (
425  GNUNET_OK ==
427  GNUNET_free (pos);
428  write_index_list ();
429  return GNUNET_YES;
430  }
431  }
432  return GNUNET_NO;
433 }
434 
435 
442 void
444  const struct GNUNET_HashCode *file_id)
445 {
446  struct IndexInfo *ii;
447  size_t slen;
448 
449  ii = GNUNET_CONTAINER_multihashmap_get (ifm, file_id);
450  if (NULL != ii)
451  {
452  GNUNET_log (
454  _ (
455  "Index request received for file `%s' is already indexed as `%s'. Permitting anyway.\n"),
456  filename,
457  ii->filename);
458  return;
459  }
461  "Adding file %s to index as %s\n",
462  filename,
463  GNUNET_h2s (file_id));
464  slen = strlen (filename) + 1;
465  ii = GNUNET_malloc (sizeof(struct IndexInfo) + slen);
466  ii->file_id = *file_id;
467  ii->filename = (const char *) &ii[1];
468  GNUNET_memcpy (&ii[1], filename, slen);
469  GNUNET_CONTAINER_DLL_insert (indexed_files_head, indexed_files_tail, ii);
472  ifm,
473  &ii->file_id,
474  ii,
476  write_index_list ();
477 }
478 
479 
483 void
485 {
486  struct IndexInfo *pos;
487 
488  while (NULL != (pos = indexed_files_head))
489  {
490  GNUNET_CONTAINER_DLL_remove (indexed_files_head, indexed_files_tail, pos);
491  if (pos->fhc != NULL)
493  GNUNET_break (
494  GNUNET_OK ==
496  GNUNET_free (pos);
497  }
499  ifm = NULL;
500  cfg = NULL;
501 }
502 
503 
510 int
512  struct GNUNET_DATASTORE_Handle *d)
513 {
514  cfg = c;
515  dsh = d;
517  read_index_list ();
518  return GNUNET_OK;
519 }
520 
521 
522 /* end of gnunet-service-fs_indexing.c */
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
int GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory)...
Definition: disk.c:544
static struct GNUNET_TIME_Absolute min_expiration
Minimum time that content should have to not be discarded instantly (time stamp of any content that w...
Open the file for reading.
int GNUNET_FS_indexing_do_unindex(const struct GNUNET_HashCode *fid)
Remove a file from the index.
struct IndexInfo * next
This is a doubly linked list.
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
struct GNUNET_HashCode file_id
Hash of the contents of the file.
int GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1280
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
struct GNUNET_SERVER_TransmitContext * tc
Context for transmitting confirmation to client, NULL if we&#39;ve done this already. ...
static void remove_cont(void *cls, int success, struct GNUNET_TIME_Absolute min_expiration, const char *msg)
Continuation called from datastore&#39;s remove function.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
ssize_t GNUNET_DISK_file_read(const struct GNUNET_DISK_FileHandle *h, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:732
struct GNUNET_BIO_ReadHandle * GNUNET_BIO_read_open_file(const char *fn)
Open a file for reading.
Definition: bio.c:119
void GNUNET_FS_indexing_done()
Shutdown the module.
static struct GNUNET_CONTAINER_MultiHashMap * ifm
Maps hash over content of indexed files to the respective &#39;struct IndexInfo&#39;.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
const char * filename
Name of the indexed file.
static unsigned int replication
definitions for the entire fs module
Nobody is allowed to do anything to the file.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:67
struct GNUNET_STATISTICS_Handle * GSF_stats
Handle for reporting statistics.
shared data structures of gnunet-service-fs.c
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
Message send by FS service in response to a request asking for a list of all indexed files...
Definition: fs.h:195
static struct IndexInfo * indexed_files_head
Head of linked list of indexed files.
off_t GNUNET_DISK_file_seek(const struct GNUNET_DISK_FileHandle *h, off_t offset, enum GNUNET_DISK_Seek whence)
Move the read/write pointer in a file.
Definition: disk.c:226
void GNUNET_STATISTICS_update(struct GNUNET_STATISTICS_Handle *handle, const char *name, int64_t delta, int make_persistent)
Set statistic value for the peer.
struct GNUNET_HashCode file_id
Hash of the indexed file.
Definition: fs.h:211
Internal representation of the hash map.
int GNUNET_BIO_read_close(struct GNUNET_BIO_ReadHandle *h, char **emsg)
Close an open handle.
Definition: bio.c:166
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
int GNUNET_FS_indexing_init(const struct GNUNET_CONFIGURATION_Handle *c, struct GNUNET_DATASTORE_Handle *d)
Initialize the indexing submodule.
void GNUNET_FS_indexing_send_list(struct GNUNET_MQ_Handle *mq)
Transmit information about indexed files to mq.
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.
#define _(String)
GNU gettext support macro.
Definition: platform.h:184
#define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY
Reply to client with an indexed file name.
int GNUNET_BIO_read(struct GNUNET_BIO_ReadHandle *h, const char *what, void *result, size_t len)
Read some contents into a buffer.
Definition: bio.c:287
#define GNUNET_MQ_msg_extra(mvar, esize, type)
Allocate an envelope, with extra space allocated after the space needed by the message struct...
Definition: gnunet_mq_lib.h:52
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
static char * fn
Filename of the unique file.
static void write_index_list()
Write the current index information list to disk.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:48
ssize_t GNUNET_CRYPTO_symmetric_encrypt(const void *block, size_t size, const struct GNUNET_CRYPTO_SymmetricSessionKey *sessionkey, const struct GNUNET_CRYPTO_SymmetricInitializationVector *iv, void *result)
Encrypt a block using a symmetric sessionkey.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
void(* GNUNET_DATASTORE_DatumProcessor)(void *cls, const struct GNUNET_HashCode *key, size_t size, const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority, uint32_t anonymity, uint32_t replication, struct GNUNET_TIME_Absolute expiration, uint64_t uid)
Process a datum that was stored in the datastore.
int GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.
static int fh
Handle to the unique file.
Handle for buffered writing.
Definition: bio.c:515
struct GNUNET_DATASTORE_QueueEntry * GNUNET_DATASTORE_remove(struct GNUNET_DATASTORE_Handle *h, const struct GNUNET_HashCode *key, size_t size, const void *data, unsigned int queue_priority, unsigned int max_queue_size, GNUNET_DATASTORE_ContinuationWithStatus cont, void *cont_cls)
Explicitly remove some content from the database.
void GNUNET_CRYPTO_hash_file_cancel(struct GNUNET_CRYPTO_FileHashContext *fhc)
Cancel a file hashing operation.
A 512-bit hashcode.
static char * expiration
Credential TTL.
Definition: gnunet-abd.c:96
In-memory information about indexed files (also available on-disk).
int GNUNET_BIO_read_string(struct GNUNET_BIO_ReadHandle *h, const char *what, char **result, size_t max_length)
Read 0-terminated string.
Definition: bio.c:326
void GNUNET_CRYPTO_hash_to_aes_key(const struct GNUNET_HashCode *hc, struct GNUNET_CRYPTO_SymmetricSessionKey *skey, struct GNUNET_CRYPTO_SymmetricInitializationVector *iv)
Convert a hashcode into a key.
Definition: crypto_hash.c:222
#define DBLOCK_SIZE
Size of the individual blocks used for file-sharing.
Definition: fs.h:40
struct GNUNET_BIO_WriteHandle * GNUNET_BIO_write_open_file(const char *fn)
Open a file for writing.
Definition: bio.c:558
There must only be one value per key; storing a value should fail if a value under the same key alrea...
struct GNUNET_HashCode key
The key used in the DHT.
static unsigned int size
Size of the "table".
Definition: peer.c:67
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
struct GNUNET_HashCode file_id
Hash code of the entire content of the file that was indexed (used to uniquely identify the plaintext...
Definition: block_fs.h:88
int GNUNET_BIO_write_close(struct GNUNET_BIO_WriteHandle *h, char **emsg)
Close an IO handle.
Definition: bio.c:607
indexing for the file-sharing service
static struct GNUNET_TESTBED_BarrierWaitHandle * wh
Our barrier wait handle.
int GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
Context used when hashing a file.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
Handle to a message queue.
Definition: mq.c:85
#define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END
Reply to client indicating end of list.
static void read_index_list()
Read index information from disk.
Seek an absolute position (from the start of the file).
configuration data
Definition: configuration.c:84
int GNUNET_BIO_write_string(struct GNUNET_BIO_WriteHandle *h, const char *what, const char *s)
Write a 0-terminated string.
Definition: bio.c:831
Handle to the datastore service.
static struct GNUNET_DATASTORE_Handle * dsh
Datastore handle.
struct GNUNET_CRYPTO_FileHashContext * fhc
Context for hashing of the file.
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
#define GNUNET_log(kind,...)
uint64_t offset
At which offset should we be able to find this on-demand encoded block? (in NBO)
Definition: block_fs.h:94
int GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
Data block (leaf) in the CHK tree.
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
struct IndexInfo * prev
This is a doubly linked list.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
Header for all communications.
Time for absolute times used by GNUnet, in microseconds.
static unsigned int anonymity
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:355
static const struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
int GNUNET_FS_handle_on_demand_block(const struct GNUNET_HashCode *key, uint32_t size, const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority, uint32_t anonymity, uint32_t replication, struct GNUNET_TIME_Absolute expiration, uint64_t uid, GNUNET_DATASTORE_DatumProcessor cont, void *cont_cls)
We&#39;ve received an on-demand encoded block from the datastore.
uint32_t reserved
Always zero.
Definition: fs.h:206
uint32_t data
The data value.
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1203
int GNUNET_BIO_write(struct GNUNET_BIO_WriteHandle *h, const char *what, const void *buffer, size_t n)
Write a buffer to a handle.
Definition: bio.c:794
Handle used to access files (and pipes).
#define GNUNET_malloc(size)
Wrapper around malloc.
Handle for buffered reading.
Definition: bio.c:73
void GNUNET_FS_add_to_index(const char *filename, const struct GNUNET_HashCode *file_id)
Add the given file to the list of indexed files.
uint64_t GNUNET_ntohll(uint64_t n)
Convert unsigned 64-bit integer to host byte order.
Definition: common_endian.c:53
index block (indexing a DBlock that can be obtained directly from reading the plaintext file) ...
Definition: block_fs.h:81
#define GNUNET_free(ptr)
Wrapper around free.
#define gettext_noop(String)
Definition: gettext.h:69
static struct IndexInfo * indexed_files_tail
Tail of linked list of indexed files.