xref: /dragonfly/lib/libfetch/common.h (revision 1de703da)
1 /*-
2  * Copyright (c) 1998 Dag-Erling Co�dan Sm�rgrav
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD: src/lib/libfetch/common.h,v 1.7.2.10 2003/06/06 06:45:25 des Exp $
29  * $DragonFly: src/lib/libfetch/common.h,v 1.2 2003/06/17 04:26:49 dillon Exp $
30  */
31 
32 #ifndef _COMMON_H_INCLUDED
33 #define _COMMON_H_INCLUDED
34 
35 #define FTP_DEFAULT_PORT	21
36 #define HTTP_DEFAULT_PORT	80
37 #define FTP_DEFAULT_PROXY_PORT	21
38 #define HTTP_DEFAULT_PROXY_PORT	3128
39 
40 #ifdef WITH_SSL
41 #include <openssl/crypto.h>
42 #include <openssl/x509.h>
43 #include <openssl/pem.h>
44 #include <openssl/ssl.h>
45 #include <openssl/err.h>
46 #endif
47 
48 /* Connection */
49 typedef struct fetchconn conn_t;
50 struct fetchconn {
51 	int		 sd;		/* socket descriptor */
52 	char		*buf;		/* buffer */
53 	size_t		 bufsize;	/* buffer size */
54 	size_t		 buflen;	/* length of buffer contents */
55 	int		 err;		/* last protocol reply code */
56 #ifdef WITH_SSL
57 	SSL		*ssl;		/* SSL handle */
58 	SSL_CTX		*ssl_ctx;	/* SSL context */
59 	X509		*ssl_cert;	/* server certificate */
60 	SSL_METHOD	*ssl_meth;	/* SSL method */
61 #endif
62 	int		 ref;		/* reference count */
63 };
64 
65 /* Structure used for error message lists */
66 struct fetcherr {
67 	const int	 num;
68 	const int	 cat;
69 	const char	*string;
70 };
71 
72 /* for _fetch_writev */
73 struct iovec;
74 
75 void		 _fetch_seterr(struct fetcherr *, int);
76 void		 _fetch_syserr(void);
77 void		 _fetch_info(const char *, ...);
78 int		 _fetch_default_port(const char *);
79 int		 _fetch_default_proxy_port(const char *);
80 int		 _fetch_bind(int, int, const char *);
81 conn_t		*_fetch_connect(const char *, int, int, int);
82 conn_t		*_fetch_reopen(int);
83 conn_t		*_fetch_ref(conn_t *);
84 int		 _fetch_ssl(conn_t *, int);
85 ssize_t		 _fetch_read(conn_t *, char *, size_t);
86 int		 _fetch_getln(conn_t *);
87 ssize_t		 _fetch_write(conn_t *, const char *, size_t);
88 ssize_t		 _fetch_writev(conn_t *, struct iovec *, int);
89 int		 _fetch_putln(conn_t *, const char *, size_t);
90 int		 _fetch_close(conn_t *);
91 int		 _fetch_add_entry(struct url_ent **, int *, int *,
92 		     const char *, struct url_stat *);
93 int		 _fetch_netrc_auth(struct url *url);
94 
95 #define _ftp_seterr(n)	 _fetch_seterr(_ftp_errlist, n)
96 #define _http_seterr(n)	 _fetch_seterr(_http_errlist, n)
97 #define _netdb_seterr(n) _fetch_seterr(_netdb_errlist, n)
98 #define _url_seterr(n)	 _fetch_seterr(_url_errlist, n)
99 
100 #ifndef NDEBUG
101 #define DEBUG(x) do { if (fetchDebug) { x; } } while (0)
102 #else
103 #define DEBUG(x) do { } while (0)
104 #endif
105 
106 /*
107  * I don't really like exporting _http_request() and _ftp_request(),
108  * but the HTTP and FTP code occasionally needs to cross-call
109  * eachother, and this saves me from adding a lot of special-case code
110  * to handle those cases.
111  *
112  * Note that _*_request() free purl, which is way ugly but saves us a
113  * whole lot of trouble.
114  */
115 FILE		*_http_request(struct url *, const char *,
116 		     struct url_stat *, struct url *, const char *);
117 FILE		*_ftp_request(struct url *, const char *,
118 		     struct url_stat *, struct url *, const char *);
119 
120 /*
121  * Check whether a particular flag is set
122  */
123 #define CHECK_FLAG(x)	(flags && strchr(flags, (x)))
124 
125 #endif
126