src/namestore/namestore.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011-2013 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 namestore/namestore.h
  23  * @brief common internal definitions for namestore service
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef NAMESTORE_H
  28 #define NAMESTORE_H
  29
  30 /**
  31  * Maximum length of any name, including 0-termination.
  32  */
  33 #define MAX_NAME_LEN 256
  34
  35 GNUNET_NETWORK_STRUCT_BEGIN
  36
  37 /**
  38  * Generic namestore message with op id
  39  */
  40 struct GNUNET_NAMESTORE_Header
  41 {
  42   /**
  43    * header.type will be GNUNET_MESSAGE_TYPE_NAMESTORE_*
  44    * header.size will be message size
  45    */
  46   struct GNUNET_MessageHeader header;
  47
  48   /**
  49    * Request ID in NBO
  50    */
  51   uint32_t r_id;
  52 };
  53
  54
  55 /**
  56  * Lookup a block in the namestore
  57  */
  58 struct LookupBlockMessage
  59 {
  60   /**
  61    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK
  62    */
  63   struct GNUNET_NAMESTORE_Header gns_header;
  64
  65   /**
  66    * The query.
  67    */
  68   struct GNUNET_HashCode query;
  69
  70 };
  71
  72
  73 /**
  74  * Lookup response
  75  */
  76 struct LookupBlockResponseMessage
  77 {
  78   /**
  79    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_BLOCK_RESPONSE
  80    */
  81   struct GNUNET_NAMESTORE_Header gns_header;
  82
  83   /**
  84    * Expiration time
  85    */
  86   struct GNUNET_TIME_AbsoluteNBO expire;
  87
  88   /**
  89    * Signature.
  90    */
  91   struct GNUNET_CRYPTO_EccSignature signature;
  92
  93   /**
  94    * Derived public key.
  95    */
  96   struct GNUNET_CRYPTO_EccPublicKey derived_key;
  97
  98   /* follwed by encrypted block data */
  99 };
 100
 101
 102 /**
 103  * Cache a record in the namestore.
 104  */
 105 struct BlockCacheMessage
 106 {
 107   /**
 108    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE
 109    */
 110   struct GNUNET_NAMESTORE_Header gns_header;
 111
 112   /**
 113    * Expiration time
 114    */
 115   struct GNUNET_TIME_AbsoluteNBO expire;
 116
 117   /**
 118    * Signature.
 119    */
 120   struct GNUNET_CRYPTO_EccSignature signature;
 121
 122   /**
 123    * Derived public key.
 124    */
 125   struct GNUNET_CRYPTO_EccPublicKey derived_key;
 126
 127   /* follwed by encrypted block data */
 128 };
 129
 130
 131 /**
 132  * Response to a request to cache a block.
 133  */
 134 struct BlockCacheResponseMessage
 135 {
 136   /**
 137    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_BLOCK_CACHE_RESPONSE
 138    */
 139   struct GNUNET_NAMESTORE_Header gns_header;
 140
 141   /**
 142    *  name length: GNUNET_NO already exists, GNUNET_YES on success, GNUNET_SYSERR error
 143    */
 144   int32_t op_result;
 145 };
 146
 147
 148 /**
 149  * Store a record to the namestore (as authority).
 150  */
 151 struct RecordStoreMessage
 152 {
 153   /**
 154    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_LOOKUP_RECORD_STORE
 155    */
 156   struct GNUNET_NAMESTORE_Header gns_header;
 157
 158   /**
 159    * Expiration time
 160    */
 161   struct GNUNET_TIME_AbsoluteNBO expire;
 162
 163   /**
 164    * Name length
 165    */
 166   uint16_t name_len;
 167
 168   /**
 169    * Length of serialized record data
 170    */
 171   uint16_t rd_len;
 172
 173   /**
 174    * Number of records contained
 175    */
 176   uint16_t rd_count;
 177
 178   /**
 179    * always zero (for alignment)
 180    */
 181   uint16_t reserved;
 182
 183   /**
 184    * The private key of the authority.
 185    */
 186   struct GNUNET_CRYPTO_EccPrivateKey private_key;
 187
 188   /* followed by:
 189    * name with length name_len
 190    * serialized record data with rd_count records
 191    */
 192 };
 193
 194
 195 /**
 196  * Response to a record storage request.
 197  */
 198 struct RecordStoreResponseMessage
 199 {
 200   /**
 201    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_STORE_RESPONSE
 202    */
 203   struct GNUNET_NAMESTORE_Header gns_header;
 204
 205   /**
 206    * result:
 207    * GNUNET_SYSERR on failure
 208    * GNUNET_OK on success
 209    */
 210   int32_t op_result;
 211 };
 212
 213
 214
 215 /**
 216  * Lookup a name for a zone hash
 217  */
 218 struct ZoneToNameMessage
 219 {
 220   /**
 221    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
 222    */
 223   struct GNUNET_NAMESTORE_Header gns_header;
 224
 225   /**
 226    * The private key of the zone to look up in
 227    */
 228   struct GNUNET_CRYPTO_EccPrivateKey zone;
 229
 230   /**
 231    * The public key of the target zone
 232    */
 233   struct GNUNET_CRYPTO_EccPublicKey value_zone;
 234 };
 235
 236
 237 /**
 238  * Respone for zone to name lookup
 239  */
 240 struct ZoneToNameResponseMessage
 241 {
 242   /**
 243    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
 244    */
 245   struct GNUNET_NAMESTORE_Header gns_header;
 246
 247   /**
 248    * Length of the name
 249    */
 250   uint16_t name_len;
 251
 252   /**
 253    * Length of serialized record data
 254    */
 255   uint16_t rd_len;
 256
 257   /**
 258    * Number of records contained
 259    */
 260   uint16_t rd_count;
 261
 262   /**
 263    * result in NBO: GNUNET_OK on success, GNUNET_NO if there were no
 264    * results, GNUNET_SYSERR on error
 265    */
 266   int16_t res;
 267
 268   /**
 269    * The private key of the zone that contained the name.
 270    */
 271   struct GNUNET_CRYPTO_EccPrivateKey zone;
 272
 273   /* followed by:
 274    * name with length name_len
 275    * serialized record data with rd_count records
 276    */
 277
 278 };
 279
 280
 281 /**
 282  * Record is returned from the namestore (as authority).
 283  */
 284 struct RecordResultMessage
 285 {
 286   /**
 287    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
 288    */
 289   struct GNUNET_NAMESTORE_Header gns_header;
 290
 291   /**
 292    * Name length
 293    */
 294   uint16_t name_len;
 295
 296   /**
 297    * Length of serialized record data
 298    */
 299   uint16_t rd_len;
 300
 301   /**
 302    * Number of records contained
 303    */
 304   uint16_t rd_count;
 305
 306   /**
 307    * always zero (for alignment)
 308    */
 309   uint16_t reserved;
 310
 311   /**
 312    * The private key of the authority.
 313    */
 314   struct GNUNET_CRYPTO_EccPrivateKey private_key;
 315
 316   /* followed by:
 317    * name with length name_len
 318    * serialized record data with rd_count records
 319    */
 320 };
 321
 322
 323 /**
 324  * Start monitoring a zone.
 325  */
 326 struct ZoneMonitorStartMessage
 327 {
 328   /**
 329    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
 330    */
 331   struct GNUNET_NAMESTORE_Header gns_header;
 332
 333   /**
 334    * Zone key.
 335    */
 336   struct GNUNET_CRYPTO_EccPrivateKey zone;
 337
 338 };
 339
 340
 341 /**
 342  * Start a zone iteration for the given zone
 343  */
 344 struct ZoneIterationStartMessage
 345 {
 346   /**
 347    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
 348    */
 349   struct GNUNET_NAMESTORE_Header gns_header;
 350
 351   /**
 352    * Zone key.
 353    */
 354   struct GNUNET_CRYPTO_EccPrivateKey zone;
 355
 356 };
 357
 358
 359 /**
 360  * Ask for next result of zone iteration for the given operation
 361  */
 362 struct ZoneIterationNextMessage
 363 {
 364   /**
 365    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
 366    */
 367   struct GNUNET_NAMESTORE_Header gns_header;
 368 };
 369
 370
 371 /**
 372  * Stop zone iteration for the given operation
 373  */
 374 struct ZoneIterationStopMessage
 375 {
 376   /**
 377    * Type will be GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
 378    */
 379   struct GNUNET_NAMESTORE_Header gns_header;
 380 };
 381
 382
 383 GNUNET_NETWORK_STRUCT_END
 384
 385
 386 /* end of namestore.h */
 387 #endif