add function conv param string
[oweals/gnunet.git] / src / vpn / vpn.h
index da7fa6eb82bf02c6a5ba7045e15b7ca259ee24cd..1f47724efb4e470a992254721a3a4a7a98bfc785 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2012 Christian Grothoff
+     Copyright (C) 2012 Christian Grothoff
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      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.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
 
 #include "gnunet_util_lib.h"
 
+GNUNET_NETWORK_STRUCT_BEGIN
 
+/**
+ * Message send by the VPN client to the VPN service requesting
+ * the setup of a redirection from some IP via an exit node to
+ * some global Internet address.
+ */
+struct RedirectToIpRequestMessage
+{
+  /**
+   * Type is #GNUNET_MESSAGE_TYPE_VPN_CLIENT_REDIRECT_TO_IP
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Always zero.
+   */
+  uint32_t reserved GNUNET_PACKED;
+
+  /**
+   * How long should the redirection be maintained at most?
+   */
+  struct GNUNET_TIME_AbsoluteNBO expiration_time;
+
+  /**
+   * Address family desired for the result (AF_INET or AF_INET6 or AF_UNSPEC, in nbo)
+   */
+  int32_t result_af GNUNET_PACKED;
+
+  /**
+   * Address family used for the destination address (AF_INET or AF_INET6, in nbo)
+   */
+  int32_t addr_af GNUNET_PACKED;
+
+  /**
+   * Unique ID to match a future response to this request.
+   * Picked by the client.
+   */
+  uint64_t request_id GNUNET_PACKED;
+
+  /* followed by destination address ('struct in_addr' or 'struct in6_addr') */
+
+};
+
+
+/**
+ * Message send by the VPN client to the VPN service requesting
+ * the setup of a redirection from some IP to a service running
+ * at a particular peer.
+ */
+struct RedirectToServiceRequestMessage
+{
+  /**
+   * Type is #GNUNET_MESSAGE_TYPE_VPN_CLIENT_REDIRECT_TO_SERVICE
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Always zero.
+   */
+  uint32_t reserved GNUNET_PACKED;
+
+  /**
+   * How long should the redirection be maintained at most?
+   */
+  struct GNUNET_TIME_AbsoluteNBO expiration_time;
+
+  /**
+   * Desired protocol (IPPROTO_UDP or IPPROTO_TCP)
+   */
+  int32_t protocol GNUNET_PACKED;
+
+  /**
+   * Address family desired for the result (AF_INET or AF_INET6 or AF_UNSPEC, in nbo)
+   */
+  int32_t result_af GNUNET_PACKED;
+
+  /**
+   * Target peer offering the service.
+   */
+  struct GNUNET_PeerIdentity target;
+
+  /**
+   * Service descriptor identifying the service.
+   */
+  struct GNUNET_HashCode service_descriptor;
+
+  /**
+   * Unique ID to match a future response to this request.
+   * Picked by the client.
+   */
+  uint64_t request_id GNUNET_PACKED;
+
+};
+
+
+/**
+ * Response from the VPN service to a VPN client informing about
+ * the IP that was assigned for the requested redirection.
+ */
+struct RedirectToIpResponseMessage
+{
+
+  /**
+   * Type is #GNUNET_MESSAGE_TYPE_VPN_CLIENT_USE_IP
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * Address family of the allocated address that follows; will match
+   * "result_af" from the request, of be "AF_UNSPEC" on errors.
+   */
+  int32_t result_af GNUNET_PACKED;
+
+  /**
+   * Unique ID to match the response to a request.
+   */
+  uint64_t request_id GNUNET_PACKED;
+
+  /* followed by destination address ('struct in_addr' or 'struct in6_addr') */
+
+};
 
+GNUNET_NETWORK_STRUCT_END
 
 
 #endif