common.h revision 1.1.1.2.8.1.2.1 
1/*	$NetBSD: common.h,v 1.1.1.2.8.1.2.1 2010/04/21 05:23:08 matt Exp $	*/
2/*-
3 * Copyright (c) 1998-2004 Dag-Erling Co�dan Sm�rgrav
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer
11 *    in this position and unchanged.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 *    derived from this software without specific prior written permission
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * $FreeBSD: common.h,v 1.30 2007/12/18 11:03:07 des 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#if !defined(__sun) && !defined(__hpux) && !defined(__INTERIX) && \
49    !defined(__digital__) && !defined(__linux) && !defined(__MINT__) && \
50    !defined(__sgi)
51#define HAVE_SA_LEN
52#endif
53
54/* Connection */
55typedef struct fetchconn conn_t;
56
57struct fetchconn {
58	int		 sd;		/* socket descriptor */
59	char		*buf;		/* buffer */
60	size_t		 bufsize;	/* buffer size */
61	size_t		 buflen;	/* length of buffer contents */
62	char		*next_buf;	/* pending buffer, e.g. after getln */
63	size_t		 next_len;	/* size of pending buffer */
64	int		 err;		/* last protocol reply code */
65#ifdef WITH_SSL
66	SSL		*ssl;		/* SSL handle */
67	SSL_CTX		*ssl_ctx;	/* SSL context */
68	X509		*ssl_cert;	/* server certificate */
69#  if OPENSSL_VERSION_NUMBER < 0x00909000L
70	SSL_METHOD *ssl_meth;		/* SSL method */
71#  else
72	const SSL_METHOD *ssl_meth;	/* SSL method */
73#  endif
74#endif
75
76	struct url	*cache_url;
77	int		cache_af;
78	int		(*cache_close)(conn_t *);
79	conn_t		*next_cached;
80};
81
82/* Structure used for error message lists */
83struct fetcherr {
84	const int	 num;
85	const int	 cat;
86	const char	*string;
87};
88
89void		 fetch_seterr(struct fetcherr *, int);
90void		 fetch_syserr(void);
91void		 fetch_info(const char *, ...);
92int		 fetch_default_port(const char *);
93int		 fetch_default_proxy_port(const char *);
94int		 fetch_bind(int, int, const char *);
95conn_t		*fetch_cache_get(const struct url *, int);
96void		 fetch_cache_put(conn_t *, int (*)(conn_t *));
97conn_t		*fetch_connect(struct url *, int, int);
98conn_t		*fetch_reopen(int);
99int		 fetch_ssl(conn_t *, int);
100ssize_t		 fetch_read(conn_t *, char *, size_t);
101int		 fetch_getln(conn_t *);
102ssize_t		 fetch_write(conn_t *, const void *, size_t);
103int		 fetch_close(conn_t *);
104int		 fetch_add_entry(struct url_list *, struct url *, const char *, int);
105int		 fetch_netrc_auth(struct url *url);
106int		 fetch_no_proxy_match(const char *);
107int		 fetch_urlpath_safe(char);
108
109#define ftp_seterr(n)	 fetch_seterr(ftp_errlist, n)
110#define http_seterr(n)	 fetch_seterr(http_errlist, n)
111#define netdb_seterr(n)	 fetch_seterr(netdb_errlist, n)
112#define url_seterr(n)	 fetch_seterr(url_errlist, n)
113
114fetchIO		*fetchIO_unopen(void *, ssize_t (*)(void *, void *, size_t),
115    ssize_t (*)(void *, const void *, size_t), void (*)(void *));
116
117/*
118 * I don't really like exporting http_request() and ftp_request(),
119 * but the HTTP and FTP code occasionally needs to cross-call
120 * eachother, and this saves me from adding a lot of special-case code
121 * to handle those cases.
122 *
123 * Note that _*_request() free purl, which is way ugly but saves us a
124 * whole lot of trouble.
125 */
126fetchIO		*http_request(struct url *, const char *,
127		     struct url_stat *, struct url *, const char *);
128fetchIO		*ftp_request(struct url *, const char *, const char *,
129		     struct url_stat *, struct url *, const char *);
130
131
132/*
133 * Check whether a particular flag is set
134 */
135#define CHECK_FLAG(x)	(flags && strchr(flags, (x)))
136
137#endif
138