1 /*- 2 * Copyright (c) 1998-2004 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.27.6.1 2006/11/11 00:16:07 des Exp $ 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 #ifdef WITH_SSL 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> 45 #endif 46 47 /* Connection */ 48 typedef struct fetchconn conn_t; 49 struct fetchconn { 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 */ 55 #ifdef WITH_SSL 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 */ 60 #endif 61 int ref; /* reference count */ 62 }; 63 64 /* Structure used for error message lists */ 65 struct fetcherr { 66 const int num; 67 const int cat; 68 const char *string; 69 }; 70 71 /* for _fetch_writev */ 72 struct iovec; 73 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 94 #define _ftp_seterr(n) _fetch_seterr(_ftp_errlist, n) 95 #define _http_seterr(n) _fetch_seterr(_http_errlist, n) 96 #define _netdb_seterr(n) _fetch_seterr(_netdb_errlist, n) 97 #define _url_seterr(n) _fetch_seterr(_url_errlist, n) 98 99 #ifndef NDEBUG 100 #define DEBUG(x) do { if (fetchDebug) { x; } } while (/* CONSTCOND */ 0) 101 #else 102 #define DEBUG(x) do { } while (/* CONSTCOND */ 0) 103 #endif 104 105 /* 106 * I don't really like exporting _http_request() and _ftp_request(), 107 * but the HTTP and FTP code occasionally needs to cross-call 108 * eachother, and this saves me from adding a lot of special-case code 109 * to handle those cases. 110 * 111 * Note that _*_request() free purl, which is way ugly but saves us a 112 * whole lot of trouble. 113 */ 114 FILE *_http_request(struct url *, const char *, 115 struct url_stat *, struct url *, const char *); 116 FILE *_ftp_request(struct url *, const char *, 117 struct url_stat *, struct url *, const char *); 118 119 /* 120 * Check whether a particular flag is set 121 */ 122 #define CHECK_FLAG(x) (flags && strchr(flags, (x))) 123 124 #endif 125