aboutsummaryrefslogtreecommitdiff
path: root/src/chat/chat.h
blob: 5df7773a7ccf33957c5e50f7ca6f993b9c07cfde (plain) (blame)
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
/*
     This file is part of GNUnet
     (C) 2008, 2011 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 2, 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
     General Public License for more details.

     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.
*/

/**
 * @file chat/chat.h
 * @brief support for chat
 * @author Christian Grothoff
 * @author Nathan Evans
 * @author Vitaly Minko
 */

#ifndef CHAT_H
#define CHAT_H

#include "gnunet_chat_service.h"

/**
 * Constant IV since we generate a new session key per each message.
 */
#define INITVALUE "InitializationVectorValue"


/**
 * Client-service messages
 */

GNUNET_NETWORK_STRUCT_BEGIN

/**
 * Notification sent by service to client indicating that we've received a chat
 * message.  After this struct, the remaining bytes are the actual text message.
 * If the mesasge is private, then the text is encrypted, otherwise it's
 * plaintext.
 */
struct ReceiveNotificationMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_MESSAGE_NOTIFICATION
   */
  struct GNUNET_MessageHeader header;

  /**
   * Message options, see GNUNET_CHAT_MsgOptions.
   */
  uint32_t msg_options GNUNET_PACKED;

  /**
   * Sequence number of the message (unique per sender).
   */
  uint32_t sequence_number GNUNET_PACKED;

  /**
   * For alignment (should be zero).
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Timestamp of the message.
   */
  struct GNUNET_TIME_AbsoluteNBO timestamp;

  /**
   * Hash of the public key of the pseudonym of the sender of the message.
   * Should be all zeros for anonymous.
   */
  GNUNET_HashCode sender;

  /**
   * The encrypted session key.
   */
  struct GNUNET_CRYPTO_RsaEncryptedData encrypted_key;

};


/**
 * Request sent by client to transmit a chat message to another room members.
 * After this struct, the remaining bytes are the actual message in plaintext.
 * Private messages are encrypted on the service side.
 */
struct TransmitRequestMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_TRANSMIT_REQUEST
   */
  struct GNUNET_MessageHeader header;

  /**
   * For alignment (should be zero).
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Signature confirming receipt.  Signature covers everything from header
   * through content.
   */
  struct GNUNET_CRYPTO_RsaSignature signature;

  /**
   * What is being signed and why?
   */
  struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;

  /**
   * Desired message options, see GNUNET_CHAT_MsgOptions.
   */
  uint32_t msg_options GNUNET_PACKED;

  /**
   * Sequence number of the message (unique per sender).
   */
  uint32_t sequence_number GNUNET_PACKED;

  /**
   * Timestamp of the message.
   */
  struct GNUNET_TIME_AbsoluteNBO timestamp;

  /**
   * Who should receive this message?  Set to all zeros for "everyone".
   */
  GNUNET_HashCode target;

};


/**
 * Receipt sent from a message receiver to the service to confirm delivery of
 * a chat message and from the service to sender of the original message to
 * acknowledge delivery.
 */
struct ConfirmationReceiptMessage
{
  /**
   * Message type will be
   * GNUNET_MESSAGE_TYPE_CHAT_CONFIRMATION_RECEIPT when sending from client,
   * GNUNET_MESSAGE_TYPE_CHAT_CONFIRMATION_NOTIFICATION when sending to client.
   */
  struct GNUNET_MessageHeader header;

  /**
   * For alignment (should be zero).
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Signature confirming receipt.  Signature covers everything from header
   * through content.
   */
  struct GNUNET_CRYPTO_RsaSignature signature;

  /**
   * What is being signed and why?
   */
  struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;

  /**
   * Sequence number of the original message.
   */
  uint32_t sequence_number GNUNET_PACKED;

  /**
   * For alignment (should be zero).
   */
  uint32_t reserved2 GNUNET_PACKED;

  /**
   * Time of receipt.
   */
  struct GNUNET_TIME_AbsoluteNBO timestamp;

  /**
   * Who is confirming the receipt?
   */
  GNUNET_HashCode target;

  /**
   * Who is the author of the chat message?
   */
  GNUNET_HashCode author;

  /**
   * Hash of the (possibly encrypted) content.
   */
  GNUNET_HashCode content;

};


/**
 * Message send from client to daemon to join a chat room.
 * This struct is followed by the room name and then
 * the serialized ECRS meta data describing the new member.
 */
struct JoinRequestMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_JOIN_REQUEST
   */
  struct GNUNET_MessageHeader header;

  /**
   * Options.  Set all options that this client is willing to receive.
   * For example, if the client does not want to receive anonymous or
   * OTR messages but is willing to generate acknowledgements and
   * receive private messages, this should be set to
   * GNUNET_CHAT_MSG_PRIVATE | GNUNET_CHAT_MSG_ACKNOWLEDGED.
   */
  uint32_t msg_options GNUNET_PACKED;

  /**
   * Length of the room name.
   */
  uint16_t room_name_len GNUNET_PACKED;

  /**
   * For alignment (should be zero).
   */
  uint16_t reserved GNUNET_PACKED;
  uint32_t reserved2 GNUNET_PACKED;

  /**
   * Public key of the joining member.
   */
  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;

};


/**
 * Message send by server to client to indicate joining of another room member.
 * This struct is followed by the serialized ECRS MetaData describing the new
 * member.
 */
struct JoinNotificationMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_JOIN_NOTIFICATION
   */
  struct GNUNET_MessageHeader header;

  /**
   * Options.  Set to all options that the new user is willing to
   * process.  For example, if the client does not want to receive
   * anonymous or OTR messages but is willing to generate
   * acknowledgements and receive private messages, this should be set
   * to GNUNET_CHAT_MSG_PRIVATE | GNUNET_CHAT_MSG_ACKNOWLEDGED.
   */
  uint32_t msg_options GNUNET_PACKED;

  /**
   * Public key of the new user.
   */
  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;

};


/**
 * Message send by server to client to indicate leaving of another room member.
 */
struct LeaveNotificationMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_LEAVE_NOTIFICATION
   */
  struct GNUNET_MessageHeader header;

  /**
   * Reserved (for alignment).
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Who is leaving?
   */
  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded user;

};


/**
 * Peer-to-peer messages
 */

/**
 * Message send by one peer to another to indicate joining of another room
 * member.  This struct is followed by the room name and then the serialized
 * ECRS MetaData describing the new member.
 */
struct P2PJoinNotificationMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_P2P_JOIN_NOTIFICATION
   */
  struct GNUNET_MessageHeader header;

  /**
   * Options.  Set all options that this client is willing to receive.
   * For example, if the client does not want to receive anonymous or
   * OTR messages but is willing to generate acknowledgements and
   * receive private messages, this should be set to
   * GNUNET_CHAT_MSG_PRIVATE | GNUNET_CHAT_MSG_ACKNOWLEDGED.
   */
  uint32_t msg_options GNUNET_PACKED;

  /**
   * Length of the room name.
   */
  uint16_t room_name_len GNUNET_PACKED;

  /**
   * Reserved (should be zero).
   */
  uint16_t reserved GNUNET_PACKED;
  uint32_t reserved2 GNUNET_PACKED;

  /**
   * Public key of the joining member.
   */
  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;

};


/**
 * Message send by one peer to another to indicate leaving of another room
 * member.
 */
struct P2PLeaveNotificationMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_P2P_LEAVE_NOTIFICATION
   */
  struct GNUNET_MessageHeader header;

  /**
   * Reserved (for alignment).
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Who is leaving?
   */
  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded user;

};


/**
 * Message send by one peer to another to indicate receiving of a chat message.
 * This struct is followed by the room name (only if the message is anonymous)
 * and then the remaining bytes are the actual text message.  If the mesasge is
 * private, then the text is encrypted, otherwise it's plaintext.
 */
struct P2PReceiveNotificationMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_P2P_MESSAGE_NOTIFICATION
   */
  struct GNUNET_MessageHeader header;

  /**
   * Message options, see GNUNET_CHAT_MsgOptions.
   */
  uint32_t msg_options GNUNET_PACKED;

  /**
   * Sequence number of the message (unique per sender).
   */
  uint32_t sequence_number GNUNET_PACKED;

  /**
   * Length of the room name. This is only used for anonymous messages.
   */
  uint16_t room_name_len GNUNET_PACKED;

  /**
   * Reserved (for alignment).
   */
  uint16_t reserved GNUNET_PACKED;

  /**
   * Timestamp of the message.
   */
  struct GNUNET_TIME_AbsoluteNBO timestamp;

  /**
   * Hash of the public key of the pseudonym of the sender of the message
   * Should be all zeros for anonymous.
   */
  GNUNET_HashCode sender;

  /**
   * Who should receive this message?  Set to all zeros for "everyone".
   */
  GNUNET_HashCode target;

  /**
   * The encrypted session key.
   */
  struct GNUNET_CRYPTO_RsaEncryptedData encrypted_key;

};


/**
 * Receipt sent from one peer to another to confirm delivery of a chat message.
 */
struct P2PConfirmationReceiptMessage
{
  /**
   * Message type will be GNUNET_MESSAGE_TYPE_CHAT_P2P_CONFIRMATION_RECEIPT
   */
  struct GNUNET_MessageHeader header;

  /**
   * For alignment (should be zero).
   */
  uint32_t reserved GNUNET_PACKED;

  /**
   * Signature confirming receipt.  Signature covers everything from header
   * through content.
   */
  struct GNUNET_CRYPTO_RsaSignature signature;

  /**
   * What is being signed and why?
   */
  struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;

  /**
   * Sequence number of the original message.
   */
  uint32_t msg_sequence_number GNUNET_PACKED;

  /**
   * Sequence number of the receipt.
   */
  uint32_t sequence_number GNUNET_PACKED;

  /**
   * Time of receipt.
   */
  struct GNUNET_TIME_AbsoluteNBO timestamp;

  /**
   * Who is confirming the receipt?
   */
  GNUNET_HashCode target;

  /**
   * Who is the author of the chat message?
   */
  GNUNET_HashCode author;

  /**
   * Hash of the (possibly encrypted) content.
   */
  GNUNET_HashCode content;

};
GNUNET_NETWORK_STRUCT_END

#endif

/* end of chat.h */