epan/addr_resolv.h

   1 /* addr_resolv.h
   2  * Definitions for network object lookup
   3  *
   4  * $Id$
   5  *
   6  * Laurent Deniel <laurent.deniel@free.fr>
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald@wireshark.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  25  */
  26 /* The buffers returned by these functions are all allocated with a
  27  * packet lifetime and does not have have to be freed.
  28  * However, take into account that when the packet dissection
  29  * completes, these buffers will be automatically reclaimed/freed.
  30  * If you need the buffer to remain for a longer scope than packet lifetime
  31  * you must copy the content to an se_alloc() buffer.
  32  */
  33
  34 #ifndef __RESOLV_H__
  35 #define __RESOLV_H__
  36
  37 #include <epan/address.h>
  38
  39 #ifndef MAXNAMELEN
  40 #define MAXNAMELEN      64      /* max name length (hostname and port name) */
  41 #endif
  42
  43 /*
  44  * Flag controlling what names to resolve.
  45  */
  46 ETH_VAR_IMPORT guint32 g_resolv_flags;
  47
  48 /* 32 types are sufficient (as are 640k of RAM) */
  49 /* FIXME: Maybe MANUF/m, IP/i, IP6/6, IPX/x, UDP+TCP/t etc would be
  50    more useful/consistent */
  51 #define RESOLV_NONE             0x0
  52 #define RESOLV_MAC              0x1
  53 #define RESOLV_NETWORK          0x2
  54 #define RESOLV_TRANSPORT        0x4
  55 #define RESOLV_CONCURRENT       0x8
  56
  57 #define RESOLV_ALL_ADDRS        (RESOLV_MAC|RESOLV_NETWORK|RESOLV_TRANSPORT)
  58 #define RESOLV_ALL              0xFFFFFFFF
  59
  60 /* global variables */
  61
  62 extern gchar *g_ethers_path;
  63 extern gchar *g_ipxnets_path;
  64 extern gchar *g_pethers_path;
  65 extern gchar *g_pipxnets_path;
  66
  67 /* Functions in resolv.c */
  68
  69 /* Set the flags controlling what names to resolve */
  70 extern void resolv_set_flags(guint32 flags);
  71
  72 /*
  73  * get_udp_port() returns the port name corresponding to that UDP port,
  74  * or the port number as a string if not found.
  75  */
  76 extern gchar *get_udp_port(guint port);
  77
  78 /*
  79  * get_tcp_port() returns the port name corresponding to that TCP port,
  80  * or the port number as a string if not found.
  81  */
  82 extern gchar *get_tcp_port(guint port);
  83
  84 /*
  85  * get_dccp_port() returns the port name corresponding to that DCCP port,
  86  * or the port number as a string if not found.
  87  */
  88 extern gchar *get_dccp_port(guint port);
  89
  90 /*
  91  * get_sctp_port() returns the port name corresponding to that SCTP port,
  92  * or the port number as a string if not found.
  93  */
  94 extern gchar *get_sctp_port(guint port);
  95
  96 /* get_addr_name takes as input an "address", as defined in address.h */
  97 /* it returns a string that contains: */
  98 /*  - if the address is of a type that can be translated into a name, and the user */
  99 /*    has activated name resolution, the translated name */
 100 /*  - if the address is of type AT_NONE, a pointer to the string "NONE" */
 101 /*  - if the address is of any other type, the result of address_to_str on the argument, */
 102 /*    which should be a string representation for the answer -e.g. "10.10.10.10" for IPv4 */
 103 /*    address 10.10.10.10 */
 104
 105 const gchar *get_addr_name(address *addr);
 106
 107 /* get_addr_name_buf solves an address in the same way as get_addr_name above */
 108 /* The difference is that get_addr_name_buf takes as input a buffer, in which it puts */
 109 /* the result, and a maximum string length -size-. the buffer should be large enough to */
 110 /* contain size characters plus the terminator */
 111
 112 void get_addr_name_buf(address *addr, gchar *buf, guint size);
 113
 114
 115 /*
 116  * Asynchronous host name lookup initialization, processing, and cleanup
 117  */
 118
 119 /* host_name_lookup_init fires up an ADNS socket if we're using ADNS */
 120 extern void host_name_lookup_init(void);
 121
 122 /* host_name_lookup_process does ADNS processing in GTK+ timeouts in Ethereal,
 123    and before processing each packet in Tethereal, if we're using ADNS */
 124 extern gint host_name_lookup_process(gpointer data);
 125
 126 /* host_name_lookup_cleanup cleans up an ADNS socket if we're using ADNS */
 127 extern void host_name_lookup_cleanup(void);
 128
 129 /* get_hostname returns the host name or "%d.%d.%d.%d" if not found */
 130 extern gchar *get_hostname(guint addr);
 131
 132 /* get_hostname6 returns the host name, or numeric addr if not found */
 133 struct e_in6_addr;
 134 const gchar* get_hostname6(struct e_in6_addr *ad);
 135
 136 /* get_ether_name returns the logical name if found in ethers files else
 137    "<vendor>_%02x:%02x:%02x" if the vendor code is known else
 138    "%02x:%02x:%02x:%02x:%02x:%02x" */
 139 extern gchar *get_ether_name(const guint8 *addr);
 140
 141 /* get_ether_name returns the logical name if found in ethers files else NULL */
 142 extern gchar *get_ether_name_if_known(const guint8 *addr);
 143
 144 /* get_manuf_name returns the vendor name or "%02x:%02x:%02x" if not known */
 145 extern const gchar *get_manuf_name(const guint8 *addr);
 146
 147 /* get_manuf_name returns the vendor name or NULL if not known */
 148 extern const gchar *get_manuf_name_if_known(const guint8 *addr);
 149
 150 /* get_ipxnet_name returns the logical name if found in an ipxnets file,
 151  * or a string formatted with "%X" if not */
 152 extern const gchar *get_ipxnet_name(const guint32 addr);
 153
 154 /* returns the ethernet address corresponding to name or NULL if not known */
 155 extern guint8 *get_ether_addr(const gchar *name);
 156
 157 /* returns the ipx network corresponding to name. If name is unknown,
 158  * 0 is returned and 'known' is set to FALSE. On success, 'known'
 159  * is set to TRUE. */
 160 guint32 get_ipxnet_addr(const gchar *name, gboolean *known);
 161
 162 /* adds a hostname/IPv4 in the hash table */
 163 extern void add_ipv4_name(guint addr, const gchar *name);
 164
 165 /* adds a hostname/IPv6 in the hash table */
 166 extern void add_ipv6_name(struct e_in6_addr *addr, const gchar *name);
 167
 168 /* add ethernet address / name corresponding to IP address  */
 169 extern void add_ether_byip(guint ip, const guint8 *eth);
 170
 171 /* Translates a string representing the hostname or dotted-decimal IP address
 172  * into a numeric IP address value, returning TRUE if it succeeds and
 173  * FALSE if it fails. */
 174 gboolean get_host_ipaddr(const char *host, guint32 *addrp);
 175
 176 /*
 177  * Translate IPv6 numeric address or FQDN hostname, into binary IPv6 address.
 178  * Return TRUE if we succeed and set "*addrp" to that numeric IP address;
 179  * return FALSE if we fail.
 180  */
 181 gboolean get_host_ipaddr6(const char *host, struct e_in6_addr *addrp);
 182
 183 /*
 184  * Find out whether a hostname resolves to an ip or ipv6 address
 185  * Return "ip6" if it is IPv6, "ip" otherwise (including the case
 186  * that we don't know)
 187  */
 188 const char* host_ip_af(const char *host);
 189
 190 #endif /* __RESOLV_H__ */