git.hungrycats.org Git - xscreensaver/blob - driver/passwd-pam.c

   1 /* passwd-pam.c --- verifying typed passwords with PAM
   2  * (Pluggable Authentication Modules.)
   3  * written by Bill Nottingham <notting@redhat.com> (and jwz) for
   4  * xscreensaver, Copyright (c) 1993-2003 Jamie Zawinski <jwz@jwz.org>
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that
   9  * copyright notice and this permission notice appear in supporting
  10  * documentation.  No representations are made about the suitability of this
  11  * software for any purpose.  It is provided "as is" without express or
  12  * implied warranty.
  13  *
  14  * Some PAM resources:
  15  *
  16  *    PAM home page:
  17  *    http://www.us.kernel.org/pub/linux/libs/pam/
  18  *
  19  *    PAM FAQ:
  20  *    http://www.us.kernel.org/pub/linux/libs/pam/FAQ
  21  *
  22  *    PAM Application Developers' Guide:
  23  *    http://www.us.kernel.org/pub/linux/libs/pam/Linux-PAM-html/pam_appl.html
  24  *
  25  *    PAM Mailing list archives:
  26  *    http://www.linuxhq.com/lnxlists/linux-pam/
  27  *
  28  *    Compatibility notes, especially between Linux and Solaris:
  29  *    http://www.contrib.andrew.cmu.edu/u/shadow/pam.html
  30  *
  31  *    The Open Group's PAM API documentation:
  32  *    http://www.opengroup.org/onlinepubs/8329799/pam_start.htm
  33  */
  34
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 #ifndef NO_LOCKING  /* whole file */
  40
  41 #include <stdlib.h>
  42 #ifdef HAVE_UNISTD_H
  43 # include <unistd.h>
  44 #endif
  45
  46 extern char *blurb(void);
  47
  48
  49 #include <stdio.h>
  50 #include <string.h>
  51 #include <sys/types.h>
  52 #include <pwd.h>
  53 #include <grp.h>
  54 #include <security/pam_appl.h>
  55 #include <signal.h>
  56 #include <errno.h>
  57
  58 #include <sys/stat.h>
  59
  60 extern sigset_t block_sigchld (void);
  61 extern void unblock_sigchld (void);
  62
  63 /* blargh */
  64 #undef  Bool
  65 #undef  True
  66 #undef  False
  67 #define Bool  int
  68 #define True  1
  69 #define False 0
  70
  71 #undef countof
  72 #define countof(x) (sizeof((x))/sizeof(*(x)))
  73
  74 /* Some time between Red Hat 4.2 and 7.0, the words were transposed
  75    in the various PAM_x_CRED macro names.  Yay!
  76  */
  77 #ifndef  PAM_REFRESH_CRED
  78 # define PAM_REFRESH_CRED PAM_CRED_REFRESH
  79 #endif
  80
  81 static int pam_conversation (int nmsgs,
  82                              const struct pam_message **msg,
  83                              struct pam_response **resp,
  84                              void *closure);
  85
  86 struct pam_closure {
  87   const char *user;
  88   const char *typed_passwd;
  89   Bool verbose_p;
  90 };
  91
  92
  93 #ifdef HAVE_PAM_FAIL_DELAY
  94    /* We handle delays ourself.*/
  95    /* Don't set this to 0 (Linux bug workaround.) */
  96 # define PAM_NO_DELAY(pamh) pam_fail_delay ((pamh), 1)
  97 #else  /* !HAVE_PAM_FAIL_DELAY */
  98 # define PAM_NO_DELAY(pamh) /* */
  99 #endif /* !HAVE_PAM_FAIL_DELAY */
 100
 101
 102 /* On SunOS 5.6, and on Linux with PAM 0.64, pam_strerror() takes two args.
 103    On some other Linux systems with some other version of PAM (e.g.,
 104    whichever Debian release comes with a 2.2.5 kernel) it takes one arg.
 105    I can't tell which is more "recent" or "correct" behavior, so configure
 106    figures out which is in use for us.  Shoot me!
 107  */
 108 #ifdef PAM_STRERROR_TWO_ARGS
 109 # define PAM_STRERROR(pamh, status) pam_strerror((pamh), (status))
 110 #else  /* !PAM_STRERROR_TWO_ARGS */
 111 # define PAM_STRERROR(pamh, status) pam_strerror((status))
 112 #endif /* !PAM_STRERROR_TWO_ARGS */
 113
 114
 115 /* PAM sucks in that there is no way to tell whether a particular service
 116    is configured at all.  That is, there is no way to tell the difference
 117    between "authentication of the FOO service is not allowed" and "the
 118    user typed the wrong password."
 119
 120    On RedHat 5.1 systems, if a service name is not known, it defaults to
 121    being not allowed (because the fallback service, /etc/pam.d/other, is
 122    set to `pam_deny'.)
 123
 124    On Solaris 2.6 systems, unknown services default to authenticating normally.
 125
 126    So, we could simply require that the person who installs xscreensaver
 127    set up an "xscreensaver" PAM service.  However, if we went that route,
 128    it would have a really awful failure mode: the failure mode would be that
 129    xscreensaver was willing to *lock* the screen, but would be unwilling to
 130    *unlock* the screen.  (With the non-PAM password code, the analagous
 131    situation -- security not being configured properly, for example do to the
 132    executable not being installed as setuid root -- the failure mode is much
 133    more palettable, in that xscreensaver will refuse to *lock* the screen,
 134    because it can know up front that there is no password that will work.)
 135
 136    Another route would be to have the service name to consult be computed at
 137    compile-time (perhaps with a configure option.)  However, that doesn't
 138    really solve the problem, because it means that the same executable might
 139    work fine on one machine, but refuse to unlock when run on another
 140    machine.
 141
 142    Another alternative would be to look in /etc/pam.conf or /etc/pam.d/ at
 143    runtime to see what services actually exist.  But I think that's no good,
 144    because who is to say that the PAM info is actually specified in those
 145    files?  Opening and reading those files is not a part of the PAM client
 146    API, so it's not guarenteed to work on any given system.
 147
 148    An alternative I tried was to specify a list of services to try, and to
 149    try them all in turn ("xscreensaver", "xlock", "xdm", and "login").
 150    This worked, but it was slow (and I also had to do some contortions to
 151    work around bugs in Linux PAM 0.64-3.)
 152
 153    So what we do today is, try PAM once, and if that fails, try the usual
 154    getpwent() method.  So if PAM doesn't work, it will at least make an
 155    attempt at looking up passwords in /etc/passwd or /etc/shadow instead.
 156
 157    This all kind of blows.  I'm not sure what else to do.
 158  */
 159
 160
 161 /* On SunOS 5.6, the `pam_conv.appdata_ptr' slot seems to be ignored, and
 162    the `closure' argument to pc.conv always comes in as random garbage.
 163    So we get around this by using a global variable instead.  Shoot me!
 164
 165    (I've been told this is bug 4092227, and is fixed in Solaris 7.)
 166    (I've also been told that it's fixed in Solaris 2.6 by patch 106257-05.)
 167  */
 168 static void *suns_pam_implementation_blows = 0;
 169
 170
 171 /* This can be called at any time, and says whether the typed password
 172    belongs to either the logged in user (real uid, not effective); or
 173    to root.
 174  */
 175 Bool
 176 pam_passwd_valid_p (const char *typed_passwd, Bool verbose_p)
 177 {
 178   const char *service = PAM_SERVICE_NAME;
 179   pam_handle_t *pamh = 0;
 180   int status = -1;
 181   struct pam_conv pc;
 182   struct pam_closure c;
 183   char *user = 0;
 184   sigset_t set;
 185   struct timespec timeout;
 186
 187   struct passwd *p = getpwuid (getuid ());
 188   if (!p) return False;
 189
 190   user = strdup (p->pw_name);
 191
 192   c.user = user;
 193   c.typed_passwd = typed_passwd;
 194   c.verbose_p = verbose_p;
 195
 196   pc.conv = &pam_conversation;
 197   pc.appdata_ptr = (void *) &c;
 198
 199   /* On SunOS 5.6, the `appdata_ptr' slot seems to be ignored, and the
 200      `closure' argument to pc.conv always comes in as random garbage. */
 201   suns_pam_implementation_blows = (void *) &c;
 202
 203
 204   /* Initialize PAM.
 205    */
 206   status = pam_start (service, c.user, &pc, &pamh);
 207   if (verbose_p)
 208     fprintf (stderr, "%s: pam_start (\"%s\", \"%s\", ...) ==> %d (%s)\n",
 209              blurb(), service, c.user,
 210              status, PAM_STRERROR (pamh, status));
 211   if (status != PAM_SUCCESS) goto DONE;
 212
 213   /* #### We should set PAM_TTY to the display we're using, but we
 214      don't have that handy from here.  So set it to :0.0, which is a
 215      good guess (and has the bonus of counting as a "secure tty" as
 216      far as PAM is concerned...)
 217    */
 218   {
 219     char *tty = strdup (":0.0");
 220     status = pam_set_item (pamh, PAM_TTY, tty);
 221     if (verbose_p)
 222       fprintf (stderr, "%s:   pam_set_item (p, PAM_TTY, \"%s\") ==> %d (%s)\n",
 223                blurb(), tty, status, PAM_STRERROR(pamh, status));
 224     free (tty);
 225   }
 226
 227   /* Try to authenticate as the current user.
 228      We must turn off our SIGCHLD handler for the duration of the call to
 229      pam_authenticate(), because in some cases, the underlying PAM code
 230      will do this:
 231
 232         1: fork a setuid subprocess to do some dirty work;
 233         2: read a response from that subprocess;
 234         3: waitpid(pid, ...) on that subprocess.
 235
 236     If we (the ignorant parent process) have a SIGCHLD handler, then there's
 237     a race condition between steps 2 and 3: if the subprocess exits before
 238     waitpid() was called, then our SIGCHLD handler fires, and gets notified
 239     of the subprocess death; then PAM's call to waitpid() fails, because the
 240     process has already been reaped.
 241
 242     I consider this a bug in PAM, since the caller should be able to have
 243     whatever signal handlers it wants -- the PAM documentation doesn't say
 244     "oh by the way, if you use PAM, you can't use SIGCHLD."
 245    */
 246
 247   PAM_NO_DELAY(pamh);
 248
 249   timeout.tv_nsec = 1;
 250   set = block_sigchld();
 251   status = pam_authenticate (pamh, 0);
 252   sigtimedwait (&set, NULL, &timeout);
 253   unblock_sigchld();
 254
 255   if (verbose_p)
 256     fprintf (stderr, "%s:   pam_authenticate (...) ==> %d (%s)\n",
 257              blurb(), status, PAM_STRERROR(pamh, status));
 258   if (status == PAM_SUCCESS)  /* Win! */
 259     {
 260       /* Each time we successfully authenticate, refresh credentials,
 261          for Kerberos/AFS/DCE/etc.  If this fails, just ignore that
 262          failure and blunder along; it shouldn't matter.
 263
 264          Note: this used to be PAM_REFRESH_CRED instead of
 265          PAM_REINITIALIZE_CRED, but Jason Heiss <jheiss@ee.washington.edu>
 266          says that the Linux PAM library ignores that one, and only refreshes
 267          credentials when using PAM_REINITIALIZE_CRED.
 268        */
 269       int status2 = pam_setcred (pamh, PAM_REINITIALIZE_CRED);
 270       if (verbose_p)
 271         fprintf (stderr, "%s:   pam_setcred (...) ==> %d (%s)\n",
 272                  blurb(), status2, PAM_STRERROR(pamh, status2));
 273       goto DONE;
 274     }
 275
 276   /* If that didn't work, set the user to root, and try to authenticate again.
 277    */
 278   if (user) free (user);
 279   user = strdup ("root");
 280   c.user = user;
 281   status = pam_set_item (pamh, PAM_USER, c.user);
 282   if (verbose_p)
 283     fprintf (stderr, "%s:   pam_set_item(p, PAM_USER, \"%s\") ==> %d (%s)\n",
 284              blurb(), c.user, status, PAM_STRERROR(pamh, status));
 285   if (status != PAM_SUCCESS) goto DONE;
 286
 287   PAM_NO_DELAY(pamh);
 288
 289   set = block_sigchld();
 290   status = pam_authenticate (pamh, 0);
 291   sigtimedwait(&set, NULL, &timeout);
 292   unblock_sigchld();
 293
 294   if (verbose_p)
 295     fprintf (stderr, "%s:   pam_authenticate (...) ==> %d (%s)\n",
 296              blurb(), status, PAM_STRERROR(pamh, status));
 297
 298  DONE:
 299   if (user) free (user);
 300   if (pamh)
 301     {
 302       int status2 = pam_end (pamh, status);
 303       pamh = 0;
 304       if (verbose_p)
 305         fprintf (stderr, "%s: pam_end (...) ==> %d (%s)\n",
 306                  blurb(), status2,
 307                  (status2 == PAM_SUCCESS ? "Success" : "Failure"));
 308     }
 309   return (status == PAM_SUCCESS ? True : False);
 310 }
 311
 312
 313 Bool
 314 pam_priv_init (int argc, char **argv, Bool verbose_p)
 315 {
 316   /* We have nothing to do at init-time.
 317      However, we might as well do some error checking.
 318      If "/etc/pam.d" exists and is a directory, but "/etc/pam.d/xlock"
 319      does not exist, warn that PAM probably isn't going to work.
 320
 321      This is a priv-init instead of a non-priv init in case the directory
 322      is unreadable or something (don't know if that actually happens.)
 323    */
 324   const char   dir[] = "/etc/pam.d";
 325   const char  file[] = "/etc/pam.d/" PAM_SERVICE_NAME;
 326   const char file2[] = "/etc/pam.conf";
 327   struct stat st;
 328
 329   if (stat (dir, &st) == 0 && st.st_mode & S_IFDIR)
 330     {
 331       if (stat (file, &st) != 0)
 332         fprintf (stderr,
 333                  "%s: warning: %s does not exist.\n"
 334                  "%s: password authentication via PAM is unlikely to work.\n",
 335                  blurb(), file, blurb());
 336     }
 337   else if (stat (file2, &st) == 0)
 338     {
 339       FILE *f = fopen (file2, "r");
 340       if (f)
 341         {
 342           Bool ok = False;
 343           char buf[255];
 344           while (fgets (buf, sizeof(buf), f))
 345             if (strstr (buf, PAM_SERVICE_NAME))
 346               {
 347                 ok = True;
 348                 break;
 349               }
 350           fclose (f);
 351           if (!ok)
 352             {
 353               fprintf (stderr,
 354                   "%s: warning: %s does not list the `%s' service.\n"
 355                   "%s: password authentication via PAM is unlikely to work.\n",
 356                        blurb(), file2, PAM_SERVICE_NAME, blurb());
 357             }
 358         }
 359       /* else warn about file2 existing but being unreadable? */
 360     }
 361   else
 362     {
 363       fprintf (stderr,
 364                "%s: warning: neither %s nor %s exist.\n"
 365                "%s: password authentication via PAM is unlikely to work.\n",
 366                blurb(), file2, file, blurb());
 367     }
 368
 369   /* Return true anyway, just in case. */
 370   return True;
 371 }
 372
 373
 374 /* This is the function PAM calls to have a conversation with the user.
 375    Really, this function should be the thing that pops up dialog boxes
 376    as needed, and prompts for various strings.
 377
 378    But, for now, xscreensaver uses its normal password-prompting dialog
 379    first, and then this function simply returns the result that has been
 380    typed.
 381
 382    This means that if PAM was using a retina scanner for auth, xscreensaver
 383    would prompt for a password; then pam_conversation() would be called
 384    with a string like "Please look into the retina scanner".  The user
 385    would never see this string, and the prompted-for password would be
 386    ignored.
 387  */
 388 static int
 389 pam_conversation (int nmsgs,
 390                   const struct pam_message **msg,
 391                   struct pam_response **resp,
 392                   void *closure)
 393 {
 394   int replies = 0;
 395   struct pam_response *reply = 0;
 396   struct pam_closure *c = (struct pam_closure *) closure;
 397
 398   /* On SunOS 5.6, the `closure' argument always comes in as random garbage. */
 399   c = (struct pam_closure *) suns_pam_implementation_blows;
 400
 401
 402   reply = (struct pam_response *) calloc (nmsgs, sizeof (*reply));
 403   if (!reply) return PAM_CONV_ERR;
 404
 405   for (replies = 0; replies < nmsgs; replies++)
 406     {
 407       switch (msg[replies]->msg_style)
 408         {
 409         case PAM_PROMPT_ECHO_ON:
 410           reply[replies].resp_retcode = PAM_SUCCESS;
 411           reply[replies].resp = strdup (c->user);          /* freed by PAM */
 412           if (c->verbose_p)
 413             fprintf (stderr, "%s:     PAM ECHO_ON(\"%s\") ==> \"%s\"\n",
 414                      blurb(), msg[replies]->msg,
 415                      reply[replies].resp);
 416           break;
 417         case PAM_PROMPT_ECHO_OFF:
 418           reply[replies].resp_retcode = PAM_SUCCESS;
 419           reply[replies].resp = strdup (c->typed_passwd);   /* freed by PAM */
 420           if (c->verbose_p)
 421             fprintf (stderr, "%s:     PAM ECHO_OFF(\"%s\") ==> password\n",
 422                      blurb(), msg[replies]->msg);
 423           break;
 424         case PAM_TEXT_INFO:
 425           /* ignore it... */
 426           reply[replies].resp_retcode = PAM_SUCCESS;
 427           reply[replies].resp = 0;
 428           if (c->verbose_p)
 429             fprintf (stderr, "%s:     PAM TEXT_INFO(\"%s\") ==> ignored\n",
 430                      blurb(), msg[replies]->msg);
 431           break;
 432         case PAM_ERROR_MSG:
 433           /* ignore it... */
 434           reply[replies].resp_retcode = PAM_SUCCESS;
 435           reply[replies].resp = 0;
 436           if (c->verbose_p)
 437             fprintf (stderr, "%s:     PAM ERROR_MSG(\"%s\") ==> ignored\n",
 438                      blurb(), msg[replies]->msg);
 439           break;
 440         default:
 441           /* Must be an error of some sort... */
 442           free (reply);
 443           if (c->verbose_p)
 444             fprintf (stderr, "%s:     PAM unknown %d(\"%s\") ==> ignored\n",
 445                      blurb(), msg[replies]->msg_style, msg[replies]->msg);
 446           return PAM_CONV_ERR;
 447         }
 448     }
 449   *resp = reply;
 450   return PAM_SUCCESS;
 451 }
 452
 453 #endif /* NO_LOCKING -- whole file */