src/namecache/namecache.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011-2013 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
  21 /**
  22  * @file namecache/namecache.h
  23  * @brief common internal definitions for namecache service
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef NAMECACHE_H
  28 #define NAMECACHE_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 namecache message with op id
  39  */
  40 struct GNUNET_NAMECACHE_Header {
  41   /**
  42    * header.type will be GNUNET_MESSAGE_TYPE_NAMECACHE_*
  43    * header.size will be message size
  44    */
  45   struct GNUNET_MessageHeader header;
  46
  47   /**
  48    * Request ID in NBO
  49    */
  50   uint32_t r_id GNUNET_PACKED;
  51 };
  52
  53
  54 /**
  55  * Lookup a block in the namecache
  56  */
  57 struct LookupBlockMessage {
  58   /**
  59    * Type will be #GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK
  60    */
  61   struct GNUNET_NAMECACHE_Header gns_header;
  62
  63   /**
  64    * The query.
  65    */
  66   struct GNUNET_HashCode query GNUNET_PACKED;
  67 };
  68
  69
  70 /**
  71  * Lookup response
  72  */
  73 struct LookupBlockResponseMessage {
  74   /**
  75    * Type will be #GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK_RESPONSE
  76    */
  77   struct GNUNET_NAMECACHE_Header gns_header;
  78
  79   /**
  80    * Expiration time
  81    */
  82   struct GNUNET_TIME_AbsoluteNBO expire;
  83
  84   /**
  85    * Signature.
  86    */
  87   struct GNUNET_CRYPTO_EcdsaSignature signature;
  88
  89   /**
  90    * Derived public key.
  91    */
  92   struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
  93
  94   /* follwed by encrypted block data */
  95 };
  96
  97
  98 /**
  99  * Cache a record in the namecache.
 100  */
 101 struct BlockCacheMessage {
 102   /**
 103    * Type will be #GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE
 104    */
 105   struct GNUNET_NAMECACHE_Header gns_header;
 106
 107   /**
 108    * Expiration time
 109    */
 110   struct GNUNET_TIME_AbsoluteNBO expire;
 111
 112   /**
 113    * Signature.
 114    */
 115   struct GNUNET_CRYPTO_EcdsaSignature signature;
 116
 117   /**
 118    * Derived public key.
 119    */
 120   struct GNUNET_CRYPTO_EcdsaPublicKey derived_key;
 121
 122   /* follwed by encrypted block data */
 123 };
 124
 125
 126 /**
 127  * Response to a request to cache a block.
 128  */
 129 struct BlockCacheResponseMessage {
 130   /**
 131    * Type will be #GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE_RESPONSE
 132    */
 133   struct GNUNET_NAMECACHE_Header gns_header;
 134
 135   /**
 136    * #GNUNET_OK on success, #GNUNET_SYSERR error
 137    */
 138   int32_t op_result GNUNET_PACKED;
 139 };
 140
 141
 142 GNUNET_NETWORK_STRUCT_END
 143
 144
 145 /* end of namecache.h */
 146 #endif