2 * Functions for looking up the remote name or addr of a socket.
4 * Copyright (C) 1992-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2002-2020 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
23 * This file is now converted to use the new-style getaddrinfo()
24 * interface, which supports IPv6 but is also supported on recent
25 * IPv4-only machines. On systems that don't have that interface, we
26 * emulate it using the KAME implementation.
34 static const char default_name
[] = "UNKNOWN";
35 static const char proxyv2sig
[] = "\r\n\r\n\0\r\nQUIT\n";
37 static char ipaddr_buf
[100];
39 #define PROXY_V2_SIG_SIZE ((int)sizeof proxyv2sig - 1)
40 #define PROXY_V2_HEADER_SIZE (PROXY_V2_SIG_SIZE + 1 + 1 + 2)
45 #define PROXY_FAM_TCPv4 0x11
46 #define PROXY_FAM_TCPv6 0x21
48 #define GET_SOCKADDR_FAMILY(ss) ((struct sockaddr*)ss)->sa_family
50 static void client_sockaddr(int fd
, struct sockaddr_storage
*ss
, socklen_t
*ss_len
);
51 static int check_name(const char *ipaddr
, const struct sockaddr_storage
*ss
, char *name_buf
, size_t name_buf_size
);
52 static int valid_ipaddr(const char *s
);
54 /* Return the IP addr of the client as a string. */
55 char *client_addr(int fd
)
57 struct sockaddr_storage ss
;
58 socklen_t length
= sizeof ss
;
63 if (am_daemon
< 0) { /* daemon over --rsh mode */
65 strlcpy(ipaddr_buf
, "0.0.0.0", sizeof ipaddr_buf
);
66 if ((env_str
= getenv("REMOTE_HOST")) != NULL
67 || (env_str
= getenv("SSH_CONNECTION")) != NULL
68 || (env_str
= getenv("SSH_CLIENT")) != NULL
69 || (env_str
= getenv("SSH2_CLIENT")) != NULL
) {
71 strlcpy(ipaddr_buf
, env_str
, sizeof ipaddr_buf
);
72 /* Truncate the value to just the IP address. */
73 if ((p
= strchr(ipaddr_buf
, ' ')) != NULL
)
76 if (valid_ipaddr(ipaddr_buf
))
80 client_sockaddr(fd
, &ss
, &length
);
81 getnameinfo((struct sockaddr
*)&ss
, length
, ipaddr_buf
, sizeof ipaddr_buf
, NULL
, 0, NI_NUMERICHOST
);
88 * Return the DNS name of the client.
90 * The name is statically cached so that repeated lookups are quick,
91 * so there is a limit of one lookup per customer.
93 * If anything goes wrong, including the name->addr->name check, then
94 * we just use "UNKNOWN", so you can use that value in hosts allow
97 * After translation from sockaddr to name we do a forward lookup to
98 * make sure nobody is spoofing PTR records.
100 char *client_name(const char *ipaddr
)
102 static char name_buf
[100];
104 struct sockaddr_storage ss
;
106 struct addrinfo hint
, *answer
;
112 strlcpy(name_buf
, default_name
, sizeof name_buf
);
114 if (strcmp(ipaddr
, "0.0.0.0") == 0)
117 memset(&ss
, 0, sizeof ss
);
118 memset(&hint
, 0, sizeof hint
);
120 #ifdef AI_NUMERICHOST
121 hint
.ai_flags
= AI_NUMERICHOST
;
123 hint
.ai_socktype
= SOCK_STREAM
;
125 if ((err
= getaddrinfo(ipaddr
, NULL
, &hint
, &answer
)) != 0) {
126 rprintf(FLOG
, "malformed address %s: %s\n", ipaddr
, gai_strerror(err
));
130 switch (answer
->ai_family
) {
132 ss_len
= sizeof (struct sockaddr_in
);
133 memcpy(&ss
, answer
->ai_addr
, ss_len
);
137 ss_len
= sizeof (struct sockaddr_in6
);
138 memcpy(&ss
, answer
->ai_addr
, ss_len
);
144 freeaddrinfo(answer
);
147 err
= getnameinfo((struct sockaddr
*)&ss
, ss_len
, name_buf
, sizeof name_buf
,
148 port_buf
, sizeof port_buf
, NI_NAMEREQD
| NI_NUMERICSERV
);
150 strlcpy(name_buf
, default_name
, sizeof name_buf
);
151 rprintf(FLOG
, "name lookup failed for %s: %s\n", ipaddr
, gai_strerror(err
));
153 check_name(ipaddr
, &ss
, name_buf
, sizeof name_buf
);
159 /* Try to read an haproxy header (V1 or V2). Returns 1 on success or 0 on failure. */
160 int read_haproxy_header(int fd
)
167 char sig
[PROXY_V2_SIG_SIZE
];
192 read_buf(fd
, (char*)&hdr
, PROXY_V2_SIG_SIZE
);
194 if (memcmp(hdr
.v2
.sig
, proxyv2sig
, PROXY_V2_SIG_SIZE
) == 0) { /* Proxy V2 */
197 read_buf(fd
, (char*)&hdr
+ PROXY_V2_SIG_SIZE
, PROXY_V2_HEADER_SIZE
- PROXY_V2_SIG_SIZE
);
199 ver
= (hdr
.v2
.ver_cmd
& 0xf0) >> 4;
200 cmd
= (hdr
.v2
.ver_cmd
& 0x0f);
201 size
= (hdr
.v2
.len
[0] << 8) + hdr
.v2
.len
[1];
203 if (ver
!= 2 || size
+ PROXY_V2_HEADER_SIZE
> (int)sizeof hdr
)
206 /* Grab all the remaining data in the binary request. */
207 read_buf(fd
, (char*)&hdr
+ PROXY_V2_HEADER_SIZE
, size
);
211 switch (hdr
.v2
.fam
) {
212 case PROXY_FAM_TCPv4
:
213 if (size
!= sizeof hdr
.v2
.addr
.ip4
)
215 inet_ntop(AF_INET
, hdr
.v2
.addr
.ip4
.src_addr
, ipaddr_buf
, sizeof ipaddr_buf
);
216 return valid_ipaddr(ipaddr_buf
);
217 case PROXY_FAM_TCPv6
:
218 if (size
!= sizeof hdr
.v2
.addr
.ip6
)
220 inet_ntop(AF_INET6
, hdr
.v2
.addr
.ip6
.src_addr
, ipaddr_buf
, sizeof ipaddr_buf
);
221 return valid_ipaddr(ipaddr_buf
);
225 /* For an unsupported protocol we'll ignore the proxy data (leaving ipaddr_buf unset)
226 * and accept the connection, which will get handled as a normal socket addr. */
237 if (memcmp(hdr
.v1
.line
, "PROXY", 5) == 0) { /* Proxy V1 */
238 char *endc
, *sp
, *p
= hdr
.v1
.line
+ PROXY_V2_SIG_SIZE
;
242 if (!strchr(hdr
.v1
.line
, '\n')) {
247 if (p
- hdr
.v1
.line
>= (int)sizeof hdr
.v1
.line
- 1)
253 endc
= strchr(hdr
.v1
.line
, '\r');
254 if (!endc
|| endc
[1] != '\n' || endc
[2])
262 if (strncmp(p
, "TCP4", 4) == 0)
264 else if (strncmp(p
, "TCP6", 4) == 0)
266 else if (strncmp(p
, "UNKNOWN", 7) == 0)
274 if ((sp
= strchr(p
, ' ')) == NULL
)
277 if (!valid_ipaddr(p
))
279 strlcpy(ipaddr_buf
, p
, sizeof ipaddr_buf
); /* It will always fit when valid. */
282 if ((sp
= strchr(p
, ' ')) == NULL
)
285 if (!valid_ipaddr(p
))
287 /* Ignore destination address. */
290 if ((sp
= strchr(p
, ' ')) == NULL
)
293 port_chk
= strtol(p
, &endc
, 10);
294 if (*endc
|| port_chk
== 0)
296 /* Ignore source port. */
299 port_chk
= strtol(p
, &endc
, 10);
300 if (*endc
|| port_chk
== 0)
302 /* Ignore destination port. */
312 * Get the sockaddr for the client.
314 * If it comes in as an ipv4 address mapped into IPv6 format then we
315 * convert it back to a regular IPv4.
317 static void client_sockaddr(int fd
, struct sockaddr_storage
*ss
, socklen_t
*ss_len
)
319 memset(ss
, 0, sizeof *ss
);
321 if (getpeername(fd
, (struct sockaddr
*) ss
, ss_len
)) {
322 /* FIXME: Can we really not continue? */
323 rsyserr(FLOG
, errno
, "getpeername on fd%d failed", fd
);
324 exit_cleanup(RERR_SOCKETIO
);
328 if (GET_SOCKADDR_FAMILY(ss
) == AF_INET6
&&
329 IN6_IS_ADDR_V4MAPPED(&((struct sockaddr_in6
*)ss
)->sin6_addr
)) {
330 /* OK, so ss is in the IPv6 family, but it is really
331 * an IPv4 address: something like
332 * "::ffff:10.130.1.2". If we use it as-is, then the
333 * reverse lookup might fail or perhaps something else
334 * bad might happen. So instead we convert it to an
335 * equivalent address in the IPv4 address family. */
336 struct sockaddr_in6 sin6
;
337 struct sockaddr_in
*sin
;
339 memcpy(&sin6
, ss
, sizeof sin6
);
340 sin
= (struct sockaddr_in
*)ss
;
341 memset(sin
, 0, sizeof *sin
);
342 sin
->sin_family
= AF_INET
;
343 *ss_len
= sizeof (struct sockaddr_in
);
344 #ifdef HAVE_SOCKADDR_IN_LEN
345 sin
->sin_len
= *ss_len
;
347 sin
->sin_port
= sin6
.sin6_port
;
349 /* There is a macro to extract the mapped part
350 * (IN6_V4MAPPED_TO_SINADDR ?), but it does not seem
351 * to be present in the Linux headers. */
352 memcpy(&sin
->sin_addr
, &sin6
.sin6_addr
.s6_addr
[12],
353 sizeof sin
->sin_addr
);
360 * Compare an addrinfo from the resolver to a sockinfo.
362 * Like strcmp, returns 0 for identical.
364 static int compare_addrinfo_sockaddr(const struct addrinfo
*ai
, const struct sockaddr_storage
*ss
)
366 int ss_family
= GET_SOCKADDR_FAMILY(ss
);
367 const char fn
[] = "compare_addrinfo_sockaddr";
369 if (ai
->ai_family
!= ss_family
) {
370 rprintf(FLOG
, "%s: response family %d != %d\n",
371 fn
, ai
->ai_family
, ss_family
);
375 /* The comparison method depends on the particular AF. */
376 if (ss_family
== AF_INET
) {
377 const struct sockaddr_in
*sin1
, *sin2
;
379 sin1
= (const struct sockaddr_in
*) ss
;
380 sin2
= (const struct sockaddr_in
*) ai
->ai_addr
;
382 return memcmp(&sin1
->sin_addr
, &sin2
->sin_addr
,
383 sizeof sin1
->sin_addr
);
387 if (ss_family
== AF_INET6
) {
388 const struct sockaddr_in6
*sin1
, *sin2
;
390 sin1
= (const struct sockaddr_in6
*) ss
;
391 sin2
= (const struct sockaddr_in6
*) ai
->ai_addr
;
393 if (ai
->ai_addrlen
< sizeof (struct sockaddr_in6
)) {
394 rprintf(FLOG
, "%s: too short sockaddr_in6; length=%d\n",
395 fn
, (int)ai
->ai_addrlen
);
399 if (memcmp(&sin1
->sin6_addr
, &sin2
->sin6_addr
,
400 sizeof sin1
->sin6_addr
))
403 #ifdef HAVE_SOCKADDR_IN6_SCOPE_ID
404 if (sin1
->sin6_scope_id
!= sin2
->sin6_scope_id
)
417 * Do a forward lookup on @p name_buf and make sure it corresponds to
418 * @p ss -- otherwise we may be being spoofed. If we suspect we are,
419 * then we don't abort the connection but just emit a warning, and
420 * change @p name_buf to be "UNKNOWN".
422 * We don't do anything with the service when checking the name,
423 * because it doesn't seem that it could be spoofed in any way, and
424 * getaddrinfo on random service names seems to cause problems on AIX.
426 static int check_name(const char *ipaddr
, const struct sockaddr_storage
*ss
, char *name_buf
, size_t name_buf_size
)
428 struct addrinfo hints
, *res
, *res0
;
430 int ss_family
= GET_SOCKADDR_FAMILY(ss
);
432 memset(&hints
, 0, sizeof hints
);
433 hints
.ai_family
= ss_family
;
434 hints
.ai_flags
= AI_CANONNAME
;
435 hints
.ai_socktype
= SOCK_STREAM
;
436 error
= getaddrinfo(name_buf
, NULL
, &hints
, &res0
);
438 rprintf(FLOG
, "forward name lookup for %s failed: %s\n",
439 name_buf
, gai_strerror(error
));
440 strlcpy(name_buf
, default_name
, name_buf_size
);
444 /* Given all these results, we expect that one of them will be
445 * the same as ss. The comparison is a bit complicated. */
446 for (res
= res0
; res
; res
= res
->ai_next
) {
447 if (!compare_addrinfo_sockaddr(res
, ss
))
448 break; /* OK, identical */
452 /* We hit the end of the list without finding an
453 * address that was the same as ss. */
454 rprintf(FLOG
, "no known address for \"%s\": "
455 "spoofed address?\n", name_buf
);
456 strlcpy(name_buf
, default_name
, name_buf_size
);
457 } else if (res
== NULL
) {
458 /* We hit the end of the list without finding an
459 * address that was the same as ss. */
460 rprintf(FLOG
, "%s is not a known address for \"%s\": "
461 "spoofed address?\n", ipaddr
, name_buf
);
462 strlcpy(name_buf
, default_name
, name_buf_size
);
469 /* Returns 1 for a valid IPv4 or IPv6 addr, or 0 for a bad one. */
470 static int valid_ipaddr(const char *s
)
474 if (strchr(s
, ':') != NULL
) { /* Only IPv6 has a colon. */
475 int count
, saw_double_colon
= 0;
478 if (*s
== ':') { /* A colon at the start must be a :: */
481 saw_double_colon
= 1;
485 for (count
= 0; count
< 8; count
++) {
487 return saw_double_colon
&& count
< 7;
489 if (strchr(s
, ':') == NULL
&& strchr(s
, '.') != NULL
) {
490 if ((!saw_double_colon
&& count
!= 6) || (saw_double_colon
&& count
> 6))
496 if (!isHexDigit(s
++)) /* Need 1-4 hex digits */
498 if (isHexDigit(s
) && isHexDigit(++s
) && isHexDigit(++s
) && isHexDigit(++s
))
505 if (saw_double_colon
)
507 saw_double_colon
= 1;
518 for (i
= 0; i
< 4; i
++) {
522 if (i
&& *s
++ != '.')
524 n
= strtol(s
, &end
, 10);
525 if (n
> 255 || n
< 0 || end
<= s
|| end
> s
+3)