src/transport/transport_api_blacklist.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010 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/transport_api_blacklist.c
  23  * @brief library to access the blacklisting functions of the transport service
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_client_lib.h"
  28 #include "gnunet_arm_service.h"
  29 #include "gnunet_hello_lib.h"
  30 #include "gnunet_protocols.h"
  31 #include "gnunet_server_lib.h"
  32 #include "gnunet_time_lib.h"
  33 #include "gnunet_transport_service.h"
  34 #include "transport.h"
  35
  36 /**
  37  * Handle for blacklisting requests.
  38  */
  39 struct GNUNET_TRANSPORT_Blacklist
  40 {
  41
  42   /**
  43    * Connection to transport service.
  44    */
  45   struct GNUNET_CLIENT_Connection * client;
  46
  47   /**
  48    * Configuration to use.
  49    */
  50   const struct GNUNET_CONFIGURATION_Handle *cfg;
  51
  52   /**
  53    * Pending handle for the current request.
  54    */
  55   struct GNUNET_CLIENT_TransmitHandle *th;
  56
  57   /**
  58    * Function to call for determining if a peer is allowed
  59    * to communicate with us.
  60    */
  61   GNUNET_TRANSPORT_BlacklistCallback cb;
  62
  63   /**
  64    * Closure for 'cb'.
  65    */
  66   void *cb_cls;
  67
  68   /**
  69    * Peer currently under consideration.
  70    */
  71   struct GNUNET_PeerIdentity peer;
  72
  73 };
  74
  75
  76 /**
  77  * Establish blacklist connection to transport service.
  78  *
  79  * @param br overall handle
  80  */
  81 static void
  82 reconnect (struct GNUNET_TRANSPORT_Blacklist *br);
  83
  84
  85 /**
  86  * Send our reply to a blacklisting request.
  87  *
  88  * @param br our overall context
  89  */
  90 static void
  91 reply (struct GNUNET_TRANSPORT_Blacklist *br);
  92
  93
  94 /**
  95  * Handle blacklist queries.
  96  *
  97  * @param cls our overall handle
  98  * @param msg query
  99  */
 100 static void
 101 query_handler (void *cls,
 102                const struct GNUNET_MessageHeader *msg)
 103 {
 104   struct GNUNET_TRANSPORT_Blacklist *br = cls;
 105   const struct BlacklistMessage *bm;
 106
 107   if ( (ntohs(msg->size) != sizeof (struct BlacklistMessage)) ||
 108        (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY) )
 109     {
 110       reconnect (br);
 111       return;
 112     }
 113   bm = (const struct BlacklistMessage *)msg;
 114   GNUNET_break (0 == ntohl (bm->is_allowed));
 115   br->peer = bm->peer;
 116   reply (br);
 117 }
 118
 119
 120 /**
 121  * Receive blacklist queries from transport service.
 122  *
 123  * @param br overall handle
 124  */
 125 static void
 126 receive (struct GNUNET_TRANSPORT_Blacklist *br)
 127 {
 128   GNUNET_CLIENT_receive (br->client,
 129                          &query_handler,
 130                          br,
 131                          GNUNET_TIME_UNIT_FOREVER_REL);
 132 }
 133
 134
 135 /**
 136  * Transmit the blacklist initialization request to the service.
 137  *
 138  * @param cls closure (struct GNUNET_TRANSPORT_Blacklist*)
 139  * @param size number of bytes available in buf
 140  * @param buf where the callee should write the message
 141  * @return number of bytes written to buf
 142  */
 143 static size_t
 144 transmit_blacklist_init (void *cls,
 145                          size_t size, void *buf)
 146 {
 147   struct GNUNET_TRANSPORT_Blacklist *br = cls;
 148   struct GNUNET_MessageHeader req;
 149
 150   if (buf == NULL)
 151     {
 152       reconnect (br);
 153       return 0;
 154     }
 155   req.size = htons (sizeof (struct GNUNET_MessageHeader));
 156   req.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT);
 157   memcpy (buf, &req, sizeof (req));
 158   receive (br);
 159   return sizeof (req);
 160 }
 161
 162
 163 /**
 164  * Establish blacklist connection to transport service.
 165  *
 166  * @param br overall handle
 167  */
 168 static void
 169 reconnect (struct GNUNET_TRANSPORT_Blacklist *br)
 170 {
 171   if (br->client != NULL)
 172     GNUNET_CLIENT_disconnect (br->client, GNUNET_NO);
 173   br->client = GNUNET_CLIENT_connect ("transport",
 174                                       br->cfg);
 175   GNUNET_assert (br->client != NULL);
 176   br->th = GNUNET_CLIENT_notify_transmit_ready (br->client,
 177                                                 sizeof (struct GNUNET_MessageHeader),
 178                                                 GNUNET_TIME_UNIT_FOREVER_REL,
 179                                                 GNUNET_YES,
 180                                                 &transmit_blacklist_init,
 181                                                 br);
 182 }
 183
 184
 185 /**
 186  * Transmit the blacklist response to the service.
 187  *
 188  * @param cls closure (struct GNUNET_TRANSPORT_Blacklist*)
 189  * @param size number of bytes available in buf
 190  * @param buf where the callee should write the message
 191  * @return number of bytes written to buf
 192  */
 193 static size_t
 194 transmit_blacklist_reply (void *cls,
 195                           size_t size, void *buf)
 196 {
 197   struct GNUNET_TRANSPORT_Blacklist *br = cls;
 198   struct BlacklistMessage req;
 199
 200   if (buf == NULL)
 201     {
 202       reconnect (br);
 203       return 0;
 204     }
 205   req.header.size = htons (sizeof (req));
 206   req.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY);
 207   req.is_allowed = htonl (br->cb (br->cb_cls, &br->peer));
 208   req.peer = br->peer;
 209   memcpy (buf, &req, sizeof (req));
 210   receive (br);
 211   return sizeof (req);
 212 }
 213
 214
 215 /**
 216  * Send our reply to a blacklisting request.
 217  *
 218  * @param br our overall context
 219  */
 220 static void
 221 reply (struct GNUNET_TRANSPORT_Blacklist *br)
 222 {
 223   br->th = GNUNET_CLIENT_notify_transmit_ready (br->client,
 224                                                 sizeof (struct BlacklistMessage),
 225                                                 GNUNET_TIME_UNIT_FOREVER_REL,
 226                                                 GNUNET_NO,
 227                                                 &transmit_blacklist_reply,
 228                                                 br);
 229   if (br->th == NULL)
 230     {
 231       reconnect (br);
 232       return;
 233     }
 234 }
 235
 236
 237 /**
 238  * Install a blacklist callback.  The service will be queried for all
 239  * existing connections as well as any fresh connections to check if
 240  * they are permitted.  If the blacklisting callback is unregistered,
 241  * all hosts that were denied in the past will automatically be
 242  * whitelisted again.  Cancelling the blacklist handle is also the
 243  * only way to re-enable connections from peers that were previously
 244  * blacklisted.
 245  *
 246  * @param cfg configuration to use
 247  * @param cb callback to invoke to check if connections are allowed
 248  * @param cb_cls closure for cb
 249  * @return NULL on error, otherwise handle for cancellation
 250  */
 251 struct GNUNET_TRANSPORT_Blacklist *
 252 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
 253                             GNUNET_TRANSPORT_BlacklistCallback cb,
 254                             void *cb_cls)
 255 {
 256   struct GNUNET_CLIENT_Connection * client;
 257   struct GNUNET_TRANSPORT_Blacklist *ret;
 258
 259   client = GNUNET_CLIENT_connect ("transport", cfg);
 260   if (NULL == client)
 261     return NULL;
 262   ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Blacklist));
 263   ret->client = client;
 264   ret->cfg = cfg;
 265   ret->th = GNUNET_CLIENT_notify_transmit_ready (client,
 266                                                  sizeof (struct GNUNET_MessageHeader),
 267                                                  GNUNET_TIME_UNIT_FOREVER_REL,
 268                                                  GNUNET_YES,
 269                                                  &transmit_blacklist_init,
 270                                                  ret);
 271   return ret;
 272 }
 273
 274
 275 /**
 276  * Abort the blacklist.  Note that this function is the only way for
 277  * removing a peer from the blacklist.
 278  *
 279  * @param br handle of the request that is to be cancelled
 280  */
 281 void
 282 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br)
 283 {
 284   if (br->th != NULL)
 285     GNUNET_CLIENT_notify_transmit_ready_cancel (br->th);
 286   GNUNET_CLIENT_disconnect (br->client, GNUNET_NO);
 287   GNUNET_free (br);
 288 }
 289
 290
 291 /* end of transport_api_blacklist.c */