0fff2fdc901441e5fc0710bf12b03d6baa4d3f97
[openafs.git] / src / pam / afs_auth.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #include <afsconfig.h>
11 #include <afs/param.h>
12
13 #include <roken.h>
14
15 #ifdef HAVE_SYS_WAIT_H
16 #include <sys/wait.h>
17 #endif
18
19 #include <afs/kautils.h>
20
21 #include <security/pam_appl.h>
22 #include <security/pam_modules.h>
23
24 #include "afs_message.h"
25 #include "afs_util.h"
26
27
28 #define RET(x) { retcode = (x); goto out; }
29
30 extern int
31 pam_sm_authenticate(pam_handle_t * pamh, int flags, int argc,
32                     const char **argv)
33 {
34     int retcode = PAM_SUCCESS;
35     int errcode = PAM_SUCCESS;
36     int code;
37     int origmask;
38     int logmask = LOG_UPTO(LOG_INFO);
39     int nowarn = 0;
40     int use_first_pass = 0;
41     int try_first_pass = 0;
42     int ignore_uid = 0;
43     uid_t ignore_uid_id = 0;
44     char my_password_buf[256];
45     char *cell_ptr = NULL;
46     /*
47      * these options are added to handle stupid apps, which won't call
48      * pam_set_cred()
49      */
50     int refresh_token = 0;
51     int set_token = 0;
52     int dont_fork = 0;
53     /* satisfy kdm 2.x
54      */
55     int use_klog = 0;
56     int set_expires = 0;        /* This option is only used in pam_set_cred() */
57     int got_authtok = 0;        /* got PAM_AUTHTOK upon entry */
58     char *user = NULL, *password = NULL;
59     afs_int32 password_expires = -1;
60     int torch_password = 1;
61     int i;
62     struct pam_conv *pam_convp = NULL;
63     int auth_ok;
64     struct passwd unix_pwd, *upwd = NULL;
65     char upwd_buf[2048];        /* size is a guess. */
66     char *reason = NULL;
67     pid_t cpid, rcpid;
68     int status;
69     struct sigaction newAction, origAction;
70
71
72 #ifndef AFS_SUN56_ENV
73     openlog(pam_afs_ident, LOG_CONS | LOG_PID, LOG_AUTH);
74 #endif
75     origmask = setlogmask(logmask);
76
77     /*
78      * Parse the user options.  Log an error for any unknown options.
79      */
80     for (i = 0; i < argc; i++) {
81         if (strcasecmp(argv[i], "debug") == 0) {
82             logmask |= LOG_MASK(LOG_DEBUG);
83             (void)setlogmask(logmask);
84         } else if (strcasecmp(argv[i], "nowarn") == 0) {
85             nowarn = 1;
86         } else if (strcasecmp(argv[i], "use_first_pass") == 0) {
87             use_first_pass = 1;
88         } else if (strcasecmp(argv[i], "try_first_pass") == 0) {
89             try_first_pass = 1;
90         } else if (strcasecmp(argv[i], "ignore_root") == 0) {
91             ignore_uid = 1;
92             ignore_uid_id = 0;
93         } else if (strcasecmp(argv[i], "ignore_uid") == 0) {
94             i++;
95             if (i == argc) {
96                 pam_afs_syslog(LOG_ERR, PAMAFS_IGNOREUID,
97                                "ignore_uid missing argument");
98                 ignore_uid = 0;
99             } else {
100                 ignore_uid = 1;
101                 ignore_uid_id = (uid_t) strtol(argv[i], (char **)NULL, 10);
102                 if ((ignore_uid_id < 0) || (ignore_uid_id > IGNORE_MAX)) {
103                     ignore_uid = 0;
104                     pam_afs_syslog(LOG_ERR, PAMAFS_IGNOREUID, argv[i]);
105                 }
106             }
107         } else if (strcasecmp(argv[i], "cell") == 0) {
108             i++;
109             if (i == argc) {
110                 pam_afs_syslog(LOG_ERR, PAMAFS_OTHERCELL,
111                                "cell missing argument");
112             } else {
113                 cell_ptr = (char *)argv[i];
114                 pam_afs_syslog(LOG_INFO, PAMAFS_OTHERCELL, cell_ptr);
115             }
116         } else if (strcasecmp(argv[i], "refresh_token") == 0) {
117             refresh_token = 1;
118         } else if (strcasecmp(argv[i], "set_token") == 0) {
119             set_token = 1;
120         } else if (strcasecmp(argv[i], "dont_fork") == 0) {
121             if (!use_klog)
122                 dont_fork = 1;
123             else
124                 pam_afs_syslog(LOG_ERR, PAMAFS_CONFLICTOPT, "dont_fork");
125         } else if (strcasecmp(argv[i], "use_klog") == 0) {
126             if (!dont_fork)
127                 use_klog = 1;
128             else
129                 pam_afs_syslog(LOG_ERR, PAMAFS_CONFLICTOPT, "use_klog");
130         } else if (strcasecmp(argv[i], "setenv_password_expires") == 0) {
131             set_expires = 1;
132         } else {
133             pam_afs_syslog(LOG_ERR, PAMAFS_UNKNOWNOPT, argv[i]);
134         }
135     }
136
137     /* Later we use try_first_pass to see if we can try again.    */
138     /* If use_first_pass is true we don't want to ever try again, */
139     /* so turn that flag off right now.                           */
140     if (use_first_pass)
141         try_first_pass = 0;
142
143     if (logmask && LOG_MASK(LOG_DEBUG))
144         pam_afs_syslog(LOG_DEBUG, PAMAFS_OPTIONS, nowarn, use_first_pass,
145                        try_first_pass, ignore_uid, ignore_uid_id,
146                        refresh_token, set_token, dont_fork, use_klog);
147
148     /* Try to get the user-interaction info, if available. */
149     errcode = pam_get_item(pamh, PAM_CONV, (const void **)&pam_convp);
150     if (errcode != PAM_SUCCESS) {
151         pam_afs_syslog(LOG_WARNING, PAMAFS_NO_USER_INT);
152         pam_convp = NULL;
153     }
154
155     /* Who are we trying to authenticate here? */
156     if ((errcode =
157          pam_get_user(pamh, (const char **)&user,
158                       "login: ")) != PAM_SUCCESS) {
159         pam_afs_syslog(LOG_ERR, PAMAFS_NOUSER, errcode);
160         RET(PAM_USER_UNKNOWN);
161     }
162
163     if (logmask && LOG_MASK(LOG_DEBUG))
164         pam_afs_syslog(LOG_DEBUG, PAMAFS_USERNAMEDEBUG, user);
165
166     /*
167      * If the user has a "local" (or via nss, possibly nss_dce) pwent,
168      * and its uid==0, and "ignore_root" was given in pam.conf,
169      * ignore the user.
170      */
171     /* enhanced: use "ignore_uid <number>" to specify the largest uid
172      * which should be ignored by this module
173      */
174 #if     defined(AFS_HPUX_ENV) || defined(AFS_DARWIN100_ENV) || defined(AFS_SUN58_ENV)
175 #if     defined(AFS_HPUX110_ENV) || defined(AFS_DARWIN100_ENV) || defined(AFS_SUN58_ENV)
176     i = getpwnam_r(user, &unix_pwd, upwd_buf, sizeof(upwd_buf), &upwd);
177 #else /* AFS_HPUX110_ENV */
178     i = getpwnam_r(user, &unix_pwd, upwd_buf, sizeof(upwd_buf));
179     if (i == 0)                 /* getpwnam_r success */
180         upwd = &unix_pwd;
181 #endif /* else AFS_HPUX110_ENV */
182     if (ignore_uid && i == 0 && upwd && upwd->pw_uid <= ignore_uid_id) {
183         pam_afs_syslog(LOG_INFO, PAMAFS_IGNORINGROOT, user);
184         RET(PAM_AUTH_ERR);
185     }
186 #else
187 #if     defined(AFS_LINUX20_ENV) || defined(AFS_FBSD_ENV) || defined(AFS_DFBSD_ENV) || defined(AFS_NBSD_ENV)
188     upwd = getpwnam(user);
189 #else
190     upwd = getpwnam_r(user, &unix_pwd, upwd_buf, sizeof(upwd_buf));
191 #endif
192     if (ignore_uid && upwd != NULL && upwd->pw_uid <= ignore_uid_id) {
193         pam_afs_syslog(LOG_INFO, PAMAFS_IGNORINGROOT, user);
194         RET(PAM_AUTH_ERR);
195     }
196 #endif
197     errcode = pam_get_item(pamh, PAM_AUTHTOK, (const void **)&password);
198     if (errcode != PAM_SUCCESS || password == NULL) {
199         if (use_first_pass) {
200             pam_afs_syslog(LOG_ERR, PAMAFS_PASSWD_REQ, user);
201             RET(PAM_AUTH_ERR);
202         }
203         password = NULL;        /* In case it isn't already NULL */
204         if (logmask && LOG_MASK(LOG_DEBUG))
205             pam_afs_syslog(LOG_DEBUG, PAMAFS_NOFIRSTPASS, user);
206     } else if (password[0] == '\0') {
207         /* Actually we *did* get one but it was empty. */
208         torch_password = 0;
209         pam_afs_syslog(LOG_INFO, PAMAFS_NILPASSWORD, user);
210         RET(PAM_NEW_AUTHTOK_REQD);
211     } else {
212         if (logmask && LOG_MASK(LOG_DEBUG))
213             pam_afs_syslog(LOG_DEBUG, PAMAFS_GOTPASS, user);
214         torch_password = 0;
215         got_authtok = 1;
216     }
217     if (!(use_first_pass || try_first_pass)) {
218         password = NULL;
219     }
220
221   try_auth:
222     if (password == NULL) {
223
224         torch_password = 1;
225
226         if (use_first_pass)
227             RET(PAM_AUTH_ERR);  /* shouldn't happen */
228         if (try_first_pass)
229             try_first_pass = 0; /* we come back if try_first_pass==1 below */
230
231         if (pam_convp == NULL || pam_convp->conv == NULL) {
232             pam_afs_syslog(LOG_ERR, PAMAFS_CANNOT_PROMPT);
233             RET(PAM_AUTH_ERR);
234         }
235
236         errcode = pam_afs_prompt(pam_convp, &password, 0, PAMAFS_PWD_PROMPT);
237         if (errcode != PAM_SUCCESS || password == NULL) {
238             pam_afs_syslog(LOG_ERR, PAMAFS_GETPASS_FAILED);
239             RET(PAM_AUTH_ERR);
240         }
241         if (password[0] == '\0') {
242             pam_afs_syslog(LOG_INFO, PAMAFS_NILPASSWORD, user);
243             RET(PAM_NEW_AUTHTOK_REQD);
244         }
245
246         /*
247          * We aren't going to free the password later (we will wipe it,
248          * though), because the storage for it if we get it from other
249          * paths may belong to someone else.  Since we do need to free
250          * this storage, copy it to a buffer that won't need to be freed
251          * later, and free this storage now.
252          */
253
254         strncpy(my_password_buf, password, sizeof(my_password_buf));
255         my_password_buf[sizeof(my_password_buf) - 1] = '\0';
256         memset(password, 0, strlen(password));
257         free(password);
258         password = my_password_buf;
259
260     }
261
262     /* Be sure to allocate a PAG here if we should set a token,
263      * All of the remaining stuff to authenticate the user and to
264      * get a token is done in a child process - if not suppressed by the config,
265      * see below
266      * But dont get a PAG if the refresh_token option was set
267      * We have to do this in such a way because some
268      * apps (such as screensavers) wont call setcred but authenticate :-(
269      */
270     if (!refresh_token) {
271         setpag();
272 #ifdef AFS_KERBEROS_ENV
273         ktc_newpag();
274 #endif
275         if (logmask && LOG_MASK(LOG_DEBUG))
276             syslog(LOG_DEBUG, "New PAG created in pam_authenticate()");
277     }
278
279     if (!dont_fork) {
280         /* Prepare for fork(): set SIGCHLD signal handler to default */
281         sigemptyset(&newAction.sa_mask);
282         newAction.sa_handler = SIG_DFL;
283         newAction.sa_flags = 0;
284         code = sigaction(SIGCHLD, &newAction, &origAction);
285         if (code) {
286             pam_afs_syslog(LOG_ERR, PAMAFS_PAMERROR, errno);
287             RET(PAM_AUTH_ERR);
288         }
289
290         /* Fork a process and let it verify authentication. So that any
291          * memory/sockets allocated will get cleaned up when the child
292          * exits: defect 11686.
293          */
294         if (use_klog) {         /* used by kdm 2.x */
295             if (refresh_token || set_token) {
296                 i = do_klog(user, password, NULL, cell_ptr);
297             } else {
298                 i = do_klog(user, password, "00:00:01", cell_ptr);
299                 ktc_ForgetAllTokens();
300             }
301             if (logmask && LOG_MASK(LOG_DEBUG))
302                 syslog(LOG_DEBUG, "do_klog returned %d", i);
303             auth_ok = i ? 0 : 1;
304         } else {
305             if (logmask && LOG_MASK(LOG_DEBUG))
306                 syslog(LOG_DEBUG, "forking ...");
307             cpid = fork();
308             if (cpid <= 0) {    /* The child process */
309                 if (logmask && LOG_MASK(LOG_DEBUG))
310                     syslog(LOG_DEBUG, "in child");
311                 if (refresh_token || set_token)
312                     code = ka_UserAuthenticateGeneral(KA_USERAUTH_VERSION, user,        /* kerberos name */
313                                                       NULL,     /* instance */
314                                                       cell_ptr, /* realm */
315                                                       password, /* password */
316                                                       0,        /* default lifetime */
317                                                       &password_expires, 0,     /* spare 2 */
318                                                       &reason
319                                                       /* error string */ );
320                 else
321                     code = ka_VerifyUserPassword(KA_USERAUTH_VERSION, user,     /* kerberos name */
322                                                  NULL,  /* instance */
323                                                  cell_ptr,      /* realm */
324                                                  password,      /* password */
325                                                  0,     /* spare 2 */
326                                                  &reason /* error string */ );
327                 if (code) {
328                     pam_afs_syslog(LOG_ERR, PAMAFS_LOGIN_FAILED, user,
329                                    reason);
330                     auth_ok = 0;
331                 } else {
332                     auth_ok = 1;
333                 }
334                 if (logmask && LOG_MASK(LOG_DEBUG))
335                     syslog(LOG_DEBUG, "child: auth_ok=%d", auth_ok);
336                 if (cpid == 0)
337                     exit(auth_ok);
338             } else {
339                 do {
340                     if (logmask && LOG_MASK(LOG_DEBUG))
341                         syslog(LOG_DEBUG, "in parent, waiting ...");
342                     rcpid = waitpid(cpid, &status, 0);
343                 } while ((rcpid == -1) && (errno == EINTR));
344
345                 if ((rcpid == cpid) && WIFEXITED(status)) {
346                     auth_ok = WEXITSTATUS(status);
347                 } else {
348                     auth_ok = 0;
349                 }
350                 if (logmask && LOG_MASK(LOG_DEBUG))
351                     syslog(LOG_DEBUG, "parent: auth_ok=%d", auth_ok);
352             }
353         }
354         /* Restore old signal handler */
355         code = sigaction(SIGCHLD, &origAction, NULL);
356         if (code) {
357             pam_afs_syslog(LOG_ERR, PAMAFS_PAMERROR, errno);
358         }
359     } else {                    /* dont_fork, used by httpd */
360         if (logmask && LOG_MASK(LOG_DEBUG))
361             syslog(LOG_DEBUG, "dont_fork");
362         if (refresh_token || set_token)
363             code = ka_UserAuthenticateGeneral(KA_USERAUTH_VERSION, user,        /* kerberos name */
364                                               NULL,     /* instance */
365                                               cell_ptr, /* realm */
366                                               password, /* password */
367                                               0,        /* default lifetime */
368                                               &password_expires, 0,     /* spare 2 */
369                                               &reason /* error string */ );
370         else
371             code = ka_VerifyUserPassword(KA_USERAUTH_VERSION, user,     /* kerberos name */
372                                          NULL,  /* instance */
373                                          cell_ptr,      /* realm */
374                                          password,      /* password */
375                                          0,     /* spare 2 */
376                                          &reason /* error string */ );
377         if (logmask && LOG_MASK(LOG_DEBUG))
378             syslog(LOG_DEBUG, "dont_fork, code = %d", code);
379         if (code) {
380             pam_afs_syslog(LOG_ERR, PAMAFS_LOGIN_FAILED, user, reason);
381             auth_ok = 0;
382         } else {
383             auth_ok = 1;
384         }
385         if (logmask && LOG_MASK(LOG_DEBUG))
386             syslog(LOG_DEBUG, "dont_fork: auth_ok=%d", auth_ok);
387     }
388
389     if (!auth_ok && try_first_pass) {
390         password = NULL;
391         goto try_auth;
392     }
393
394     /* We don't care if this fails; all we can do is try. */
395     /* It is not reasonable to store the password only if it was correct
396      * because it could satisfy another module that is called in the chain
397      * after pam_afs
398      */
399     if (!got_authtok) {
400         torch_password = 0;
401         (void)pam_set_item(pamh, PAM_AUTHTOK, password);
402     }
403
404     if (logmask && LOG_MASK(LOG_DEBUG))
405         syslog(LOG_DEBUG, "leaving auth: auth_ok=%d", auth_ok);
406     if (code == KANOENT)
407         RET(PAM_USER_UNKNOWN);
408     RET(auth_ok ? PAM_SUCCESS : PAM_AUTH_ERR);
409
410   out:
411     if (password) {
412         /* we store the password in the data portion */
413         char *tmp = strdup(password);
414         (void)pam_set_data(pamh, pam_afs_lh, tmp, lc_cleanup);
415         if (torch_password)
416             memset(password, 0, strlen(password));
417     }
418     (void)setlogmask(origmask);
419 #ifndef AFS_SUN56_ENV
420     closelog();
421 #endif
422     return retcode;
423 }