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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Jeffrey Burdges
25 * SOCKS proxy for connections
27 * @defgroup socks SOCKS proxy
28 * SOCKS proxy for connections.
32 #ifndef GNUNET_SOCKS_H
33 #define GNUNET_SOCKS_H
38 #if 0 /* keep Emacsens' auto-indent happy */
43 #include "gnunet_common.h"
47 * Check if a SOCKS proxy is required by a service. Do not use local service
48 * if a SOCKS proxy port is configured as this could deanonymize a user.
50 * @param service_name name of service to connect to
51 * @param cfg configuration to use
52 * @return GNUNET_YES if so, GNUNET_NO if not
55 GNUNET_SOCKS_check_service (const char *service_name,
56 const struct GNUNET_CONFIGURATION_Handle *cfg);
60 * Try to connect to a service configured to use a SOCKS5 proxy.
62 * @param service_name name of service to connect to
63 * @param cfg configuration to use
64 * @return Connection handle that becomes usable when the handshake completes.
65 * NULL if SOCKS not configured or not configured properly
67 struct GNUNET_CONNECTION_Handle *
68 GNUNET_SOCKS_do_connect (const char *service_name,
69 const struct GNUNET_CONFIGURATION_Handle *cfg);
72 #if 0 /* keep Emacsens' auto-indent happy */
79 /* ifndef GNUNET_SOCKS_H */
82 /** @} */ /* end of group */
84 /* end of gnunet_socks.h */