1
/* http.h - HTTP protocol handler
2
* Copyright (C) 1999, 2000, 2001, 2003,
3
* 2006 Free Software Foundation, Inc.
5
* This file is part of GnuPG.
7
* GnuPG is free software; you can redistribute it and/or modify
8
* it under the terms of the GNU General Public License as published by
9
* the Free Software Foundation; either version 3 of the License, or
10
* (at your option) any later version.
12
* GnuPG is distributed in the hope that it will be useful,
13
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
* GNU General Public License for more details.
17
* You should have received a copy of the GNU General Public License
18
* along with this program; if not, see <http://www.gnu.org/licenses/>.
20
#ifndef GNUPG_COMMON_HTTP_H
21
#define GNUPG_COMMON_HTTP_H
23
#include <gpg-error.h>
24
#ifdef HTTP_USE_ESTREAM
29
struct uri_tuple_s *next;
30
const char *name; /* A pointer into name. */
31
char *value; /* A pointer to value (a Nul is always appended). */
32
size_t valuelen; /* The real length of the value; we need it
33
because the value may contain embedded Nuls. */
34
int no_value; /* True if no value has been given in the URL. */
36
typedef struct uri_tuple_s *uri_tuple_t;
40
/* All these pointers point into BUFFER; most stuff is not escaped. */
41
char *scheme; /* Pointer to the scheme string (lowercase). */
42
int use_tls; /* Whether TLS should be used. */
43
char *auth; /* username/password for basic auth */
44
char *host; /* Host (converted to lowercase). */
45
unsigned short port; /* Port (always set if the host is set). */
46
char *path; /* Path. */
47
uri_tuple_t params; /* ";xxxxx" */
48
uri_tuple_t query; /* "?xxx=yyy" */
49
char buffer[1]; /* Buffer which holds a (modified) copy of the URI. */
51
typedef struct parsed_uri_s *parsed_uri_t;
61
/* We put the flag values into an enum, so that gdb can display them. */
64
HTTP_FLAG_TRY_PROXY = 1,
65
HTTP_FLAG_NO_SHUTDOWN = 2,
66
HTTP_FLAG_TRY_SRV = 4,
67
HTTP_FLAG_LOG_RESP = 8,
68
HTTP_FLAG_NEED_HEADER = 16
71
struct http_context_s;
72
typedef struct http_context_s *http_t;
74
void http_register_tls_callback (gpg_error_t (*cb) (http_t, void *, int));
76
gpg_error_t http_parse_uri (parsed_uri_t *ret_uri, const char *uri);
78
void http_release_parsed_uri (parsed_uri_t uri);
80
gpg_error_t http_open (http_t *r_hd, http_req_t reqtype,
87
void http_start_data (http_t hd);
89
gpg_error_t http_wait_response (http_t hd);
91
void http_close (http_t hd, int keep_read_stream);
93
gpg_error_t http_open_document (http_t *r_hd,
100
#ifdef HTTP_USE_ESTREAM
101
estream_t http_get_read_ptr (http_t hd);
102
estream_t http_get_write_ptr (http_t hd);
103
#else /*!HTTP_USE_ESTREAM*/
104
FILE *http_get_read_ptr (http_t hd);
105
FILE *http_get_write_ptr (http_t hd);
106
#endif /*!HTTP_USE_ESTREAM*/
107
unsigned int http_get_status_code (http_t hd);
108
const char *http_get_header (http_t hd, const char *name);
110
char *http_escape_string (const char *string, const char *specials);
113
#endif /*GNUPG_COMMON_HTTP_H*/