common.h revision 97868 
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: head/lib/libfetch/common.h 97868 2002-06-05 12:46:36Z des $
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#include <openssl/crypto.h>
40#include <openssl/x509.h>
41#include <openssl/pem.h>
42#include <openssl/ssl.h>
43#include <openssl/err.h>
44
45/* Connection */
46typedef struct fetchconn conn_t;
47struct fetchconn {
48	int		 sd;		/* socket descriptor */
49	char		*buf;		/* buffer */
50	size_t		 bufsize;	/* buffer size */
51	size_t		 buflen;	/* length of buffer contents */
52	int		 err;		/* last protocol reply code */
53	SSL		*ssl;		/* SSL handle */
54	SSL_CTX		*ssl_ctx;	/* SSL context */
55	X509		*ssl_cert;	/* server certificate */
56	SSL_METHOD	*ssl_meth;	/* SSL method */
57};
58
59/* Structure used for error message lists */
60struct fetcherr {
61	const int	 num;
62	const int	 cat;
63	const char	*string;
64};
65
66void		 _fetch_seterr(struct fetcherr *, int);
67void		 _fetch_syserr(void);
68void		 _fetch_info(const char *, ...);
69int		 _fetch_default_port(const char *);
70int		 _fetch_default_proxy_port(const char *);
71conn_t		*_fetch_connect(const char *, int, int, int);
72conn_t		*_fetch_reopen(int);
73int		 _fetch_ssl(conn_t *, int);
74ssize_t		 _fetch_read(conn_t *, char *, size_t);
75int		 _fetch_getln(conn_t *);
76ssize_t		 _fetch_write(conn_t *, const char *, size_t);
77int		 _fetch_putln(conn_t *, const char *, size_t);
78int		 _fetch_close(conn_t *);
79int		 _fetch_add_entry(struct url_ent **, int *, int *,
80		     const char *, struct url_stat *);
81
82#define _ftp_seterr(n)	 _fetch_seterr(_ftp_errlist, n)
83#define _http_seterr(n)	 _fetch_seterr(_http_errlist, n)
84#define _netdb_seterr(n) _fetch_seterr(_netdb_errlist, n)
85#define _url_seterr(n)	 _fetch_seterr(_url_errlist, n)
86
87#ifndef NDEBUG
88#define DEBUG(x) do { if (fetchDebug) { x; } } while (0)
89#else
90#define DEBUG(x) do { } while (0)
91#endif
92
93/*
94 * I don't really like exporting _http_request() and _ftp_request(),
95 * but the HTTP and FTP code occasionally needs to cross-call
96 * eachother, and this saves me from adding a lot of special-case code
97 * to handle those cases.
98 *
99 * Note that _*_request() free purl, which is way ugly but saves us a
100 * whole lot of trouble.
101 */
102FILE		*_http_request(struct url *, const char *,
103		     struct url_stat *, struct url *, const char *);
104FILE		*_ftp_request(struct url *, const char *,
105		     struct url_stat *, struct url *, const char *);
106
107/*
108 * Check whether a particular flag is set
109 */
110#define CHECK_FLAG(x)	(flags && strchr(flags, (x)))
111
112#endif
113