src/scalarproduct/gnunet-service-scalarproduct.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2013, 2014 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  * @file scalarproduct/gnunet-service-scalarproduct.h
  22  * @brief scalarproduct service  P2P messages
  23  * @author Christian M. Fuchs
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_SCALARPRODUCT_H
  27 #define GNUNET_SERVICE_SCALARPRODUCT_H
  28
  29
  30 GNUNET_NETWORK_STRUCT_BEGIN
  31
  32 /**
  33  * Message type passed from requesting service Alice to responding
  34  * service Bob to initiate a request and make Bob participate in our
  35  * protocol.  Afterwards, Bob is expected to perform the set
  36  * intersection with Alice. Once that has succeeded, Alice will
  37  * send a `struct AliceCryptodataMessage *`.  Bob is not expected
  38  * to respond via CADET in the meantime.
  39  */
  40 struct ServiceRequestMessage
  41 {
  42   /**
  43    * Type is #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_SESSION_INITIALIZATION
  44    */
  45   struct GNUNET_MessageHeader header;
  46
  47   /**
  48    * For alignment. Always zero.
  49    */
  50   uint32_t reserved;
  51
  52   /**
  53    * The transaction/session key used to identify a session
  54    */
  55   struct GNUNET_HashCode session_id;
  56
  57   /**
  58    * Alice's public key
  59    */
  60   struct GNUNET_CRYPTO_PaillierPublicKey public_key;
  61 };
  62
  63
  64 /**
  65  * Vector of Pallier-encrypted values sent by Alice to Bob
  66  * (after set intersection).  Alice may send messages of this
  67  * type repeatedly to transmit all values.
  68  */
  69 struct AliceCryptodataMessage
  70 {
  71   /**
  72    * Type is #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_ALICE_CRYPTODATA
  73    */
  74   struct GNUNET_MessageHeader header;
  75
  76   /**
  77    * How many elements we appended to this message? In NBO.
  78    */
  79   uint32_t contained_element_count GNUNET_PACKED;
  80
  81   /**
  82    * struct GNUNET_CRYPTO_PaillierCiphertext[contained_element_count]
  83    */
  84 };
  85
  86
  87 /**
  88  * Message type passed from responding service Bob to responding
  89  * service Alice to complete a request and allow Alice to compute the
  90  * result.  If Bob's reply does not fit into this one message, the
  91  * conversation may be continued with `struct BobCryptodataMultipartMessage`
  92  * messages afterwards.
  93  */
  94 struct BobCryptodataMessage
  95 {
  96   /**
  97    * GNUNET message header with type
  98    * #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_BOB_CRYPTODATA.
  99    */
 100   struct GNUNET_MessageHeader header;
 101
 102   /**
 103    * How many elements this individual message delivers (in NBO).
 104    */
 105   uint32_t contained_element_count GNUNET_PACKED;
 106
 107   /**
 108    * followed by s | s' | k[i][perm]
 109    */
 110 };
 111
 112
 113 /**
 114  * Multipart Message type passed between to supply additional elements
 115  * for the peer.  Send from Bob to Alice with additional elements
 116  * of k[i][perm] after his `struct BobCryptodataMessage *`.
 117  * Once all k-values have been transmitted, Bob is finished and
 118  * Alice can transmit the final result to the client.
 119  */
 120 struct BobCryptodataMultipartMessage
 121 {
 122   /**
 123    * GNUNET message header
 124    */
 125   struct GNUNET_MessageHeader header;
 126
 127   /**
 128    * How many elements we supply within this message? In NBO.
 129    */
 130   uint32_t contained_element_count GNUNET_PACKED;
 131
 132   /**
 133    * Followed by `struct
 134    * GNUNET_CRYPTO_PaillierCiphertext[contained_element_count]`
 135    */
 136 };
 137
 138
 139 GNUNET_NETWORK_STRUCT_END
 140
 141
 142 #endif