2 This file is part of GNUnet.
3 Copyright (C) 2009-2017 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @author Christian Grothoff
25 * CADET service; establish channels to distant peers
27 * @defgroup cadet CADET service
28 * Confidential Ad-hoc Decentralized End-to-End Transport
30 * @see [Documentation](https://gnunet.org/cadet-subsystem)
31 * @see [Paper](https://gnunet.org/cadet)
35 #ifndef GNUNET_CADET_SERVICE_H
36 #define GNUNET_CADET_SERVICE_H
41 #if 0 /* keep Emacsens' auto-indent happy */
46 #include "gnunet_util_lib.h"
47 #include "gnunet_transport_service.h"
50 * Version number of GNUnet-cadet API.
52 #define GNUNET_CADET_VERSION 0x00000005
56 * Opaque handle to the service.
58 struct GNUNET_CADET_Handle;
61 * Opaque handle to a channel.
63 struct GNUNET_CADET_Channel;
66 * Opaque handle to a port.
68 struct GNUNET_CADET_Port;
72 * Hash uniquely identifying a connection below a tunnel.
74 struct GNUNET_CADET_ConnectionTunnelIdentifier
76 struct GNUNET_ShortHashCode connection_of_tunnel;
81 * Number identifying a CADET channel within a tunnel.
83 struct GNUNET_CADET_ChannelTunnelNumber
86 * Which number does this channel have that uniquely identfies
87 * it within its tunnel, in network byte order.
89 * Given two peers, both may initiate channels over the same tunnel.
90 * The @e cn must be greater or equal to 0x80000000 (high-bit set)
91 * for tunnels initiated with the peer that has the larger peer
92 * identity as compared using #GNUNET_CRYPTO_cmp_peer_identity().
94 uint32_t cn GNUNET_PACKED;
99 * Channel options. Second line indicates filed in the
100 * CadetChannelInfo union carrying the answer.
102 enum GNUNET_CADET_ChannelOption
105 * Default options: unreliable, default buffering, not out of order.
107 GNUNET_CADET_OPTION_DEFAULT = 0x0,
110 * Disable buffering on intermediate nodes (for minimum latency).
113 GNUNET_CADET_OPTION_NOBUFFER = 0x1,
116 * Enable channel reliability, lost messages will be retransmitted.
119 GNUNET_CADET_OPTION_RELIABLE = 0x2,
122 * Enable out of order delivery of messages.
123 * Set bit for out-of-order delivery.
125 GNUNET_CADET_OPTION_OUT_OF_ORDER = 0x4,
128 * Who is the peer at the other end of the channel.
129 * Only for use in @c GNUNET_CADET_channel_get_info
130 * struct GNUNET_PeerIdentity *peer
132 GNUNET_CADET_OPTION_PEER = 0x8
138 * Method called whenever a peer connects to a port in MQ-based CADET.
140 * @param cls Closure from #GNUNET_CADET_open_port.
141 * @param channel New handle to the channel.
142 * @param source Peer that started this channel.
143 * @return Closure for the incoming @a channel. It's given to:
144 * - The #GNUNET_CADET_DisconnectEventHandler (given to
145 * #GNUNET_CADET_open_port) when the channel dies.
146 * - Each the #GNUNET_MQ_MessageCallback handlers for each message
147 * received on the @a channel.
150 (*GNUNET_CADET_ConnectEventHandler) (void *cls,
151 struct GNUNET_CADET_Channel *channel,
152 const struct GNUNET_PeerIdentity *source);
156 * Function called whenever an MQ-channel is destroyed, even if the destruction
157 * was requested by #GNUNET_CADET_channel_destroy.
158 * It must NOT call #GNUNET_CADET_channel_destroy on the channel.
160 * It should clean up any associated state, including cancelling any pending
161 * transmission on this channel.
163 * @param cls Channel closure.
164 * @param channel Connection to the other end (henceforth invalid).
167 (*GNUNET_CADET_DisconnectEventHandler) (void *cls,
168 const struct GNUNET_CADET_Channel *channel);
172 * Function called whenever an MQ-channel's transmission window size changes.
174 * The first callback in an outgoing channel will be with a non-zero value
175 * and will mean the channel is connected to the destination.
177 * For an incoming channel it will be called immediately after the
178 * #GNUNET_CADET_ConnectEventHandler, also with a non-zero value.
180 * @param cls Channel closure.
181 * @param channel Connection to the other end --- FIXME: drop?
182 * @param window_size New window size. If the is more messages than buffer size
183 * this value will be negative. -- FIXME: make unsigned, we never call negative?
186 (*GNUNET_CADET_WindowSizeEventHandler) (void *cls,
187 const struct GNUNET_CADET_Channel *channel,
192 * Connect to the MQ-based cadet service.
194 * @param cfg Configuration to use.
195 * @return Handle to the cadet service NULL on error.
197 struct GNUNET_CADET_Handle *
198 GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
202 * Disconnect from the cadet service. All channels will be destroyed. All channel
203 * disconnect callbacks will be called on any still connected peers, notifying
204 * about their disconnection. The registered inbound channel cleaner will be
205 * called should any inbound channels still exist.
207 * @param handle connection to cadet to disconnect
210 GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle);
214 * Open a port to receive incomming MQ-based channels.
216 * @param h CADET handle.
217 * @param port Hash identifying the port.
218 * @param connects Function called when an incoming channel is connected.
219 * @param connects_cls Closure for the @a connects handler.
220 * @param window_changes Function called when the transmit window size changes.
222 * @param disconnects Function called when a channel is disconnected.
223 * @param handlers Callbacks for messages we care about, NULL-terminated.
224 * @return Port handle, NULL if port is in use
226 struct GNUNET_CADET_Port *
227 GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h,
228 const struct GNUNET_HashCode *port,
229 GNUNET_CADET_ConnectEventHandler connects,
231 GNUNET_CADET_WindowSizeEventHandler window_changes,
232 GNUNET_CADET_DisconnectEventHandler disconnects,
233 const struct GNUNET_MQ_MessageHandler *handlers);
237 * Close a port opened with @a GNUNET_CADET_open_port.
238 * The @a new_channel callback will no longer be called.
240 * @param p Port handle.
243 GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p);
247 * Create a new channel towards a remote peer.
249 * If the destination port is not open by any peer or the destination peer
250 * does not accept the channel, @a disconnects will be called
253 * @param h CADET handle.
254 * @param channel_cls Closure for the channel. It's given to:
255 * - The management handler @a window_changes.
256 * - The disconnect handler @a disconnects
257 * - Each message type callback in @a handlers
258 * @param destination Peer identity the channel should go to.
259 * @param port Identification of the destination port.
260 * @param options CadetOption flag field, with all desired option bits set to 1.
261 * @param window_changes Function called when the transmit window size changes.
262 * Can be NULL if this data is of no interest.
263 * TODO Not yet implemented.
264 * @param disconnects Function called when the channel is disconnected.
265 * @param handlers Callbacks for messages we care about, NULL-terminated.
266 * @return Handle to the channel.
268 struct GNUNET_CADET_Channel *
269 GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
271 const struct GNUNET_PeerIdentity *destination,
272 const struct GNUNET_HashCode *port,
273 enum GNUNET_CADET_ChannelOption options,
274 GNUNET_CADET_WindowSizeEventHandler window_changes,
275 GNUNET_CADET_DisconnectEventHandler disconnects,
276 const struct GNUNET_MQ_MessageHandler *handlers);
280 * Destroy an existing channel.
282 * The existing end callback for the channel will be called immediately.
283 * Any pending outgoing messages will be sent but no incoming messages will be
284 * accepted and no data callbacks will be called.
286 * @param channel Channel handle, becomes invalid after this call.
289 GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel);
293 * Obtain the message queue for a connected channel.
295 * @param channel The channel handle from which to get the MQ.
296 * @return The message queue of the channel.
298 struct GNUNET_MQ_Handle *
299 GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel);
303 * Indicate readiness to receive the next message on a channel.
305 * Should only be called once per handler called.
307 * @param channel Channel that will be allowed to call another handler.
310 GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel);
313 /******************************************************************************/
314 /******************** MONITORING /DEBUG API *************************/
315 /******************************************************************************/
316 /* The following calls are not useful for normal CADET operation, but for */
317 /* debug and monitoring of the cadet state. They can be safely ignored. */
318 /* The API can change at any point without notice. */
319 /* Please contact the developer if you consider any of this calls useful for */
320 /* normal cadet applications. */
321 /******************************************************************************/
325 * Transitional function to convert an unsigned int port to a hash value.
326 * WARNING: local static value returned, NOT reentrant!
327 * WARNING: do not use this function for new code!
329 * @param port Numerical port (unsigned int format).
331 * @return A GNUNET_HashCode usable for the new CADET API.
333 const struct GNUNET_HashCode *
334 GC_u2h (uint32_t port);
339 * Struct to retrieve info about a channel.
341 union GNUNET_CADET_ChannelInfo
345 * #GNUNET_YES / #GNUNET_NO, for binary flags.
350 * Peer on the other side of the channel
352 const struct GNUNET_PeerIdentity peer;
357 * Get information about a channel.
359 * @param channel Channel handle.
360 * @param option Query type GNUNET_CADET_OPTION_*
361 * @param ... dependant on option, currently not used
362 * @return Union with an answer to the query.
364 const union GNUNET_CADET_ChannelInfo *
365 GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
366 enum GNUNET_CADET_ChannelOption option,
371 * Method called to retrieve information about a specific channel the cadet peer
372 * is aware of, including all transit nodes.
374 * @param cls Closure.
375 * @param root Root of the channel.
376 * @param dest Destination of the channel.
377 * @param port Destination port of the channel.
378 * @param root_channel_number Local number for root, if known.
379 * @param dest_channel_number Local number for dest, if known.
380 * @param public_channel_numbe Number for P2P, always known.
383 (*GNUNET_CADET_ChannelCB) (void *cls,
384 const struct GNUNET_PeerIdentity *root,
385 const struct GNUNET_PeerIdentity *dest,
386 uint32_t /* UGH */ port,
387 uint32_t /* ugh */ root_channel_number,
388 uint32_t /* ugh */ dest_channel_number,
389 uint32_t /* ugh */ public_channel_number);
392 * Method called to retrieve information about all peers in CADET, called
395 * After last peer has been reported, an additional call with NULL is done.
397 * @param cls Closure.
398 * @param peer Peer, or NULL on "EOF".
399 * @param tunnel Do we have a tunnel towards this peer?
400 * @param n_paths Number of known paths towards this peer.
401 * @param best_path How long is the best path?
402 * (0 = unknown, 1 = ourselves, 2 = neighbor)
405 (*GNUNET_CADET_PeersCB) (void *cls,
406 const struct GNUNET_PeerIdentity *peer,
408 unsigned int n_paths,
409 unsigned int best_path);
412 * Method called to retrieve information about a specific peer
413 * known to the service.
415 * @param cls Closure.
416 * @param peer Peer ID.
417 * @param tunnel Do we have a tunnel towards this peer? #GNUNET_YES/#GNUNET_NO
418 * @param neighbor Is this a direct neighbor? #GNUNET_YES/#GNUNET_NO
419 * @param n_paths Number of paths known towards peer.
420 * @param paths Array of PEER_IDs representing all paths to reach the peer.
421 * Each path starts with the first hop (local peer not included).
422 * Each path ends with the destination peer (given in @c peer).
425 (*GNUNET_CADET_PeerCB) (void *cls,
426 const struct GNUNET_PeerIdentity *peer,
429 unsigned int n_paths,
430 const struct GNUNET_PeerIdentity *paths);
434 * Method called to retrieve information about all tunnels in CADET, called
437 * After last tunnel has been reported, an additional call with NULL is done.
439 * @param cls Closure.
440 * @param peer Destination peer, or NULL on "EOF".
441 * @param channels Number of channels.
442 * @param connections Number of connections.
443 * @param estate Encryption state.
444 * @param cstate Connectivity state.
447 (*GNUNET_CADET_TunnelsCB) (void *cls,
448 const struct GNUNET_PeerIdentity *peer,
449 unsigned int channels,
450 unsigned int connections,
456 * Method called to retrieve information about a specific tunnel the cadet peer
457 * has established, o`r is trying to establish.
459 * @param cls Closure.
460 * @param peer Peer towards whom the tunnel is directed.
461 * @param n_channels Number of channels.
462 * @param n_connections Number of connections.
463 * @param channels Channels.
464 * @param connections Connections.
465 * @param estate Encryption state.
466 * @param cstate Connectivity state.
469 (*GNUNET_CADET_TunnelCB) (void *cls,
470 const struct GNUNET_PeerIdentity *peer,
471 unsigned int n_channels,
472 unsigned int n_connections,
473 const struct GNUNET_CADET_ChannelTunnelNumber *channels,
474 const struct GNUNET_CADET_ConnectionTunnelIdentifier *connections,
476 unsigned int cstate);
480 * Request information about a specific channel of the running cadet peer.
482 * WARNING: unstable API, likely to change in the future!
484 * @param h Handle to the cadet peer.
485 * @param peer ID of the other end of the channel.
486 * @param channel_number Channel number.
487 * @param callback Function to call with the requested data.
488 * @param callback_cls Closure for @c callback.
491 GNUNET_CADET_get_channel (struct GNUNET_CADET_Handle *h,
492 struct GNUNET_PeerIdentity *peer,
493 uint32_t /* UGH */ channel_number,
494 GNUNET_CADET_ChannelCB callback,
499 * Request a debug dump on the service's STDERR.
501 * WARNING: unstable API, likely to change in the future!
503 * @param h cadet handle
506 GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h);
510 * Request information about peers known to the running cadet service.
511 * The callback will be called for every peer known to the service.
512 * Only one info request (of any kind) can be active at once.
515 * WARNING: unstable API, likely to change in the future!
517 * @param h Handle to the cadet peer.
518 * @param callback Function to call with the requested data.
519 * @param callback_cls Closure for @c callback.
521 * @return #GNUNET_OK / #GNUNET_SYSERR
524 GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
525 GNUNET_CADET_PeersCB callback,
530 * Cancel a peer info request. The callback will not be called (anymore).
532 * WARNING: unstable API, likely to change in the future!
534 * @param h Cadet handle.
536 * @return Closure that was given to #GNUNET_CADET_get_peers().
539 GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h);
543 * Request information about a peer known to the running cadet peer.
544 * The callback will be called for the tunnel once.
545 * Only one info request (of any kind) can be active at once.
547 * WARNING: unstable API, likely to change in the future!
549 * @param h Handle to the cadet peer.
550 * @param id Peer whose tunnel to examine.
551 * @param callback Function to call with the requested data.
552 * @param callback_cls Closure for @c callback.
554 * @return #GNUNET_OK / #GNUNET_SYSERR
557 GNUNET_CADET_get_peer (struct GNUNET_CADET_Handle *h,
558 const struct GNUNET_PeerIdentity *id,
559 GNUNET_CADET_PeerCB callback,
564 * Request information about tunnels of the running cadet peer.
565 * The callback will be called for every tunnel of the service.
566 * Only one info request (of any kind) can be active at once.
568 * WARNING: unstable API, likely to change in the future!
570 * @param h Handle to the cadet peer.
571 * @param callback Function to call with the requested data.
572 * @param callback_cls Closure for @c callback.
574 * @return #GNUNET_OK / #GNUNET_SYSERR
577 GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
578 GNUNET_CADET_TunnelsCB callback,
583 * Cancel a monitor request. The monitor callback will not be called.
585 * @param h Cadet handle.
587 * @return Closure given to #GNUNET_CADET_get_tunnels(), if any.
590 GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h);
594 * Request information about a tunnel of the running cadet peer.
595 * The callback will be called for the tunnel once.
596 * Only one info request (of any kind) can be active at once.
598 * WARNING: unstable API, likely to change in the future!
600 * @param h Handle to the cadet peer.
601 * @param id Peer whose tunnel to examine.
602 * @param callback Function to call with the requested data.
603 * @param callback_cls Closure for @c callback.
605 * @return #GNUNET_OK / #GNUNET_SYSERR
608 GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
609 const struct GNUNET_PeerIdentity *id,
610 GNUNET_CADET_TunnelCB callback,
615 #if 0 /* keep Emacsens' auto-indent happy */
622 /* ifndef GNUNET_CADET_SERVICE_H */
625 /** @} */ /* end of group */
627 /* end of gnunet_cadet_service.h */