src/transport/gnunet-service-transport_blacklist.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 transport/gnunet-service-transport_blacklist.h
  23  * @brief blacklisting API
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_TRANSPORT_BLACKLIST_H
  27 #define GNUNET_SERVICE_TRANSPORT_BLACKLIST_H
  28
  29 #include "gnunet_statistics_service.h"
  30 #include "gnunet_util_lib.h"
  31
  32 /**
  33  * Start blacklist subsystem.
  34  *
  35  * @param server server used to accept clients from
  36  */
  37 void GST_blacklist_start (struct GNUNET_SERVER_Handle *server);
  38
  39
  40 /**
  41  * Stop blacklist subsystem.
  42  */
  43 void GST_blacklist_stop (void);
  44
  45
  46 /**
  47  * Initialize a blacklisting client.  We got a blacklist-init
  48  * message from this client, add him to the list of clients
  49  * to query for blacklisting.
  50  *
  51  * @param cls unused
  52  * @param client the client
  53  * @param message the blacklist-init message that was sent
  54  */
  55 void GST_blacklist_handle_init (void *cls, struct GNUNET_SERVER_Client *client,
  56                                 const struct GNUNET_MessageHeader *message);
  57
  58 /**
  59  * A blacklisting client has sent us reply. Process it.
  60  *
  61  * @param cls unused
  62  * @param client the client
  63  * @param message the blacklist-init message that was sent
  64  */
  65 void GST_blacklist_handle_reply (void *cls, struct GNUNET_SERVER_Client *client,
  66                                  const struct GNUNET_MessageHeader *message);
  67
  68 /**
  69  * Add the given peer to the blacklist (for the given transport).
  70  *
  71  * @param peer peer to blacklist
  72  * @param transport_name transport to blacklist for this peer, NULL for all
  73  */
  74 void GST_blacklist_add_peer (const struct GNUNET_PeerIdentity *peer,
  75                              const char *transport_name);
  76
  77
  78 /**
  79  * Handle to an active blacklist check.
  80  */
  81 struct GST_BlacklistCheck;
  82
  83
  84 /**
  85  * Continuation called from a blacklist test.
  86  *
  87  * @param cls closure
  88  * @param peer identity of peer that was tested
  89  * @param result GNUNET_OK if the connection is allowed,
  90  *               GNUNET_NO if not
  91  */
  92 typedef void (*GST_BlacklistTestContinuation) (void *cls,
  93                                                const struct GNUNET_PeerIdentity
  94                                                * peer, int result);
  95
  96
  97 /**
  98  * Test if a peer/transport combination is blacklisted.
  99  *
 100  * @param peer the identity of the peer to test
 101  * @param transport_name name of the transport to test, never NULL
 102  * @param cont function to call with result
 103  * @param cont_cls closure for 'cont'
 104  * @return handle to the blacklist check, NULL if the decision
 105  *        was made instantly and 'cont' was already called
 106  */
 107 struct GST_BlacklistCheck *GST_blacklist_test_allowed (const struct
 108                                                        GNUNET_PeerIdentity
 109                                                        *peer,
 110                                                        const char
 111                                                        *transport_name,
 112                                                        GST_BlacklistTestContinuation
 113                                                        cont, void *cont_cls);
 114
 115
 116 /**
 117  * Cancel a blacklist check.
 118  *
 119  * @param bc check to cancel
 120  */
 121 void GST_blacklist_test_cancel (struct GST_BlacklistCheck *bc);
 122
 123 #endif
 124 /* end of file gnunet-service-transport_blacklist.h */