2 This file is part of GNUnet.
3 Copyright (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @author Bartlomiej Polot
23 * @file cadet/cadet_protocol.h
26 #ifndef CADET_PROTOCOL_H_
27 #define CADET_PROTOCOL_H_
30 #include "gnunet_util_lib.h"
35 struct GNUNET_CADET_TunnelMessage;
39 /* keep Emacsens' auto-indent happy */
44 /******************************************************************************/
45 /******************** CADET NETWORK MESSAGES **************************/
46 /******************************************************************************/
48 GNUNET_NETWORK_STRUCT_BEGIN
51 * Message for cadet connection creation.
53 struct GNUNET_CADET_ConnectionCreate
56 * Type: GNUNET_MESSAGE_TYPE_CADET_CONNECTION_CREATE
58 * Size: sizeof (struct GNUNET_CADET_ConnectionCreate) +
59 * path_length * sizeof (struct GNUNET_PeerIdentity)
61 struct GNUNET_MessageHeader header;
64 * ID of the connection
66 struct GNUNET_CADET_Hash cid;
69 * path_length structs defining the *whole* path from the origin [0] to the
70 * final destination [path_length-1].
72 /* struct GNUNET_PeerIdentity peers[path_length]; */
77 * Message for ack'ing a connection
79 struct GNUNET_CADET_ConnectionACK
82 * Type: GNUNET_MESSAGE_TYPE_CADET_CONNECTION_ACK
84 struct GNUNET_MessageHeader header;
87 * ID of the connection.
89 struct GNUNET_CADET_Hash cid;
95 * Message for encapsulation of a Key eXchange message in a connection.
97 struct GNUNET_CADET_KX
100 * Type: GNUNET_MESSAGE_TYPE_CADET_KX.
102 struct GNUNET_MessageHeader header;
105 * ID of the connection.
107 struct GNUNET_CADET_Hash cid;
109 /* Specific KX message follows. */
115 * Message for encapsulation of a Key eXchange message in a connection.
117 struct GNUNET_CADET_AX_KX
120 * Type: GNUNET_MESSAGE_TYPE_CADET_AX_KX.
122 struct GNUNET_MessageHeader header;
125 * Sender's ephemeral public ECC key (always for NIST P-521) encoded in a
126 * format suitable for network transmission, as created
127 * using 'gcry_sexp_sprint'.
129 struct GNUNET_CRYPTO_EcdhePublicKey ephemeral_key;
132 * Sender's next ephemeral public ECC key (always for NIST P-521) encoded in a
133 * format suitable for network transmission, as created
134 * using 'gcry_sexp_sprint'.
136 struct GNUNET_CRYPTO_EcdhePublicKey ratchet_key;
141 * Message transmitted with the signed ephemeral key of a peer. The
142 * session key is then derived from the two ephemeral keys (ECDHE).
144 * As far as possible, same as CORE's EphemeralKeyMessage.
146 struct GNUNET_CADET_KX_Ephemeral
150 * Message type is GNUNET_MESSAGE_TYPE_CADET_KX_EPHEMERAL.
152 struct GNUNET_MessageHeader header;
155 * Status of the sender (should be in "enum PeerStateMachine"), nbo.
157 int32_t sender_status GNUNET_PACKED;
160 * An ECC signature of the 'origin' asserting the validity of
161 * the given ephemeral key.
163 struct GNUNET_CRYPTO_EddsaSignature signature;
166 * Information about what is being signed.
168 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
171 * At what time was this key created (beginning of validity).
173 struct GNUNET_TIME_AbsoluteNBO creation_time;
176 * When does the given ephemeral key expire (end of validity).
178 struct GNUNET_TIME_AbsoluteNBO expiration_time;
181 * Ephemeral public ECC key (always for NIST P-521) encoded in a format
182 * suitable for network transmission as created using 'gcry_sexp_sprint'.
184 struct GNUNET_CRYPTO_EcdhePublicKey ephemeral_key;
187 * Public key of the signing peer
188 * (persistent version, not the ephemeral public key).
190 struct GNUNET_PeerIdentity origin_identity;
193 * Seed for the IV of nonce.
195 uint32_t iv GNUNET_PACKED;
198 * Nonce to check liveness of peer.
200 uint32_t nonce GNUNET_PACKED;
205 * Response to a PING. Includes data from the original PING.
207 struct GNUNET_CADET_KX_Pong
210 * Message type is GNUNET_MESSAGE_TYPE_CADET_KX_PONG.
212 struct GNUNET_MessageHeader header;
217 uint32_t iv GNUNET_PACKED;
220 * Same nonce as in the reve.
222 uint32_t nonce GNUNET_PACKED;
227 * Tunnel(ed) message.
229 struct GNUNET_CADET_Encrypted
232 * Type: GNUNET_MESSAGE_TYPE_CADET_ENCRYPTED
234 struct GNUNET_MessageHeader header;
237 * ID of the connection.
239 struct GNUNET_CADET_Hash cid;
242 * ID of the packet (hop by hop).
244 uint32_t pid GNUNET_PACKED;
247 * Number of hops to live.
249 uint32_t ttl GNUNET_PACKED;
252 * Initialization Vector for payload encryption.
254 uint32_t iv GNUNET_PACKED;
257 * MAC of the encrypted message, used to verify message integrity.
258 * Everything after this value will be encrypted and authenticated.
260 struct GNUNET_CADET_Hash hmac;
263 * Encrypted content follows.
269 * Axolotl tunnel message.
271 struct GNUNET_CADET_AX
274 * Type: GNUNET_MESSAGE_TYPE_CADET_AXOLOTL_DATA
276 struct GNUNET_MessageHeader header;
279 * ID of the connection.
281 struct GNUNET_CADET_Hash cid;
284 * ID of the packet (hop by hop).
286 uint32_t pid GNUNET_PACKED;
289 * Number of hops to live.
291 uint32_t ttl GNUNET_PACKED;
294 * Initialization Vector for payload encryption.
296 uint32_t iv GNUNET_PACKED;
299 * MAC of the encrypted message, used to verify message integrity.
300 * Everything after this value will be encrypted and authenticated.
302 struct GNUNET_CADET_Hash hmac;
305 * Encrypted content follows.
311 * Message to create a Channel.
313 struct GNUNET_CADET_ChannelCreate
316 * Type: GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE
318 struct GNUNET_MessageHeader header;
323 CADET_ChannelNumber chid GNUNET_PACKED;
328 uint32_t port GNUNET_PACKED;
333 uint32_t opt GNUNET_PACKED;
338 * Message to manage a Channel (ACK, NACK, Destroy).
340 struct GNUNET_CADET_ChannelManage
343 * Type: GNUNET_MESSAGE_TYPE_CADET_CHANNEL_{ACK|NACK|DESTROY}
345 struct GNUNET_MessageHeader header;
350 CADET_ChannelNumber chid GNUNET_PACKED;
355 * Message for cadet data traffic.
357 struct GNUNET_CADET_Data
360 * Type: GNUNET_MESSAGE_TYPE_CADET_UNICAST,
361 * GNUNET_MESSAGE_TYPE_CADET_TO_ORIGIN
363 struct GNUNET_MessageHeader header;
366 * Unique ID of the payload message
368 uint32_t mid GNUNET_PACKED;
373 CADET_ChannelNumber chid GNUNET_PACKED;
382 * Message to acknowledge end-to-end data.
384 struct GNUNET_CADET_DataACK
387 * Type: GNUNET_MESSAGE_TYPE_CADET_DATA_ACK
389 struct GNUNET_MessageHeader header;
394 CADET_ChannelNumber chid GNUNET_PACKED;
397 * Bitfield of already-received newer messages
401 uint64_t futures GNUNET_PACKED;
404 * Last message ID received.
406 uint32_t mid GNUNET_PACKED;
411 * Message to acknowledge cadet encrypted traffic.
413 struct GNUNET_CADET_ACK
416 * Type: GNUNET_MESSAGE_TYPE_CADET_ACK
418 struct GNUNET_MessageHeader header;
421 * Maximum packet ID authorized.
423 uint32_t ack GNUNET_PACKED;
426 * ID of the connection.
428 struct GNUNET_CADET_Hash cid;
433 * Message to query a peer about its Flow Control status regarding a tunnel.
435 struct GNUNET_CADET_Poll
438 * Type: GNUNET_MESSAGE_TYPE_CADET_POLL
440 struct GNUNET_MessageHeader header;
445 uint32_t pid GNUNET_PACKED;
448 * ID of the connection.
450 struct GNUNET_CADET_Hash cid;
456 * Message for notifying a disconnection in a path
458 struct GNUNET_CADET_ConnectionBroken
461 * Type: GNUNET_MESSAGE_TYPE_CADET_CONNECTION_BROKEN
463 struct GNUNET_MessageHeader header;
466 * ID of the connection.
468 struct GNUNET_CADET_Hash cid;
473 struct GNUNET_PeerIdentity peer1;
478 struct GNUNET_PeerIdentity peer2;
483 * Message to destroy a connection.
485 struct GNUNET_CADET_ConnectionDestroy
488 * Type: GNUNET_MESSAGE_TYPE_CADET_CONNECTION_DESTROY
490 struct GNUNET_MessageHeader header;
493 * ID of the connection.
495 struct GNUNET_CADET_Hash cid;
499 GNUNET_NETWORK_STRUCT_END
501 #if 0 /* keep Emacsens' auto-indent happy */
508 /* ifndef CADET_PROTOCOL_H */
510 /* end of cadet_protocol.h */