openssh/auth.c

   1 /*
   2  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #include "includes.h"
  26 RCSID("$OpenBSD: auth.c,v 1.58 2005/03/14 11:44:42 dtucker Exp $");
  27
  28 #ifdef HAVE_LOGIN_H
  29 #include <login.h>
  30 #endif
  31 #ifdef USE_SHADOW
  32 #include <shadow.h>
  33 #endif
  34
  35 #ifdef HAVE_LIBGEN_H
  36 #include <libgen.h>
  37 #endif
  38
  39 #include "xmalloc.h"
  40 #include "match.h"
  41 #include "groupaccess.h"
  42 #include "log.h"
  43 #include "servconf.h"
  44 #include "auth.h"
  45 #include "auth-options.h"
  46 #include "canohost.h"
  47 #include "buffer.h"
  48 #include "bufaux.h"
  49 #include "uidswap.h"
  50 #include "misc.h"
  51 #include "bufaux.h"
  52 #include "packet.h"
  53 #include "loginrec.h"
  54 #include "monitor_wrap.h"
  55
  56 /* import */
  57 extern ServerOptions options;
  58 extern Buffer loginmsg;
  59
  60 /* Debugging messages */
  61 Buffer auth_debug;
  62 int auth_debug_init;
  63
  64 /*
  65  * Check if the user is allowed to log in via ssh. If user is listed
  66  * in DenyUsers or one of user's groups is listed in DenyGroups, false
  67  * will be returned. If AllowUsers isn't empty and user isn't listed
  68  * there, or if AllowGroups isn't empty and one of user's groups isn't
  69  * listed there, false will be returned.
  70  * If the user's shell is not executable, false will be returned.
  71  * Otherwise true is returned.
  72  */
  73 int
  74 allowed_user(struct passwd * pw)
  75 {
  76         struct stat st;
  77         const char *hostname = NULL, *ipaddr = NULL, *passwd = NULL;
  78         char *shell;
  79         int i;
  80 #ifdef USE_SHADOW
  81         struct spwd *spw = NULL;
  82 #endif
  83
  84         /* Shouldn't be called if pw is NULL, but better safe than sorry... */
  85         if (!pw || !pw->pw_name)
  86                 return 0;
  87
  88 #ifdef USE_SHADOW
  89         if (!options.use_pam)
  90                 spw = getspnam(pw->pw_name);
  91 #ifdef HAS_SHADOW_EXPIRE
  92         if (!options.use_pam && spw != NULL && auth_shadow_acctexpired(spw))
  93                 return 0;
  94 #endif /* HAS_SHADOW_EXPIRE */
  95 #endif /* USE_SHADOW */
  96
  97         /* grab passwd field for locked account check */
  98 #ifdef USE_SHADOW
  99         if (spw != NULL)
 100                 passwd = spw->sp_pwdp;
 101 #else
 102         passwd = pw->pw_passwd;
 103 #endif
 104
 105         /* check for locked account */
 106         if (!options.use_pam && passwd && *passwd) {
 107                 int locked = 0;
 108
 109 #ifdef LOCKED_PASSWD_STRING
 110                 if (strcmp(passwd, LOCKED_PASSWD_STRING) == 0)
 111                          locked = 1;
 112 #endif
 113 #ifdef LOCKED_PASSWD_PREFIX
 114                 if (strncmp(passwd, LOCKED_PASSWD_PREFIX,
 115                     strlen(LOCKED_PASSWD_PREFIX)) == 0)
 116                          locked = 1;
 117 #endif
 118 #ifdef LOCKED_PASSWD_SUBSTR
 119                 if (strstr(passwd, LOCKED_PASSWD_SUBSTR))
 120                         locked = 1;
 121 #endif
 122                 if (locked) {
 123                         logit("User %.100s not allowed because account is locked",
 124                             pw->pw_name);
 125                         return 0;
 126                 }
 127         }
 128
 129         /*
 130          * Get the shell from the password data.  An empty shell field is
 131          * legal, and means /bin/sh.
 132          */
 133         shell = (pw->pw_shell[0] == '\0') ? _PATH_BSHELL : pw->pw_shell;
 134
 135         /* deny if shell does not exists or is not executable */
 136         if (stat(shell, &st) != 0) {
 137                 logit("User %.100s not allowed because shell %.100s does not exist",
 138                     pw->pw_name, shell);
 139                 return 0;
 140         }
 141         if (S_ISREG(st.st_mode) == 0 ||
 142             (st.st_mode & (S_IXOTH|S_IXUSR|S_IXGRP)) == 0) {
 143                 logit("User %.100s not allowed because shell %.100s is not executable",
 144                     pw->pw_name, shell);
 145                 return 0;
 146         }
 147
 148         if (options.num_deny_users > 0 || options.num_allow_users > 0 ||
 149             options.num_deny_groups > 0 || options.num_allow_groups > 0) {
 150                 hostname = get_canonical_hostname(options.use_dns);
 151                 ipaddr = get_remote_ipaddr();
 152         }
 153
 154         /* Return false if user is listed in DenyUsers */
 155         if (options.num_deny_users > 0) {
 156                 for (i = 0; i < options.num_deny_users; i++)
 157                         if (match_user(pw->pw_name, hostname, ipaddr,
 158                             options.deny_users[i])) {
 159                                 logit("User %.100s from %.100s not allowed "
 160                                     "because listed in DenyUsers",
 161                                     pw->pw_name, hostname);
 162                                 return 0;
 163                         }
 164         }
 165         /* Return false if AllowUsers isn't empty and user isn't listed there */
 166         if (options.num_allow_users > 0) {
 167                 for (i = 0; i < options.num_allow_users; i++)
 168                         if (match_user(pw->pw_name, hostname, ipaddr,
 169                             options.allow_users[i]))
 170                                 break;
 171                 /* i < options.num_allow_users iff we break for loop */
 172                 if (i >= options.num_allow_users) {
 173                         logit("User %.100s from %.100s not allowed because "
 174                             "not listed in AllowUsers", pw->pw_name, hostname);
 175                         return 0;
 176                 }
 177         }
 178         if (options.num_deny_groups > 0 || options.num_allow_groups > 0) {
 179                 /* Get the user's group access list (primary and supplementary) */
 180                 if (ga_init(pw->pw_name, pw->pw_gid) == 0) {
 181                         logit("User %.100s from %.100s not allowed because "
 182                             "not in any group", pw->pw_name, hostname);
 183                         return 0;
 184                 }
 185
 186                 /* Return false if one of user's groups is listed in DenyGroups */
 187                 if (options.num_deny_groups > 0)
 188                         if (ga_match(options.deny_groups,
 189                             options.num_deny_groups)) {
 190                                 ga_free();
 191                                 logit("User %.100s from %.100s not allowed "
 192                                     "because a group is listed in DenyGroups",
 193                                     pw->pw_name, hostname);
 194                                 return 0;
 195                         }
 196                 /*
 197                  * Return false if AllowGroups isn't empty and one of user's groups
 198                  * isn't listed there
 199                  */
 200                 if (options.num_allow_groups > 0)
 201                         if (!ga_match(options.allow_groups,
 202                             options.num_allow_groups)) {
 203                                 ga_free();
 204                                 logit("User %.100s from %.100s not allowed "
 205                                     "because none of user's groups are listed "
 206                                     "in AllowGroups", pw->pw_name, hostname);
 207                                 return 0;
 208                         }
 209                 ga_free();
 210         }
 211
 212 #ifdef CUSTOM_SYS_AUTH_ALLOWED_USER
 213         if (!sys_auth_allowed_user(pw, &loginmsg))
 214                 return 0;
 215 #endif
 216
 217         /* We found no reason not to let this user try to log on... */
 218         return 1;
 219 }
 220
 221 void
 222 auth_log(Authctxt *authctxt, int authenticated, char *method, char *info)
 223 {
 224         void (*authlog) (const char *fmt,...) = verbose;
 225         char *authmsg;
 226
 227         /* Raise logging level */
 228         if (authenticated == 1 ||
 229             !authctxt->valid ||
 230             authctxt->failures >= options.max_authtries / 2 ||
 231             strcmp(method, "password") == 0)
 232                 authlog = logit;
 233
 234         if (authctxt->postponed)
 235                 authmsg = "Postponed";
 236         else
 237                 authmsg = authenticated ? "Accepted" : "Failed";
 238
 239         authlog("%s %s for %s%.100s from %.200s port %d%s",
 240             authmsg,
 241             method,
 242             authctxt->valid ? "" : "invalid user ",
 243             (authctxt->user && authctxt->user[0]) ?
 244                 authctxt->user : "<implicit>",
 245             get_remote_ipaddr(),
 246             get_remote_port(),
 247             info);
 248
 249 #ifdef CUSTOM_FAILED_LOGIN
 250         if (authenticated == 0 && !authctxt->postponed &&
 251             (strcmp(method, "password") == 0 ||
 252             strncmp(method, "keyboard-interactive", 20) == 0 ||
 253             strcmp(method, "challenge-response") == 0))
 254                 record_failed_login(authctxt->user,
 255                     get_canonical_hostname(options.use_dns), "ssh");
 256 #endif
 257 #ifdef SSH_AUDIT_EVENTS
 258         if (authenticated == 0 && !authctxt->postponed) {
 259                 ssh_audit_event_t event;
 260
 261                 debug3("audit failed auth attempt, method %s euid %d",
 262                     method, (int)geteuid());
 263                 /*
 264                  * Because the auth loop is used in both monitor and slave,
 265                  * we must be careful to send each event only once and with
 266                  * enough privs to write the event.
 267                  */
 268                 event = audit_classify_auth(method);
 269                 switch(event) {
 270                 case SSH_AUTH_FAIL_NONE:
 271                 case SSH_AUTH_FAIL_PASSWD:
 272                 case SSH_AUTH_FAIL_KBDINT:
 273                         if (geteuid() == 0)
 274                                 audit_event(event);
 275                         break;
 276                 case SSH_AUTH_FAIL_PUBKEY:
 277                 case SSH_AUTH_FAIL_HOSTBASED:
 278                 case SSH_AUTH_FAIL_GSSAPI:
 279                         /*
 280                          * This is required to handle the case where privsep
 281                          * is enabled but it's root logging in, since
 282                          * use_privsep won't be cleared until after a
 283                          * successful login.
 284                          */
 285                         if (geteuid() == 0)
 286                                 audit_event(event);
 287                         else
 288                                 PRIVSEP(audit_event(event));
 289                         break;
 290                 default:
 291                         error("unknown authentication audit event %d", event);
 292                 }
 293         }
 294 #endif
 295 }
 296
 297 /*
 298  * Check whether root logins are disallowed.
 299  */
 300 int
 301 auth_root_allowed(char *method)
 302 {
 303         switch (options.permit_root_login) {
 304         case PERMIT_YES:
 305                 return 1;
 306                 break;
 307         case PERMIT_NO_PASSWD:
 308                 if (strcmp(method, "password") != 0)
 309                         return 1;
 310                 break;
 311         case PERMIT_FORCED_ONLY:
 312                 if (forced_command) {
 313                         logit("Root login accepted for forced command.");
 314                         return 1;
 315                 }
 316                 break;
 317         }
 318         logit("ROOT LOGIN REFUSED FROM %.200s", get_remote_ipaddr());
 319         return 0;
 320 }
 321
 322
 323 /*
 324  * Given a template and a passwd structure, build a filename
 325  * by substituting % tokenised options. Currently, %% becomes '%',
 326  * %h becomes the home directory and %u the username.
 327  *
 328  * This returns a buffer allocated by xmalloc.
 329  */
 330 char *
 331 expand_filename(const char *filename, struct passwd *pw)
 332 {
 333         Buffer buffer;
 334         char *file;
 335         const char *cp;
 336
 337         /*
 338          * Build the filename string in the buffer by making the appropriate
 339          * substitutions to the given file name.
 340          */
 341         buffer_init(&buffer);
 342         for (cp = filename; *cp; cp++) {
 343                 if (cp[0] == '%' && cp[1] == '%') {
 344                         buffer_append(&buffer, "%", 1);
 345                         cp++;
 346                         continue;
 347                 }
 348                 if (cp[0] == '%' && cp[1] == 'h') {
 349                         buffer_append(&buffer, pw->pw_dir, strlen(pw->pw_dir));
 350                         cp++;
 351                         continue;
 352                 }
 353                 if (cp[0] == '%' && cp[1] == 'u') {
 354                         buffer_append(&buffer, pw->pw_name,
 355                             strlen(pw->pw_name));
 356                         cp++;
 357                         continue;
 358                 }
 359                 buffer_append(&buffer, cp, 1);
 360         }
 361         buffer_append(&buffer, "\0", 1);
 362
 363         /*
 364          * Ensure that filename starts anchored. If not, be backward
 365          * compatible and prepend the '%h/'
 366          */
 367         file = xmalloc(MAXPATHLEN);
 368         cp = buffer_ptr(&buffer);
 369         if (*cp != '/')
 370                 snprintf(file, MAXPATHLEN, "%s/%s", pw->pw_dir, cp);
 371         else
 372                 strlcpy(file, cp, MAXPATHLEN);
 373
 374         buffer_free(&buffer);
 375         return file;
 376 }
 377
 378 char *
 379 authorized_keys_file(struct passwd *pw)
 380 {
 381         return expand_filename(options.authorized_keys_file, pw);
 382 }
 383
 384 char *
 385 authorized_keys_file2(struct passwd *pw)
 386 {
 387         return expand_filename(options.authorized_keys_file2, pw);
 388 }
 389
 390 /* return ok if key exists in sysfile or userfile */
 391 HostStatus
 392 check_key_in_hostfiles(struct passwd *pw, Key *key, const char *host,
 393     const char *sysfile, const char *userfile)
 394 {
 395         Key *found;
 396         char *user_hostfile;
 397         struct stat st;
 398         HostStatus host_status;
 399
 400         /* Check if we know the host and its host key. */
 401         found = key_new(key->type);
 402         host_status = check_host_in_hostfile(sysfile, host, key, found, NULL);
 403
 404         if (host_status != HOST_OK && userfile != NULL) {
 405                 user_hostfile = tilde_expand_filename(userfile, pw->pw_uid);
 406                 if (options.strict_modes &&
 407                     (stat(user_hostfile, &st) == 0) &&
 408                     ((st.st_uid != 0 && st.st_uid != pw->pw_uid) ||
 409                     (st.st_mode & 022) != 0)) {
 410                         logit("Authentication refused for %.100s: "
 411                             "bad owner or modes for %.200s",
 412                             pw->pw_name, user_hostfile);
 413                 } else {
 414                         temporarily_use_uid(pw);
 415                         host_status = check_host_in_hostfile(user_hostfile,
 416                             host, key, found, NULL);
 417                         restore_uid();
 418                 }
 419                 xfree(user_hostfile);
 420         }
 421         key_free(found);
 422
 423         debug2("check_key_in_hostfiles: key %s for %s", host_status == HOST_OK ?
 424             "ok" : "not found", host);
 425         return host_status;
 426 }
 427
 428
 429 /*
 430  * Check a given file for security. This is defined as all components
 431  * of the path to the file must be owned by either the owner of
 432  * of the file or root and no directories must be group or world writable.
 433  *
 434  * XXX Should any specific check be done for sym links ?
 435  *
 436  * Takes an open file descriptor, the file name, a uid and and
 437  * error buffer plus max size as arguments.
 438  *
 439  * Returns 0 on success and -1 on failure
 440  */
 441 int
 442 secure_filename(FILE *f, const char *file, struct passwd *pw,
 443     char *err, size_t errlen)
 444 {
 445         uid_t uid = pw->pw_uid;
 446         char buf[MAXPATHLEN], homedir[MAXPATHLEN];
 447         char *cp;
 448         int comparehome = 0;
 449         struct stat st;
 450
 451         if (realpath(file, buf) == NULL) {
 452                 snprintf(err, errlen, "realpath %s failed: %s", file,
 453                     strerror(errno));
 454                 return -1;
 455         }
 456         if (realpath(pw->pw_dir, homedir) != NULL)
 457                 comparehome = 1;
 458
 459         /* check the open file to avoid races */
 460         if (fstat(fileno(f), &st) < 0 ||
 461             (st.st_uid != 0 && st.st_uid != uid) ||
 462             (st.st_mode & 022) != 0) {
 463                 snprintf(err, errlen, "bad ownership or modes for file %s",
 464                     buf);
 465                 return -1;
 466         }
 467
 468         /* for each component of the canonical path, walking upwards */
 469         for (;;) {
 470                 if ((cp = dirname(buf)) == NULL) {
 471                         snprintf(err, errlen, "dirname() failed");
 472                         return -1;
 473                 }
 474                 strlcpy(buf, cp, sizeof(buf));
 475
 476                 debug3("secure_filename: checking '%s'", buf);
 477                 if (stat(buf, &st) < 0 ||
 478                     (st.st_uid != 0 && st.st_uid != uid) ||
 479                     (st.st_mode & 022) != 0) {
 480                         snprintf(err, errlen,
 481                             "bad ownership or modes for directory %s", buf);
 482                         return -1;
 483                 }
 484
 485                 /* If are passed the homedir then we can stop */
 486                 if (comparehome && strcmp(homedir, buf) == 0) {
 487                         debug3("secure_filename: terminating check at '%s'",
 488                             buf);
 489                         break;
 490                 }
 491                 /*
 492                  * dirname should always complete with a "/" path,
 493                  * but we can be paranoid and check for "." too
 494                  */
 495                 if ((strcmp("/", buf) == 0) || (strcmp(".", buf) == 0))
 496                         break;
 497         }
 498         return 0;
 499 }
 500
 501 struct passwd *
 502 getpwnamallow(const char *user)
 503 {
 504 #ifdef HAVE_LOGIN_CAP
 505         extern login_cap_t *lc;
 506 #ifdef BSD_AUTH
 507         auth_session_t *as;
 508 #endif
 509 #endif
 510         struct passwd *pw;
 511
 512         pw = getpwnam(user);
 513         if (pw == NULL) {
 514                 logit("Invalid user %.100s from %.100s",
 515                       (user && user[0]) ? user : "<implicit>",
 516                       get_remote_ipaddr());
 517 #ifdef CUSTOM_FAILED_LOGIN
 518                 record_failed_login(user,
 519                     get_canonical_hostname(options.use_dns), "ssh");
 520 #endif
 521 #ifdef SSH_AUDIT_EVENTS
 522                 audit_event(SSH_INVALID_USER);
 523 #endif /* SSH_AUDIT_EVENTS */
 524                 return (NULL);
 525         }
 526         if (!allowed_user(pw))
 527                 return (NULL);
 528 #ifdef HAVE_LOGIN_CAP
 529         if ((lc = login_getclass(pw->pw_class)) == NULL) {
 530                 debug("unable to get login class: %s", user);
 531                 return (NULL);
 532         }
 533 #ifdef BSD_AUTH
 534         if ((as = auth_open()) == NULL || auth_setpwd(as, pw) != 0 ||
 535             auth_approval(as, lc, pw->pw_name, "ssh") <= 0) {
 536                 debug("Approval failure for %s", user);
 537                 pw = NULL;
 538         }
 539         if (as != NULL)
 540                 auth_close(as);
 541 #endif
 542 #endif
 543         if (pw != NULL)
 544                 return (pwcopy(pw));
 545         return (NULL);
 546 }
 547
 548 void
 549 auth_debug_add(const char *fmt,...)
 550 {
 551         char buf[1024];
 552         va_list args;
 553
 554         if (!auth_debug_init)
 555                 return;
 556
 557         va_start(args, fmt);
 558         vsnprintf(buf, sizeof(buf), fmt, args);
 559         va_end(args);
 560         buffer_put_cstring(&auth_debug, buf);
 561 }
 562
 563 void
 564 auth_debug_send(void)
 565 {
 566         char *msg;
 567
 568         if (!auth_debug_init)
 569                 return;
 570         while (buffer_len(&auth_debug)) {
 571                 msg = buffer_get_string(&auth_debug, NULL);
 572                 packet_send_debug("%s", msg);
 573                 xfree(msg);
 574         }
 575 }
 576
 577 void
 578 auth_debug_reset(void)
 579 {
 580         if (auth_debug_init)
 581                 buffer_clear(&auth_debug);
 582         else {
 583                 buffer_init(&auth_debug);
 584                 auth_debug_init = 1;
 585         }
 586 }
 587
 588 struct passwd *
 589 fakepw(void)
 590 {
 591         static struct passwd fake;
 592
 593         memset(&fake, 0, sizeof(fake));
 594         fake.pw_name = "NOUSER";
 595         fake.pw_passwd =
 596             "$2a$06$r3.juUaHZDlIbQaO2dS9FuYxL1W9M81R1Tc92PoSNmzvpEqLkLGrK";
 597         fake.pw_gecos = "NOUSER";
 598         fake.pw_uid = (uid_t)-1;
 599         fake.pw_gid = (gid_t)-1;
 600 #ifdef HAVE_PW_CLASS_IN_PASSWD
 601         fake.pw_class = "";
 602 #endif
 603         fake.pw_dir = "/nonexist";
 604         fake.pw_shell = "/nonexist";
 605
 606         return (&fake);
 607 }