dirmngr: New function http_status2string.
[gnupg.git] / dirmngr / http.h
1 /* http.h  -  HTTP protocol handler
2  * Copyright (C) 1999, 2000, 2001, 2003, 2006,
3  *               2010 Free Software Foundation, Inc.
4  * Copyright (C) 2015  g10 Code GmbH
5  *
6  * This file is part of GnuPG.
7  *
8  * This file is free software; you can redistribute it and/or modify
9  * it under the terms of either
10  *
11  *   - the GNU Lesser General Public License as published by the Free
12  *     Software Foundation; either version 3 of the License, or (at
13  *     your option) any later version.
14  *
15  * or
16  *
17  *   - the GNU General Public License as published by the Free
18  *     Software Foundation; either version 2 of the License, or (at
19  *     your option) any later version.
20  *
21  * or both in parallel, as here.
22  *
23  * This file is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program; if not, see <https://www.gnu.org/licenses/>.
30  */
31 #ifndef GNUPG_COMMON_HTTP_H
32 #define GNUPG_COMMON_HTTP_H
33
34 #include <gpg-error.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 *original;       /* Unmodified copy of the parsed URI.  */
51   char *scheme;         /* Pointer to the scheme string (always lowercase). */
52   unsigned int is_http:1; /* This is a HTTP style URI.   */
53   unsigned int use_tls:1; /* Whether TLS should be used. */
54   unsigned int opaque:1;/* Unknown scheme; PATH has the rest.  */
55   unsigned int v6lit:1; /* Host was given as a literal v6 address.  */
56   unsigned int onion:1; /* .onion address given.  */
57   unsigned int explicit_port :1; /* The port was explicitly specified.  */
58   char *auth;           /* username/password for basic auth.  */
59   char *host;           /* Host (converted to lowercase). */
60   unsigned short port;  /* Port (always set if the host is set). */
61   unsigned short off_host; /* Offset to the HOST respective PATH parts  */
62   unsigned short off_path; /* in the original URI buffer.               */
63   char *path;           /* Path. */
64   uri_tuple_t params;   /* ";xxxxx" */
65   uri_tuple_t query;    /* "?xxx=yyy" */
66   char buffer[1];       /* Buffer which holds a (modified) copy of the URI. */
67 };
68 typedef struct parsed_uri_s *parsed_uri_t;
69
70 struct uri_tuple_s *uri_query_lookup (parsed_uri_t uri, const char *key);
71
72 typedef enum
73   {
74     HTTP_REQ_GET  = 1,
75     HTTP_REQ_HEAD = 2,
76     HTTP_REQ_POST = 3,
77     HTTP_REQ_OPAQUE = 4  /* Internal use.  */
78   }
79 http_req_t;
80
81 /* We put the flag values into an enum, so that gdb can display them. */
82 enum
83   {
84     HTTP_FLAG_TRY_PROXY = 1,     /* Try to use a proxy.  */
85     HTTP_FLAG_SHUTDOWN = 2,      /* Close sending end after the request.  */
86     HTTP_FLAG_FORCE_TOR = 4,     /* Force a TOR connection.  */
87     HTTP_FLAG_LOG_RESP = 8,      /* Log the server response.  */
88     HTTP_FLAG_FORCE_TLS = 16,    /* Force the use of TLS.  */
89     HTTP_FLAG_IGNORE_CL = 32,    /* Ignore content-length.  */
90     HTTP_FLAG_IGNORE_IPv4 = 64,  /* Do not use IPv4.  */
91     HTTP_FLAG_IGNORE_IPv6 = 128, /* Do not use IPv6.  */
92     HTTP_FLAG_TRUST_DEF   = 256, /* Use the CAs configured for HKP.  */
93     HTTP_FLAG_TRUST_SYS   = 512, /* Also use the system defined CAs. */
94     HTTP_FLAG_TRUST_CFG  = 1024, /* Also use configured CAs.         */
95     HTTP_FLAG_NO_CRL     = 2048  /* Do not consult CRLs for https.   */
96   };
97
98
99 struct http_session_s;
100 typedef struct http_session_s *http_session_t;
101
102 struct http_context_s;
103 typedef struct http_context_s *http_t;
104
105 /* An object used to track redirection infos.  */
106 struct http_redir_info_s
107 {
108   unsigned int redirects_left;   /* Number of still possible redirects.    */
109   const char *orig_url;          /* The original requested URL.            */
110   unsigned int orig_onion:1;     /* Original request was an onion address. */
111   unsigned int orig_https:1;     /* Original request was a http address.   */
112   unsigned int silent:1;         /* No diagnostics.                        */
113   unsigned int allow_downgrade:1;/* Allow a downgrade from https to http.  */
114   unsigned int trust_location:1; /* Trust the received Location header.    */
115 };
116 typedef struct http_redir_info_s http_redir_info_t;
117
118
119
120 /* A TLS verify callback function.  */
121 typedef gpg_error_t (*http_verify_cb_t) (void *opaque,
122                                          http_t http,
123                                          http_session_t session,
124                                          unsigned int flags,
125                                          void *tls_context);
126
127 void http_set_verbose (int verbose, int debug);
128
129 void http_register_tls_callback (gpg_error_t (*cb)(http_t,http_session_t,int));
130 void http_register_tls_ca (const char *fname);
131 void http_register_cfg_ca (const char *fname);
132 void http_register_netactivity_cb (void (*cb)(void));
133
134
135 gpg_error_t http_session_new (http_session_t *r_session,
136                               const char *intended_hostname,
137                               unsigned int flags,
138                               http_verify_cb_t cb,
139                               void *cb_value);
140 http_session_t http_session_ref (http_session_t sess);
141 void http_session_release (http_session_t sess);
142
143 void http_session_set_log_cb (http_session_t sess,
144                               void (*cb)(http_session_t, gpg_error_t,
145                                          const char *,
146                                          const void **, size_t *));
147 void http_session_set_timeout (http_session_t sess, unsigned int timeout);
148
149
150 gpg_error_t http_parse_uri (parsed_uri_t *ret_uri, const char *uri,
151                             int no_scheme_check);
152
153 void http_release_parsed_uri (parsed_uri_t uri);
154
155 gpg_error_t http_raw_connect (ctrl_t ctrl, http_t *r_hd,
156                               const char *server, unsigned short port,
157                               unsigned int flags, const char *srvtag,
158                               unsigned int timeout);
159
160 gpg_error_t http_open (ctrl_t ctrl, http_t *r_hd, http_req_t reqtype,
161                        const char *url,
162                        const char *httphost,
163                        const char *auth,
164                        unsigned int flags,
165                        const char *proxy,
166                        http_session_t session,
167                        const char *srvtag,
168                        strlist_t headers);
169
170 void http_start_data (http_t hd);
171
172 gpg_error_t http_wait_response (http_t hd);
173
174 void http_close (http_t hd, int keep_read_stream);
175
176 gpg_error_t http_open_document (ctrl_t ctrl, http_t *r_hd,
177                                 const char *document,
178                                 const char *auth,
179                                 unsigned int flags,
180                                 const char *proxy,
181                                 http_session_t session,
182                                 const char *srvtag,
183                                 strlist_t headers);
184
185 estream_t http_get_read_ptr (http_t hd);
186 estream_t http_get_write_ptr (http_t hd);
187 unsigned int http_get_status_code (http_t hd);
188 const char *http_get_tls_info (http_t hd, const char *what);
189 const char *http_get_header (http_t hd, const char *name);
190 const char **http_get_header_names (http_t hd);
191 gpg_error_t http_verify_server_credentials (http_session_t sess);
192
193 char *http_escape_string (const char *string, const char *specials);
194 char *http_escape_data (const void *data, size_t datalen, const char *specials);
195
196 gpg_error_t http_prepare_redirect (http_redir_info_t *info,
197                                    unsigned int status_code,
198                                    const char *location, char **r_url);
199
200 const char *http_status2string (unsigned int status);
201
202
203 #endif /*GNUPG_COMMON_HTTP_H*/