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  */
  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         struct {                        /* data cached after an interrupted
  56                                            read */
  57                 char    *buf;
  58                 size_t   size;
  59                 size_t   pos;
  60                 size_t   len;
  61         } cache;
  62 #ifdef WITH_SSL
  63         SSL             *ssl;           /* SSL handle */
  64         SSL_CTX         *ssl_ctx;       /* SSL context */
  65         X509            *ssl_cert;      /* server certificate */
  66         const SSL_METHOD *ssl_meth;     /* SSL method */
  67 #endif
  68         int              ref;           /* reference count */
  69 };
  70
  71 /* Structure used for error message lists */
  72 struct fetcherr {
  73         const int        num;
  74         const int        cat;
  75         const char      *string;
  76 };
  77
  78 /* for fetch_writev */
  79 struct iovec;
  80
  81 void             fetch_seterr(struct fetcherr *, int);
  82 void             fetch_syserr(void);
  83 void             fetch_info(const char *, ...) __printflike(1, 2);
  84 int              fetch_default_port(const char *);
  85 int              fetch_default_proxy_port(const char *);
  86 int              fetch_bind(int, int, const char *);
  87 conn_t          *fetch_connect(const char *, int, int, int);
  88 conn_t          *fetch_reopen(int);
  89 conn_t          *fetch_ref(conn_t *);
  90 int              fetch_ssl(conn_t *, int);
  91 ssize_t          fetch_read(conn_t *, char *, size_t);
  92 int              fetch_getln(conn_t *);
  93 ssize_t          fetch_write(conn_t *, const char *, size_t);
  94 ssize_t          fetch_writev(conn_t *, struct iovec *, int);
  95 int              fetch_putln(conn_t *, const char *, size_t);
  96 int              fetch_close(conn_t *);
  97 int              fetch_add_entry(struct url_ent **, int *, int *,
  98                      const char *, struct url_stat *);
  99 int              fetch_netrc_auth(struct url *url);
 100 int              fetch_no_proxy_match(const char *);
 101
 102 #define ftp_seterr(n)    fetch_seterr(ftp_errlist, n)
 103 #define http_seterr(n)   fetch_seterr(http_errlist, n)
 104 #define netdb_seterr(n)  fetch_seterr(netdb_errlist, n)
 105 #define url_seterr(n)    fetch_seterr(url_errlist, n)
 106
 107 #ifndef NDEBUG
 108 #define DEBUG(x) do { if (fetchDebug) { x; } } while (0)
 109 #else
 110 #define DEBUG(x) do { } while (0)
 111 #endif
 112
 113 /*
 114  * I don't really like exporting http_request() and ftp_request(),
 115  * but the HTTP and FTP code occasionally needs to cross-call
 116  * eachother, and this saves me from adding a lot of special-case code
 117  * to handle those cases.
 118  *
 119  * Note that _*_request() free purl, which is way ugly but saves us a
 120  * whole lot of trouble.
 121  */
 122 FILE            *http_request(struct url *, const char *,
 123                      struct url_stat *, struct url *, const char *);
 124 FILE            *ftp_request(struct url *, const char *,
 125                      struct url_stat *, struct url *, const char *);
 126
 127 /*
 128  * Check whether a particular flag is set
 129  */
 130 #define CHECK_FLAG(x)   (flags && strchr(flags, (x)))
 131
 132 #endif