2 * Copyright (c) 1998-2011 Dag-Erling Smørgrav
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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
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.
31 #ifndef _COMMON_H_INCLUDED
32 #define _COMMON_H_INCLUDED
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
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>
48 typedef struct fetchconn conn_t;
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 */
56 SSL *ssl; /* SSL handle */
57 SSL_CTX *ssl_ctx; /* SSL context */
58 X509 *ssl_cert; /* server certificate */
59 SSL_METHOD *ssl_meth; /* SSL method */
61 int ref; /* reference count */
64 /* Structure used for error message lists */
71 /* for fetch_writev */
74 void fetch_seterr(struct fetcherr *, int);
75 void fetch_syserr(void);
76 void fetch_info(const char *, ...);
77 int fetch_default_port(const char *);
78 int fetch_default_proxy_port(const char *);
79 int fetch_bind(int, int, const char *);
80 conn_t *fetch_connect(const char *, int, int, int);
81 conn_t *fetch_reopen(int);
82 conn_t *fetch_ref(conn_t *);
83 int fetch_ssl(conn_t *, int);
84 ssize_t fetch_read(conn_t *, char *, size_t);
85 int fetch_getln(conn_t *);
86 ssize_t fetch_write(conn_t *, const char *, size_t);
87 ssize_t fetch_writev(conn_t *, struct iovec *, int);
88 int fetch_putln(conn_t *, const char *, size_t);
89 int fetch_close(conn_t *);
90 int fetch_add_entry(struct url_ent **, int *, int *,
91 const char *, struct url_stat *);
92 int fetch_netrc_auth(struct url *url);
93 int fetch_no_proxy_match(const char *);
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)
101 #define DEBUG(x) do { if (fetchDebug) { x; } } while (0)
103 #define DEBUG(x) do { } while (0)
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.
112 * Note that _*_request() free purl, which is way ugly but saves us a
113 * whole lot of trouble.
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 *);
121 * Check whether a particular flag is set
123 #define CHECK_FLAG(x) (flags && strchr(flags, (x)))