src/core/gnunet-service-core_kx.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  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
  25  */
  26 #ifndef GNUNET_SERVICE_CORE_KX_H
  27 #define GNUNET_SERVICE_CORE_KX_H
  28
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_transport_service.h"
  31
  32
  33 /**
  34  * Information about the status of a key exchange with another peer.
  35  */
  36 struct GSC_KeyExchangeInfo;
  37
  38
  39 /**
  40  * We received a SET_KEY message.  Validate and update
  41  * our key material and status.
  42  *
  43  * @param kx key exchange status for the corresponding peer
  44  * @param msg the set key message we received
  45  */
  46 void
  47 GSC_KX_handle_set_key (struct GSC_KeyExchangeInfo *kx,
  48                        const struct GNUNET_MessageHeader *msg);
  49
  50
  51 /**
  52  * We received a PING message.  Validate and transmit
  53  * a PONG message.
  54  *
  55  * @param kx key exchange status for the corresponding peer
  56  * @param msg the encrypted PING message itself
  57  */
  58 void
  59 GSC_KX_handle_ping (struct GSC_KeyExchangeInfo *kx,
  60                     const struct GNUNET_MessageHeader *msg);
  61
  62
  63 /**
  64  * We received a PONG message.  Validate and update our status.
  65  *
  66  * @param kx key exchange status for the corresponding peer
  67  * @param msg the encrypted PONG message itself
  68  */
  69 void
  70 GSC_KX_handle_pong (struct GSC_KeyExchangeInfo *kx,
  71                     const struct GNUNET_MessageHeader *msg);
  72
  73
  74 /**
  75  * Encrypt and transmit a message with the given payload.
  76  *
  77  * @param kx key exchange context
  78  * @param bw_in bandwidth limit to transmit to the other peer;
  79  *              the other peer shall not send us more than the
  80  *              given rate
  81  * @param payload payload of the message
  82  * @param payload_size number of bytes in 'payload'
  83  */
  84 void
  85 GSC_KX_encrypt_and_transmit (struct GSC_KeyExchangeInfo *kx,
  86                              struct GNUNET_BANDWIDTH_Value32NBO bw_in,
  87                              const void *payload,
  88                              size_t payload_size);
  89
  90
  91 /**
  92  * We received an encrypted message.  Decrypt, validate and
  93  * pass on to the appropriate clients.
  94  *
  95  * @param kx key exchange information context
  96  * @param msg encrypted message
  97  * @param atsi performance data
  98  * @param atsi_count number of entries in ats (excluding 0-termination)
  99  */
 100 void
 101 GSC_KX_handle_encrypted_message (struct GSC_KeyExchangeInfo *kx,
 102                                  const struct GNUNET_MessageHeader *msg,
 103                                  const struct GNUNET_TRANSPORT_ATS_Information *atsi,
 104                                  uint32_t atsi_count);
 105
 106
 107 /**
 108  * Start the key exchange with the given peer.
 109  *
 110  * @param pid identity of the peer to do a key exchange with
 111  * @return key exchange information context
 112  */
 113 struct GSC_KeyExchangeInfo *
 114 GSC_KX_start (const struct GNUNET_PeerIdentity *pid);
 115
 116
 117 /**
 118  * Stop key exchange with the given peer.  Clean up key material.
 119  *
 120  * @param kx key exchange to stop
 121  */
 122 void
 123 GSC_KX_stop (struct GSC_KeyExchangeInfo *kx);
 124
 125
 126 /**
 127  * Initialize KX subsystem.
 128  *
 129  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 130  */
 131 int
 132 GSC_KX_init (void);
 133
 134
 135 /**
 136  * Shutdown KX subsystem.
 137  */
 138 void
 139 GSC_KX_done (void);
 140
 141 #endif
 142 /* end of gnunet-service-core_kx.h */