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 GNUNET_PACKED;
  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 GNUNET_PACKED;
  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_EccPublicSignKey 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_EccPublicSignKey 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    * #GNUNET_OK on success, #GNUNET_SYSERR error
 143    */
 144   int32_t op_result GNUNET_PACKED;
 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_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 GNUNET_PACKED;
 167
 168   /**
 169    * Length of serialized record data
 170    */
 171   uint16_t rd_len GNUNET_PACKED;
 172
 173   /**
 174    * Number of records contained
 175    */
 176   uint16_t rd_count GNUNET_PACKED;
 177
 178   /**
 179    * always zero (for alignment)
 180    */
 181   uint16_t reserved GNUNET_PACKED;
 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    * #GNUNET_SYSERR on failure, #GNUNET_OK on success
 207    */
 208   int32_t op_result GNUNET_PACKED;
 209 };
 210
 211
 212
 213 /**
 214  * Lookup a name for a zone hash
 215  */
 216 struct ZoneToNameMessage
 217 {
 218   /**
 219    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
 220    */
 221   struct GNUNET_NAMESTORE_Header gns_header;
 222
 223   /**
 224    * The private key of the zone to look up in
 225    */
 226   struct GNUNET_CRYPTO_EccPrivateKey zone;
 227
 228   /**
 229    * The public key of the target zone
 230    */
 231   struct GNUNET_CRYPTO_EccPublicSignKey value_zone;
 232 };
 233
 234
 235 /**
 236  * Respone for zone to name lookup
 237  */
 238 struct ZoneToNameResponseMessage
 239 {
 240   /**
 241    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
 242    */
 243   struct GNUNET_NAMESTORE_Header gns_header;
 244
 245   /**
 246    * Length of the name
 247    */
 248   uint16_t name_len GNUNET_PACKED;
 249
 250   /**
 251    * Length of serialized record data
 252    */
 253   uint16_t rd_len GNUNET_PACKED;
 254
 255   /**
 256    * Number of records contained
 257    */
 258   uint16_t rd_count GNUNET_PACKED;
 259
 260   /**
 261    * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no
 262    * results, #GNUNET_SYSERR on error
 263    */
 264   int16_t res GNUNET_PACKED;
 265
 266   /**
 267    * The private key of the zone that contained the name.
 268    */
 269   struct GNUNET_CRYPTO_EccPrivateKey zone;
 270
 271   /* followed by:
 272    * name with length name_len
 273    * serialized record data with rd_count records
 274    */
 275
 276 };
 277
 278
 279 /**
 280  * Record is returned from the namestore (as authority).
 281  */
 282 struct RecordResultMessage
 283 {
 284   /**
 285    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
 286    */
 287   struct GNUNET_NAMESTORE_Header gns_header;
 288
 289   /**
 290    * Name length
 291    */
 292   uint16_t name_len GNUNET_PACKED;
 293
 294   /**
 295    * Length of serialized record data
 296    */
 297   uint16_t rd_len GNUNET_PACKED;
 298
 299   /**
 300    * Number of records contained
 301    */
 302   uint16_t rd_count GNUNET_PACKED;
 303
 304   /**
 305    * always zero (for alignment)
 306    */
 307   uint16_t reserved GNUNET_PACKED;
 308
 309   /**
 310    * The private key of the authority.
 311    */
 312   struct GNUNET_CRYPTO_EccPrivateKey private_key;
 313
 314   /* followed by:
 315    * name with length name_len
 316    * serialized record data with rd_count records
 317    */
 318 };
 319
 320
 321 /**
 322  * Start monitoring a zone.
 323  */
 324 struct ZoneMonitorStartMessage
 325 {
 326   /**
 327    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
 328    */
 329   struct GNUNET_NAMESTORE_Header gns_header;
 330
 331   /**
 332    * Zone key.
 333    */
 334   struct GNUNET_CRYPTO_EccPrivateKey zone;
 335
 336 };
 337
 338
 339 /**
 340  * Start a zone iteration for the given zone
 341  */
 342 struct ZoneIterationStartMessage
 343 {
 344   /**
 345    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
 346    */
 347   struct GNUNET_NAMESTORE_Header gns_header;
 348
 349   /**
 350    * Zone key.  All zeros for "all zones".
 351    */
 352   struct GNUNET_CRYPTO_EccPrivateKey zone;
 353
 354 };
 355
 356
 357 /**
 358  * Ask for next result of zone iteration for the given operation
 359  */
 360 struct ZoneIterationNextMessage
 361 {
 362   /**
 363    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
 364    */
 365   struct GNUNET_NAMESTORE_Header gns_header;
 366 };
 367
 368
 369 /**
 370  * Stop zone iteration for the given operation
 371  */
 372 struct ZoneIterationStopMessage
 373 {
 374   /**
 375    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
 376    */
 377   struct GNUNET_NAMESTORE_Header gns_header;
 378 };
 379
 380
 381 GNUNET_NETWORK_STRUCT_END
 382
 383
 384 /* end of namestore.h */
 385 #endif