/*
This file is part of GNUnet.
- (C) 2009, 2010, 2011, 2012, 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2010, 2011, 2012, 2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
-
/**
* @file scalarproduct.h
- * @brief Scalar Product Message Types
+ * @brief Scalar Product API Message Types
* @author Christian M. Fuchs
- *
- * Created on September 2, 2013, 3:43 PM
*/
-
#ifndef SCALARPRODUCT_H
#define SCALARPRODUCT_H
-#ifdef __cplusplus
-extern "C"
-{
-#endif
-///////////////////////////////////////////////////////////////////////////////
-// Defines
-///////////////////////////////////////////////////////////////////////////////
-
-/**
- * Maximum count of elements we can put into a multipart message
- */
-#define MULTIPART_ELEMENT_CAPACITY ((GNUNET_SERVER_MAX_MESSAGE_SIZE - 1 - sizeof (struct GNUNET_SCALARPRODUCT_multipart_message)) / sizeof (struct GNUNET_CRYPTO_PaillierCiphertext))
+GNUNET_NETWORK_STRUCT_BEGIN
/**
* Log an error message at log-level 'level' that indicates
*/
#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)
-///////////////////////////////////////////////////////////////////////////////
-// Scalar Product Message Types
-///////////////////////////////////////////////////////////////////////////////
/**
* Message type passed from client to service
* to initiate a request or responder role
*/
-struct GNUNET_SCALARPRODUCT_client_request
+struct AliceComputationMessage
{
/**
- * GNUNET message header
+ * GNUNET message header with type
+ * #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE
*/
struct GNUNET_MessageHeader header;
/**
* how many elements the vector in payload contains
*/
- uint32_t element_count GNUNET_PACKED;
+ uint32_t element_count_total GNUNET_PACKED;
/**
- * how many bytes the mask has
+ * contained elements the vector in payload contains
*/
- uint32_t mask_length GNUNET_PACKED;
+ uint32_t element_count_contained GNUNET_PACKED;
+
+ /**
+ * Always zero.
+ */
+ uint32_t reserved GNUNET_PACKED;
/**
* the transaction/session key used to identify a session
*/
- struct GNUNET_HashCode key;
+ struct GNUNET_HashCode session_key;
/**
* the identity of a remote peer we want to communicate with
struct GNUNET_PeerIdentity peer;
/**
- * followed by long vector[element_count] | [unsigned char mask[mask_bytes]]
+ * followed by struct GNUNET_SCALARPRODUCT_Element[]
*/
};
+
/**
- * Message type passed from requesting service Alice to responding service Bob
- * to initiate a request and make bob participate in our protocol
+ * Message type passed from client to service
+ * to initiate a request or responder role
*/
-struct GNUNET_SCALARPRODUCT_service_request {
+struct BobComputationMessage
+{
/**
- * GNUNET message header
+ * GNUNET message header with type
+ * #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB
*/
struct GNUNET_MessageHeader header;
/**
- * how many elements the total message including all multipart msgs contains
- */
- uint32_t total_element_count GNUNET_PACKED;
-
- /**
- * how many elements are actually included after the mask was applied.
+ * how many elements the vector in payload contains
*/
- uint32_t contained_element_count GNUNET_PACKED;
+ uint32_t element_count_total GNUNET_PACKED;
/**
- * how many bytes the mask has
+ * contained elements the vector in payload contains
*/
- uint32_t mask_length GNUNET_PACKED;
+ uint32_t element_count_contained GNUNET_PACKED;
/**
- * the transaction/session key used to identify a session
+ * Always zero.
*/
- struct GNUNET_HashCode key;
+ uint32_t reserved GNUNET_PACKED;
/**
- * how many elements the vector in payload contains
+ * the transaction/session key used to identify a session
*/
- uint32_t element_count GNUNET_PACKED;
+ struct GNUNET_HashCode session_key;
/**
- * followed by mask | public_key | vector[used_element_count]
+ * followed by struct GNUNET_SCALARPRODUCT_Element[]
*/
};
-/**
- * Multipart Message type passed between to supply additional elements for the peer
- */
-struct GNUNET_SCALARPRODUCT_multipart_message {
- /**
- * GNUNET message header
- */
- struct GNUNET_MessageHeader header;
-
- /**
- * how many elements we supply within this message
- */
- uint32_t multipart_element_count GNUNET_PACKED;
-
- // followed by vector[multipart_element_count] or k[i][perm]
-};
/**
- * Message type passed from responding service Bob to responding service Alice
- * to complete a request and allow Alice to compute the result
+ * multipart messages following `struct ComputationMessage`
*/
-struct GNUNET_SCALARPRODUCT_service_response {
+struct ComputationBobCryptodataMultipartMessage
+{
/**
* GNUNET message header
*/
struct GNUNET_MessageHeader header;
/**
- * how many elements the session input had
+ * contained elements the vector in payload contains
*/
- uint32_t total_element_count GNUNET_PACKED;
+ uint32_t element_count_contained GNUNET_PACKED;
/**
- * how many elements were included after the mask was applied including all multipart msgs.
- */
- uint32_t used_element_count GNUNET_PACKED;
-
- /**
- * how many elements this individual message delivers
- */
- uint32_t contained_element_count GNUNET_PACKED;
-
- /**
- * the transaction/session key used to identify a session
- */
- struct GNUNET_HashCode key;
-
- /**
- * followed by s | s' | k[i][perm]
+ * followed by struct GNUNET_SCALARPRODUCT_Element[]
*/
};
+
/**
* Message type passed from service client
* to finalize a session as requester or responder
*/
-struct GNUNET_SCALARPRODUCT_client_response
+struct ClientResponseMessage
{
/**
* GNUNET message header
uint32_t product_length GNUNET_PACKED;
/**
- * the transaction/session key used to identify a session
- */
- struct GNUNET_HashCode key;
-
- /**
- * the identity of a remote peer we want to communicate with
+ * Status information about the outcome of this session,
+ * An `enum GNUNET_SCALARPRODUCT_ResponseStatus` (in NBO).
*/
- struct GNUNET_PeerIdentity peer;
+ uint32_t status GNUNET_PACKED;
/**
* Workaround for libgcrypt: -1 if negative, 0 if zero, else 1
*/
- int8_t range;
+ int32_t range GNUNET_PACKED;
/**
* followed by product of length product_length (or nothing)
*/
};
-#ifdef __cplusplus
-}
-#endif
+GNUNET_NETWORK_STRUCT_END
#endif /* SCALARPRODUCT_H */
-