remove 'nac' option from VPN, always return IP immediately, always build mesh tunnel...
[oweals/gnunet.git] / src / vpn / gnunet-service-vpn.c
index a896eb6c6311702fd4490d152e09828ea3fb936c..2b5b41e14fc2bf0c28d37aef9c119ff5fcbdb826 100644 (file)
@@ -82,8 +82,8 @@ struct DestinationEntry
   struct GNUNET_CONTAINER_HeapNode *heap_node;
 
   /**
-   * GNUNET_NO if this is a tunnel to an Internet-exit,
-   * GNUNET_YES if this tunnel is to a service.
+   * #GNUNET_NO if this is a tunnel to an Internet-exit,
+   * #GNUNET_YES if this tunnel is to a service.
    */
   int is_service;
 
@@ -203,23 +203,12 @@ struct TunnelState
    */
   struct TunnelMessageQueueEntry *tmq_tail;  
 
-  /**
-   * Client that needs to be notified about the tunnel being
-   * up as soon as a peer is connected; NULL for none.
-   */
-  struct GNUNET_SERVER_Client *client;
-
   /**
    * Destination entry that has a pointer to this tunnel state;
    * NULL if this tunnel state is in the tunnel map.
    */
   struct DestinationEntry *destination_container;
 
-  /**
-   * ID of the client request that caused us to setup this entry.
-   */ 
-  uint64_t request_id;
-
   /**
    * Destination to which this tunnel leads.  Note that
    * this struct is NOT in the destination_map (but a
@@ -581,7 +570,7 @@ free_tunnel_state (struct TunnelState *ts)
 /**
  * Destroy the mesh tunnel.
  *
- * @param cls the 'struct TunnelState' with the tunnel to destroy
+ * @param cls the `struct TunnelState` with the tunnel to destroy
  * @param tc scheduler context
  */
 static void
@@ -611,7 +600,7 @@ destroy_tunnel_task (void *cls,
 void
 tunnel_peer_disconnect_handler (void *cls,
                                const struct
-                               GNUNET_PeerIdentity * peer)
+                               GNUNET_PeerIdentity *peer)
 {
   struct TunnelState *ts = cls;
 
@@ -635,48 +624,13 @@ tunnel_peer_disconnect_handler (void *cls,
 }
 
 
-/**
- * Method called whenever a peer has connected to the tunnel.  Notifies
- * the waiting client that the tunnel is now up.
- *
- * FIXME merge with tunnel_create
- * 
- * @param cls closure
- * @param peer peer identity the tunnel was created to, NULL on timeout
- * @param atsi performance data for the connection
- */
-void
-tunnel_peer_connect_handler (void *cls,
-                            const struct GNUNET_PeerIdentity
-                            * peer,
-                            const struct
-                            GNUNET_ATS_Information * atsi)
-{
-  struct TunnelState *ts = cls;
-
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Peer %s connected to tunnel.\n",
-             GNUNET_i2s (peer));
-  GNUNET_STATISTICS_update (stats,
-                           gettext_noop ("# peers connected to mesh tunnels"),
-                           1, GNUNET_NO);
-  if (NULL == ts->client)
-    return; /* nothing to do */
-  send_client_reply (ts->client,
-                    ts->request_id,
-                    ts->af,
-                    &ts->destination_ip);
-  ts->client = NULL;
-}
-
-
 /**
  * Send a message from the message queue via mesh.
  *
- * @param cls the 'struct TunnelState' with the message queue
- * @param size number of bytes available in buf
+ * @param cls the `struct TunnelState` with the message queue
+ * @param size number of bytes available in @a buf
  * @param buf where to copy the message
- * @return number of bytes copied to buf
+ * @return number of bytes copied to @a buf
  */
 static size_t
 send_to_peer_notify_callback (void *cls, size_t size, void *buf)
@@ -797,14 +751,12 @@ handle_regex_result (void *cls,
  * Initialize the given destination entry's mesh tunnel.
  *
  * @param de destination entry for which we need to setup a tunnel
- * @param client client to notify on successful tunnel setup, or NULL for none
  * @param client_af address family of the address returned to the client
  * @param request_id request ID to send in client notification (unused if client is NULL)
  * @return tunnel state of the tunnel that was created
  */
 static struct TunnelState *
 create_tunnel_to_destination (struct DestinationEntry *de,
-                             struct GNUNET_SERVER_Client *client,
                              int client_af,
                              uint64_t request_id)
 {
@@ -814,13 +766,8 @@ create_tunnel_to_destination (struct DestinationEntry *de,
                            gettext_noop ("# Mesh tunnels created"),
                            1, GNUNET_NO);
   GNUNET_assert (NULL == de->ts);
-  ts = GNUNET_malloc (sizeof (struct TunnelState));
+  ts = GNUNET_new (struct TunnelState);
   ts->af = client_af;
-  if (NULL != client)
-  {
-    ts->request_id = request_id;
-    ts->client = client;
-  }
   ts->destination = *de;
   ts->destination.heap_node = NULL; /* copy is NOT in destination heap */
   de->ts = ts;
@@ -829,10 +776,10 @@ create_tunnel_to_destination (struct DestinationEntry *de,
   {
     ts->tunnel = GNUNET_MESH_tunnel_create (mesh_handle,
                                            ts,
-                        &de->details.service_destination.target,
+                                           &de->details.service_destination.target,
                                            PORT_VPN,
-                        GNUNET_YES,
-                        GNUNET_NO);
+                                           GNUNET_YES,
+                                           GNUNET_NO);
     if (NULL == ts->tunnel)
     {
       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
@@ -1094,7 +1041,7 @@ route_packet (struct DestinationEntry *destination,
        available) or create a fresh one */
     is_new = GNUNET_YES;
     if (NULL == destination->ts)
-      ts = create_tunnel_to_destination (destination, NULL, af, 0);
+      ts = create_tunnel_to_destination (destination, af, 0);
     else
       ts = destination->ts;
     if (NULL == ts)
@@ -1599,11 +1546,6 @@ message_token (void *cls GNUNET_UNUSED, void *client GNUNET_UNUSED,
                                   &pkt6->destination_address,
                                   &key);
       de = GNUNET_CONTAINER_multihashmap_get (destination_map, &key);
-      /* FIXME: do we need to guard against hash collision? 
-        (if so, we need to also store the local destination IP in the
-        destination entry and then compare here; however, the risk
-        of collision seems minimal AND the impact is unlikely to be
-        super-problematic as well... */
       if (NULL == de)
       {
        char buf[INET6_ADDRSTRLEN];
@@ -1640,11 +1582,6 @@ message_token (void *cls GNUNET_UNUSED, void *client GNUNET_UNUSED,
                                   &pkt4->destination_address,
                                   &key);
       de = GNUNET_CONTAINER_multihashmap_get (destination_map, &key);
-      /* FIXME: do we need to guard against hash collision? 
-        (if so, we need to also store the local destination IP in the
-        destination entry and then compare here; however, the risk
-        of collision seems minimal AND the impact is unlikely to be
-        super-problematic as well... */
       if (NULL == de)
       {
        char buf[INET_ADDRSTRLEN];
@@ -1742,9 +1679,8 @@ make_up_icmpv6_payload (struct TunnelState *ts,
  * @param tunnel connection to the other end
  * @param tunnel_ctx pointer to our 'struct TunnelState *'
  * @param message the actual message
- * 
- * @return GNUNET_OK to keep the connection open,
- *         GNUNET_SYSERR to close it (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ *         #GNUNET_SYSERR to close it (signal serious error)
  */ 
 static int
 receive_icmp_back (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
@@ -2081,9 +2017,8 @@ receive_icmp_back (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
  * @param tunnel connection to the other end
  * @param tunnel_ctx pointer to our 'struct TunnelState *'
  * @param message the actual message
- * 
- * @return GNUNET_OK to keep the connection open,
- *         GNUNET_SYSERR to close it (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ *         #GNUNET_SYSERR to close it (signal serious error)
  */ 
 static int
 receive_udp_back (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
@@ -2234,11 +2169,10 @@ receive_udp_back (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
  *
  * @param cls closure, NULL
  * @param tunnel connection to the other end
- * @param tunnel_ctx pointer to our 'struct TunnelState *'
+ * @param tunnel_ctx pointer to our `struct TunnelState *`
  * @param message the actual message
- * 
- * @return GNUNET_OK to keep the connection open,
- *         GNUNET_SYSERR to close it (signal serious error)
+ * @return #GNUNET_OK to keep the connection open,
+ *         #GNUNET_SYSERR to close it (signal serious error)
  */ 
 static int
 receive_tcp_back (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
@@ -2375,8 +2309,8 @@ receive_tcp_back (void *cls GNUNET_UNUSED, struct GNUNET_MESH_Tunnel *tunnel,
  * for a new redirection.
  *
  * @param v4 where to store the address
- * @return GNUNET_OK on success,
- *         GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success,
+ *         #GNUNET_SYSERR on error
  */
 static int
 allocate_v4_address (struct in_addr *v4)
@@ -2426,8 +2360,8 @@ allocate_v4_address (struct in_addr *v4)
  * for a new redirection.
  *
  * @param v6 where to store the address
- * @return GNUNET_OK on success,
- *         GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success,
+ *         #GNUNET_SYSERR on error
  */
 static int
 allocate_v6_address (struct in6_addr *v6)
@@ -2544,7 +2478,7 @@ expire_destination (struct DestinationEntry *except)
  *         storage location was used; set to NULL if allocation failed
  * @param v4 storage space for an IPv4 address
  * @param v6 storage space for an IPv6 address
- * @return GNUNET_OK normally, GNUNET_SYSERR if '*result_af' was
+ * @return #GNUNET_OK normally, #GNUNET_SYSERR if `* result_af` was
  *         an unsupported address family (not AF_INET, AF_INET6 or AF_UNSPEC)
  */
 static int
@@ -2593,16 +2527,17 @@ allocate_response_ip (int *result_af,
 
 
 /**
- * A client asks us to setup a redirection via some exit
- * node to a particular IP.  Setup the redirection and
- * give the client the allocated IP.
+ * A client asks us to setup a redirection via some exit node to a
+ * particular IP.  Setup the redirection and give the client the
+ * allocated IP.
  *
  * @param cls unused
  * @param client requesting client
- * @param message redirection request (a 'struct RedirectToIpRequestMessage')
+ * @param message redirection request (a `struct RedirectToIpRequestMessage`)
  */
 static void
-service_redirect_to_ip (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Client *client,
+service_redirect_to_ip (void *cls,
+                       struct GNUNET_SERVER_Client *client,
                        const struct GNUNET_MessageHeader *message)
 {
   size_t mlen;
@@ -2661,15 +2596,11 @@ service_redirect_to_ip (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Client *cl
     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
     return;      
   }
-  if ( (result_af == AF_UNSPEC) ||
-       (GNUNET_NO == ntohl (msg->nac)) )
-  {
-    /* send reply "instantly" */
-    send_client_reply (client,
-                      msg->request_id,
-                      result_af,
-                      addr);
-  }
+  /* send reply with our IP address */
+  send_client_reply (client,
+                    msg->request_id,
+                    result_af,
+                    addr);  
   if (result_af == AF_UNSPEC)
   {
     /* failure, we're done */
@@ -2689,7 +2620,7 @@ service_redirect_to_ip (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Client *cl
   }
   
   /* setup destination record */
-  de = GNUNET_malloc (sizeof (struct DestinationEntry));
+  de = GNUNET_new (struct DestinationEntry);
   de->is_service = GNUNET_NO;
   de->details.exit_destination.af = addr_af;
   memcpy (&de->details.exit_destination.ip,
@@ -2715,7 +2646,6 @@ service_redirect_to_ip (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Client *cl
   
   /* setup tunnel to destination */
   ts = create_tunnel_to_destination (de, 
-                                    (GNUNET_NO == ntohl (msg->nac)) ? NULL : client,
                                     result_af,
                                     msg->request_id);
   switch (result_af)
@@ -2741,7 +2671,7 @@ service_redirect_to_ip (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Client *cl
  *
  * @param cls unused
  * @param client requesting client
- * @param message redirection request (a 'struct RedirectToPeerRequestMessage')
+ * @param message redirection request (a `struct RedirectToPeerRequestMessage`)
  */
 static void
 service_redirect_to_service (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Client *client,
@@ -2768,15 +2698,10 @@ service_redirect_to_service (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Clien
     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
     return;      
   }
-  if ( (result_af == AF_UNSPEC) ||
-       (GNUNET_NO == ntohl (msg->nac)) )
-  {
-    /* send reply "instantly" */
-    send_client_reply (client,
-                      msg->request_id,
-                      result_af,
-                      addr);
-  }
+  send_client_reply (client,
+                    msg->request_id,
+                    result_af,
+                    addr);  
   if (result_af == AF_UNSPEC)
   {
     /* failure, we're done */
@@ -2797,7 +2722,7 @@ service_redirect_to_service (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Clien
   }
   
   /* setup destination record */
-  de = GNUNET_malloc (sizeof (struct DestinationEntry));
+  de = GNUNET_new (struct DestinationEntry);
   de->is_service = GNUNET_YES;
   de->details.service_destination.service_descriptor = msg->service_descriptor;
   de->details.service_destination.target = msg->target;
@@ -2816,7 +2741,6 @@ service_redirect_to_service (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Clien
   while (GNUNET_CONTAINER_multihashmap_size (destination_map) > max_destination_mappings)
     expire_destination (de);
   ts = create_tunnel_to_destination (de,
-                                    (GNUNET_NO == ntohl (msg->nac)) ? NULL : client,
                                     result_af,
                                     msg->request_id);
   switch (result_af)
@@ -2836,21 +2760,23 @@ service_redirect_to_service (void *cls GNUNET_UNUSED, struct GNUNET_SERVER_Clien
 
 
 /**
- * Function called whenever an inbound tunnel is destroyed.  Should clean up
+ * Function called whenever a tunnel is destroyed.  Should clean up
  * any associated state.
  * 
- * FIXME now its also user for disconnections
- *
- * @param cls closure (set from GNUNET_MESH_connect)
+ * @param cls closure (set from #GNUNET_MESH_connect)
  * @param tunnel connection to the other end (henceforth invalid)
  * @param tunnel_ctx place where local state associated
- *                   with the tunnel is stored (our 'struct TunnelState')
+ *                   with the tunnel is stored (our `struct TunnelState`)
  */ 
 static void
-tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel, void *tunnel_ctx)
+tunnel_cleaner (void *cls, 
+               const struct GNUNET_MESH_Tunnel *tunnel, 
+               void *tunnel_ctx)
 {
-  /* we don't have inbound tunnels, so this function should never be called */
-  GNUNET_break (0);
+  struct TunnelState *ts = tunnel_ctx;
+
+  ts->tunnel = NULL; /* we must not call GNUNET_MESH_tunnel_destroy() anymore */
+  free_tunnel_state (ts);
 }
 
 
@@ -2859,8 +2785,8 @@ tunnel_cleaner (void *cls, const struct GNUNET_MESH_Tunnel *tunnel, void *tunnel
  *
  * @param cls unused
  * @param key unused
- * @param value a 'struct DestinationEntry *'
- * @return GNUNET_OK (continue to iterate)
+ * @param value a `struct DestinationEntry *`
+ * @return #GNUNET_OK (continue to iterate)
  */
 static int
 cleanup_destination (void *cls,
@@ -2879,8 +2805,8 @@ cleanup_destination (void *cls,
  *
  * @param cls unused
  * @param key unused
- * @param value a 'struct TunnelState *'
- * @return GNUNET_OK (continue to iterate)
+ * @param value a `struct TunnelState *`
+ * @return #GNUNET_OK (continue to iterate)
  */
 static int
 cleanup_tunnel (void *cls,
@@ -2901,7 +2827,7 @@ cleanup_tunnel (void *cls,
  * @param tc unused
  */
 static void
-cleanup (void *cls GNUNET_UNUSED,
+cleanup (void *cls,
          const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   unsigned int i;
@@ -2949,7 +2875,7 @@ cleanup (void *cls GNUNET_UNUSED,
     GNUNET_SERVER_notification_context_destroy (nc);
     nc = NULL;
   }
-  if (stats != NULL)
+  if (NULL != stats)
   {
     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
     stats = NULL;
@@ -2959,74 +2885,6 @@ cleanup (void *cls GNUNET_UNUSED,
 }
 
 
-/**
- * A client disconnected, clean up all references to it.
- *
- * @param cls the client that disconnected
- * @param key unused
- * @param value a 'struct TunnelState *'
- * @return GNUNET_OK (continue to iterate)
- */
-static int
-cleanup_tunnel_client (void *cls,
-                      const struct GNUNET_HashCode *key,
-                      void *value)
-{
-  struct GNUNET_SERVER_Client *client = cls;
-  struct TunnelState *ts = value;
-
-  if (client == ts->client)
-    ts->client = NULL;
-  return GNUNET_OK;
-}
-
-
-/**
- * A client disconnected, clean up all references to it.
- *
- * @param cls the client that disconnected
- * @param key unused
- * @param value a 'struct DestinationEntry *'
- * @return GNUNET_OK (continue to iterate)
- */
-static int
-cleanup_destination_client (void *cls,
-                           const struct GNUNET_HashCode *key,
-                           void *value)
-{
-  struct GNUNET_SERVER_Client *client = cls;
-  struct DestinationEntry *de = value;
-  struct TunnelState *ts;
-
-  if (NULL == (ts = de->ts))
-    return GNUNET_OK;
-  if (client == ts->client)
-    ts->client = NULL;
-  return GNUNET_OK;
-}
-
-  
-/**
- * A client has disconnected from us.  If we are currently building
- * a tunnel for it, cancel the operation.
- *
- * @param cls unused
- * @param client handle to the client that disconnected
- */
-static void
-client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
-{
-  if (NULL != tunnel_map)
-    GNUNET_CONTAINER_multihashmap_iterate (tunnel_map,
-                                          &cleanup_tunnel_client,
-                                          client);
-  if (NULL != destination_map)
-    GNUNET_CONTAINER_multihashmap_iterate (destination_map,
-                                          &cleanup_destination_client,
-                                          client);
-}
-
-
 /**
  * Main function that will be run by the scheduler.
  *
@@ -3187,7 +3045,6 @@ run (void *cls,
                                       &message_token, NULL, NULL);
   nc = GNUNET_SERVER_notification_context_create (server, 1);
   GNUNET_SERVER_add_handlers (server, service_handlers);
-  GNUNET_SERVER_disconnect_notify (server, &client_disconnect, NULL);
   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &cleanup, cls);
 }