* http.c (send_request, http_open, http_open_document): Pass in auth
[gnupg.git] / include / http.h
1 /* http.h  -  HTTP protocol handler
2  * Copyright (C) 1999, 2000, 2001, 2003, 2004 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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef G10_HTTP_H
23 #define G10_HTTP_H 1
24
25 #include "iobuf.h"
26
27 struct uri_tuple {
28     struct uri_tuple *next;
29     const char *name;   /* a pointer into name */
30     char  *value;       /* a pointer to value (a Nul is always appended) */
31     size_t valuelen;    /* and the real length of the value */
32                         /* because the value may contain embedded Nuls */
33 };
34 typedef struct uri_tuple *URI_TUPLE;
35
36 struct parsed_uri {
37     /* all these pointers point into buffer; most stuff is not escaped */
38     char *scheme;       /* pointer to the scheme string (lowercase) */
39     char *auth;         /* username/password for basic auth */
40     char *host;         /* host (converted to lowercase) */
41     ushort port;        /* port (always set if the host is set) */
42     char *path;         /* the path */
43     URI_TUPLE params;   /* ";xxxxx" */
44     URI_TUPLE query;    /* "?xxx=yyy" */
45     char buffer[1];     /* buffer which holds a (modified) copy of the URI */
46 };
47 typedef struct parsed_uri *PARSED_URI;
48
49 typedef enum {
50     HTTP_REQ_GET  = 1,
51     HTTP_REQ_HEAD = 2,
52     HTTP_REQ_POST = 3
53 } HTTP_REQ_TYPE;
54
55 /* put flag values into an enum, so that gdb can display them */
56 enum
57   { 
58     HTTP_FLAG_NO_SHUTDOWN = 1,
59     HTTP_FLAG_TRY_SRV = 2
60   };
61
62 struct http_context {
63     int initialized;
64     unsigned int status_code;
65     int sock;
66     int in_data;
67     IOBUF fp_read;
68     IOBUF fp_write;
69     int is_http_0_9;
70     PARSED_URI uri;
71     HTTP_REQ_TYPE req_type;
72     byte *buffer;          /* line buffer */
73     unsigned buffer_size;
74     unsigned int flags;
75 };
76 typedef struct http_context *HTTP_HD;
77
78 int http_open( HTTP_HD hd, HTTP_REQ_TYPE reqtype, const char *url,
79                unsigned int flags, const char *proxy );
80 void http_start_data( HTTP_HD hd );
81 int  http_wait_response( HTTP_HD hd, unsigned int *ret_status );
82 void http_close( HTTP_HD hd );
83 int http_open_document( HTTP_HD hd, const char *document,
84                         unsigned int flags, const char *proxy );
85
86 #endif /*G10_HTTP_H*/