2 This file is part of GNUnet.
3 (C) 2010 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 transport/transport_api_blacklist.c
23 * @brief library to access the blacklisting functions of the transport service
24 * @author Christian Grothoff
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"
37 * Handle for blacklisting requests.
39 struct GNUNET_TRANSPORT_Blacklist
43 * Connection to transport service.
45 struct GNUNET_CLIENT_Connection *client;
48 * Configuration to use.
50 const struct GNUNET_CONFIGURATION_Handle *cfg;
53 * Pending handle for the current request.
55 struct GNUNET_CLIENT_TransmitHandle *th;
58 * Function to call for determining if a peer is allowed
59 * to communicate with us.
61 GNUNET_TRANSPORT_BlacklistCallback cb;
69 * Peer currently under consideration.
71 struct GNUNET_PeerIdentity peer;
77 * Establish blacklist connection to transport service.
79 * @param br overall handle
82 reconnect (struct GNUNET_TRANSPORT_Blacklist *br);
86 * Send our reply to a blacklisting request.
88 * @param br our overall context
91 reply (struct GNUNET_TRANSPORT_Blacklist *br);
95 * Handle blacklist queries.
97 * @param cls our overall handle
101 query_handler (void *cls, const struct GNUNET_MessageHeader *msg)
103 struct GNUNET_TRANSPORT_Blacklist *br = cls;
104 const struct BlacklistMessage *bm;
106 if ((ntohs (msg->size) != sizeof (struct BlacklistMessage)) ||
107 (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY))
112 bm = (const struct BlacklistMessage *) msg;
113 GNUNET_break (0 == ntohl (bm->is_allowed));
120 * Receive blacklist queries from transport service.
122 * @param br overall handle
125 receive (struct GNUNET_TRANSPORT_Blacklist *br)
127 GNUNET_CLIENT_receive (br->client, &query_handler, br,
128 GNUNET_TIME_UNIT_FOREVER_REL);
133 * Transmit the blacklist initialization request to the service.
135 * @param cls closure (struct GNUNET_TRANSPORT_Blacklist*)
136 * @param size number of bytes available in buf
137 * @param buf where the callee should write the message
138 * @return number of bytes written to buf
141 transmit_blacklist_init (void *cls, size_t size, void *buf)
143 struct GNUNET_TRANSPORT_Blacklist *br = cls;
144 struct GNUNET_MessageHeader req;
151 req.size = htons (sizeof (struct GNUNET_MessageHeader));
152 req.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT);
153 memcpy (buf, &req, sizeof (req));
160 * Establish blacklist connection to transport service.
162 * @param br overall handle
165 reconnect (struct GNUNET_TRANSPORT_Blacklist *br)
167 if (br->client != NULL)
168 GNUNET_CLIENT_disconnect (br->client, GNUNET_NO);
169 br->client = GNUNET_CLIENT_connect ("transport", br->cfg);
170 GNUNET_assert (br->client != NULL);
172 GNUNET_CLIENT_notify_transmit_ready (br->client,
173 sizeof (struct GNUNET_MessageHeader),
174 GNUNET_TIME_UNIT_FOREVER_REL,
175 GNUNET_YES, &transmit_blacklist_init,
181 * Transmit the blacklist response to the service.
183 * @param cls closure (struct GNUNET_TRANSPORT_Blacklist*)
184 * @param size number of bytes available in buf
185 * @param buf where the callee should write the message
186 * @return number of bytes written to buf
189 transmit_blacklist_reply (void *cls, size_t size, void *buf)
191 struct GNUNET_TRANSPORT_Blacklist *br = cls;
192 struct BlacklistMessage req;
199 req.header.size = htons (sizeof (req));
200 req.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY);
201 req.is_allowed = htonl (br->cb (br->cb_cls, &br->peer));
203 memcpy (buf, &req, sizeof (req));
210 * Send our reply to a blacklisting request.
212 * @param br our overall context
215 reply (struct GNUNET_TRANSPORT_Blacklist *br)
218 GNUNET_CLIENT_notify_transmit_ready (br->client,
219 sizeof (struct BlacklistMessage),
220 GNUNET_TIME_UNIT_FOREVER_REL,
221 GNUNET_NO, &transmit_blacklist_reply,
232 * Install a blacklist callback. The service will be queried for all
233 * existing connections as well as any fresh connections to check if
234 * they are permitted. If the blacklisting callback is unregistered,
235 * all hosts that were denied in the past will automatically be
236 * whitelisted again. Cancelling the blacklist handle is also the
237 * only way to re-enable connections from peers that were previously
240 * @param cfg configuration to use
241 * @param cb callback to invoke to check if connections are allowed
242 * @param cb_cls closure for cb
243 * @return NULL on error, otherwise handle for cancellation
245 struct GNUNET_TRANSPORT_Blacklist *
246 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
247 GNUNET_TRANSPORT_BlacklistCallback cb, void *cb_cls)
249 struct GNUNET_CLIENT_Connection *client;
250 struct GNUNET_TRANSPORT_Blacklist *ret;
252 client = GNUNET_CLIENT_connect ("transport", cfg);
255 ret = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_Blacklist));
256 ret->client = client;
259 GNUNET_CLIENT_notify_transmit_ready (client,
260 sizeof (struct GNUNET_MessageHeader),
261 GNUNET_TIME_UNIT_FOREVER_REL,
262 GNUNET_YES, &transmit_blacklist_init,
269 * Abort the blacklist. Note that this function is the only way for
270 * removing a peer from the blacklist.
272 * @param br handle of the request that is to be cancelled
275 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br)
278 GNUNET_CLIENT_notify_transmit_ready_cancel (br->th);
279 GNUNET_CLIENT_disconnect (br->client, GNUNET_NO);
284 /* end of transport_api_blacklist.c */