use enum GNUNET_ATS_Network_Type instead of uint32_t where appropriate
[oweals/gnunet.git] / src / transport / plugin_transport_http_common.h
1 /*
2      This file is part of GNUnet
3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file transport/plugin_transport_http_common.c
23  * @brief functionality shared by http client and server transport service plugin
24  * @author Matthias Wachs
25  */
26
27 #include "platform.h"
28 #include "gnunet_common.h"
29 #include "gnunet_transport_plugin.h"
30
31 /**
32  * Timeout values for testing
33  */
34 #define TESTING GNUNET_NO
35
36 #if TESTING
37 #define HTTP_SERVER_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
38 #define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
39 #define HTTP_CLIENT_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 7)
40 #define SERVER_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 7)
41 #define TIMEOUT_LOG GNUNET_ERROR_TYPE_DEBUG
42
43 #else
44
45 #if BUILD_HTTPS
46 #define PROTOCOL "https"
47 #else
48 #define PROTOCOL "http"
49 #endif
50
51 #define HTTP_SERVER_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
52 #define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
53 #define HTTP_CLIENT_SESSION_TIMEOUT GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
54 #define HTTP_SERVER_SESSION_TIMEOUT GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
55 #define TIMEOUT_LOG GNUNET_ERROR_TYPE_DEBUG
56
57 #endif
58
59 #define HTTP_DEFAULT_PORT 80
60 #define HTTPS_DEFAULT_PORT 443
61
62 enum HTTP_OPTIONS
63 {
64                         HTTP_OPTIONS_NONE = 0,
65         HTTP_OPTIONS_VERIFY_CERTIFICATE = 1
66 };
67
68
69 GNUNET_NETWORK_STRUCT_BEGIN
70
71 /**
72  * HttpAddress
73  */
74 struct HttpAddress
75 {
76         /**
77          * Address options
78          */
79         uint32_t options;
80
81         /**
82          * Length of URL located after struct
83          *
84          */
85         uint32_t urlen;
86 };
87
88 GNUNET_NETWORK_STRUCT_END
89
90 struct SplittedHTTPAddress;
91
92 struct SplittedHTTPAddress *
93 http_split_address (const char * addr);
94
95 /**
96  * Convert the transports address to a nice, human-readable
97  * format.
98  *
99  * @param cls closure
100  * @param type name of the transport that generated the address
101  * @param addr one of the addresses of the host, NULL for the last address
102  *        the specific address format depends on the transport
103  * @param addrlen length of the address
104  * @param numeric should (IP) addresses be displayed in numeric form?
105  * @param timeout after how long should we give up?
106  * @param asc function to call on each string
107  * @param asc_cls closure for asc
108  */
109 void
110 http_common_plugin_address_pretty_printer (void *cls, const char *type,
111                                         const void *addr, size_t addrlen,
112                                         int numeric,
113                                         struct GNUNET_TIME_Relative timeout,
114                                         GNUNET_TRANSPORT_AddressStringCallback
115                                         asc, void *asc_cls);
116
117 /**
118  * Function called for a quick conversion of the binary address to
119  * a numeric address.  Note that the caller must not free the
120  * address and that the next call to this function is allowed
121  * to override the address again.
122  *
123  * @param cls closure
124  * @param plugin the plugin
125  * @param addr binary address
126  * @param addrlen length of the address
127  * @return string representing the same address
128  */
129 const char *
130 http_common_plugin_address_to_string (void *cls,
131                                                                                                                                                         char *plugin,
132                                       const void *addr,
133                                       size_t addrlen);
134
135 /**
136  * Function called to convert a string address to
137  * a binary address.
138  *
139  * @param cls closure ('struct Plugin*')
140  * @param addr string address
141  * @param addrlen length of the address
142  * @param buf location to store the buffer
143  *        If the function returns GNUNET_SYSERR, its contents are undefined.
144  * @param added length of created address
145  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
146  */
147 int
148 http_common_plugin_string_to_address (void *cls,
149                                       const char *addr,
150                                       uint16_t addrlen,
151                                       void **buf,
152                                       size_t *added);
153
154
155 /**
156  * Create a HTTP address from a socketaddr
157  *
158  * @param protocol protocol
159  * @param addr sockaddr * address
160  * @param addrlen length of the address
161  * @return the string
162  */
163 struct HttpAddress *
164 http_common_address_from_socket (const char *protocol,
165                                                                                                                                  const struct sockaddr *addr,
166                                                                                                                                  socklen_t addrlen);
167
168 /**
169  * Create a socketaddr from a HTTP address
170  *
171  * @param addr sockaddr * address
172  * @param addrlen length of the address
173  * @param res the result:
174  * GNUNET_SYSERR, invalid input,
175  * GNUNET_YES: could convert to ip,
176  * GNUNET_NO: valid input but could not convert to ip (hostname?)
177  * @return the string
178  */
179 struct sockaddr *
180 http_common_socket_from_address (const void *addr, size_t addrlen, int *res);
181
182 const char *
183 http_common_plugin_address_to_url (void *cls, const void *addr, size_t addrlen);
184
185 /**
186  * Get the length of an address
187  *
188  * @param addr address
189  * @return the size
190  */
191 size_t
192 http_common_address_get_size (const struct HttpAddress * addr);
193
194
195 /**
196  * Compare addr1 to addr2
197  *
198  * @param addr1 address1
199  * @param addrlen1 address 1 length
200  * @param addr2 address2
201  * @param addrlen2 address 2 length
202  * @return GNUNET_YES if equal, GNUNET_NO else
203  */
204 size_t
205 http_common_cmp_addresses (const void *addr1, size_t addrlen1, const void *addr2, size_t addrlen2);
206 /* end of plugin_transport_http_common.c */