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