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-1998 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
  56 #include <sys/stat.h>
  57
  58
  59 /* blargh */
  60 #undef  Bool
  61 #undef  True
  62 #undef  False
  63 #define Bool  int
  64 #define True  1
  65 #define False 0
  66
  67 #undef countof
  68 #define countof(x) (sizeof((x))/sizeof(*(x)))
  69
  70 static int pam_conversation (int nmsgs,
  71                              const struct pam_message **msg,
  72                              struct pam_response **resp,
  73                              void *closure);
  74
  75 struct pam_closure {
  76   const char *user;
  77   const char *typed_passwd;
  78   Bool verbose_p;
  79 };
  80
  81
  82 #ifdef HAVE_PAM_FAIL_DELAY
  83    /* We handle delays ourself.*/
  84    /* Don't set this to 0 (Linux bug workaround.) */
  85 # define PAM_NO_DELAY(pamh) pam_fail_delay ((pamh), 1)
  86 #else  /* !HAVE_PAM_FAIL_DELAY */
  87 # define PAM_NO_DELAY(pamh) /* */
  88 #endif /* !HAVE_PAM_FAIL_DELAY */
  89
  90
  91 /* On SunOS 5.6, and on Linux with PAM 0.64, pam_strerror() takes two args.
  92    On some other Linux systems with some other version of PAM (e.g.,
  93    whichever Debian release comes with a 2.2.5 kernel) it takes one arg.
  94    I can't tell which is more "recent" or "correct" behavior, so configure
  95    figures out which is in use for us.  Shoot me!
  96  */
  97 #ifdef PAM_STRERROR_TWO_ARGS
  98 # define PAM_STRERROR(pamh, status) pam_strerror((pamh), (status))
  99 #else  /* !PAM_STRERROR_TWO_ARGS */
 100 # define PAM_STRERROR(pamh, status) pam_strerror((status))
 101 #endif /* !PAM_STRERROR_TWO_ARGS */
 102
 103
 104 /* PAM sucks in that there is no way to tell whether a particular service
 105    is configured at all.  That is, there is no way to tell the difference
 106    between "authentication of the FOO service is not allowed" and "the
 107    user typed the wrong password."
 108
 109    On RedHat 5.1 systems, if a service name is not known, it defaults to
 110    being not allowed (because the fallback service, /etc/pam.d/other, is
 111    set to `pam_deny'.)
 112
 113    On Solaris 2.6 systems, unknown services default to authenticating normally.
 114
 115    So, we could simply require that the person who installs xscreensaver
 116    set up an "xscreensaver" PAM service.  However, if we went that route,
 117    it would have a really awful failure mode: the failure mode would be that
 118    xscreensaver was willing to *lock* the screen, but would be unwilling to
 119    *unlock* the screen.  (With the non-PAM password code, the analagous
 120    situation -- security not being configured properly, for example do to the
 121    executable not being installed as setuid root -- the failure mode is much
 122    more palettable, in that xscreensaver will refuse to *lock* the screen,
 123    because it can know up front that there is no password that will work.)
 124
 125    Another route would be to have the service name to consult be computed at
 126    compile-time (perhaps with a configure option.)  However, that doesn't
 127    really solve the problem, because it means that the same executable might
 128    work fine on one machine, but refuse to unlock when run on another
 129    machine.
 130
 131    Another alternative would be to look in /etc/pam.conf or /etc/pam.d/ at
 132    runtime to see what services actually exist.  But I think that's no good,
 133    because who is to say that the PAM info is actually specified in those
 134    files?  Opening and reading those files is not a part of the PAM client
 135    API, so it's not guarenteed to work on any given system.
 136
 137    An alternative I tried was to specify a list of services to try, and to
 138    try them all in turn ("xscreensaver", "xlock", "xdm", and "login").
 139    This worked, but it was slow (and I also had to do some contortions to
 140    work around bugs in Linux PAM 0.64-3.)
 141
 142    So what we do today is, try PAM once, and if that fails, try the usual
 143    getpwent() method.  So if PAM doesn't work, it will at least make an
 144    attempt at looking up passwords in /etc/passwd or /etc/shadow instead.
 145
 146    This all kind of blows.  I'm not sure what else to do.
 147  */
 148
 149
 150 /* On SunOS 5.6, the `pam_conv.appdata_ptr' slot seems to be ignored, and
 151    the `closure' argument to pc.conv always comes in as random garbage.
 152    So we get around this by using a global variable instead.  Shoot me!
 153  */
 154 static void *suns_pam_implementation_blows = 0;
 155
 156
 157 /* This can be called at any time, and says whether the typed password
 158    belongs to either the logged in user (real uid, not effective); or
 159    to root.
 160  */
 161 Bool
 162 pam_passwd_valid_p (const char *typed_passwd, Bool verbose_p)
 163 {
 164   const char *service = PAM_SERVICE_NAME;
 165   pam_handle_t *pamh = 0;
 166   int status = -1;
 167   struct pam_conv pc;
 168   struct pam_closure c;
 169   char *user = 0;
 170
 171   struct passwd *p = getpwuid (getuid ());
 172   if (!p) return False;
 173
 174   user = strdup (p->pw_name);
 175
 176   c.user = user;
 177   c.typed_passwd = typed_passwd;
 178   c.verbose_p = verbose_p;
 179
 180   pc.conv = &pam_conversation;
 181   pc.appdata_ptr = (void *) &c;
 182
 183   /* On SunOS 5.6, the `appdata_ptr' slot seems to be ignored, and the
 184      `closure' argument to pc.conv always comes in as random garbage. */
 185   suns_pam_implementation_blows = (void *) &c;
 186
 187
 188   /* Initialize PAM.
 189    */
 190   status = pam_start (service, c.user, &pc, &pamh);
 191   if (verbose_p)
 192     fprintf (stderr, "%s: pam_start (\"%s\", \"%s\", ...) ==> %d (%s)\n",
 193              blurb(), service, c.user,
 194              status, PAM_STRERROR (pamh, status));
 195   if (status != PAM_SUCCESS) goto DONE;
 196
 197   /* #### We should set PAM_TTY to the display we're using, but we
 198      don't have that handy from here.  So set it to :0.0, which is a
 199      good guess (and has the bonus of counting as a "secure tty" as
 200      far as PAM is concerned...)
 201    */
 202   {
 203     const char *tty = ":0.0";
 204     status = pam_set_item (pamh, PAM_TTY, strdup(tty));
 205     if (verbose_p)
 206       fprintf (stderr, "%s:   pam_set_item (p, PAM_TTY, \"%s\") ==> %d (%s)\n",
 207                blurb(), tty, status, PAM_STRERROR(pamh, status));
 208   }
 209
 210   /* Try to authenticate as the current user.
 211    */
 212   PAM_NO_DELAY(pamh);
 213   status = pam_authenticate (pamh, 0);
 214   if (verbose_p)
 215     fprintf (stderr, "%s:   pam_authenticate (...) ==> %d (%s)\n",
 216              blurb(), status, PAM_STRERROR(pamh, status));
 217   if (status == PAM_SUCCESS)  /* Win! */
 218     goto DONE;
 219
 220   /* If that didn't work, set the user to root, and try to authenticate again.
 221    */
 222   c.user = "root";
 223   status = pam_set_item (pamh, PAM_USER, strdup(c.user));
 224   if (verbose_p)
 225     fprintf (stderr, "%s:   pam_set_item(p, PAM_USER, \"%s\") ==> %d (%s)\n",
 226              blurb(), c.user, status, PAM_STRERROR(pamh, status));
 227   if (status != PAM_SUCCESS) goto DONE;
 228
 229   PAM_NO_DELAY(pamh);
 230   status = pam_authenticate (pamh, 0);
 231   if (verbose_p)
 232     fprintf (stderr, "%s:   pam_authenticate (...) ==> %d (%s)\n",
 233              blurb(), status, PAM_STRERROR(pamh, status));
 234
 235  DONE:
 236   if (user) free (user);
 237   if (pamh)
 238     {
 239       int status2 = pam_end (pamh, status);
 240       pamh = 0;
 241       if (verbose_p)
 242         fprintf (stderr, "%s: pam_end (...) ==> %d (%s)\n",
 243                  blurb(), status2,
 244                  (status2 == PAM_SUCCESS ? "Success" : "Failure"));
 245     }
 246   return (status == PAM_SUCCESS ? True : False);
 247 }
 248
 249
 250 Bool
 251 pam_priv_init (int argc, char **argv, Bool verbose_p)
 252 {
 253   /* We have nothing to do at init-time.
 254      However, we might as well do some error checking.
 255      If "/etc/pam.d" exists and is a directory, but "/etc/pam.d/xlock"
 256      does not exist, warn that PAM probably isn't going to work.
 257
 258      This is a priv-init instead of a non-priv init in case the directory
 259      is unreadable or something (don't know if that actually happens.)
 260    */
 261   const char   dir[] = "/etc/pam.d";
 262   const char  file[] = "/etc/pam.d/" PAM_SERVICE_NAME;
 263   const char file2[] = "/etc/pam.conf";
 264   struct stat st;
 265
 266   if (stat (dir, &st) == 0 && st.st_mode & S_IFDIR)
 267     {
 268       if (stat (file, &st) != 0)
 269         fprintf (stderr,
 270                  "%s: warning: %s does not exist.\n"
 271                  "%s: password authentication via PAM is unlikely to work.\n",
 272                  blurb(), file, blurb());
 273     }
 274   else if (stat (file2, &st) == 0)
 275     {
 276       FILE *f = fopen (file2, "r");
 277       if (f)
 278         {
 279           Bool ok = False;
 280           char buf[255];
 281           while (fgets (buf, sizeof(buf), f))
 282             if (strstr (buf, PAM_SERVICE_NAME))
 283               {
 284                 ok = True;
 285                 break;
 286               }
 287           fclose (f);
 288           if (!ok)
 289             {
 290               fprintf (stderr,
 291                   "%s: warning: %s does not list the `%s' service.\n"
 292                   "%s: password authentication via PAM is unlikely to work.\n",
 293                        blurb(), file2, PAM_SERVICE_NAME, blurb());
 294             }
 295         }
 296       /* else warn about file2 existing but being unreadable? */
 297     }
 298   else
 299     {
 300       fprintf (stderr,
 301                "%s: warning: neither %s nor %s exist.\n"
 302                "%s: password authentication via PAM is unlikely to work.\n",
 303                blurb(), file2, file, blurb());
 304     }
 305
 306   /* Return true anyway, just in case. */
 307   return True;
 308 }
 309
 310
 311 /* This is the function PAM calls to have a conversation with the user.
 312    Really, this function should be the thing that pops up dialog boxes
 313    as needed, and prompts for various strings.
 314
 315    But, for now, xscreensaver uses its normal password-prompting dialog
 316    first, and then this function simply returns the result that has been
 317    typed.
 318
 319    This means that if PAM was using a retina scanner for auth, xscreensaver
 320    would prompt for a password; then pam_conversation() would be called
 321    with a string like "Please look into the retina scanner".  The user
 322    would never see this string, and the prompted-for password would be
 323    ignored.
 324  */
 325 static int
 326 pam_conversation (int nmsgs,
 327                   const struct pam_message **msg,
 328                   struct pam_response **resp,
 329                   void *closure)
 330 {
 331   int replies = 0;
 332   struct pam_response *reply = 0;
 333   struct pam_closure *c = (struct pam_closure *) closure;
 334
 335   /* On SunOS 5.6, the `closure' argument always comes in as random garbage. */
 336   c = (struct pam_closure *) suns_pam_implementation_blows;
 337
 338
 339   reply = (struct pam_response *) calloc (nmsgs, sizeof (*reply));
 340   if (!reply) return PAM_CONV_ERR;
 341
 342   for (replies = 0; replies < nmsgs; replies++)
 343     {
 344       switch (msg[replies]->msg_style)
 345         {
 346         case PAM_PROMPT_ECHO_ON:
 347           reply[replies].resp_retcode = PAM_SUCCESS;
 348           reply[replies].resp = strdup (c->user);          /* freed by PAM */
 349           if (c->verbose_p)
 350             fprintf (stderr, "%s:     PAM ECHO_ON(\"%s\") ==> \"%s\"\n",
 351                      blurb(), msg[replies]->msg,
 352                      reply[replies].resp);
 353           break;
 354         case PAM_PROMPT_ECHO_OFF:
 355           reply[replies].resp_retcode = PAM_SUCCESS;
 356           reply[replies].resp = strdup (c->typed_passwd);   /* freed by PAM */
 357           if (c->verbose_p)
 358             fprintf (stderr, "%s:     PAM ECHO_OFF(\"%s\") ==> password\n",
 359                      blurb(), msg[replies]->msg);
 360           break;
 361         case PAM_TEXT_INFO:
 362           /* ignore it... */
 363           reply[replies].resp_retcode = PAM_SUCCESS;
 364           reply[replies].resp = 0;
 365           if (c->verbose_p)
 366             fprintf (stderr, "%s:     PAM TEXT_INFO(\"%s\") ==> ignored\n",
 367                      blurb(), msg[replies]->msg);
 368           break;
 369         case PAM_ERROR_MSG:
 370           /* ignore it... */
 371           reply[replies].resp_retcode = PAM_SUCCESS;
 372           reply[replies].resp = 0;
 373           if (c->verbose_p)
 374             fprintf (stderr, "%s:     PAM ERROR_MSG(\"%s\") ==> ignored\n",
 375                      blurb(), msg[replies]->msg);
 376           break;
 377         default:
 378           /* Must be an error of some sort... */
 379           free (reply);
 380           if (c->verbose_p)
 381             fprintf (stderr, "%s:     PAM unknown %d(\"%s\") ==> ignored\n",
 382                      blurb(), msg[replies]->msg_style, msg[replies]->msg);
 383           return PAM_CONV_ERR;
 384         }
 385     }
 386   *resp = reply;
 387   return PAM_SUCCESS;
 388 }
 389
 390 #endif /* NO_LOCKING -- whole file */