Add IPv6 heuristic.
[metze/wireshark/wip.git] / epan / addr_resolv.h
index ff37d5fb891a05bb6bbacc8193a80597366a28ff..059d97693532df4dfe399b2157ecf45deb3b564b 100644 (file)
@@ -21,7 +21,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 /* The buffers returned by these functions are all allocated with a
  * packet lifetime and does not have have to be freed.
@@ -35,6 +35,7 @@
 #define __RESOLV_H__
 
 #include <epan/address.h>
+#include <epan/tvbuff.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -44,22 +45,19 @@ extern "C" {
 #define MAXNAMELEN     64      /* max name length (hostname and port name) */
 #endif
 
+typedef struct _e_addr_resolve {
+  gboolean mac_name;
+  gboolean network_name;
+  gboolean transport_name;
+  gboolean concurrent_dns;
+  gboolean use_external_net_name_resolver;
+  gboolean load_hosts_file_from_profile_only;
+} e_addr_resolve;
+
 /*
  * Flag controlling what names to resolve.
  */
-WS_VAR_IMPORT guint32 g_resolv_flags;
-
-/* 32 types are sufficient (as are 640k of RAM) */
-/* FIXME: Maybe MANUF/m, IP/i, IP6/6, IPX/x, UDP+TCP/t etc would be
-   more useful/consistent */
-#define RESOLV_NONE            0x0
-#define RESOLV_MAC             0x1
-#define RESOLV_NETWORK         0x2
-#define RESOLV_TRANSPORT       0x4
-#define RESOLV_CONCURRENT      0x8
-
-#define RESOLV_ALL_ADDRS       (RESOLV_MAC|RESOLV_NETWORK|RESOLV_TRANSPORT)
-#define RESOLV_ALL             0xFFFFFFFF
+WS_VAR_IMPORT e_addr_resolve gbl_resolv_flags;
 
 /* global variables */
 
@@ -68,10 +66,7 @@ extern gchar *g_ipxnets_path;
 extern gchar *g_pethers_path;
 extern gchar *g_pipxnets_path;
 
-/* Functions in resolv.c */
-
-/* Set the flags controlling what names to resolve */
-extern void resolv_set_flags(guint32 flags);
+/* Functions in addr_resolv.c */
 
 /*
  * get_udp_port() returns the port name corresponding to that UDP port,
@@ -114,13 +109,17 @@ const gchar *se_get_addr_name(const address *addr);
 /* the result which is always NUL ('\0') terminated. The buffer should be large enough to */
 /* contain size characters including the terminator */
 
-void get_addr_name_buf(address *addr, gchar *buf, gsize size);
+void get_addr_name_buf(const address *addr, gchar *buf, gsize size);
 
 
 /*
  * Asynchronous host name lookup initialization, processing, and cleanup
  */
 
+/* Setup name resolution preferences */
+struct pref_module;
+extern void addr_resolve_pref_init(struct pref_module *nameres);
+
 /* host_name_lookup_init fires up an ADNS socket if we're using ADNS */
 extern void host_name_lookup_init(void);
 
@@ -138,11 +137,11 @@ extern gboolean host_name_lookup_process(gpointer data);
 extern void host_name_lookup_cleanup(void);
 
 /* get_hostname returns the host name or "%d.%d.%d.%d" if not found */
-extern const gchar *get_hostname(guint addr);
+extern const gchar *get_hostname(const guint addr);
 
 /* get_hostname6 returns the host name, or numeric addr if not found */
 struct e_in6_addr;
-extern const gchar* get_hostname6(struct e_in6_addr *ad);
+extern const gchar* get_hostname6(const struct e_in6_addr *ad);
 
 /* get_ether_name returns the logical name if found in ethers files else
    "<vendor>_%02x:%02x:%02x" if the vendor code is known else
@@ -152,12 +151,52 @@ extern gchar *get_ether_name(const guint8 *addr);
 /* get_ether_name returns the logical name if found in ethers files else NULL */
 extern gchar *get_ether_name_if_known(const guint8 *addr);
 
-/* get_manuf_name returns the vendor name or "%02x:%02x:%02x" if not known */
+/*
+ * Given a sequence of 3 octets containing an OID, get_manuf_name()
+ * returns the vendor name, or "%02x:%02x:%02x" if not known.
+ */
 extern const gchar *get_manuf_name(const guint8 *addr);
 
-/* get_manuf_name returns the vendor name or NULL if not known */
+/*
+ * Given a sequence of 3 octets containing an OID, get_manuf_name_if_known()
+ * returns the vendor name, or NULL if not known.
+ */
 extern const gchar *get_manuf_name_if_known(const guint8 *addr);
 
+/*
+ * Given an integer containing a 24-bit OID, uint_get_manuf_name()
+ * returns the vendor name, or "%02x:%02x:%02x" if not known.
+ */
+extern const gchar *uint_get_manuf_name(const guint oid);
+
+/*
+ * Given an integer containing a 24-bit OID, uint_get_manuf_name_if_known()
+ * returns the vendor name, or NULL if not known.
+ */
+extern const gchar *uint_get_manuf_name_if_known(const guint oid);
+
+/*
+ * Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
+ * tvb_get_manuf_name() returns the vendor name, or "%02x:%02x:%02x"
+ * if not known.
+ */
+extern const gchar *tvb_get_manuf_name(tvbuff_t *tvb, gint offset);
+
+/*
+ * Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
+ * tvb_get_manuf_name_if_known() returns the vendor name, or NULL
+ * if not known.
+ */
+extern const gchar *tvb_get_manuf_name_if_known(tvbuff_t *tvb, gint offset);
+
+/* get_eui64_name returns "<vendor>_%02x:%02x:%02x:%02x:%02x:%02x" if the vendor code is known
+   "%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x" */
+extern const gchar *get_eui64_name(const guint64 addr);
+
+/* get_eui64_name_if_known returns "<vendor>_%02x:%02x:%02x:%02x:%02x:%02x" if the vendor code is known else NULL */
+extern const gchar *get_eui64_name_if_known(const guint64 addr);
+
+
 /* get_ipxnet_name returns the logical name if found in an ipxnets file,
  * or a string formatted with "%X" if not */
 extern const gchar *get_ipxnet_name(const guint32 addr);
@@ -171,22 +210,58 @@ extern guint8 *get_ether_addr(const gchar *name);
 guint32 get_ipxnet_addr(const gchar *name, gboolean *known);
 
 /* adds a hostname/IPv4 in the hash table */
-extern void add_ipv4_name(guint addr, const gchar *name);
+extern void add_ipv4_name(const guint addr, const gchar *name);
 
 /* adds a hostname/IPv6 in the hash table */
-extern void add_ipv6_name(struct e_in6_addr *addr, const gchar *name);
+extern void add_ipv6_name(const struct e_in6_addr *addr, const gchar *name);
+
+/* read a "hosts" file and add its entries to the IPv4 & IPv6 hash tables */
+extern gboolean read_hosts_file (const char *hostspath);
+
+/* adds a hostname in the hash table */
+extern gboolean add_ip_name_from_string (const char *addr, const char *name);
+
+/** Get a list of host name to address mappings we know about.
+ *
+ * Each list element is an addrinfo struct with the following fields defined:
+ *   - ai_family: 0, AF_INET or AF_INET6
+ *   - ai_addrlen: Length of ai_addr
+ *   - ai_canonname: Host name or NULL
+ *   - ai_addr: Pointer to a struct sockaddr or NULL (see below)
+ *   - ai_next: Next element or NULL
+ * All other fields are zero-filled.
+ *
+ * If ai_family is 0, this is a dummy entry which should only appear at the beginning of the list.
+ *
+ * If ai_family is AF_INET, ai_addr points to a struct sockaddr_in with the following fields defined:
+ *   - sin_family: AF_INET
+ *   - sin_addr: Host IPv4 address
+ * All other fields are zero-filled.
+ *
+ * If ai_family is AF_INET6, ai_addr points to a struct sockaddr_in6 with the following fields defined:
+ *   - sin6_family: AF_INET6
+ *   - sin6_addr: Host IPv6 address
+ * All other fields are zero-filled.
+ *
+ * The list and its elements MUST NOT be modified or freed.
+ *
+ * @return The first element in our list of known addresses. May be NULL.
+ */
+extern struct addrinfo *get_addrinfo_list(void);
 
 /* add ethernet address / name corresponding to IP address  */
-extern void add_ether_byip(guint ip, const guint8 *eth);
+extern void add_ether_byip(const guint ip, const guint8 *eth);
 
 /** Translates a string representing a hostname or dotted-decimal IPv4 address
  *  into a numeric IPv4 address value in network byte order. If compiled with
  *  c-ares, the request will wait a maximum of 250ms for the request to finish.
  *  Otherwise the wait time will be system-dependent, ususally much longer.
+ *  Immediately returns FALSE for hostnames if network name resolution is
+ *  disabled.
  *
  * @param[in] host The hostname.
  * @param[out] addrp The numeric IPv4 address in network byte order.
- * @return TRUE on success, FALSE on failure or timeout.
+ * @return TRUE on success, FALSE on failure, timeout.
  */
 gboolean get_host_ipaddr(const char *host, guint32 *addrp);
 
@@ -194,6 +269,8 @@ gboolean get_host_ipaddr(const char *host, guint32 *addrp);
  *  into a numeric IPv6 address value in network byte order. If compiled with
  *  c-ares, the request will wait a maximum of 250ms for the request to finish.
  *  Otherwise the wait time will be system-dependent, usually much longer.
+ *  Immediately returns FALSE for hostnames if network name resolution is
+ *  disabled.
  *
  * @param[in] host The hostname.
  * @param[out] addrp The numeric IPv6 address in network byte order.