src/common/address.h

   1 /* Copyright (c) 2003-2004, Roger Dingledine
   2  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   3  * Copyright (c) 2007-2013, The Tor Project, Inc. */
   4 /* See LICENSE for licensing information */
   5
   6 /**
   7  * \file address.h
   8  * \brief Headers for address.h
   9  **/
  10
  11 #ifndef TOR_ADDRESS_H
  12 #define TOR_ADDRESS_H
  13
  14 #include "orconfig.h"
  15 #include "torint.h"
  16 #include "compat.h"
  17
  18 /** The number of bits from an address to consider while doing a masked
  19  * comparison. */
  20 typedef uint8_t maskbits_t;
  21
  22 struct in_addr;
  23 /** Holds an IPv4 or IPv6 address.  (Uses less memory than struct
  24  * sockaddr_storage.) */
  25 typedef struct tor_addr_t
  26 {
  27   sa_family_t family;
  28   union {
  29     uint32_t dummy_; /* This field is here so we have something to initialize
  30                       * with a reliable cross-platform type. */
  31     struct in_addr in_addr;
  32     struct in6_addr in6_addr;
  33   } addr;
  34 } tor_addr_t;
  35
  36 /** Holds an IP address and a TCP/UDP port.  */
  37 typedef struct tor_addr_port_t
  38 {
  39   tor_addr_t addr;
  40   uint16_t port;
  41 } tor_addr_port_t;
  42
  43 #define TOR_ADDR_NULL {AF_UNSPEC, {0}}
  44
  45 static INLINE const struct in6_addr *tor_addr_to_in6(const tor_addr_t *a);
  46 static INLINE uint32_t tor_addr_to_ipv4n(const tor_addr_t *a);
  47 static INLINE uint32_t tor_addr_to_ipv4h(const tor_addr_t *a);
  48 static INLINE uint32_t tor_addr_to_mapped_ipv4h(const tor_addr_t *a);
  49 static INLINE sa_family_t tor_addr_family(const tor_addr_t *a);
  50 static INLINE const struct in_addr *tor_addr_to_in(const tor_addr_t *a);
  51 static INLINE int tor_addr_eq_ipv4h(const tor_addr_t *a, uint32_t u);
  52
  53 socklen_t tor_addr_to_sockaddr(const tor_addr_t *a, uint16_t port,
  54                                struct sockaddr *sa_out, socklen_t len);
  55 int tor_addr_from_sockaddr(tor_addr_t *a, const struct sockaddr *sa,
  56                            uint16_t *port_out);
  57 void tor_addr_make_unspec(tor_addr_t *a);
  58 void tor_addr_make_null(tor_addr_t *a, sa_family_t family);
  59 char *tor_sockaddr_to_str(const struct sockaddr *sa);
  60
  61 /** Return an in6_addr* equivalent to <b>a</b>, or NULL if <b>a</b> is not
  62  * an IPv6 address. */
  63 static INLINE const struct in6_addr *
  64 tor_addr_to_in6(const tor_addr_t *a)
  65 {
  66   return a->family == AF_INET6 ? &a->addr.in6_addr : NULL;
  67 }
  68
  69 /** Given an IPv6 address <b>x</b>, yield it as an array of uint8_t.
  70  *
  71  * Requires that <b>x</b> is actually an IPv6 address.
  72  */
  73 #define tor_addr_to_in6_addr8(x) tor_addr_to_in6(x)->s6_addr
  74 /** Given an IPv6 address <b>x</b>, yield it as an array of uint16_t.
  75  *
  76  * Requires that <b>x</b> is actually an IPv6 address.
  77  */
  78 #define tor_addr_to_in6_addr16(x) S6_ADDR16(*tor_addr_to_in6(x))
  79 /** Given an IPv6 address <b>x</b>, yield it as an array of uint32_t.
  80  *
  81  * Requires that <b>x</b> is actually an IPv6 address.
  82  */
  83 #define tor_addr_to_in6_addr32(x) S6_ADDR32(*tor_addr_to_in6(x))
  84
  85 /** Return an IPv4 address in network order for <b>a</b>, or 0 if
  86  * <b>a</b> is not an IPv4 address. */
  87 static INLINE uint32_t
  88 tor_addr_to_ipv4n(const tor_addr_t *a)
  89 {
  90   return a->family == AF_INET ? a->addr.in_addr.s_addr : 0;
  91 }
  92 /** Return an IPv4 address in host order for <b>a</b>, or 0 if
  93  * <b>a</b> is not an IPv4 address. */
  94 static INLINE uint32_t
  95 tor_addr_to_ipv4h(const tor_addr_t *a)
  96 {
  97   return ntohl(tor_addr_to_ipv4n(a));
  98 }
  99 /** Given an IPv6 address, return its mapped IPv4 address in host order, or
 100  * 0 if <b>a</b> is not an IPv6 address.
 101  *
 102  * (Does not check whether the address is really a mapped address */
 103 static INLINE uint32_t
 104 tor_addr_to_mapped_ipv4h(const tor_addr_t *a)
 105 {
 106   return a->family == AF_INET6 ? ntohl(tor_addr_to_in6_addr32(a)[3]) : 0;
 107 }
 108 /** Return the address family of <b>a</b>.  Possible values are:
 109  * AF_INET6, AF_INET, AF_UNSPEC. */
 110 static INLINE sa_family_t
 111 tor_addr_family(const tor_addr_t *a)
 112 {
 113   return a->family;
 114 }
 115 /** Return an in_addr* equivalent to <b>a</b>, or NULL if <b>a</b> is not
 116  * an IPv4 address. */
 117 static INLINE const struct in_addr *
 118 tor_addr_to_in(const tor_addr_t *a)
 119 {
 120   return a->family == AF_INET ? &a->addr.in_addr : NULL;
 121 }
 122 /** Return true iff <b>a</b> is an IPv4 address equal to the host-ordered
 123  * address in <b>u</b>. */
 124 static INLINE int
 125 tor_addr_eq_ipv4h(const tor_addr_t *a, uint32_t u)
 126 {
 127   return a->family == AF_INET ? (tor_addr_to_ipv4h(a) == u) : 0;
 128 }
 129
 130 /** Length of a buffer that you need to allocate to be sure you can encode
 131  * any tor_addr_t.
 132  *
 133  * This allows enough space for
 134  *   "[ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255]",
 135  * plus a terminating NUL.
 136  */
 137 #define TOR_ADDR_BUF_LEN 48
 138
 139 int tor_addr_lookup(const char *name, uint16_t family, tor_addr_t *addr_out);
 140 char *tor_dup_addr(const tor_addr_t *addr) ATTR_MALLOC;
 141
 142 /** Wrapper function of fmt_addr_impl(). It does not decorate IPv6
 143  *  addresses. */
 144 #define fmt_addr(a) fmt_addr_impl((a), 0)
 145 /** Wrapper function of fmt_addr_impl(). It decorates IPv6
 146  *  addresses. */
 147 #define fmt_and_decorate_addr(a) fmt_addr_impl((a), 1)
 148 const char *fmt_addr_impl(const tor_addr_t *addr, int decorate);
 149 const char *fmt_addrport(const tor_addr_t *addr, uint16_t port);
 150 const char * fmt_addr32(uint32_t addr);
 151 int get_interface_address6(int severity, sa_family_t family, tor_addr_t *addr);
 152
 153 /** Flag to specify how to do a comparison between addresses.  In an "exact"
 154  * comparison, addresses are equivalent only if they are in the same family
 155  * with the same value.  In a "semantic" comparison, IPv4 addresses match all
 156  * IPv6 encodings of those addresses. */
 157 typedef enum {
 158   CMP_EXACT,
 159   CMP_SEMANTIC,
 160 } tor_addr_comparison_t;
 161
 162 int tor_addr_compare(const tor_addr_t *addr1, const tor_addr_t *addr2,
 163                      tor_addr_comparison_t how);
 164 int tor_addr_compare_masked(const tor_addr_t *addr1, const tor_addr_t *addr2,
 165                             maskbits_t mask, tor_addr_comparison_t how);
 166 /** Return true iff a and b are the same address.  The comparison is done
 167  * "exactly". */
 168 #define tor_addr_eq(a,b) (0==tor_addr_compare((a),(b),CMP_EXACT))
 169
 170 unsigned int tor_addr_hash(const tor_addr_t *addr);
 171 int tor_addr_is_v4(const tor_addr_t *addr);
 172 int tor_addr_is_internal_(const tor_addr_t *ip, int for_listening,
 173                           const char *filename, int lineno);
 174 #define tor_addr_is_internal(addr, for_listening) \
 175   tor_addr_is_internal_((addr), (for_listening), SHORT_FILE__, __LINE__)
 176
 177 /** Longest length that can be required for a reverse lookup name. */
 178 /* 32 nybbles, 32 dots, 8 characters of "ip6.arpa", 1 NUL: 73 characters. */
 179 #define REVERSE_LOOKUP_NAME_BUF_LEN 73
 180 int tor_addr_to_PTR_name(char *out, size_t outlen,
 181                                     const tor_addr_t *addr);
 182 int tor_addr_parse_PTR_name(tor_addr_t *result, const char *address,
 183                                        int family, int accept_regular);
 184
 185 int tor_addr_port_lookup(const char *s, tor_addr_t *addr_out,
 186                         uint16_t *port_out);
 187 #define TAPMP_EXTENDED_STAR 1
 188 int tor_addr_parse_mask_ports(const char *s, unsigned flags,
 189                               tor_addr_t *addr_out, maskbits_t *mask_out,
 190                               uint16_t *port_min_out, uint16_t *port_max_out);
 191 const char * tor_addr_to_str(char *dest, const tor_addr_t *addr, size_t len,
 192                              int decorate);
 193 int tor_addr_parse(tor_addr_t *addr, const char *src);
 194 void tor_addr_copy(tor_addr_t *dest, const tor_addr_t *src);
 195 void tor_addr_from_ipv4n(tor_addr_t *dest, uint32_t v4addr);
 196 /** Set <b>dest</b> to the IPv4 address encoded in <b>v4addr</b> in host
 197  * order. */
 198 #define tor_addr_from_ipv4h(dest, v4addr)       \
 199   tor_addr_from_ipv4n((dest), htonl(v4addr))
 200 void tor_addr_from_ipv6_bytes(tor_addr_t *dest, const char *bytes);
 201 /** Set <b>dest</b> to the IPv4 address incoded in <b>in</b>. */
 202 #define tor_addr_from_in(dest, in) \
 203   tor_addr_from_ipv4n((dest), (in)->s_addr);
 204 void tor_addr_from_in6(tor_addr_t *dest, const struct in6_addr *in6);
 205 int tor_addr_is_null(const tor_addr_t *addr);
 206 int tor_addr_is_loopback(const tor_addr_t *addr);
 207
 208 int tor_addr_port_split(int severity, const char *addrport,
 209                         char **address_out, uint16_t *port_out);
 210
 211 int tor_addr_port_parse(int severity, const char *addrport,
 212                         tor_addr_t *address_out, uint16_t *port_out);
 213
 214 int tor_addr_hostname_is_local(const char *name);
 215
 216 /* IPv4 helpers */
 217 int is_internal_IP(uint32_t ip, int for_listening);
 218 int addr_port_lookup(int severity, const char *addrport, char **address,
 219                     uint32_t *addr, uint16_t *port_out);
 220 int parse_port_range(const char *port, uint16_t *port_min_out,
 221                      uint16_t *port_max_out);
 222 int addr_mask_get_bits(uint32_t mask);
 223 /** Length of a buffer to allocate to hold the results of tor_inet_ntoa.*/
 224 #define INET_NTOA_BUF_LEN 16
 225 int tor_inet_ntoa(const struct in_addr *in, char *buf, size_t buf_len);
 226 char *tor_dup_ip(uint32_t addr) ATTR_MALLOC;
 227 int get_interface_address(int severity, uint32_t *addr);
 228
 229 tor_addr_port_t *tor_addr_port_new(const tor_addr_t *addr, uint16_t port);
 230
 231 #endif
 232