src/core/gnunet-service-core_kx.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009, 2010, 2011 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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  * Encrypt and transmit a message with the given payload.
  41  *
  42  * @param kx key exchange context
  43  * @param payload payload of the message
  44  * @param payload_size number of bytes in 'payload'
  45  */
  46 void
  47 GSC_KX_encrypt_and_transmit (struct GSC_KeyExchangeInfo *kx,
  48                              const void *payload,
  49                              size_t payload_size);
  50
  51
  52 /**
  53  * Initialize KX subsystem.
  54  *
  55  * @param pk private key to use for the peer
  56  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
  57  */
  58 int
  59 GSC_KX_init (struct GNUNET_CRYPTO_EddsaPrivateKey *pk);
  60
  61
  62 /**
  63  * Shutdown KX subsystem.
  64  */
  65 void
  66 GSC_KX_done (void);
  67
  68
  69 /**
  70  * Check if the given neighbour has excess bandwidth available.
  71  *
  72  * @param target neighbour to check
  73  * @return #GNUNET_YES if excess bandwidth is available, #GNUNET_NO if not
  74  */
  75 int
  76 GSC_NEIGHBOURS_check_excess_bandwidth (const struct
  77                                        GSC_KeyExchangeInfo *target);
  78
  79
  80 /**
  81  * Check how many messages are queued for the given neighbour.
  82  *
  83  * @param target neighbour to check
  84  * @return number of items in the message queue
  85  */
  86 unsigned int
  87 GSC_NEIGHBOURS_get_queue_length (const struct GSC_KeyExchangeInfo *target);
  88
  89
  90 /**
  91  * Handle #GNUNET_MESSAGE_TYPE_CORE_MONITOR_PEERS request.  For this
  92  * request type, the client does not have to have transmitted an INIT
  93  * request.  All current peers are returned, regardless of which
  94  * message types they accept.
  95  *
  96  * @param mq message queue to add for monitoring
  97  */
  98 void
  99 GSC_KX_handle_client_monitor_peers (struct GNUNET_MQ_Handle *mq);
 100
 101
 102 #endif
 103 /* end of gnunet-service-core_kx.h */