2 This file is part of GNUnet.
3 Copyright (C) 2001-2013 GNUnet e.V.
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.
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.
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/>.
20 * @author Jeffrey Burdges
23 * SOCKS proxy for connections
25 * @defgroup socks SOCKS proxy
26 * SOCKS proxy for connections.
30 #ifndef GNUNET_SOCKS_H
31 #define GNUNET_SOCKS_H
36 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_common.h"
45 * Check if a SOCKS proxy is required by a service. Do not use local service
46 * if a SOCKS proxy port is configured as this could deanonymize a user.
48 * @param service_name name of service to connect to
49 * @param cfg configuration to use
50 * @return GNUNET_YES if so, GNUNET_NO if not
53 GNUNET_SOCKS_check_service (const char *service_name,
54 const struct GNUNET_CONFIGURATION_Handle *cfg);
58 * Try to connect to a service configured to use a SOCKS5 proxy.
60 * @param service_name name of service to connect to
61 * @param cfg configuration to use
62 * @return Connection handle that becomes usable when the handshake completes.
63 * NULL if SOCKS not configured or not configured properly
65 struct GNUNET_CONNECTION_Handle *
66 GNUNET_SOCKS_do_connect (const char *service_name,
67 const struct GNUNET_CONFIGURATION_Handle *cfg);
70 #if 0 /* keep Emacsens' auto-indent happy */
77 /* ifndef GNUNET_SOCKS_H */
80 /** @} */ /* end of group */
82 /* end of gnunet_socks.h */