/*
This file is part of GNUnet
- (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2002-2014 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
-
/**
* @file transport/plugin_transport_http_common.c
* @brief functionality shared by http client and server transport service plugin
* @author Matthias Wachs
+ * @author Christian Grothoff
*/
-
#include "platform.h"
#include "gnunet_common.h"
+#include "gnunet_transport_plugin.h"
+
+/**
+ * Timeout values for testing
+ */
+#define TESTING GNUNET_NO
+
+#if TESTING
+#define HTTP_SERVER_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
+#define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
+#define HTTP_CLIENT_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 7)
+#define SERVER_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 7)
+#define TIMEOUT_LOG GNUNET_ERROR_TYPE_DEBUG
+
+#else
+
+#if BUILD_HTTPS
+#define PROTOCOL "https"
+#else
+#define PROTOCOL "http"
+#endif
+
+#define HTTP_SERVER_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
+#define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
+#define HTTP_CLIENT_SESSION_TIMEOUT GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
+#define HTTP_SERVER_SESSION_TIMEOUT GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
+#define TIMEOUT_LOG GNUNET_ERROR_TYPE_DEBUG
+
+#endif
+
+#define HTTP_DEFAULT_PORT 80
+#define HTTPS_DEFAULT_PORT 443
+
+/**
+ * Bits in the `options` field of HTTP addresses.
+ */
+enum HttpAddressOptions
+{
+ /**
+ * No bits set.
+ */
+ HTTP_OPTIONS_NONE = 0,
+
+ /**
+ * Verify X509 server certificate, it should be valid.
+ * (if this bit is not set, it is probably just self-
+ * signed and not expected to be verified).
+ */
+ HTTP_OPTIONS_VERIFY_CERTIFICATE = 1,
+
+ /**
+ * Enable TCP Stealth-style port knocking.
+ */
+ HTTP_OPTIONS_TCP_STEALTH = 2
+};
+
+
+GNUNET_NETWORK_STRUCT_BEGIN
+
+/**
+ * HttpAddress
+ */
+struct HttpAddress
+{
+ /**
+ * Address options
+ * see `enum HttpAddressOptions`
+ */
+ uint32_t options GNUNET_PACKED;
+
+ /**
+ * Length of URL located after struct
+ */
+ uint32_t urlen GNUNET_PACKED;
+};
+
+GNUNET_NETWORK_STRUCT_END
+
+/**
+ * Representation of HTTP URL split into its components.
+ */
+struct SplittedHTTPAddress
+{
+ char *protocol;
+ char *host;
+ char *path;
+ int port;
+};
+
+
+/**
+ * Split an HTTP address into protocol, hostname, port
+ * and path components.
+ */
+struct SplittedHTTPAddress *
+http_split_address (const char *addr);
+
/**
* Convert the transports address to a nice, human-readable
* @param numeric should (IP) addresses be displayed in numeric form?
* @param timeout after how long should we give up?
* @param asc function to call on each string
- * @param asc_cls closure for asc
+ * @param asc_cls closure for @a asc
*/
void
-http_common_plugin_address_pretty_printer (void *cls, const char *type,
- const void *addr, size_t addrlen,
- int numeric,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_AddressStringCallback
- asc, void *asc_cls);
+http_common_plugin_address_pretty_printer (void *cls,
+ const char *type,
+ const void *addr,
+ size_t addrlen,
+ int numeric,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_AddressStringCallback asc,
+ void *asc_cls);
+
/**
* Function called for a quick conversion of the binary address to
* address and that the next call to this function is allowed
* to override the address again.
*
- * @param cls closure
+ * @param plugin name of the plugin
* @param addr binary address
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
* @return string representing the same address
*/
const char *
-http_common_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
+http_common_plugin_address_to_string (const char *plugin,
+ const void *addr,
+ size_t addrlen);
+
/**
* Function called to convert a string address to
* a binary address.
*
- * @param cls closure ('struct Plugin*')
+ * @param cls closure (`struct Plugin*`)
* @param addr string address
* @param addrlen length of the address
* @param buf location to store the buffer
- * If the function returns GNUNET_SYSERR, its contents are undefined.
+ * If the function returns #GNUNET_SYSERR, its contents are undefined.
* @param added length of created address
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
http_common_plugin_string_to_address (void *cls,
void **buf,
size_t *added);
-/* end of plugin_transport_http_common.c */
+
+/**
+ * Create a HTTP address from a socketaddr
+ *
+ * @param protocol protocol
+ * @param addr `sockaddr *` address
+ * @param addrlen length of the @a addr
+ * @return the string
+ */
+struct HttpAddress *
+http_common_address_from_socket (const char *protocol,
+ const struct sockaddr *addr,
+ socklen_t addrlen);
+
+
+/**
+ * Create a socketaddr from a HTTP address
+ *
+ * @param addr a `sockaddr *` address
+ * @param addrlen length of the @a addr
+ * @param res the result:
+ * #GNUNET_SYSERR, invalid input,
+ * #GNUNET_YES: could convert to ip,
+ * #GNUNET_NO: valid input but could not convert to ip (hostname?)
+ * @return the string
+ */
+struct sockaddr *
+http_common_socket_from_address (const void *addr,
+ size_t addrlen,
+ int *res);
+
+
+const char *
+http_common_plugin_address_to_url (void *cls,
+ const void *addr,
+ size_t addrlen);
+
+
+/**
+ * Get the length of an address
+ *
+ * @param addr address
+ * @return the size
+ */
+size_t
+http_common_address_get_size (const struct HttpAddress * addr);
+
+
+/**
+ * Compare addr1 to addr2
+ *
+ * @param addr1 address1
+ * @param addrlen1 length of @a address1
+ * @param addr2 address2
+ * @param addrlen2 length of @a address2
+ * @return #GNUNET_YES if equal, #GNUNET_NO else
+ */
+size_t
+http_common_cmp_addresses (const void *addr1,
+ size_t addrlen1,
+ const void *addr2,
+ size_t addrlen2);
+
+
+/**
+ * Function obtain the network type for an address.
+ *
+ * @param env the environment
+ * @param address the address
+ * @return the network type
+ */
+enum GNUNET_NetworkType
+http_common_get_network_for_address (struct GNUNET_TRANSPORT_PluginEnvironment *env,
+ const struct GNUNET_HELLO_Address *address);
+
+
+/* end of plugin_transport_http_common.h */
projects / oweals / gnunet.git / blobdiff