lib/libfetch/common.h

   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.30 2007/12/18 11:03:07 des Exp $
  29  * $DragonFly: src/lib/libfetch/common.h,v 1.3 2007/08/05 21:48:12 swildner 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 /* Connection */
  49 typedef struct fetchconn conn_t;
  50 struct fetchconn {
  51         int              sd;            /* socket descriptor */
  52         char            *buf;           /* buffer */
  53         size_t           bufsize;       /* buffer size */
  54         size_t           buflen;        /* length of buffer contents */
  55         int              err;           /* last protocol reply code */
  56 #ifdef WITH_SSL
  57         SSL             *ssl;           /* SSL handle */
  58         SSL_CTX         *ssl_ctx;       /* SSL context */
  59         X509            *ssl_cert;      /* server certificate */
  60         const SSL_METHOD *ssl_meth;     /* SSL method */
  61 #endif
  62         int              ref;           /* reference count */
  63 };
  64
  65 /* Structure used for error message lists */
  66 struct fetcherr {
  67         const int        num;
  68         const int        cat;
  69         const char      *string;
  70 };
  71
  72 /* for fetch_writev */
  73 struct iovec;
  74
  75 void             fetch_seterr(struct fetcherr *, int);
  76 void             fetch_syserr(void);
  77 void             fetch_info(const char *, ...);
  78 int              fetch_default_port(const char *);
  79 int              fetch_default_proxy_port(const char *);
  80 int              fetch_bind(int, int, const char *);
  81 conn_t          *fetch_connect(const char *, int, int, int);
  82 conn_t          *fetch_reopen(int);
  83 conn_t          *fetch_ref(conn_t *);
  84 int              fetch_ssl(conn_t *, int);
  85 ssize_t          fetch_read(conn_t *, char *, size_t);
  86 int              fetch_getln(conn_t *);
  87 ssize_t          fetch_write(conn_t *, const char *, size_t);
  88 ssize_t          fetch_writev(conn_t *, struct iovec *, int);
  89 int              fetch_putln(conn_t *, const char *, size_t);
  90 int              fetch_close(conn_t *);
  91 int              fetch_add_entry(struct url_ent **, int *, int *,
  92                      const char *, struct url_stat *);
  93 int              fetch_netrc_auth(struct url *url);
  94 int              fetch_no_proxy_match(const char *);
  95
  96 #define ftp_seterr(n)    fetch_seterr(ftp_errlist, n)
  97 #define http_seterr(n)   fetch_seterr(http_errlist, n)
  98 #define netdb_seterr(n)  fetch_seterr(netdb_errlist, n)
  99 #define url_seterr(n)    fetch_seterr(url_errlist, n)
 100
 101 #ifndef NDEBUG
 102 #define DEBUG(x) do { if (fetchDebug) { x; } } while (0)
 103 #else
 104 #define DEBUG(x) do { } while (0)
 105 #endif
 106
 107 /*
 108  * I don't really like exporting http_request() and ftp_request(),
 109  * but the HTTP and FTP code occasionally needs to cross-call
 110  * eachother, and this saves me from adding a lot of special-case code
 111  * to handle those cases.
 112  *
 113  * Note that _*_request() free purl, which is way ugly but saves us a
 114  * whole lot of trouble.
 115  */
 116 FILE            *http_request(struct url *, const char *,
 117                      struct url_stat *, struct url *, const char *);
 118 FILE            *ftp_request(struct url *, const char *,
 119                      struct url_stat *, struct url *, const char *);
 120
 121 /*
 122  * Check whether a particular flag is set
 123  */
 124 #define CHECK_FLAG(x)   (flags && strchr(flags, (x)))
 125
 126 #endif