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_EcdsaSignature signature;
  92
  93   /**
  94    * Derived public key.
  95    */
  96   struct GNUNET_CRYPTO_EcdsaPublicKey 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_EcdsaSignature signature;
 121
 122   /**
 123    * Derived public key.
 124    */
 125   struct GNUNET_CRYPTO_EcdsaPublicKey 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_EcdsaPrivateKey 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  * Lookup a label
 214  */
 215 struct LabelLookupMessage
 216 {
 217   /**
 218    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_LABEL_LOOKUP
 219    */
 220   struct GNUNET_NAMESTORE_Header gns_header;
 221
 222   /**
 223    * The private key of the zone to look up in
 224    */
 225   struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 226
 227   /**
 228    * Length of the name
 229    */
 230   uint16_t label_len GNUNET_PACKED;
 231
 232   /* followed by:
 233    * name with length name_len
 234    */
 235 };
 236
 237
 238
 239
 240 /**
 241  * Lookup a name for a zone hash
 242  */
 243 struct ZoneToNameMessage
 244 {
 245   /**
 246    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME
 247    */
 248   struct GNUNET_NAMESTORE_Header gns_header;
 249
 250   /**
 251    * The private key of the zone to look up in
 252    */
 253   struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 254
 255   /**
 256    * The public key of the target zone
 257    */
 258   struct GNUNET_CRYPTO_EcdsaPublicKey value_zone;
 259 };
 260
 261
 262 /**
 263  * Respone for zone to name lookup
 264  */
 265 struct ZoneToNameResponseMessage
 266 {
 267   /**
 268    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_TO_NAME_RESPONSE
 269    */
 270   struct GNUNET_NAMESTORE_Header gns_header;
 271
 272   /**
 273    * Length of the name
 274    */
 275   uint16_t name_len GNUNET_PACKED;
 276
 277   /**
 278    * Length of serialized record data
 279    */
 280   uint16_t rd_len GNUNET_PACKED;
 281
 282   /**
 283    * Number of records contained
 284    */
 285   uint16_t rd_count GNUNET_PACKED;
 286
 287   /**
 288    * result in NBO: #GNUNET_OK on success, #GNUNET_NO if there were no
 289    * results, #GNUNET_SYSERR on error
 290    */
 291   int16_t res GNUNET_PACKED;
 292
 293   /**
 294    * The private key of the zone that contained the name.
 295    */
 296   struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 297
 298   /* followed by:
 299    * name with length name_len
 300    * serialized record data with rd_count records
 301    */
 302
 303 };
 304
 305
 306 /**
 307  * Record is returned from the namestore (as authority).
 308  */
 309 struct RecordResultMessage
 310 {
 311   /**
 312    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_RECORD_RESULT
 313    */
 314   struct GNUNET_NAMESTORE_Header gns_header;
 315
 316   /**
 317    * Name length
 318    */
 319   uint16_t name_len GNUNET_PACKED;
 320
 321   /**
 322    * Length of serialized record data
 323    */
 324   uint16_t rd_len GNUNET_PACKED;
 325
 326   /**
 327    * Number of records contained
 328    */
 329   uint16_t rd_count GNUNET_PACKED;
 330
 331   /**
 332    * always zero (for alignment)
 333    */
 334   uint16_t reserved GNUNET_PACKED;
 335
 336   /**
 337    * The private key of the authority.
 338    */
 339   struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 340
 341   /* followed by:
 342    * name with length name_len
 343    * serialized record data with rd_count records
 344    */
 345 };
 346
 347
 348 /**
 349  * Start monitoring a zone.
 350  */
 351 struct ZoneMonitorStartMessage
 352 {
 353   /**
 354    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_MONITOR_START
 355    */
 356   struct GNUNET_NAMESTORE_Header gns_header;
 357
 358   /**
 359    * Zone key.
 360    */
 361   struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 362
 363 };
 364
 365
 366 /**
 367  * Start a zone iteration for the given zone
 368  */
 369 struct ZoneIterationStartMessage
 370 {
 371   /**
 372    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_START
 373    */
 374   struct GNUNET_NAMESTORE_Header gns_header;
 375
 376   /**
 377    * Zone key.  All zeros for "all zones".
 378    */
 379   struct GNUNET_CRYPTO_EcdsaPrivateKey zone;
 380
 381 };
 382
 383
 384 /**
 385  * Ask for next result of zone iteration for the given operation
 386  */
 387 struct ZoneIterationNextMessage
 388 {
 389   /**
 390    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT
 391    */
 392   struct GNUNET_NAMESTORE_Header gns_header;
 393 };
 394
 395
 396 /**
 397  * Stop zone iteration for the given operation
 398  */
 399 struct ZoneIterationStopMessage
 400 {
 401   /**
 402    * Type will be #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_STOP
 403    */
 404   struct GNUNET_NAMESTORE_Header gns_header;
 405 };
 406
 407
 408 GNUNET_NETWORK_STRUCT_END
 409
 410
 411 /* end of namestore.h */
 412 #endif