2 This file is part of GNUnet.
3 (C) 2009, 2010, 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 * @file core/gnunet-service-core_kx.h
23 * @brief code for managing the key exchange (SET_KEY, PING, PONG) with other peers
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_CORE_KX_H
27 #define GNUNET_SERVICE_CORE_KX_H
29 #include "gnunet_util_lib.h"
30 #include "gnunet_transport_service.h"
34 * Information about the status of a key exchange with another peer.
36 struct GSC_KeyExchangeInfo;
40 * We received a SET_KEY message. Validate and update
41 * our key material and status.
43 * @param kx key exchange status for the corresponding peer
44 * @param msg the set key message we received
47 GSC_KX_handle_set_key (struct GSC_KeyExchangeInfo *kx,
48 const struct GNUNET_MessageHeader *msg);
52 * We received a PING message. Validate and transmit
55 * @param kx key exchange status for the corresponding peer
56 * @param msg the encrypted PING message itself
59 GSC_KX_handle_ping (struct GSC_KeyExchangeInfo *kx,
60 const struct GNUNET_MessageHeader *msg);
64 * We received a PONG message. Validate and update our status.
66 * @param kx key exchange status for the corresponding peer
67 * @param msg the encrypted PONG message itself
70 GSC_KX_handle_pong (struct GSC_KeyExchangeInfo *kx,
71 const struct GNUNET_MessageHeader *msg);
75 * Encrypt and transmit a message with the given payload.
77 * @param kx key exchange context
78 * @param payload payload of the message
79 * @param payload_size number of bytes in 'payload'
82 GSC_KX_encrypt_and_transmit (struct GSC_KeyExchangeInfo *kx,
83 const void *payload, size_t payload_size);
87 * We received an encrypted message. Decrypt, validate and
88 * pass on to the appropriate clients.
90 * @param kx key exchange information context
91 * @param msg encrypted message
92 * @param atsi performance data
93 * @param atsi_count number of entries in ats (excluding 0-termination)
96 GSC_KX_handle_encrypted_message (struct GSC_KeyExchangeInfo *kx,
97 const struct GNUNET_MessageHeader *msg,
98 const struct GNUNET_ATS_Information *atsi,
103 * Start the key exchange with the given peer.
105 * @param pid identity of the peer to do a key exchange with
106 * @return key exchange information context
108 struct GSC_KeyExchangeInfo *
109 GSC_KX_start (const struct GNUNET_PeerIdentity *pid);
113 * Stop key exchange with the given peer. Clean up key material.
115 * @param kx key exchange to stop
118 GSC_KX_stop (struct GSC_KeyExchangeInfo *kx);
122 * Initialize KX subsystem.
124 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
131 * Shutdown KX subsystem.
137 /* end of gnunet-service-core_kx.h */