Added a remote-shell substitute for use in testing and for certain
[rsync/rsync.git] / authenticate.c
1 /*
2  * Support rsync daemon authentication.
3  *
4  * Copyright (C) 1998-2000 Andrew Tridgell
5  * Copyright (C) 2002-2007 Wayne Davison
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, visit the http://fsf.org website.
19  */
20
21 #include "rsync.h"
22
23 extern char *password_file;
24
25 /***************************************************************************
26 encode a buffer using base64 - simple and slow algorithm. null terminates
27 the result.
28   ***************************************************************************/
29 void base64_encode(const char *buf, int len, char *out, int pad)
30 {
31         char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
32         int bit_offset, byte_offset, idx, i;
33         const uchar *d = (const uchar *)buf;
34         int bytes = (len*8 + 5)/6;
35
36         for (i = 0; i < bytes; i++) {
37                 byte_offset = (i*6)/8;
38                 bit_offset = (i*6)%8;
39                 if (bit_offset < 3) {
40                         idx = (d[byte_offset] >> (2-bit_offset)) & 0x3F;
41                 } else {
42                         idx = (d[byte_offset] << (bit_offset-2)) & 0x3F;
43                         if (byte_offset+1 < len) {
44                                 idx |= (d[byte_offset+1] >> (8-(bit_offset-2)));
45                         }
46                 }
47                 out[i] = b64[idx];
48         }
49
50         while (pad && (i % 4))
51                 out[i++] = '=';
52
53         out[i] = '\0';
54 }
55
56 /* Generate a challenge buffer and return it base64-encoded. */
57 static void gen_challenge(const char *addr, char *challenge)
58 {
59         char input[32];
60         char digest[MAX_DIGEST_LEN];
61         struct timeval tv;
62         int len;
63
64         memset(input, 0, sizeof input);
65
66         strlcpy(input, addr, 17);
67         sys_gettimeofday(&tv);
68         SIVAL(input, 16, tv.tv_sec);
69         SIVAL(input, 20, tv.tv_usec);
70         SIVAL(input, 24, getpid());
71
72         sum_init(0);
73         sum_update(input, sizeof input);
74         len = sum_end(digest);
75
76         base64_encode(digest, len, challenge, 0);
77 }
78
79
80 /* Return the secret for a user from the secret file, null terminated.
81  * Maximum length is len (not counting the null). */
82 static int get_secret(int module, const char *user, char *secret, int len)
83 {
84         const char *fname = lp_secrets_file(module);
85         STRUCT_STAT st;
86         int fd, ok = 1;
87         const char *p;
88         char ch, *s;
89
90         if (!fname || !*fname)
91                 return 0;
92
93         if ((fd = open(fname, O_RDONLY)) < 0)
94                 return 0;
95
96         if (do_stat(fname, &st) == -1) {
97                 rsyserr(FLOG, errno, "stat(%s)", fname);
98                 ok = 0;
99         } else if (lp_strict_modes(module)) {
100                 if ((st.st_mode & 06) != 0) {
101                         rprintf(FLOG, "secrets file must not be other-accessible (see strict modes option)\n");
102                         ok = 0;
103                 } else if (MY_UID() == 0 && st.st_uid != 0) {
104                         rprintf(FLOG, "secrets file must be owned by root when running as root (see strict modes)\n");
105                         ok = 0;
106                 }
107         }
108         if (!ok) {
109                 rprintf(FLOG, "continuing without secrets file\n");
110                 close(fd);
111                 return 0;
112         }
113
114         if (*user == '#') {
115                 /* Reject attempt to match a comment. */
116                 close(fd);
117                 return 0;
118         }
119
120         /* Try to find a line that starts with the user name and a ':'. */
121         p = user;
122         while (1) {
123                 if (read(fd, &ch, 1) != 1) {
124                         close(fd);
125                         return 0;
126                 }
127                 if (ch == '\n')
128                         p = user;
129                 else if (p) {
130                         if (*p == ch)
131                                 p++;
132                         else if (!*p && ch == ':')
133                                 break;
134                         else
135                                 p = NULL;
136                 }
137         }
138
139         /* Slurp the secret into the "secret" buffer. */
140         s = secret;
141         while (len > 0) {
142                 if (read(fd, s, 1) != 1 || *s == '\n')
143                         break;
144                 if (*s == '\r')
145                         continue;
146                 s++;
147                 len--;
148         }
149         *s = '\0';
150         close(fd);
151
152         return 1;
153 }
154
155 static const char *getpassf(const char *filename)
156 {
157         STRUCT_STAT st;
158         char buffer[512], *p;
159         int fd, n, ok = 1;
160         const char *envpw = getenv("RSYNC_PASSWORD");
161
162         if (!filename)
163                 return NULL;
164
165         if ((fd = open(filename,O_RDONLY)) < 0) {
166                 rsyserr(FERROR, errno, "could not open password file \"%s\"",
167                         filename);
168                 if (envpw)
169                         rprintf(FERROR, "falling back to RSYNC_PASSWORD environment variable.\n");
170                 return NULL;
171         }
172
173         if (do_stat(filename, &st) == -1) {
174                 rsyserr(FERROR, errno, "stat(%s)", filename);
175                 ok = 0;
176         } else if ((st.st_mode & 06) != 0) {
177                 rprintf(FERROR,"password file must not be other-accessible\n");
178                 ok = 0;
179         } else if (MY_UID() == 0 && st.st_uid != 0) {
180                 rprintf(FERROR,"password file must be owned by root when running as root\n");
181                 ok = 0;
182         }
183         if (!ok) {
184                 rprintf(FERROR,"continuing without password file\n");
185                 if (envpw)
186                         rprintf(FERROR, "using RSYNC_PASSWORD environment variable.\n");
187                 close(fd);
188                 return NULL;
189         }
190
191         if (envpw)
192                 rprintf(FERROR, "RSYNC_PASSWORD environment variable ignored\n");
193
194         n = read(fd, buffer, sizeof buffer - 1);
195         close(fd);
196         if (n > 0) {
197                 buffer[n] = '\0';
198                 if ((p = strtok(buffer, "\n\r")) != NULL)
199                         return strdup(p);
200         }
201
202         return NULL;
203 }
204
205 /* Generate an MD4 hash created from the combination of the password
206  * and the challenge string and return it base64-encoded. */
207 static void generate_hash(const char *in, const char *challenge, char *out)
208 {
209         char buf[MAX_DIGEST_LEN];
210         int len;
211
212         sum_init(0);
213         sum_update(in, strlen(in));
214         sum_update(challenge, strlen(challenge));
215         len = sum_end(buf);
216
217         base64_encode(buf, len, out, 0);
218 }
219
220 /* Possibly negotiate authentication with the client.  Use "leader" to
221  * start off the auth if necessary.
222  *
223  * Return NULL if authentication failed.  Return "" if anonymous access.
224  * Otherwise return username.
225  */
226 char *auth_server(int f_in, int f_out, int module, const char *host,
227                   const char *addr, const char *leader)
228 {
229         char *users = lp_auth_users(module);
230         char challenge[MAX_DIGEST_LEN*2];
231         char line[BIGPATHBUFLEN];
232         char secret[512];
233         char pass2[MAX_DIGEST_LEN*2];
234         char *tok, *pass;
235
236         /* if no auth list then allow anyone in! */
237         if (!users || !*users)
238                 return "";
239
240         gen_challenge(addr, challenge);
241
242         io_printf(f_out, "%s%s\n", leader, challenge);
243
244         if (!read_line(f_in, line, sizeof line - 1)
245          || (pass = strchr(line, ' ')) == NULL) {
246                 rprintf(FLOG, "auth failed on module %s from %s (%s): "
247                         "invalid challenge response\n",
248                         lp_name(module), host, addr);
249                 return NULL;
250         }
251         *pass++ = '\0';
252
253         if (!(users = strdup(users)))
254                 out_of_memory("auth_server");
255
256         for (tok = strtok(users, " ,\t"); tok; tok = strtok(NULL, " ,\t")) {
257                 if (wildmatch(tok, line))
258                         break;
259         }
260         free(users);
261
262         if (!tok) {
263                 rprintf(FLOG, "auth failed on module %s from %s (%s): "
264                         "unauthorized user\n",
265                         lp_name(module), host, addr);
266                 return NULL;
267         }
268
269         memset(secret, 0, sizeof secret);
270         if (!get_secret(module, line, secret, sizeof secret - 1)) {
271                 memset(secret, 0, sizeof secret);
272                 rprintf(FLOG, "auth failed on module %s from %s (%s): "
273                         "missing secret for user \"%s\"\n",
274                         lp_name(module), host, addr, line);
275                 return NULL;
276         }
277
278         generate_hash(secret, challenge, pass2);
279         memset(secret, 0, sizeof secret);
280
281         if (strcmp(pass, pass2) != 0) {
282                 rprintf(FLOG, "auth failed on module %s from %s (%s): "
283                         "password mismatch\n",
284                         lp_name(module), host, addr);
285                 return NULL;
286         }
287
288         return strdup(line);
289 }
290
291 void auth_client(int fd, const char *user, const char *challenge)
292 {
293         const char *pass;
294         char pass2[MAX_DIGEST_LEN*2];
295
296         if (!user || !*user)
297                 user = "nobody";
298
299         if (!(pass = getpassf(password_file))
300          && !(pass = getenv("RSYNC_PASSWORD"))) {
301                 /* XXX: cyeoh says that getpass is deprecated, because
302                  * it may return a truncated password on some systems,
303                  * and it is not in the LSB.
304                  *
305                  * Andrew Klein says that getpassphrase() is present
306                  * on Solaris and reads up to 256 characters.
307                  *
308                  * OpenBSD has a readpassphrase() that might be more suitable.
309                  */
310                 pass = getpass("Password: ");
311         }
312
313         if (!pass)
314                 pass = "";
315
316         generate_hash(pass, challenge, pass2);
317         io_printf(fd, "%s %s\n", user, pass2);
318 }