Merge pull request #2652 from geky/nsapi-gethostbyname

sg- · web-flow · commit f93f484fdc1b · 2016-09-26T02:30:49.000-05:00
nsapi - Add explicit DNS interface to the network socket API
diff --git a/features/net/FEATURE_IPV4/lwip-interface/lwip_stack.c b/features/net/FEATURE_IPV4/lwip-interface/lwip_stack.c
@@ -273,7 +273,7 @@ static int lwip_err_remap(err_t err) {
 
 
 /* LWIP network stack implementation */
-static int lwip_gethostbyname(nsapi_stack_t *stack, nsapi_addr_t *addr, const char *host)
+static int lwip_gethostbyname(nsapi_stack_t *stack, const char *host, nsapi_addr_t *addr)
 {
     err_t err = netconn_gethostbyname(host, (ip_addr_t *)addr->bytes);
     if (err != ERR_OK) {
diff --git a/features/net/network-socket/NetworkInterface.cpp b/features/net/network-socket/NetworkInterface.cpp
@@ -15,9 +15,11 @@
  */
 
 #include "network-socket/NetworkInterface.h"
+#include "network-socket/NetworkStack.h"
 #include <string.h>
 
 
+// Default network-interface state
 const char *NetworkInterface::get_mac_address()
 {
     return 0;
@@ -52,3 +54,19 @@ int NetworkInterface::set_dhcp(bool dhcp)
     }
 }
 
+// DNS operations go through the underlying stack by default
+int NetworkInterface::gethostbyname(const char *name, SocketAddress *address)
+{
+    return get_stack()->gethostbyname(name, address);
+}
+
+int NetworkInterface::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
+{
+    return get_stack()->gethostbyname(name, address, version);
+}
+
+int NetworkInterface::add_dns_server(const SocketAddress &address)
+{
+    return get_stack()->add_dns_server(address);
+}
+
diff --git a/features/net/network-socket/NetworkInterface.h b/features/net/network-socket/NetworkInterface.h
@@ -18,6 +18,7 @@
 #define NETWORK_INTERFACE_H
 
 #include "network-socket/nsapi_types.h"
+#include "network-socket/SocketAddress.h"
 
 // Predeclared class
 class NetworkStack;
@@ -99,6 +100,42 @@ class NetworkInterface {
      */
     virtual int disconnect() = 0;
 
+    /** Translates a hostname to an IP address
+     *
+     *  The hostname may be either a domain name or an IP address. If the
+     *  hostname is an IP address, no network transactions will be performed.
+     *
+     *  If no stack-specific DNS resolution is provided, the hostname
+     *  will be resolve using a UDP socket on the stack.
+     *
+     *  @param address  Destination for the host SocketAddress
+     *  @param host     Hostname to resolve
+     *  @return         0 on success, negative error code on failure
+     */
+    virtual int gethostbyname(const char *host, SocketAddress *address);
+
+    /** Translates a hostname to an IP address with specific version
+     *
+     *  The hostname may be either a domain name or an IP address. If the
+     *  hostname is an IP address, no network transactions will be performed.
+     *
+     *  If no stack-specific DNS resolution is provided, the hostname
+     *  will be resolve using a UDP socket on the stack.
+     *
+     *  @param address  Destination for the host SocketAddress
+     *  @param host     Hostname to resolve
+     *  @param version  IP version of address to resolve
+     *  @return         0 on success, negative error code on failure
+     */
+    virtual int gethostbyname(const char *host, SocketAddress *address, nsapi_version_t version);
+
+    /** Add a domain name server to list of servers to query
+     *
+     *  @param addr     Destination for the host address
+     *  @return         0 on success, negative error code on failure
+     */
+    virtual int add_dns_server(const SocketAddress &address);
+
 protected:
     friend class Socket;
     friend class UDPSocket;
diff --git a/features/net/network-socket/NetworkStack.cpp b/features/net/network-socket/NetworkStack.cpp
@@ -22,9 +22,33 @@
 
 
 // Default NetworkStack operations
-int NetworkStack::gethostbyname(SocketAddress *address, const char *name)
+int NetworkStack::gethostbyname(const char *name, SocketAddress *address)
 {
-    return nsapi_dns_query(this, address, name);
+    // check for simple ip addresses
+    if (address->set_ip_address(name)) {
+        return 0;
+    }
+
+    return nsapi_dns_query(this, name, address);
+}
+
+int NetworkStack::gethostbyname(const char *name, SocketAddress *address, nsapi_version_t version)
+{
+    // check for simple ip addresses
+    if (address->set_ip_address(name)) {
+        if (address->get_ip_version() != version) {
+            return NSAPI_ERROR_DNS_FAILURE;
+        }
+
+        return 0;
+    }
+
+    return nsapi_dns_query(this, name, address, version);
+}
+
+int NetworkStack::add_dns_server(const SocketAddress &address)
+{
+    return nsapi_dns_add_server(address);
 }
 
 int NetworkStack::setstackopt(int level, int optname, const void *optval, unsigned optlen)
@@ -76,18 +100,27 @@ class NetworkStackWrapper : public NetworkStack
         return address->get_ip_address();
     }
 
-    virtual int gethostbyname(SocketAddress *address, const char *name)
+    virtual int gethostbyname(const char *name, SocketAddress *address)
     {
         if (!_stack_api()->gethostbyname) {
-            return NetworkStack::gethostbyname(address, name);
+            return NetworkStack::gethostbyname(name, address);
         }
 
         nsapi_addr_t addr = {NSAPI_IPv4, 0};
-        int err = _stack_api()->gethostbyname(_stack(), &addr, name);
+        int err = _stack_api()->gethostbyname(_stack(), name, &addr);
         address->set_addr(addr);
         return err;
     }
 
+    virtual int add_dns_server(const SocketAddress &address)
+    {
+        if (!_stack_api()->add_dns_server) {
+            return NetworkStack::add_dns_server(address);
+        }
+
+        return _stack_api()->add_dns_server(_stack(), address.get_addr());
+    }
+
     virtual int setstackopt(int level, int optname, const void *optval, unsigned optlen)
     {
         if (!_stack_api()->setstackopt) {
diff --git a/features/net/network-socket/NetworkStack.h b/features/net/network-socket/NetworkStack.h
@@ -45,15 +45,37 @@ class NetworkStack
      *
      *  The hostname may be either a domain name or an IP address. If the
      *  hostname is an IP address, no network transactions will be performed.
-     *  
+     *
      *  If no stack-specific DNS resolution is provided, the hostname
-     *  will be resolve using a UDP socket on the stack. 
+     *  will be resolve using a UDP socket on the stack.
      *
+     *  @param host     Hostname to resolve
      *  @param address  Destination for the host SocketAddress
+     *  @return         0 on success, negative error code on failure
+     */
+    virtual int gethostbyname(const char *host, SocketAddress *address);
+
+    /** Translates a hostname to an IP address with specific version
+     *
+     *  The hostname may be either a domain name or an IP address. If the
+     *  hostname is an IP address, no network transactions will be performed.
+     *
+     *  If no stack-specific DNS resolution is provided, the hostname
+     *  will be resolve using a UDP socket on the stack.
+     *
      *  @param host     Hostname to resolve
+     *  @param address  Destination for the host SocketAddress
+     *  @param version  IP version of address to resolve
+     *  @return         0 on success, negative error code on failure
+     */
+    virtual int gethostbyname(const char *host, SocketAddress *address, nsapi_version_t version);
+
+    /** Add a domain name server to list of servers to query
+     *
+     *  @param addr     Destination for the host address
      *  @return         0 on success, negative error code on failure
      */
-    virtual int gethostbyname(SocketAddress *address, const char *host);
+    virtual int add_dns_server(const SocketAddress &address);
 
     /*  Set stack-specific stack options
      *
@@ -66,7 +88,7 @@ class NetworkStack
      *  @param optval   Option value
      *  @param optlen   Length of the option value
      *  @return         0 on success, negative error code on failure
-     */    
+     */
     virtual int setstackopt(int level, int optname, const void *optval, unsigned optlen);
 
     /*  Get stack-specific stack options
@@ -80,7 +102,7 @@ class NetworkStack
      *  @param optval   Destination for option value
      *  @param optlen   Length of the option value
      *  @return         0 on success, negative error code on failure
-     */    
+     */
     virtual int getstackopt(int level, int optname, void *optval, unsigned *optlen);
 
 protected:
@@ -260,7 +282,7 @@ class NetworkStack
      *  @param optval   Option value
      *  @param optlen   Length of the option value
      *  @return         0 on success, negative error code on failure
-     */    
+     */
     virtual int setsockopt(nsapi_socket_t handle, int level, int optname, const void *optval, unsigned optlen);
 
     /*  Get stack-specific socket options
@@ -275,7 +297,7 @@ class NetworkStack
      *  @param optval   Destination for option value
      *  @param optlen   Length of the option value
      *  @return         0 on success, negative error code on failure
-     */    
+     */
     virtual int getsockopt(nsapi_socket_t handle, int level, int optname, void *optval, unsigned *optlen);
 };
 
diff --git a/features/net/network-socket/SocketAddress.cpp b/features/net/network-socket/SocketAddress.cpp
@@ -43,16 +43,21 @@ static bool ipv4_is_valid(const char *addr)
 static bool ipv6_is_valid(const char *addr)
 {
     // Check each digit for [0-9a-fA-F:]
+    // Must also have at least 2 colons
+    int colons = 0;
     for (int i = 0; addr[i]; i++) {
         if (!(addr[i] >= '0' && addr[i] <= '9') &&
             !(addr[i] >= 'a' && addr[i] <= 'f') &&
             !(addr[i] >= 'A' && addr[i] <= 'F') &&
             addr[i] != ':') {
             return false;
         }
+        if (addr[i] == ':') {
+            colons++;
+        }
     }
 
-    return true;
+    return colons >= 2;
 }
 
 static void ipv4_from_address(uint8_t *bytes, const char *addr)
@@ -171,18 +176,21 @@ SocketAddress::SocketAddress(const SocketAddress &addr)
     set_port(addr.get_port());
 }
 
-void SocketAddress::set_ip_address(const char *addr)
+bool SocketAddress::set_ip_address(const char *addr)
 {
     _ip_address[0] = '\0';
 
     if (addr && ipv4_is_valid(addr)) {
         _addr.version = NSAPI_IPv4;
         ipv4_from_address(_addr.bytes, addr);
+        return true;
     } else if (addr && ipv6_is_valid(addr)) {
         _addr.version = NSAPI_IPv6;
         ipv6_from_address(_addr.bytes, addr);
+        return true;
     } else {
         _addr = nsapi_addr_t();
+        return false;
     }
 }
 
@@ -292,7 +300,7 @@ void SocketAddress::_SocketAddress(NetworkStack *iface, const char *host, uint16
         _port = port;
     } else {
         // DNS lookup
-        int err = iface->gethostbyname(this, host);
+        int err = iface->gethostbyname(host, this);
         _port = port;
         if (err) {
             _addr = nsapi_addr_t();
diff --git a/features/net/network-socket/SocketAddress.h b/features/net/network-socket/SocketAddress.h
@@ -41,8 +41,14 @@ class SocketAddress {
      *  @param stack    Network stack to use for DNS resolution
      *  @param host     Hostname to resolve
      *  @param port     Optional 16-bit port
+     *  @deprecated
+     *      Constructors hide possible errors. Replaced by
+     *      NetworkInterface::gethostbyname.
      */
     template <typename S>
+    MBED_DEPRECATED_SINCE("mbed-os-5.1.3",
+        "Constructors hide possible errors. Replaced by "
+        "NetworkInterface::gethostbyname.")
     SocketAddress(S *stack, const char *host, uint16_t port = 0)
     {
         _SocketAddress(nsapi_create_stack(stack), host, port);
@@ -79,8 +85,10 @@ class SocketAddress {
     /** Set the IP address
      *
      *  @param addr     Null-terminated represention of the IP address
+     *  @return         True if address is a valid representation of an IP address,
+     *                  otherwise False and SocketAddress is set to null
      */
-    void set_ip_address(const char *addr);
+    bool set_ip_address(const char *addr);
 
     /** Set the raw IP bytes and IP version
      *
diff --git a/features/net/network-socket/TCPSocket.cpp b/features/net/network-socket/TCPSocket.cpp
@@ -51,11 +51,14 @@ int TCPSocket::connect(const SocketAddress &address)
 
 int TCPSocket::connect(const char *host, uint16_t port)
 {
-    SocketAddress address(_stack, host, port);
-    if (!address) {
+    SocketAddress address;
+    int err = _stack->gethostbyname(host, &address);
+    if (err) {
         return NSAPI_ERROR_DNS_FAILURE;
     }
 
+    address.set_port(port);
+
     // connect is thread safe
     return connect(address);
 }
diff --git a/features/net/network-socket/UDPSocket.cpp b/features/net/network-socket/UDPSocket.cpp
@@ -36,11 +36,14 @@ nsapi_protocol_t UDPSocket::get_proto()
 
 int UDPSocket::sendto(const char *host, uint16_t port, const void *data, unsigned size)
 {
-    SocketAddress address(_stack, host, port);
-    if (!address) {
+    SocketAddress address;
+    int err = _stack->gethostbyname(host, &address);
+    if (err) {
         return NSAPI_ERROR_DNS_FAILURE;
     }
 
+    address.set_port(port);
+
     // sendto is thread safe
     return sendto(address, data, size);
 }
diff --git a/features/net/network-socket/nsapi_dns.cpp b/features/net/network-socket/nsapi_dns.cpp
diff --git a/features/net/network-socket/nsapi_dns.h b/features/net/network-socket/nsapi_dns.h
diff --git a/features/net/network-socket/nsapi_types.h b/features/net/network-socket/nsapi_types.h

Original file line number	Diff line number	Diff line change
`@@ -273,7 +273,7 @@ static int lwip_err_remap(err_t err) {`
`273`	`273`
`274`	`274`
`275`	`275`	`/* LWIP network stack implementation */`
`276`		`-static int lwip_gethostbyname(nsapi_stack_t stack, nsapi_addr_t addr, const char *host)`
	`276`	`+static int lwip_gethostbyname(nsapi_stack_t stack, const char host, nsapi_addr_t *addr)`
`277`	`277`	`{`
`278`	`278`	`err_t err = netconn_gethostbyname(host, (ip_addr_t *)addr->bytes);`
`279`	`279`	`if (err != ERR_OK) {`
Original file line number	Diff line number	Diff line change
`@@ -51,11 +51,14 @@ int TCPSocket::connect(const SocketAddress &address)`
`51`	`51`
`52`	`52`	`int TCPSocket::connect(const char *host, uint16_t port)`
`53`	`53`	`{`
`54`		`- SocketAddress address(_stack, host, port);`
`55`		`- if (!address) {`
	`54`	`+ SocketAddress address;`
	`55`	`+ int err = _stack->gethostbyname(host, &address);`
	`56`	`+ if (err) {`
`56`	`57`	`return NSAPI_ERROR_DNS_FAILURE;`
`57`	`58`	`}`
`58`	`59`
	`60`	`+ address.set_port(port);`
	`61`	`+`
`59`	`62`	`// connect is thread safe`
`60`	`63`	`return connect(address);`
`61`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,14 @@ nsapi_protocol_t UDPSocket::get_proto()`
`36`	`36`
`37`	`37`	`int UDPSocket::sendto(const char host, uint16_t port, const void data, unsigned size)`
`38`	`38`	`{`
`39`		`- SocketAddress address(_stack, host, port);`
`40`		`- if (!address) {`
	`39`	`+ SocketAddress address;`
	`40`	`+ int err = _stack->gethostbyname(host, &address);`
	`41`	`+ if (err) {`
`41`	`42`	`return NSAPI_ERROR_DNS_FAILURE;`
`42`	`43`	`}`
`43`	`44`
	`45`	`+ address.set_port(port);`
	`46`	`+`
`44`	`47`	`// sendto is thread safe`
`45`	`48`	`return sendto(address, data, size);`
`46`	`49`	`}`