indentation, comment and style fixes, no semantic changes
[oweals/gnunet.git] / src / vpn / vpn_api.c
index 5c351a190c2220775485b630044362073d9aca45..bc77865a89d0e17799ab2f52079d94a8f494646f 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2012 Christian Grothoff
+     Copyright (C) 2012, 2016 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.
 */
 
 /**
@@ -41,7 +41,7 @@ struct GNUNET_VPN_Handle
   /**
    * Connection to VPN service.
    */
-  struct GNUNET_CLIENT_Connection *client;
+  struct GNUNET_MQ_Handle *mq;
 
   /**
    * Head of list of active redirection requests.
@@ -52,6 +52,22 @@ struct GNUNET_VPN_Handle
    * Tail of list of active redirection requests.
    */
   struct GNUNET_VPN_RedirectionRequest *rr_tail;
+
+  /**
+   * Identifier of a reconnect task.
+   */
+  struct GNUNET_SCHEDULER_Task *rt;
+
+  /**
+   * How long do we wait until we try to reconnect?
+   */
+  struct GNUNET_TIME_Relative backoff;
+
+  /**
+   * ID of the last request that was submitted to the service.
+   */
+  uint64_t request_id_gen;
+
 };
 
 
@@ -85,9 +101,9 @@ struct GNUNET_VPN_RedirectionRequest
    * Function to call with the designated IP address.
    */
   GNUNET_VPN_AllocationCallback cb;
-  
+
   /**
-   * Closure for 'cb'.
+   * Closure for @e cb.
    */
   void *cb_cls;
 
@@ -99,7 +115,7 @@ struct GNUNET_VPN_RedirectionRequest
   /**
    * For service redirection, service descriptor.
    */
-  GNUNET_HashCode serv;                     
+  struct GNUNET_HashCode serv;
 
   /**
    * At what time should the created service mapping expire?
@@ -107,16 +123,20 @@ struct GNUNET_VPN_RedirectionRequest
   struct GNUNET_TIME_Absolute expiration_time;
 
   /**
-   * AF_INET or AF_INET6.
+   * non-zero if this request has been sent to the service.
    */
-  int af;
-  
+  uint64_t request_id;
+
   /**
-   * GNUNET_YES if we are to call the callback only after successful
-   * mesh tunnel creation.
+   * Desired address family for the result.
    */
-  int nac;
-  
+  int result_af;
+
+  /**
+   * Address family of @e addr.  AF_INET or AF_INET6.
+   */
+  int addr_af;
+
   /**
    * For service redirection, IPPROT_UDP or IPPROTO_TCP.
    */
@@ -125,6 +145,221 @@ struct GNUNET_VPN_RedirectionRequest
 };
 
 
+/**
+ * Disconnect from the service (communication error) and reconnect later.
+ *
+ * @param vh handle to reconnect.
+ */
+static void
+reconnect (struct GNUNET_VPN_Handle *vh);
+
+
+/**
+ * Check a #GNUNET_MESSAGE_TYPE_VPN_CLIENT_USE_IP message from the
+ * VPN service.
+ *
+ * @param cls the `struct GNUNET_VPN_Handle`
+ * @param rm message received
+ * @return #GNUNET_OK if @a rm is well-formed
+ */
+static int
+check_use_ip (void *cls,
+              const struct RedirectToIpResponseMessage *rm)
+{
+  size_t alen;
+  int af;
+
+  af = (int) ntohl (rm->result_af);
+  switch (af)
+  {
+  case AF_UNSPEC:
+    alen = 0;
+    break;
+  case AF_INET:
+    alen = sizeof (struct in_addr);
+    break;
+  case AF_INET6:
+    alen = sizeof (struct in6_addr);
+    break;
+  default:
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
+  }
+  if ( (ntohs (rm->header.size) != alen + sizeof (*rm)) ||
+       (0 == rm->request_id) )
+  {
+    GNUNET_break (0);
+    return GNUNET_SYSERR;
+  }
+  return GNUNET_OK;
+}
+
+
+/**
+ * Handle a #GNUNET_MESSAGE_TYPE_VPN_CLIENT_USE_IP message from the
+ * VPN service.
+ *
+ * @param cls the `struct GNUNET_VPN_Handle`
+ * @param rm message received
+ */
+static void
+handle_use_ip (void *cls,
+               const struct RedirectToIpResponseMessage *rm)
+{
+  struct GNUNET_VPN_Handle *vh = cls;
+  struct GNUNET_VPN_RedirectionRequest *rr;
+  int af;
+
+  af = (int) ntohl (rm->result_af);
+  for (rr = vh->rr_head; NULL != rr; rr = rr->next)
+  {
+    if (rr->request_id == rm->request_id)
+    {
+      GNUNET_CONTAINER_DLL_remove (vh->rr_head,
+                                  vh->rr_tail,
+                                  rr);
+      rr->cb (rr->cb_cls,
+             af,
+             (af == AF_UNSPEC) ? NULL : &rm[1]);
+      GNUNET_free (rr);
+      break;
+    }
+  }
+}
+
+
+/**
+ * Add a request to our request queue and transmit it.
+ *
+ * @param rr request to queue and transmit.
+ */
+static void
+send_request (struct GNUNET_VPN_RedirectionRequest *rr)
+{
+  struct GNUNET_VPN_Handle *vh = rr->vh;
+  struct RedirectToIpRequestMessage *rip;
+  struct RedirectToServiceRequestMessage *rs;
+  struct GNUNET_MQ_Envelope *env;
+  size_t alen;
+
+  if (NULL == vh->mq)
+    return;
+  if (NULL == rr->addr)
+  {
+    env = GNUNET_MQ_msg (rs,
+                         GNUNET_MESSAGE_TYPE_VPN_CLIENT_REDIRECT_TO_SERVICE);
+    rs->reserved = htonl (0);
+    rs->expiration_time = GNUNET_TIME_absolute_hton (rr->expiration_time);
+    rs->protocol = htonl (rr->protocol);
+    rs->result_af = htonl (rr->result_af);
+    rs->target = rr->peer;
+    rs->service_descriptor = rr->serv;
+    rs->request_id = rr->request_id = ++vh->request_id_gen;
+  }
+  else
+  {
+    switch (rr->addr_af)
+    {
+    case AF_INET:
+      alen = sizeof (struct in_addr);
+      break;
+    case AF_INET6:
+      alen = sizeof (struct in6_addr);
+      break;
+    default:
+      GNUNET_assert (0);
+      return;
+    }
+    env = GNUNET_MQ_msg_extra (rip,
+                               alen,
+                               GNUNET_MESSAGE_TYPE_VPN_CLIENT_REDIRECT_TO_IP);
+    rip->reserved = htonl (0);
+    rip->expiration_time = GNUNET_TIME_absolute_hton (rr->expiration_time);
+    rip->result_af = htonl (rr->result_af);
+    rip->addr_af = htonl (rr->addr_af);
+    rip->request_id = rr->request_id = ++vh->request_id_gen;
+    GNUNET_memcpy (&rip[1],
+                   rr->addr,
+                   alen);
+  }
+  GNUNET_MQ_send (vh->mq,
+                  env);
+}
+
+
+/**
+ * Generic error handler, called with the appropriate error code and
+ * the same closure specified at the creation of the message queue.
+ * Not every message queue implementation supports an error handler.
+ *
+ * @param cls closure with the `struct GNUNET_VPN_Handle *`
+ * @param error error code
+ */
+static void
+mq_error_handler (void *cls,
+                  enum GNUNET_MQ_Error error)
+{
+  struct GNUNET_VPN_Handle *vh = cls;
+
+  reconnect (vh);
+}
+
+
+/**
+ * Connect to the VPN service and start again to transmit our requests.
+ *
+ * @param cls the `struct GNUNET_VPN_Handle *`
+ */
+static void
+connect_task (void *cls)
+{
+  struct GNUNET_VPN_Handle *vh = cls;
+  struct GNUNET_MQ_MessageHandler handlers[] = {
+    GNUNET_MQ_hd_var_size (use_ip,
+                           GNUNET_MESSAGE_TYPE_VPN_CLIENT_USE_IP,
+                           struct RedirectToIpResponseMessage,
+                           cls),
+    GNUNET_MQ_handler_end ()
+  };
+  struct GNUNET_VPN_RedirectionRequest *rr;
+
+  vh->rt = NULL;
+  vh->mq = GNUNET_CLIENT_connect (vh->cfg,
+                                  "vpn",
+                                  handlers,
+                                  &mq_error_handler,
+                                  vh);
+  if (NULL == vh->mq)
+    return;
+  for (rr = vh->rr_head; NULL != rr; rr = rr->next)
+    send_request (rr);
+}
+
+
+/**
+ * Disconnect from the service (communication error) and reconnect later.
+ *
+ * @param vh handle to reconnect.
+ */
+static void
+reconnect (struct GNUNET_VPN_Handle *vh)
+{
+  struct GNUNET_VPN_RedirectionRequest *rr;
+
+  GNUNET_MQ_destroy (vh->mq);
+  vh->mq = NULL;
+  vh->request_id_gen = 0;
+  for (rr = vh->rr_head; NULL != rr; rr = rr->next)
+    rr->request_id = 0;
+  vh->backoff = GNUNET_TIME_relative_max (GNUNET_TIME_UNIT_MILLISECONDS,
+                                         GNUNET_TIME_relative_min (GNUNET_TIME_relative_saturating_multiply (vh->backoff, 2),
+                                                                   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)));
+  vh->rt = GNUNET_SCHEDULER_add_delayed (vh->backoff,
+                                        &connect_task,
+                                        vh);
+}
+
+
 /**
  * Cancel redirection request with the service.
  *
@@ -152,36 +387,48 @@ GNUNET_VPN_cancel_request (struct GNUNET_VPN_RedirectionRequest *rr)
  * limitations, the longest inactive mappings will be destroyed.
  *
  * @param vh VPN handle
- * @param af address family, AF_INET or AF_INET6
+ * @param result_af desired address family for the returned allocation
+ *                  can also be AF_UNSPEC
  * @param protocol protocol, IPPROTO_UDP or IPPROTO_TCP
  * @param peer target peer for the redirection
  * @param serv service descriptor to give to the peer
- * @param nac GNUNET_YES to notify via callback only after completion of
- *            the MESH-level connection,
- *            GNUNET_NO to notify as soon as the IP has been reserved
  * @param expiration_time at what time should the redirection expire?
  *        (this should not impact connections that are active at that time)
  * @param cb function to call with the IP
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
  * @return handle to cancel the request (means the callback won't be
  *         invoked anymore; the mapping may or may not be established
  *         anyway)
  */
 struct GNUNET_VPN_RedirectionRequest *
-GNUNET_VPN_redirect_to_peer (struct GNUNET_VPN_Handle *rh,                
-                            int af,
+GNUNET_VPN_redirect_to_peer (struct GNUNET_VPN_Handle *vh,
+                            int result_af,
                             uint8_t protocol,
                             const struct GNUNET_PeerIdentity *peer,
-                            const GNUNET_HashCode *serv,
-                            int nac,
+                            const struct GNUNET_HashCode *serv,
                             struct GNUNET_TIME_Absolute expiration_time,
                             GNUNET_VPN_AllocationCallback cb,
                             void *cb_cls)
 {
-  return NULL; // FIXME
+  struct GNUNET_VPN_RedirectionRequest *rr;
+
+  rr = GNUNET_new (struct GNUNET_VPN_RedirectionRequest);
+  rr->vh = vh;
+  rr->cb = cb;
+  rr->cb_cls = cb_cls;
+  rr->peer = *peer;
+  rr->serv = *serv;
+  rr->expiration_time = expiration_time;
+  rr->result_af = result_af;
+  rr->protocol = protocol;
+  GNUNET_CONTAINER_DLL_insert_tail (vh->rr_head,
+                                   vh->rr_tail,
+                                   rr);
+  send_request (rr);
+  return rr;
 }
 
-               
+
 /**
  * Tell the VPN that forwarding to the Internet via some exit node is
  * requested.  Note that both UDP and TCP traffic will be forwarded,
@@ -192,30 +439,58 @@ GNUNET_VPN_redirect_to_peer (struct GNUNET_VPN_Handle *rh,
  * limitations, the longest inactive mappings will be destroyed.
  *
  * @param vh VPN handle
- * @param af address family, AF_INET or AF_INET6
+ * @param result_af desired address family for the returned allocation
+ * @param addr_af address family for @a addr, AF_INET or AF_INET6
  * @param addr destination IP address on the Internet; destination
  *             port is to be taken from the VPN packet itself
- * @param nac GNUNET_YES to notify via callback only after completion of
- *            the MESH-level connection,
- *            GNUNET_NO to notify as soon as the IP has been reserved
  * @param expiration_time at what time should the redirection expire?
  *        (this should not impact connections that are active at that time)
  * @param cb function to call with the IP
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
  * @return handle to cancel the request (means the callback won't be
  *         invoked anymore; the mapping may or may not be established
  *         anyway)
  */
 struct GNUNET_VPN_RedirectionRequest *
-GNUNET_VPN_redirect_to_ip (struct GNUNET_VPN_Handle *rh,                  
-                          int af,
+GNUNET_VPN_redirect_to_ip (struct GNUNET_VPN_Handle *vh,
+                          int result_af,
+                          int addr_af,
                           const void *addr,
-                          int nac,
                           struct GNUNET_TIME_Absolute expiration_time,
                           GNUNET_VPN_AllocationCallback cb,
                           void *cb_cls)
 {
-  return NULL; // FIXME
+  struct GNUNET_VPN_RedirectionRequest *rr;
+  size_t alen;
+
+  switch (addr_af)
+  {
+  case AF_INET:
+    alen = sizeof (struct in_addr);
+    break;
+  case AF_INET6:
+    alen = sizeof (struct in6_addr);
+    break;
+  default:
+    GNUNET_break (0);
+    return NULL;
+  }
+  rr = GNUNET_malloc (sizeof (struct GNUNET_VPN_RedirectionRequest) + alen);
+  rr->vh = vh;
+  rr->addr = &rr[1];
+  rr->cb = cb;
+  rr->cb_cls = cb_cls;
+  rr->expiration_time = expiration_time;
+  rr->result_af = result_af;
+  rr->addr_af = addr_af;
+  GNUNET_memcpy (&rr[1],
+          addr,
+          alen);
+  GNUNET_CONTAINER_DLL_insert_tail (vh->rr_head,
+                                   vh->rr_tail,
+                                   rr);
+  send_request (rr);
+  return rr;
 }
 
 
@@ -223,16 +498,21 @@ GNUNET_VPN_redirect_to_ip (struct GNUNET_VPN_Handle *rh,
  * Connect to the VPN service
  *
  * @param cfg configuration to use
- * @return VPN handle 
+ * @return VPN handle
  */
 struct GNUNET_VPN_Handle *
 GNUNET_VPN_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
 {
-  struct GNUNET_VPN_Handle *vh;
+  struct GNUNET_VPN_Handle *vh
+    = GNUNET_new (struct GNUNET_VPN_Handle);
 
-  vh = GNUNET_malloc (sizeof (struct GNUNET_VPN_Handle));
   vh->cfg = cfg;
-  vh->client = GNUNET_CLIENT_connect ("vpn", cfg);
+  connect_task (vh);
+  if (NULL == vh->mq)
+  {
+    GNUNET_free (vh);
+    return NULL;
+  }
   return vh;
 }
 
@@ -246,7 +526,16 @@ void
 GNUNET_VPN_disconnect (struct GNUNET_VPN_Handle *vh)
 {
   GNUNET_assert (NULL == vh->rr_head);
-  GNUNET_CLIENT_disconnect (vh->client, GNUNET_NO);
+  if (NULL != vh->mq)
+  {
+    GNUNET_MQ_destroy (vh->mq);
+    vh->mq = NULL;
+  }
+  if (NULL != vh->rt)
+  {
+    GNUNET_SCHEDULER_cancel (vh->rt);
+    vh->rt = NULL;
+  }
   GNUNET_free (vh);
 }