- Use precompiler conditionals in to_wire_mode() and from_write_mode()
[rsync/rsync.git] / clientname.c
1 /*
2  * Functions for looking up the remote name or addr of a socket.
3  *
4  * Copyright (C) 1992-2001 Andrew Tridgell <tridge@samba.org>
5  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
6  * Copyright (C) 2002, 2003, 2004 Wayne Davison
7  *
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 2 of the License, or
11  * (at your option) any later version.
12  *
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.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
21  */
22
23 /*
24  * This file is now converted to use the new-style getaddrinfo()
25  * interface, which supports IPv6 but is also supported on recent
26  * IPv4-only machines.  On systems that don't have that interface, we
27  * emulate it using the KAME implementation.
28  */
29
30 #include "rsync.h"
31
32 static const char default_name[] = "UNKNOWN";
33 extern int am_server;
34
35
36 /**
37  * Return the IP addr of the client as a string
38  **/
39 char *client_addr(int fd)
40 {
41         static char addr_buf[100];
42         static int initialised;
43         struct sockaddr_storage ss;
44         socklen_t length = sizeof ss;
45         char *ssh_info, *p;
46
47         if (initialised)
48                 return addr_buf;
49
50         initialised = 1;
51
52         if (am_server) {        /* daemon over --rsh mode */
53                 strcpy(addr_buf, "0.0.0.0");
54                 if ((ssh_info = getenv("SSH_CONNECTION")) != NULL
55                     || (ssh_info = getenv("SSH_CLIENT")) != NULL
56                     || (ssh_info = getenv("SSH2_CLIENT")) != NULL) {
57                         strlcpy(addr_buf, ssh_info, sizeof addr_buf);
58                         /* Truncate the value to just the IP address. */
59                         if ((p = strchr(addr_buf, ' ')) != NULL)
60                                 *p = '\0';
61                 }
62         } else {
63                 client_sockaddr(fd, &ss, &length);
64                 getnameinfo((struct sockaddr *)&ss, length,
65                             addr_buf, sizeof addr_buf, NULL, 0, NI_NUMERICHOST);
66         }
67
68         return addr_buf;
69 }
70
71
72 static int get_sockaddr_family(const struct sockaddr_storage *ss)
73 {
74         return ((struct sockaddr *) ss)->sa_family;
75 }
76
77
78 /**
79  * Return the DNS name of the client.
80  *
81  * The name is statically cached so that repeated lookups are quick,
82  * so there is a limit of one lookup per customer.
83  *
84  * If anything goes wrong, including the name->addr->name check, then
85  * we just use "UNKNOWN", so you can use that value in hosts allow
86  * lines.
87  *
88  * After translation from sockaddr to name we do a forward lookup to
89  * make sure nobody is spoofing PTR records.
90  **/
91 char *client_name(int fd)
92 {
93         static char name_buf[100];
94         static char port_buf[100];
95         static int initialised;
96         struct sockaddr_storage ss;
97         socklen_t ss_len;
98
99         if (initialised)
100                 return name_buf;
101
102         strcpy(name_buf, default_name);
103         initialised = 1;
104
105         memset(&ss, 0, sizeof ss);
106
107         if (am_server) {        /* daemon over --rsh mode */
108                 char *addr = client_addr(fd);
109                 struct addrinfo hint, *answer;
110                 int err;
111
112                 memset(&hint, 0, sizeof hint);
113
114 #ifdef AI_NUMERICHOST
115                 hint.ai_flags = AI_NUMERICHOST;
116 #endif
117                 hint.ai_socktype = SOCK_STREAM;
118
119                 if ((err = getaddrinfo(addr, NULL, &hint, &answer)) != 0) {
120                         rprintf(FLOG, "malformed address %s: %s\n",
121                                 addr, gai_strerror(err));
122                         return name_buf;
123                 }
124
125                 switch (answer->ai_family) {
126                 case AF_INET:
127                         ss_len = sizeof (struct sockaddr_in);
128                         memcpy(&ss, answer->ai_addr, ss_len);
129                         break;
130 #ifdef INET6
131                 case AF_INET6:
132                         ss_len = sizeof (struct sockaddr_in6);
133                         memcpy(&ss, answer->ai_addr, ss_len);
134                         break;
135 #endif
136                 }
137                 freeaddrinfo(answer);
138         } else {
139                 ss_len = sizeof ss;
140                 client_sockaddr(fd, &ss, &ss_len);
141         }
142
143         if (lookup_name(fd, &ss, ss_len, name_buf, sizeof name_buf,
144                         port_buf, sizeof port_buf) == 0)
145                 check_name(fd, &ss, name_buf);
146
147         return name_buf;
148 }
149
150
151
152 /**
153  * Get the sockaddr for the client.
154  *
155  * If it comes in as an ipv4 address mapped into IPv6 format then we
156  * convert it back to a regular IPv4.
157  **/
158 void client_sockaddr(int fd,
159                      struct sockaddr_storage *ss,
160                      socklen_t *ss_len)
161 {
162         memset(ss, 0, sizeof *ss);
163
164         if (getpeername(fd, (struct sockaddr *) ss, ss_len)) {
165                 /* FIXME: Can we really not continue? */
166                 rsyserr(FLOG, errno, "getpeername on fd%d failed", fd);
167                 exit_cleanup(RERR_SOCKETIO);
168         }
169
170 #ifdef INET6
171         if (get_sockaddr_family(ss) == AF_INET6 &&
172             IN6_IS_ADDR_V4MAPPED(&((struct sockaddr_in6 *)ss)->sin6_addr)) {
173                 /* OK, so ss is in the IPv6 family, but it is really
174                  * an IPv4 address: something like
175                  * "::ffff:10.130.1.2".  If we use it as-is, then the
176                  * reverse lookup might fail or perhaps something else
177                  * bad might happen.  So instead we convert it to an
178                  * equivalent address in the IPv4 address family.  */
179                 struct sockaddr_in6 sin6;
180                 struct sockaddr_in *sin;
181
182                 memcpy(&sin6, ss, sizeof sin6);
183                 sin = (struct sockaddr_in *)ss;
184                 memset(sin, 0, sizeof *sin);
185                 sin->sin_family = AF_INET;
186                 *ss_len = sizeof (struct sockaddr_in);
187 #ifdef HAVE_SOCKADDR_IN_LEN
188                 sin->sin_len = *ss_len;
189 #endif
190                 sin->sin_port = sin6.sin6_port;
191
192                 /* There is a macro to extract the mapped part
193                  * (IN6_V4MAPPED_TO_SINADDR ?), but it does not seem
194                  * to be present in the Linux headers. */
195                 memcpy(&sin->sin_addr, &sin6.sin6_addr.s6_addr[12],
196                     sizeof sin->sin_addr);
197         }
198 #endif
199 }
200
201
202 /**
203  * Look up a name from @p ss into @p name_buf.
204  *
205  * @param fd file descriptor for client socket.
206  **/
207 int lookup_name(int fd, const struct sockaddr_storage *ss,
208                 socklen_t ss_len,
209                 char *name_buf, size_t name_buf_len,
210                 char *port_buf, size_t port_buf_len)
211 {
212         int name_err;
213
214         /* reverse lookup */
215         name_err = getnameinfo((struct sockaddr *) ss, ss_len,
216                                name_buf, name_buf_len,
217                                port_buf, port_buf_len,
218                                NI_NAMEREQD | NI_NUMERICSERV);
219         if (name_err != 0) {
220                 strcpy(name_buf, default_name);
221                 rprintf(FLOG, "name lookup failed for %s: %s\n",
222                         client_addr(fd), gai_strerror(name_err));
223                 return name_err;
224         }
225
226         return 0;
227 }
228
229
230
231 /**
232  * Compare an addrinfo from the resolver to a sockinfo.
233  *
234  * Like strcmp, returns 0 for identical.
235  **/
236 int compare_addrinfo_sockaddr(const struct addrinfo *ai,
237                               const struct sockaddr_storage *ss)
238 {
239         int ss_family = get_sockaddr_family(ss);
240         const char fn[] = "compare_addrinfo_sockaddr";
241
242         if (ai->ai_family != ss_family) {
243                 rprintf(FLOG, "%s: response family %d != %d\n",
244                         fn, ai->ai_family, ss_family);
245                 return 1;
246         }
247
248         /* The comparison method depends on the particular AF. */
249         if (ss_family == AF_INET) {
250                 const struct sockaddr_in *sin1, *sin2;
251
252                 sin1 = (const struct sockaddr_in *) ss;
253                 sin2 = (const struct sockaddr_in *) ai->ai_addr;
254
255                 return memcmp(&sin1->sin_addr, &sin2->sin_addr,
256                               sizeof sin1->sin_addr);
257         }
258
259 #ifdef INET6
260         if (ss_family == AF_INET6) {
261                 const struct sockaddr_in6 *sin1, *sin2;
262
263                 sin1 = (const struct sockaddr_in6 *) ss;
264                 sin2 = (const struct sockaddr_in6 *) ai->ai_addr;
265
266                 if (ai->ai_addrlen < sizeof (struct sockaddr_in6)) {
267                         rprintf(FLOG, "%s: too short sockaddr_in6; length=%d\n",
268                                 fn, ai->ai_addrlen);
269                         return 1;
270                 }
271
272                 if (memcmp(&sin1->sin6_addr, &sin2->sin6_addr,
273                            sizeof sin1->sin6_addr))
274                         return 1;
275
276 #ifdef HAVE_SOCKADDR_IN6_SCOPE_ID
277                 if (sin1->sin6_scope_id != sin2->sin6_scope_id)
278                         return 1;
279 #endif
280                 return 0;
281         }
282 #endif /* INET6 */
283
284         /* don't know */
285         return 1;
286 }
287
288
289 /**
290  * Do a forward lookup on @p name_buf and make sure it corresponds to
291  * @p ss -- otherwise we may be being spoofed.  If we suspect we are,
292  * then we don't abort the connection but just emit a warning, and
293  * change @p name_buf to be "UNKNOWN".
294  *
295  * We don't do anything with the service when checking the name,
296  * because it doesn't seem that it could be spoofed in any way, and
297  * getaddrinfo on random service names seems to cause problems on AIX.
298  **/
299 int check_name(int fd,
300                const struct sockaddr_storage *ss,
301                char *name_buf)
302 {
303         struct addrinfo hints, *res, *res0;
304         int error;
305         int ss_family = get_sockaddr_family(ss);
306
307         memset(&hints, 0, sizeof hints);
308         hints.ai_family = ss_family;
309         hints.ai_flags = AI_CANONNAME;
310         hints.ai_socktype = SOCK_STREAM;
311         error = getaddrinfo(name_buf, NULL, &hints, &res0);
312         if (error) {
313                 rprintf(FLOG, "forward name lookup for %s failed: %s\n",
314                         name_buf, gai_strerror(error));
315                 strcpy(name_buf, default_name);
316                 return error;
317         }
318
319         /* Given all these results, we expect that one of them will be
320          * the same as ss.  The comparison is a bit complicated. */
321         for (res = res0; res; res = res->ai_next) {
322                 if (!compare_addrinfo_sockaddr(res, ss))
323                         break;  /* OK, identical */
324         }
325
326         if (!res0) {
327                 /* We hit the end of the list without finding an
328                  * address that was the same as ss. */
329                 rprintf(FLOG, "no known address for \"%s\": "
330                         "spoofed address?\n", name_buf);
331                 strcpy(name_buf, default_name);
332         } else if (res == NULL) {
333                 /* We hit the end of the list without finding an
334                  * address that was the same as ss. */
335                 rprintf(FLOG, "%s is not a known address for \"%s\": "
336                         "spoofed address?\n", client_addr(fd), name_buf);
337                 strcpy(name_buf, default_name);
338         }
339
340         freeaddrinfo(res0);
341         return 0;
342 }