2 This file is part of GNUnet
3 (C) 2002-2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file transport/plugin_transport_http_common.c
23 * @brief functionality shared by http client and server transport service plugin
24 * @author Matthias Wachs
28 #include "gnunet_common.h"
29 #include "gnunet_transport_plugin.h"
32 * Timeout values for testing
34 #define TESTING GNUNET_NO
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
46 #define PROTOCOL "https"
48 #define PROTOCOL "http"
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
59 #define HTTP_DEFAULT_PORT 80
60 #define HTTPS_DEFAULT_PORT 443
64 HTTP_OPTIONS_NONE = 0,
65 HTTP_OPTIONS_VERIFY_CERTIFICATE = 1
69 GNUNET_NETWORK_STRUCT_BEGIN
82 * Length of URL located after struct
87 GNUNET_NETWORK_STRUCT_END
89 struct SplittedHTTPAddress;
91 struct SplittedHTTPAddress *
92 http_split_address (const char * addr);
95 * Convert the transports address to a nice, human-readable
99 * @param type name of the transport that generated the address
100 * @param addr one of the addresses of the host, NULL for the last address
101 * the specific address format depends on the transport
102 * @param addrlen length of the address
103 * @param numeric should (IP) addresses be displayed in numeric form?
104 * @param timeout after how long should we give up?
105 * @param asc function to call on each string
106 * @param asc_cls closure for @a asc
109 http_common_plugin_address_pretty_printer (void *cls, const char *type,
110 const void *addr, size_t addrlen,
112 struct GNUNET_TIME_Relative timeout,
113 GNUNET_TRANSPORT_AddressStringCallback
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.
124 * @param plugin the plugin
125 * @param addr binary address
126 * @param addrlen length of the address
127 * @return string representing the same address
130 http_common_plugin_address_to_string (void *cls,
137 * Function called to convert a string address to
140 * @param cls closure (`struct Plugin*`)
141 * @param addr string address
142 * @param addrlen length of the address
143 * @param buf location to store the buffer
144 * If the function returns #GNUNET_SYSERR, its contents are undefined.
145 * @param added length of created address
146 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
149 http_common_plugin_string_to_address (void *cls,
157 * Create a HTTP address from a socketaddr
159 * @param protocol protocol
160 * @param addr `sockaddr *` address
161 * @param addrlen length of the @a addr
165 http_common_address_from_socket (const char *protocol,
166 const struct sockaddr *addr,
171 * Create a socketaddr from a HTTP address
173 * @param addr a `sockaddr *` address
174 * @param addrlen length of the @a addr
175 * @param res the result:
176 * #GNUNET_SYSERR, invalid input,
177 * #GNUNET_YES: could convert to ip,
178 * #GNUNET_NO: valid input but could not convert to ip (hostname?)
182 http_common_socket_from_address (const void *addr,
188 http_common_plugin_address_to_url (void *cls,
194 * Get the length of an address
196 * @param addr address
200 http_common_address_get_size (const struct HttpAddress * addr);
204 * Compare addr1 to addr2
206 * @param addr1 address1
207 * @param addrlen1 address 1 length
208 * @param addr2 address2
209 * @param addrlen2 address 2 length
210 * @return #GNUNET_YES if equal, #GNUNET_NO else
213 http_common_cmp_addresses (const void *addr1,
218 /* end of plugin_transport_http_common.h */