Change license for some files in common to LGPLv3+/GPLv2+.
[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   char *auth;           /* username/password for basic auth.  */
55   char *host;           /* Host (converted to lowercase). */
56   unsigned short port;  /* Port (always set if the host is set). */
57   char *path;           /* Path. */
58   uri_tuple_t params;   /* ";xxxxx" */
59   uri_tuple_t query;    /* "?xxx=yyy" */
60   char buffer[1];       /* Buffer which holds a (modified) copy of the URI. */
61 };
62 typedef struct parsed_uri_s *parsed_uri_t;
63
64 typedef enum
65   {
66     HTTP_REQ_GET  = 1,
67     HTTP_REQ_HEAD = 2,
68     HTTP_REQ_POST = 3,
69     HTTP_REQ_OPAQUE = 4  /* Internal use.  */
70   }
71 http_req_t;
72
73 /* We put the flag values into an enum, so that gdb can display them. */
74 enum
75   {
76     HTTP_FLAG_TRY_PROXY = 1,
77     HTTP_FLAG_SHUTDOWN = 2,
78     HTTP_FLAG_LOG_RESP = 8,
79     HTTP_FLAG_IGNORE_CL = 32
80   };
81
82 struct http_context_s;
83 typedef struct http_context_s *http_t;
84
85 void http_register_tls_callback (gpg_error_t (*cb) (http_t, void *, int));
86
87 gpg_error_t http_parse_uri (parsed_uri_t *ret_uri, const char *uri,
88                             int no_scheme_check);
89
90 void http_release_parsed_uri (parsed_uri_t uri);
91
92 gpg_error_t http_raw_connect (http_t *r_hd,
93                               const char *server, unsigned short port,
94                               unsigned int flags, const char *srvtag);
95
96 gpg_error_t http_open (http_t *r_hd, http_req_t reqtype,
97                        const char *url,
98                        const char *auth,
99                        unsigned int flags,
100                        const char *proxy,
101                        void *tls_context,
102                        const char *srvtag,
103                        strlist_t headers);
104
105 void http_start_data (http_t hd);
106
107 gpg_error_t http_wait_response (http_t hd);
108
109 void http_close (http_t hd, int keep_read_stream);
110
111 gpg_error_t http_open_document (http_t *r_hd,
112                                 const char *document,
113                                 const char *auth,
114                                 unsigned int flags,
115                                 const char *proxy,
116                                 void *tls_context,
117                                 const char *srvtag,
118                                 strlist_t headers);
119
120 estream_t http_get_read_ptr (http_t hd);
121 estream_t http_get_write_ptr (http_t hd);
122 unsigned int http_get_status_code (http_t hd);
123 const char *http_get_header (http_t hd, const char *name);
124
125 char *http_escape_string (const char *string, const char *specials);
126 char *http_escape_data (const void *data, size_t datalen, const char *specials);
127
128
129 #endif /*GNUPG_COMMON_HTTP_H*/