summaryrefslogtreecommitdiff
path: root/src/scalarproduct/scalarproduct.h
blob: f2311cda05f56650e703932f4522cc46a19fdaec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
     This file is part of GNUnet.
     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 Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.

     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.

     SPDX-License-Identifier: AGPL3.0-or-later
 */
/**
 * @file   scalarproduct.h
 * @brief  Scalar Product API Message Types
 * @author Christian M. Fuchs
 */
#ifndef SCALARPRODUCT_H
#define SCALARPRODUCT_H

GNUNET_NETWORK_STRUCT_BEGIN

/**
 * Log an error message at log-level 'level' that indicates
 * a failure of the command 'cmd' with the message given
 * by gcry_strerror(rc).
 */
#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)


/**
 * Message type passed from client to service
 * to initiate a request or responder role
 */
struct AliceComputationMessage
{
  /**
   * 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_total GNUNET_PACKED;

  /**
   * contained elements the vector in payload contains
   */
  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 session_key;

  /**
   * the identity of a remote peer we want to communicate with
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * followed by struct GNUNET_SCALARPRODUCT_Element[]
   */
};


/**
 * Message type passed from client to service
 * to initiate a request or responder role
 */
struct BobComputationMessage
{
  /**
   * GNUNET message header with type
   * #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB
   */
  struct GNUNET_MessageHeader header;

  /**
   * how many elements the vector in payload contains
   */
  uint32_t element_count_total GNUNET_PACKED;

  /**
   * contained elements the vector in payload contains
   */
  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 session_key;

  /**
   * followed by struct GNUNET_SCALARPRODUCT_Element[]
   */
};


/**
 * multipart messages following `struct ComputationMessage`
 */
struct ComputationBobCryptodataMultipartMessage
{
  /**
   * GNUNET message header
   */
  struct GNUNET_MessageHeader header;

  /**
   * contained elements the vector in payload contains
   */
  uint32_t element_count_contained GNUNET_PACKED;

  /**
   * followed by struct GNUNET_SCALARPRODUCT_Element[]
   */
};


/**
 * Message type passed from service client
 * to finalize a session as requester or responder
 */
struct ClientResponseMessage
{
  /**
   * GNUNET message header
   */
  struct GNUNET_MessageHeader header;

  /**
   * 0 if no product attached
   */
  uint32_t product_length GNUNET_PACKED;

  /**
   * Status information about the outcome of this session,
   * An `enum GNUNET_SCALARPRODUCT_ResponseStatus` (in NBO).
   */
  uint32_t status GNUNET_PACKED;

  /**
   * Workaround for libgcrypt: -1 if negative, 0 if zero, else 1
   */
  int32_t range GNUNET_PACKED;

  /**
   * followed by product of length product_length (or nothing)
   */
};

GNUNET_NETWORK_STRUCT_END

#endif  /* SCALARPRODUCT_H */