src/scalarproduct/scalarproduct.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011, 2012, 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   scalarproduct.h
  23  * @brief  Scalar Product Message Types
  24  * @author Christian M. Fuchs
  25  *
  26  * Created on September 2, 2013, 3:43 PM
  27  */
  28
  29 #ifndef SCALARPRODUCT_H
  30 #define SCALARPRODUCT_H
  31
  32 #ifdef  __cplusplus
  33 extern "C"
  34 {
  35 #endif
  36 ///////////////////////////////////////////////////////////////////////////////
  37 //                      Defines
  38 ///////////////////////////////////////////////////////////////////////////////
  39 /**
  40  * Length of the key used for encryption
  41  */
  42 #define KEYBITS 2048
  43
  44 /**
  45  * When performing our crypto, we may add two encrypted values with each
  46  * a maximal length of GNUNET_CRYPTO_RSA_DATA_ENCODING_LENGTH.
  47  * thus we can receive a slightly longer element (+1 byte)
  48  */
  49 #define PAILLIER_ELEMENT_LENGTH (2*KEYBITS/8 +1)
  50
  51 /**
  52  * Log an error message at log-level 'level' that indicates
  53  * a failure of the command 'cmd' with the message given
  54  * by gcry_strerror(rc).
  55  */
  56 #define LOG_GCRY(level, cmd, rc) do { LOG(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, gcry_strerror(rc)); } while(0)
  57
  58 ///////////////////////////////////////////////////////////////////////////////
  59 //                     Scalar Product Message Types
  60 ///////////////////////////////////////////////////////////////////////////////
  61
  62 /**
  63  * Message type passed from client to service
  64  * to initiate a request or responder role
  65  */
  66 struct GNUNET_SCALARPRODUCT_client_request
  67 {
  68   /**
  69    * GNUNET message header
  70    */
  71   struct GNUNET_MessageHeader header;
  72
  73   /**
  74    * how many elements the vector in payload contains
  75    */
  76   uint32_t element_count GNUNET_PACKED;
  77
  78   /**
  79    * how many bytes the mask has
  80    */
  81   uint32_t mask_length GNUNET_PACKED;
  82
  83   /**
  84    * the transaction/session key used to identify a session
  85    */
  86   struct GNUNET_HashCode key;
  87
  88   /**
  89    * the identity of a remote peer we want to communicate with
  90    */
  91   struct GNUNET_PeerIdentity peer;
  92
  93   /**
  94    * followed by long vector[element_count] | [unsigned char mask[mask_bytes]]
  95    */
  96 };
  97
  98 /**
  99  * Message type passed from requesting service Alice to responding service Bob
 100  * to initiate a request and make bob participate in our protocol
 101  */
 102 struct GNUNET_SCALARPRODUCT_service_request {
 103   /**
 104    * GNUNET message header
 105    */
 106   struct GNUNET_MessageHeader header;
 107
 108   /**
 109    * how many elements the total message including all multipart msgs contains
 110    */
 111   uint32_t total_element_count GNUNET_PACKED;
 112
 113     /**
 114    * how many elements are actually included after the mask was applied.
 115    */
 116   uint32_t contained_element_count GNUNET_PACKED;
 117
 118   /**
 119    * how many bytes the mask has
 120    */
 121   uint32_t mask_length GNUNET_PACKED;
 122
 123   /**
 124    * the length of the publickey contained within this message
 125    */
 126   uint32_t pk_length GNUNET_PACKED;
 127
 128   /**
 129    * the transaction/session key used to identify a session
 130    */
 131   struct GNUNET_HashCode key;
 132
 133   /**
 134    * how many elements the vector in payload contains
 135    */
 136   uint32_t element_count GNUNET_PACKED;
 137
 138   /**
 139    * followed by mask | public_key | vector[used_element_count]
 140    */
 141 };
 142
 143 /**
 144  * Multipart Message type passed between to supply additional elements for the peer
 145  */
 146 struct GNUNET_SCALARPRODUCT_multipart_message {
 147   /**
 148    * GNUNET message header
 149    */
 150   struct GNUNET_MessageHeader header;
 151
 152   /**
 153    * how many elements we supply within this message
 154    */
 155   uint32_t multipart_element_count GNUNET_PACKED;
 156
 157   // followed by vector[multipart_element_count] or k[i][perm]
 158 };
 159
 160 /**
 161  * Message type passed from responding service Bob to responding service Alice
 162  * to complete a request and allow Alice to compute the result
 163  */
 164 struct GNUNET_SCALARPRODUCT_service_response {
 165   /**
 166    * GNUNET message header
 167    */
 168   struct GNUNET_MessageHeader header;
 169
 170   /**
 171    * how many elements the session input had
 172    */
 173   uint32_t total_element_count GNUNET_PACKED;
 174
 175   /**
 176    * how many elements were included after the mask was applied including all multipart msgs.
 177    */
 178   uint32_t used_element_count GNUNET_PACKED;
 179
 180   /**
 181    * how many elements this individual message delivers
 182    */
 183   uint32_t contained_element_count GNUNET_PACKED;
 184
 185   /**
 186    * the transaction/session key used to identify a session
 187    */
 188   struct GNUNET_HashCode key;
 189
 190   /**
 191    * followed by s | s' | k[i][perm]
 192    */
 193 };
 194
 195 /**
 196  * Message type passed from service client
 197  * to finalize a session as requester or responder
 198  */
 199 struct GNUNET_SCALARPRODUCT_client_response
 200 {
 201   /**
 202    * GNUNET message header
 203    */
 204   struct GNUNET_MessageHeader header;
 205
 206   /**
 207    * 0 if no product attached
 208    */
 209   uint32_t product_length GNUNET_PACKED;
 210
 211   /**
 212    * the transaction/session key used to identify a session
 213    */
 214   struct GNUNET_HashCode key;
 215
 216   /**
 217    * the identity of a remote peer we want to communicate with
 218    */
 219   struct GNUNET_PeerIdentity peer;
 220
 221   /**
 222    * Workaround for libgcrypt: -1 if negative, 0 if zero, else 1
 223    */
 224   int8_t range;
 225
 226   /**
 227    * followed by product of length product_length (or nothing)
 228    */
 229 };
 230
 231 #ifdef  __cplusplus
 232 }
 233 #endif
 234
 235 #endif  /* SCALARPRODUCT_H */
 236