1#ifndef HEADER_CURL_SOCKS_H
2#define HEADER_CURL_SOCKS_H
3/***************************************************************************
4 * _ _ ____ _
5 * Project ___| | | | _ \| |
6 * / __| | | | |_) | |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
9 *
10 * Copyright (C) 1998 - 2022, Daniel Stenberg, <[email protected]>, et al.
11 *
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.se/docs/copyright.html.
15 *
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
19 *
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
22 *
23 * SPDX-License-Identifier: curl
24 *
25 ***************************************************************************/
26
27#include "curl_setup.h"
28
29#ifdef CURL_DISABLE_PROXY
30#define Curl_SOCKS4(a,b,c,d,e) CURLE_NOT_BUILT_IN
31#define Curl_SOCKS5(a,b,c,d,e,f) CURLE_NOT_BUILT_IN
32#define Curl_SOCKS_getsock(x,y,z) 0
33#else
34/*
35 * Helper read-from-socket functions. Does the same as Curl_read() but it
36 * blocks until all bytes amount of buffersize will be read. No more, no less.
37 *
38 * This is STUPID BLOCKING behavior
39 */
40int Curl_blockread_all(struct Curl_easy *data,
41 curl_socket_t sockfd,
42 char *buf,
43 ssize_t buffersize,
44 ssize_t *n);
45
46int Curl_SOCKS_getsock(struct connectdata *conn,
47 curl_socket_t *sock,
48 int sockindex);
49/*
50 * This function logs in to a SOCKS4(a) proxy and sends the specifics to the
51 * final destination server.
52 */
53CURLproxycode Curl_SOCKS4(const char *proxy_name,
54 const char *hostname,
55 int remote_port,
56 int sockindex,
57 struct Curl_easy *data,
58 bool *done);
59
60/*
61 * This function logs in to a SOCKS5 proxy and sends the specifics to the
62 * final destination server.
63 */
64CURLproxycode Curl_SOCKS5(const char *proxy_name,
65 const char *proxy_password,
66 const char *hostname,
67 int remote_port,
68 int sockindex,
69 struct Curl_easy *data,
70 bool *done);
71
72#if defined(HAVE_GSSAPI) || defined(USE_WINDOWS_SSPI)
73/*
74 * This function handles the SOCKS5 GSS-API negotiation and initialization
75 */
76CURLcode Curl_SOCKS5_gssapi_negotiate(int sockindex,
77 struct Curl_easy *data);
78#endif
79
80#endif /* CURL_DISABLE_PROXY */
81
82#endif /* HEADER_CURL_SOCKS_H */
83