1 /* $NetBSD: ntp_net.h,v 1.6 2024/08/18 20:46:50 christos Exp $ */ 2 3 /* 4 * ntp_net.h - definitions for NTP network stuff 5 */ 6 7 #ifndef NTP_NET_H 8 #define NTP_NET_H 9 10 #include <sys/types.h> 11 #ifdef HAVE_SYS_SOCKET_H 12 #include <sys/socket.h> 13 #endif 14 #ifdef HAVE_NET_IF_H 15 #include <net/if.h> 16 #endif 17 #ifdef HAVE_NETINET_IN_H 18 #include <netinet/in.h> 19 #endif 20 #ifdef HAVE_NET_IF_VAR_H 21 #include <net/if_var.h> 22 #endif 23 #ifdef HAVE_NETINET_IN_VAR_H 24 #include <netinet/in_var.h> 25 #endif 26 27 #include "ntp_rfc2553.h" 28 #include "ntp_malloc.h" 29 30 typedef union { 31 struct sockaddr sa; 32 struct sockaddr_in sa4; 33 struct sockaddr_in6 sa6; 34 } sockaddr_u; 35 36 /* 37 * Utilities for manipulating sockaddr_u v4/v6 unions 38 */ 39 #define SOCK_ADDR4(psau) ((psau)->sa4.sin_addr) 40 #define SOCK_ADDR6(psau) ((psau)->sa6.sin6_addr) 41 42 #define PSOCK_ADDR4(psau) (&SOCK_ADDR4(psau)) 43 #define PSOCK_ADDR6(psau) (&SOCK_ADDR6(psau)) 44 45 #define AF(psau) ((psau)->sa.sa_family) 46 47 #define IS_IPV4(psau) (AF_INET == AF(psau)) 48 #define IS_IPV6(psau) (AF_INET6 == AF(psau)) 49 50 /* sockaddr_u v4 address in network byte order */ 51 #define NSRCADR(psau) (SOCK_ADDR4(psau).s_addr) 52 53 /* sockaddr_u v4 address in host byte order */ 54 #define SRCADR(psau) (ntohl(NSRCADR(psau))) 55 56 /* sockaddr_u v6 address in network byte order */ 57 #define NSRCADR6(psau) (SOCK_ADDR6(psau).s6_addr) 58 59 /* assign sockaddr_u v4 address from host byte order */ 60 #define SET_ADDR4(psau, addr4) (NSRCADR(psau) = htonl(addr4)) 61 62 /* assign sockaddr_u v4 address from network byte order */ 63 #define SET_ADDR4N(psau, addr4n) (NSRCADR(psau) = (addr4n)); 64 65 /* assign sockaddr_u v6 address from network byte order */ 66 #define SET_ADDR6N(psau, s6_addr) \ 67 (SOCK_ADDR6(psau) = (s6_addr)) 68 69 /* sockaddr_u v4/v6 port in network byte order */ 70 #define NSRCPORT(psau) ((psau)->sa4.sin_port) 71 72 /* sockaddr_u v4/v6 port in host byte order */ 73 #define SRCPORT(psau) (ntohs(NSRCPORT(psau))) 74 75 /* assign sockaddr_u v4/v6 port from host byte order */ 76 #define SET_PORT(psau, port) (NSRCPORT(psau) = htons(port)) 77 78 /* sockaddr_u v6 scope */ 79 #define SCOPE_VAR(psau) ((psau)->sa6.sin6_scope_id) 80 81 #ifdef ISC_PLATFORM_HAVESCOPEID 82 /* v4/v6 scope (always zero for v4) */ 83 # define SCOPE(psau) (IS_IPV4(psau) \ 84 ? 0 \ 85 : SCOPE_VAR(psau)) 86 87 /* are two v6 sockaddr_u scopes equal? */ 88 # define SCOPE_EQ(psau1, psau2) \ 89 (SCOPE_VAR(psau1) == SCOPE_VAR(psau2)) 90 91 /* assign scope if supported */ 92 # define SET_SCOPE(psau, s) \ 93 do \ 94 if (IS_IPV6(psau)) \ 95 SCOPE_VAR(psau) = (s); \ 96 while (0) 97 #else /* ISC_PLATFORM_HAVESCOPEID not defined */ 98 # define SCOPE(psau) (0) 99 # define SCOPE_EQ(psau1, psau2) (1) 100 # define SET_SCOPE(psau, s) do { } while (0) 101 #endif /* ISC_PLATFORM_HAVESCOPEID */ 102 103 /* v4/v6 is multicast address */ 104 #define IS_MCAST(psau) \ 105 (IS_IPV4(psau) \ 106 ? IN_CLASSD(SRCADR(psau)) \ 107 : IN6_IS_ADDR_MULTICAST(PSOCK_ADDR6(psau))) 108 109 /* v6 is interface ID scope universal, as with MAC-derived addresses */ 110 #define IS_IID_UNIV(psau) \ 111 (!!(0x02 & NSRCADR6(psau)[8])) 112 113 #define SIZEOF_INADDR(fam) \ 114 ((AF_INET == (fam)) \ 115 ? sizeof(struct in_addr) \ 116 : sizeof(struct in6_addr)) 117 118 #define SIZEOF_SOCKADDR(fam) \ 119 ((AF_INET == (fam)) \ 120 ? sizeof(struct sockaddr_in) \ 121 : sizeof(struct sockaddr_in6)) 122 123 #define SOCKLEN(psau) \ 124 (IS_IPV4(psau) \ 125 ? sizeof((psau)->sa4) \ 126 : sizeof((psau)->sa6)) 127 128 #define ZERO_SOCK(psau) \ 129 ZERO(*(psau)) 130 131 /* blast a byte value across sockaddr_u v6 address */ 132 #define MEMSET_ADDR6(psau, v) \ 133 memset((psau)->sa6.sin6_addr.s6_addr, (v), \ 134 sizeof((psau)->sa6.sin6_addr.s6_addr)) 135 136 #define SET_ONESMASK(psau) \ 137 do { \ 138 if (IS_IPV6(psau)) \ 139 MEMSET_ADDR6((psau), 0xff); \ 140 else \ 141 NSRCADR(psau) = 0xffffffff; \ 142 } while(0) 143 144 /* zero sockaddr_u, fill in family and all-ones (host) mask */ 145 #define SET_HOSTMASK(psau, family) \ 146 do { \ 147 ZERO_SOCK(psau); \ 148 AF(psau) = (family); \ 149 SET_ONESMASK(psau); \ 150 } while (0) 151 152 /* 153 * compare two in6_addr returning negative, 0, or positive. 154 * ADDR6_CMP is negative if *pin6A is lower than *pin6B, zero if they 155 * are equal, positive if *pin6A is higher than *pin6B. IN6ADDR_ANY 156 * is the lowest address (128 zero bits). 157 */ 158 #define ADDR6_CMP(pin6A, pin6B) \ 159 memcmp((pin6A)->s6_addr, (pin6B)->s6_addr, \ 160 sizeof(pin6A)->s6_addr) 161 162 /* compare two in6_addr for equality only */ 163 #if !defined(SYS_WINNT) || !defined(in_addr6) 164 #define ADDR6_EQ(pin6A, pin6B) \ 165 (!ADDR6_CMP(pin6A, pin6B)) 166 #else 167 #define ADDR6_EQ(pin6A, pin6B) \ 168 IN6_ADDR_EQUAL(pin6A, pin6B) 169 #endif 170 171 /* compare a in6_addr with socket address */ 172 #define S_ADDR6_EQ(psau, pin6) \ 173 ADDR6_EQ(&(psau)->sa6.sin6_addr, pin6) 174 175 /* are two sockaddr_u's addresses equal? (port excluded) */ 176 #define SOCK_EQ(psau1, psau2) \ 177 ((AF(psau1) != AF(psau2)) \ 178 ? 0 \ 179 : IS_IPV4(psau1) \ 180 ? (NSRCADR(psau1) == NSRCADR(psau2)) \ 181 : (S_ADDR6_EQ((psau1), PSOCK_ADDR6(psau2)) \ 182 && SCOPE_EQ((psau1), (psau2)))) 183 184 /* are two sockaddr_u's addresses and ports equal? */ 185 #define ADDR_PORT_EQ(psau1, psau2) \ 186 ((NSRCPORT(psau1) != NSRCPORT(psau2) \ 187 ? 0 \ 188 : SOCK_EQ((psau1), (psau2)))) 189 190 /* is sockaddr_u address unspecified? */ 191 #define SOCK_UNSPEC(psau) \ 192 (IS_IPV4(psau) \ 193 ? !NSRCADR(psau) \ 194 : IN6_IS_ADDR_UNSPECIFIED(PSOCK_ADDR6(psau))) 195 196 /* just how unspecified do you mean? (scope 0/unspec too) */ 197 #define SOCK_UNSPEC_S(psau) \ 198 (SOCK_UNSPEC(psau) && !SCOPE(psau)) 199 200 /* choose a default net interface (endpt) for v4 or v6 */ 201 #define ANY_INTERFACE_BYFAM(family) \ 202 ((AF_INET == family) \ 203 ? any_interface \ 204 : any6_interface) 205 206 /* choose a default interface for addresses' protocol (addr family) */ 207 #define ANY_INTERFACE_CHOOSE(psau) \ 208 ANY_INTERFACE_BYFAM(AF(psau)) 209 210 211 /* 212 * We tell reference clocks from real peers by giving the reference 213 * clocks an address of the form 127.127.t.u, where t is the type and 214 * u is the unit number. We define some of this here since we will need 215 * some sanity checks to make sure this address isn't interpretted as 216 * that of a normal peer. 217 */ 218 #define REFCLOCK_ADDR 0x7f7f0000 /* 127.127.0.0 */ 219 #define REFCLOCK_MASK 0xffff0000 /* 255.255.0.0 */ 220 221 #define ISREFCLOCKADR(srcadr) \ 222 (IS_IPV4(srcadr) && \ 223 (SRCADR(srcadr) & REFCLOCK_MASK) == REFCLOCK_ADDR) 224 225 /* 226 * Macro for checking for invalid addresses. This is really, really 227 * gross, but is needed so no one configures a host on net 127 now that 228 * we're encouraging it the the configuration file. 229 */ 230 #define LOOPBACKADR 0x7f000001 231 #define LOOPNETMASK 0xff000000 232 #ifdef WORDS_BIGENDIAN 233 # define LOOPBACKADR_N LOOPBACKADR 234 #else 235 # define LOOPBACKADR_N 0x0100007f 236 #endif 237 238 239 #define ISBADADR(srcadr) \ 240 (IS_IPV4(srcadr) \ 241 && ((SRCADR(srcadr) & LOOPNETMASK) \ 242 == (LOOPBACKADR & LOOPNETMASK)) \ 243 && SRCADR(srcadr) != LOOPBACKADR) 244 245 #define IS_LOOPBACK_ADDR(psau) \ 246 (IS_IPV4(psau) \ 247 ? LOOPBACKADR == SRCADR(psau) \ 248 : IN6_IS_ADDR_LOOPBACK(PSOCK_ADDR6(psau)) \ 249 ) 250 251 #endif /* NTP_NET_H */ 252