candidate: Add utility function to get STUN server address

Can be useful to know which STUN server was used to discover the given candidate.

9 files changed, 64 insertions, 13 deletions

diff --git a/agent/agent.c b/agent/agent.c
index fb494d3..a2e150f 100644
--- a/agent/agent.c
+++ b/agent/agent.c
@@ -3081,6 +3081,7 @@ static void _upnp_mapped_external_port (GUPnPSimpleIgd *self, gchar *proto,
         &externaddr,
         host_candidate->c.transport,
         host_candidate->sockptr,
+        NULL,
         TRUE);
 
     check_upnp_gathering_done (agent, stream);
diff --git a/agent/candidate-priv.h b/agent/candidate-priv.h
index 51cb806..e6e2529 100644
--- a/agent/candidate-priv.h
+++ b/agent/candidate-priv.h
@@ -105,6 +105,8 @@ struct _TurnServer
  * of type %NICE_CANDIDATE_TYPE_RELAYED
  * @sockptr: The underlying socket
  * @keepalive_next_tick: The timestamp for the next keepalive
+ * @stun_server: The STUN server address, if the candidate is
+ * of type %NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE
  *
  * A structure to represent an ICE candidate
  */
@@ -114,6 +116,7 @@ struct _NiceCandidateImpl
   TurnServer *turn;
   NiceSocket *sockptr;
   guint64 keepalive_next_tick; /* next tick timestamp */
+  NiceAddress *stun_server;
 };
 
 
diff --git a/agent/candidate.c b/agent/candidate.c
index 1754324..1632f51 100644
--- a/agent/candidate.c
+++ b/agent/candidate.c
@@ -88,6 +88,9 @@ nice_candidate_free (NiceCandidate *candidate)
   if (c->turn)
     turn_server_unref (c->turn);
 
+  if (c->stun_server)
+    nice_address_free (c->stun_server);
+
   g_slice_free (NiceCandidateImpl, c);
 }
 
@@ -474,3 +477,19 @@ nice_candidate_relay_address (const NiceCandidate *candidate, NiceAddress *addr)
 
   *addr = c->turn->server;
 }
+
+NICEAPI_EXPORT gboolean
+nice_candidate_stun_server_address (const NiceCandidate *candidate, NiceAddress *addr)
+{
+  const NiceCandidateImpl *c = (NiceCandidateImpl *) candidate;
+
+  g_return_val_if_fail (candidate != NULL, FALSE);
+  g_return_val_if_fail (candidate->type != NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE, FALSE);
+
+  if (c->stun_server) {
+    *addr = *c->stun_server;
+    return TRUE;
+  } else {
+    return FALSE;
+  }
+}
diff --git a/agent/candidate.h b/agent/candidate.h
index 419a52e..dfa9f06 100644
--- a/agent/candidate.h
+++ b/agent/candidate.h
@@ -90,11 +90,11 @@ G_BEGIN_DECLS
 /**
  * NiceCandidateType:
  * @NICE_CANDIDATE_TYPE_HOST: A host candidate
- * @NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE: A server reflexive candidate
+ * @NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE: A server reflexive candidate (or a NAT-assisted candidate)
  * @NICE_CANDIDATE_TYPE_PEER_REFLEXIVE: A peer reflexive candidate
  * @NICE_CANDIDATE_TYPE_RELAYED: A relay candidate
  *
- * An enum represneting the type of a candidate
+ * An enum representing the type of a candidate
  */
 typedef enum
 {
@@ -269,6 +269,21 @@ void
 nice_candidate_relay_address (const NiceCandidate *candidate, NiceAddress *addr);
 
 /**
+ * nice_candidate_stun_server_address:
+ * @candidate: A server-reflexive candidate
+ * @addr: The #NiceAddress to fill
+ *
+ * In case the given candidate server-reflexive, use this utility function to get its address. The
+ * address will be filled only if the candidate was generated using an STUN server.
+ *
+ * Returns: TRUE if it's a STUN created ICE candidate, or FALSE if the reflexed's server was not STUN.
+ *
+ * Since: 0.1.20
+ */
+gboolean
+nice_candidate_stun_server_address (const NiceCandidate *candidate, NiceAddress *addr);
+
+/**
  * NICE_TYPE_CANDIDATE:
  *
  * A boxed type for a #NiceCandidate.
diff --git a/agent/conncheck.c b/agent/conncheck.c
index 9f1374a..49869a3 100644
--- a/agent/conncheck.c
+++ b/agent/conncheck.c
@@ -3758,7 +3758,7 @@ static gboolean priv_map_reply_to_conn_check_request (NiceAgent *agent, NiceStre
  *
  * @return TRUE if a matching transaction is found
  */
-static gboolean priv_map_reply_to_discovery_request (NiceAgent *agent, StunMessage *resp)
+static gboolean priv_map_reply_to_discovery_request (NiceAgent *agent, StunMessage *resp, const NiceAddress *server_address)
 {
   union {
     struct sockaddr_storage storage;
@@ -3814,14 +3814,17 @@ static gboolean priv_map_reply_to_discovery_request (NiceAgent *agent, StunMessa
                 &niceaddr,
                 NICE_CANDIDATE_TRANSPORT_UDP,
                 d->nicesock,
+                server_address,
                 FALSE);
+
             if (agent->use_ice_tcp)
               discovery_discover_tcp_server_reflexive_candidates (
                   agent,
                   d->stream_id,
                   d->component_id,
                   &niceaddr,
-                  d->nicesock);
+                  d->nicesock,
+                  server_address);
           }
           d->stun_message.buffer = NULL;
           d->stun_message.buffer_len = 0;
@@ -4045,6 +4048,7 @@ static gboolean priv_map_reply_to_relay_request (NiceAgent *agent, StunMessage *
                   &mappedniceaddr,
                   NICE_CANDIDATE_TRANSPORT_UDP,
                   d->nicesock,
+                  &niceaddr,
                   FALSE);
             }
             if (agent->use_ice_tcp) {
@@ -4059,7 +4063,8 @@ static gboolean priv_map_reply_to_relay_request (NiceAgent *agent, StunMessage *
                     d->stream_id,
                     d->component_id,
                     &mappedniceaddr,
-                    d->nicesock);
+                    d->nicesock,
+                    &niceaddr);
               }
             }
           }
@@ -4885,7 +4890,7 @@ gboolean conn_check_handle_inbound_stun (NiceAgent *agent, NiceStream *stream,
 
       /* step: let's try to match the response to an existing discovery */
       if (trans_found != TRUE)
-        trans_found = priv_map_reply_to_discovery_request (agent, &req);
+        trans_found = priv_map_reply_to_discovery_request (agent, &req, from);
 
       /* step: let's try to match the response to an existing turn allocate */
       if (trans_found != TRUE)
diff --git a/agent/discovery.c b/agent/discovery.c
index 4231804..ace338d 100644
--- a/agent/discovery.c
+++ b/agent/discovery.c
@@ -848,7 +848,7 @@ errors:
  *
  * @return pointer to the created candidate, or NULL on error
  */
-NiceCandidate*
+void
 discovery_add_server_reflexive_candidate (
   NiceAgent *agent,
   guint stream_id,
@@ -856,6 +856,7 @@ discovery_add_server_reflexive_candidate (
   NiceAddress *address,
   NiceCandidateTransport transport,
   NiceSocket *base_socket,
+  const NiceAddress *server_address,
   gboolean nat_assisted)
 {
   NiceCandidate *candidate;
@@ -865,7 +866,7 @@ discovery_add_server_reflexive_candidate (
   gboolean result = FALSE;
 
   if (!agent_find_component (agent, stream_id, component_id, &stream, &component))
-    return NULL;
+    return;
 
   candidate = nice_candidate_new (NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE);
   c = (NiceCandidateImpl *) candidate;
@@ -891,6 +892,9 @@ discovery_add_server_reflexive_candidate (
         agent->reliable, nat_assisted);
   }
 
+  if (server_address != NULL)
+    c->stun_server = nice_address_dup (server_address);
+
   priv_generate_candidate_credentials (agent, candidate);
   priv_assign_foundation (agent, candidate);
 
@@ -902,8 +906,6 @@ discovery_add_server_reflexive_candidate (
     /* error: duplicate candidate */
     nice_candidate_free (candidate), candidate = NULL;
   }
-
-  return candidate;
 }
 
 /*
@@ -919,7 +921,8 @@ discovery_discover_tcp_server_reflexive_candidates (
   guint stream_id,
   guint component_id,
   NiceAddress *address,
-  NiceSocket *base_socket)
+  NiceSocket *base_socket,
+  const NiceAddress *server_addr)
 {
   NiceComponent *component;
   NiceStream *stream;
@@ -948,6 +951,7 @@ discovery_discover_tcp_server_reflexive_candidates (
           address,
           c->transport,
           ((NiceCandidateImpl *) c)->sockptr,
+          server_addr,
           FALSE);
     }
   }
diff --git a/agent/discovery.h b/agent/discovery.h
index 703fff6..84ce1c1 100644
--- a/agent/discovery.h
+++ b/agent/discovery.h
@@ -131,7 +131,7 @@ discovery_add_relay_candidate (
   TurnServer *turn,
   uint32_t *lifetime);
 
-NiceCandidate*
+void
 discovery_add_server_reflexive_candidate (
   NiceAgent *agent,
   guint stream_id,
@@ -139,6 +139,7 @@ discovery_add_server_reflexive_candidate (
   NiceAddress *address,
   NiceCandidateTransport transport,
   NiceSocket *base_socket,
+  const NiceAddress *server_address,
   gboolean nat_assisted);
 
 void
@@ -147,7 +148,8 @@ discovery_discover_tcp_server_reflexive_candidates (
   guint stream_id,
   guint component_id,
   NiceAddress *address,
-  NiceSocket *base_socket);
+  NiceSocket *base_socket,
+  const NiceAddress *server_address);
 
 NiceCandidate*
 discovery_add_peer_reflexive_candidate (
diff --git a/docs/reference/libnice/libnice-sections.txt b/docs/reference/libnice/libnice-sections.txt
index d0c48e1..3814c3b 100644
--- a/docs/reference/libnice/libnice-sections.txt
+++ b/docs/reference/libnice/libnice-sections.txt
@@ -100,6 +100,7 @@ nice_candidate_equal_target
 nice_candidate_transport_to_string
 nice_candidate_type_to_string
 nice_candidate_relay_address
+nice_candidate_stun_server_address
 <SUBSECTION Standard>
 NICE_TYPE_CANDIDATE
 nice_candidate_get_type
diff --git a/nice/libnice.sym b/nice/libnice.sym
index 2c8cec5..08aaece 100644
--- a/nice/libnice.sym
+++ b/nice/libnice.sym
@@ -73,6 +73,7 @@ nice_candidate_transport_to_string
 nice_candidate_type_get_type
 nice_candidate_type_to_string
 nice_candidate_relay_address
+nice_candidate_stun_server_address
 nice_compatibility_get_type
 nice_component_state_get_type
 nice_component_state_to_string