doc: Add a spec comment to app-piv.c
[gnupg.git] / dirmngr / ks-engine-http.c
1 /* ks-engine-http.c - HTTP OpenPGP key access
2  * Copyright (C) 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <https://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "dirmngr.h"
28 #include "misc.h"
29 #include "ks-engine.h"
30
31 /* How many redirections do we allow.  */
32 #define MAX_REDIRECTS 2
33
34 /* Print a help output for the schemata supported by this module. */
35 gpg_error_t
36 ks_http_help (ctrl_t ctrl, parsed_uri_t uri)
37 {
38   const char data[] =
39     "Handler for HTTP URLs:\n"
40     "  http://\n"
41 #if  HTTP_USE_GNUTLS || HTTP_USE_NTBTLS
42     "  https://\n"
43 #endif
44     "Supported methods: fetch\n";
45   gpg_error_t err;
46
47 #if  HTTP_USE_GNUTLS || HTTP_USE_NTBTLS
48   const char data2[] = "  http\n  https";
49 #else
50   const char data2[] = "  http";
51 #endif
52
53   if (!uri)
54     err = ks_print_help (ctrl, data2);
55   else if (uri->is_http && strcmp (uri->scheme, "hkp"))
56     err = ks_print_help (ctrl, data);
57   else
58     err = 0;
59
60   return err;
61 }
62
63
64 /* Get the key from URL which is expected to specify a http style
65  * scheme.  On success R_FP has an open stream to read the data.
66  * Despite its name this function is also used to retrieve arbitrary
67  * data via https or http.
68  */
69 gpg_error_t
70 ks_http_fetch (ctrl_t ctrl, const char *url, unsigned int flags,
71                estream_t *r_fp)
72 {
73   gpg_error_t err;
74   http_session_t session = NULL;
75   unsigned int session_flags;
76   http_t http = NULL;
77   http_redir_info_t redirinfo = { MAX_REDIRECTS };
78   estream_t fp = NULL;
79   char *request_buffer = NULL;
80   parsed_uri_t uri = NULL;
81
82   err = http_parse_uri (&uri, url, 0);
83   if (err)
84     goto leave;
85   redirinfo.orig_url   = url;
86   redirinfo.orig_onion = uri->onion;
87   redirinfo.orig_https = uri->use_tls;
88   redirinfo.allow_downgrade = !!(flags & KS_HTTP_FETCH_ALLOW_DOWNGRADE);
89
90   /* By default we only use the system provided certificates with this
91    * fetch command.  */
92   session_flags = HTTP_FLAG_TRUST_SYS;
93   if ((flags & KS_HTTP_FETCH_NO_CRL) || ctrl->http_no_crl)
94     session_flags |= HTTP_FLAG_NO_CRL;
95   if ((flags & KS_HTTP_FETCH_TRUST_CFG))
96     session_flags |= HTTP_FLAG_TRUST_CFG;
97
98  once_more:
99   err = http_session_new (&session, NULL, session_flags,
100                           gnupg_http_tls_verify_cb, ctrl);
101   if (err)
102     goto leave;
103   http_session_set_log_cb (session, cert_log_cb);
104   http_session_set_timeout (session, ctrl->timeout);
105
106   *r_fp = NULL;
107   err = http_open (ctrl, &http,
108                    HTTP_REQ_GET,
109                    url,
110                    /* httphost */ NULL,
111                    /* fixme: AUTH */ NULL,
112                    ((opt.honor_http_proxy? HTTP_FLAG_TRY_PROXY:0)
113                     | (DBG_LOOKUP? HTTP_FLAG_LOG_RESP:0)
114                     | (dirmngr_use_tor ()? HTTP_FLAG_FORCE_TOR:0)
115                     | (opt.disable_ipv4? HTTP_FLAG_IGNORE_IPv4 : 0)
116                     | (opt.disable_ipv6? HTTP_FLAG_IGNORE_IPv6 : 0)),
117                    ctrl->http_proxy,
118                    session,
119                    NULL,
120                    /*FIXME curl->srvtag*/NULL);
121   if (!err)
122     {
123       fp = http_get_write_ptr (http);
124       /* Avoid caches to get the most recent copy of the key.  We set
125        * both the Pragma and Cache-Control versions of the header, so
126        * we're good with both HTTP 1.0 and 1.1.  */
127       if ((flags & KS_HTTP_FETCH_NOCACHE))
128         es_fputs ("Pragma: no-cache\r\n"
129                   "Cache-Control: no-cache\r\n", fp);
130       http_start_data (http);
131       if (es_ferror (fp))
132         err = gpg_error_from_syserror ();
133     }
134   if (err)
135     {
136       /* Fixme: After a redirection we show the old host name.  */
137       log_error (_("error connecting to '%s': %s\n"),
138                  url, gpg_strerror (err));
139       goto leave;
140     }
141
142   /* Wait for the response.  */
143   dirmngr_tick (ctrl);
144   err = http_wait_response (http);
145   if (err)
146     {
147       log_error (_("error reading HTTP response for '%s': %s\n"),
148                  url, gpg_strerror (err));
149       goto leave;
150     }
151
152   switch (http_get_status_code (http))
153     {
154     case 200:
155       err = 0;
156       break; /* Success.  */
157
158     case 301:
159     case 302:
160     case 307:
161       {
162         xfree (request_buffer);
163         err = http_prepare_redirect (&redirinfo, http_get_status_code (http),
164                                      http_get_header (http, "Location"),
165                                      &request_buffer);
166         if (err)
167           goto leave;
168
169         url = request_buffer;
170         http_close (http, 0);
171         http = NULL;
172         http_session_release (session);
173         session = NULL;
174       }
175       goto once_more;
176
177     default:
178       log_error (_("error accessing '%s': http status %u\n"),
179                  url, http_get_status_code (http));
180       err = gpg_error (GPG_ERR_NO_DATA);
181       goto leave;
182     }
183
184   fp = http_get_read_ptr (http);
185   if (!fp)
186     {
187       err = gpg_error (GPG_ERR_BUG);
188       goto leave;
189     }
190
191   /* Return the read stream and close the HTTP context.  */
192   *r_fp = fp;
193   http_close (http, 1);
194   http = NULL;
195
196  leave:
197   http_close (http, 0);
198   http_session_release (session);
199   xfree (request_buffer);
200   http_release_parsed_uri (uri);
201   return err;
202 }