w32: Fix build problem with dirmngr.
[gnupg.git] / common / http.h
1 /* http.h  -  HTTP protocol handler
2  * Copyright (C) 1999, 2000, 2001, 2003, 2006,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * This file is free software; you can redistribute it and/or modify
8  * it under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * This file is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, see <http://www.gnu.org/licenses/>.
29  */
30 #ifndef GNUPG_COMMON_HTTP_H
31 #define GNUPG_COMMON_HTTP_H
32
33 #include <gpg-error.h>
34 #include "../common/estream.h"
35
36 struct uri_tuple_s
37 {
38   struct uri_tuple_s *next;
39   const char *name;     /* A pointer into name. */
40   char  *value;         /* A pointer to value (a Nul is always appended). */
41   size_t valuelen;      /* The real length of the value; we need it
42                            because the value may contain embedded Nuls. */
43   int no_value;         /* True if no value has been given in the URL. */
44 };
45 typedef struct uri_tuple_s *uri_tuple_t;
46
47 struct parsed_uri_s
48 {
49   /* All these pointers point into BUFFER; most stuff is not escaped. */
50   char *scheme;         /* Pointer to the scheme string (always lowercase). */
51   unsigned int is_http:1; /* This is a HTTP style URI.   */
52   unsigned int use_tls:1; /* Whether TLS should be used. */
53   unsigned int opaque:1;/* Unknown scheme; PATH has the rest.  */
54   unsigned int v6lit:1; /* Host was given as a literal v6 address.  */
55   char *auth;           /* username/password for basic auth.  */
56   char *host;           /* Host (converted to lowercase). */
57   unsigned short port;  /* Port (always set if the host is set). */
58   char *path;           /* Path. */
59   uri_tuple_t params;   /* ";xxxxx" */
60   uri_tuple_t query;    /* "?xxx=yyy" */
61   char buffer[1];       /* Buffer which holds a (modified) copy of the URI. */
62 };
63 typedef struct parsed_uri_s *parsed_uri_t;
64
65 typedef enum
66   {
67     HTTP_REQ_GET  = 1,
68     HTTP_REQ_HEAD = 2,
69     HTTP_REQ_POST = 3,
70     HTTP_REQ_OPAQUE = 4  /* Internal use.  */
71   }
72 http_req_t;
73
74 /* We put the flag values into an enum, so that gdb can display them. */
75 enum
76   {
77     HTTP_FLAG_TRY_PROXY = 1,     /* Try to use a proxy.  */
78     HTTP_FLAG_SHUTDOWN = 2,      /* Close sending end after the request.  */
79     HTTP_FLAG_LOG_RESP = 8,      /* Log the server respone.  */
80     HTTP_FLAG_FORCE_TLS = 16,    /* Force the use opf TLS.  */
81     HTTP_FLAG_IGNORE_CL = 32,    /* Ignore content-length.  */
82     HTTP_FLAG_IGNORE_IPv4 = 64,  /* Do not use IPv4.  */
83     HTTP_FLAG_IGNORE_IPv6 = 128  /* Do not use IPv6.  */
84   };
85
86
87 struct http_session_s;
88 typedef struct http_session_s *http_session_t;
89
90 struct http_context_s;
91 typedef struct http_context_s *http_t;
92
93 void http_register_tls_callback (gpg_error_t (*cb)(http_t,http_session_t,int));
94 void http_register_tls_ca (const char *fname);
95
96 gpg_error_t http_session_new (http_session_t *r_session,
97                               const char *tls_priority);
98 http_session_t http_session_ref (http_session_t sess);
99 void http_session_release (http_session_t sess);
100
101 void http_session_set_log_cb (http_session_t sess,
102                               void (*cb)(http_session_t, gpg_error_t,
103                                          const char *,
104                                          const void **, size_t *));
105
106
107 gpg_error_t http_parse_uri (parsed_uri_t *ret_uri, const char *uri,
108                             int no_scheme_check);
109
110 void http_release_parsed_uri (parsed_uri_t uri);
111
112 gpg_error_t http_raw_connect (http_t *r_hd,
113                               const char *server, unsigned short port,
114                               unsigned int flags, const char *srvtag);
115
116 gpg_error_t http_open (http_t *r_hd, http_req_t reqtype,
117                        const char *url,
118                        const char *httphost,
119                        const char *auth,
120                        unsigned int flags,
121                        const char *proxy,
122                        http_session_t session,
123                        const char *srvtag,
124                        strlist_t headers);
125
126 void http_start_data (http_t hd);
127
128 gpg_error_t http_wait_response (http_t hd);
129
130 void http_close (http_t hd, int keep_read_stream);
131
132 gpg_error_t http_open_document (http_t *r_hd,
133                                 const char *document,
134                                 const char *auth,
135                                 unsigned int flags,
136                                 const char *proxy,
137                                 http_session_t session,
138                                 const char *srvtag,
139                                 strlist_t headers);
140
141 estream_t http_get_read_ptr (http_t hd);
142 estream_t http_get_write_ptr (http_t hd);
143 unsigned int http_get_status_code (http_t hd);
144 const char *http_get_tls_info (http_t hd, const char *what);
145 const char *http_get_header (http_t hd, const char *name);
146 const char **http_get_header_names (http_t hd);
147 gpg_error_t http_verify_server_credentials (http_session_t sess);
148
149 char *http_escape_string (const char *string, const char *specials);
150 char *http_escape_data (const void *data, size_t datalen, const char *specials);
151
152
153 #endif /*GNUPG_COMMON_HTTP_H*/