xref: /freebsd/lib/libfetch/common.h (revision b3e76948)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1998-2014 Dag-Erling Smørgrav
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer
12  *    in this position and unchanged.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef _COMMON_H_INCLUDED
32 #define _COMMON_H_INCLUDED
33 
34 #define FTP_DEFAULT_PORT	21
35 #define HTTP_DEFAULT_PORT	80
36 #define FTP_DEFAULT_PROXY_PORT	21
37 #define HTTP_DEFAULT_PROXY_PORT	3128
38 
39 #ifdef WITH_SSL
40 #include <openssl/crypto.h>
41 #include <openssl/x509.h>
42 #include <openssl/pem.h>
43 #include <openssl/ssl.h>
44 #include <openssl/err.h>
45 #endif
46 
47 /* Connection */
48 typedef struct fetchconn conn_t;
49 struct fetchconn {
50 	int		 sd;		/* socket descriptor */
51 	char		*buf;		/* buffer */
52 	size_t		 bufsize;	/* buffer size */
53 	size_t		 buflen;	/* length of buffer contents */
54 	int		 err;		/* last protocol reply code */
55 #ifdef WITH_SSL
56 	SSL		*ssl;		/* SSL handle */
57 	SSL_CTX		*ssl_ctx;	/* SSL context */
58 	X509		*ssl_cert;	/* server certificate */
59 	const SSL_METHOD *ssl_meth;	/* SSL method */
60 #endif
61 	int		 ref;		/* reference count */
62 };
63 
64 /* Structure used for error message lists */
65 struct fetcherr {
66 	const int	 num;
67 	const int	 cat;
68 	const char	*string;
69 };
70 
71 /* For SOCKS header size */
72 #define HEAD_SIZE	4
73 #define FQDN_SIZE	256
74 #define PACK_SIZE	1
75 #define PORT_SIZE	2
76 #define BUFF_SIZE	HEAD_SIZE + FQDN_SIZE + PACK_SIZE + PORT_SIZE
77 
78 /* SOCKS5 Request Header */
79 #define SOCKS_VERSION_5		0x05
80 /* SOCKS5 CMD */
81 #define SOCKS_CONNECTION	0x01
82 #define SOCKS_BIND		0x02
83 #define SOCKS_UDP		0x03
84 #define SOCKS_NOMETHODS		0xFF
85 #define SOCKS5_NOTIMPLEMENTED	0x00
86 /* SOCKS5 Reserved */
87 #define SOCKS_RSV		0x00
88 /* SOCKS5 Address Type */
89 #define SOCKS_ATYP_IPV4		0x01
90 #define SOCKS_ATYP_DOMAINNAME	0x03
91 #define SOCKS_ATYP_IPV6		0x04
92 /* SOCKS5 Reply Field */
93 #define SOCKS_SUCCESS			0x00
94 #define SOCKS_GENERAL_FAILURE		0x01
95 #define SOCKS_CONNECTION_NOT_ALLOWED	0x02
96 #define SOCKS_NETWORK_UNREACHABLE	0x03
97 #define SOCKS_HOST_UNREACHABLE		0x04
98 #define SOCKS_CONNECTION_REFUSED	0x05
99 #define SOCKS_TTL_EXPIRED		0x06
100 #define SOCKS_COMMAND_NOT_SUPPORTED	0x07
101 #define SOCKS_ADDRESS_NOT_SUPPORTED	0x08
102 
103 /* for fetch_writev */
104 struct iovec;
105 
106 void		 fetch_seterr(struct fetcherr *, int);
107 void		 fetch_syserr(void);
108 void		 fetch_info(const char *, ...) __printflike(1, 2);
109 int		 fetch_socks5_getenv(char **host, int *port);
110 int		 fetch_socks5_init(conn_t *conn, const char *host,
111 		     int port, int verbose);
112 int		 fetch_default_port(const char *);
113 int		 fetch_default_proxy_port(const char *);
114 struct addrinfo *fetch_resolve(const char *, int, int);
115 int		 fetch_bind(int, int, const char *);
116 conn_t		*fetch_connect(const char *, int, int, int);
117 conn_t		*fetch_reopen(int);
118 conn_t		*fetch_ref(conn_t *);
119 #ifdef WITH_SSL
120 int		 fetch_ssl_cb_verify_crt(int, X509_STORE_CTX*);
121 #endif
122 int		 fetch_ssl(conn_t *, const struct url *, int);
123 ssize_t		 fetch_read(conn_t *, char *, size_t);
124 int		 fetch_getln(conn_t *);
125 ssize_t		 fetch_write(conn_t *, const char *, size_t);
126 ssize_t		 fetch_writev(conn_t *, struct iovec *, int);
127 int		 fetch_putln(conn_t *, const char *, size_t);
128 int		 fetch_close(conn_t *);
129 int		 fetch_add_entry(struct url_ent **, int *, int *,
130 		     const char *, struct url_stat *);
131 int		 fetch_netrc_auth(struct url *url);
132 int		 fetch_no_proxy_match(const char *);
133 
134 #define ftp_seterr(n)	 fetch_seterr(ftp_errlist, n)
135 #define http_seterr(n)	 fetch_seterr(http_errlist, n)
136 #define netdb_seterr(n)	 fetch_seterr(netdb_errlist, n)
137 #define url_seterr(n)	 fetch_seterr(url_errlist, n)
138 #define socks5_seterr(n) fetch_seterr(socks5_errlist, n)
139 
140 #ifndef NDEBUG
141 #define DEBUGF(...)							\
142 	do {								\
143 		if (fetchDebug)						\
144 			fprintf(stderr, __VA_ARGS__);			\
145 	} while (0)
146 #else
147 #define DEBUGF(...)							\
148 	do {								\
149 		/* nothing */						\
150 	} while (0)
151 #endif
152 
153 /*
154  * I don't really like exporting http_request() and ftp_request(),
155  * but the HTTP and FTP code occasionally needs to cross-call
156  * eachother, and this saves me from adding a lot of special-case code
157  * to handle those cases.
158  *
159  * Note that _*_request() free purl, which is way ugly but saves us a
160  * whole lot of trouble.
161  */
162 FILE		*http_request(struct url *, const char *,
163 		     struct url_stat *, struct url *, const char *);
164 FILE		*http_request_body(struct url *, const char *,
165 		     struct url_stat *, struct url *, const char *,
166 		     const char *, const char *);
167 FILE		*ftp_request(struct url *, const char *,
168 		     struct url_stat *, struct url *, const char *);
169 
170 /*
171  * Check whether a particular flag is set
172  */
173 #define CHECK_FLAG(x)	(flags && strchr(flags, (x)))
174 
175 #endif
176