nsswitch/pam_winbind.c

   1 /* pam_winbind module
   2
   3    Copyright Andrew Tridgell <tridge@samba.org> 2000
   4    Copyright Tim Potter <tpot@samba.org> 2000
   5    Copyright Andrew Bartlett <abartlet@samba.org> 2002
   6    Copyright Guenther Deschner <gd@samba.org> 2005-2008
   7
   8    largely based on pam_userdb by Cristian Gafton <gafton@redhat.com> also
   9    contains large slabs of code from pam_unix by Elliot Lee
  10    <sopwith@redhat.com> (see copyright below for full details)
  11 */
  12
  13 #include "pam_winbind.h"
  14 #define CONST_DISCARD(type,ptr) ((type)(void *)ptr)
  15
  16
  17 static int wbc_error_to_pam_error(wbcErr status)
  18 {
  19         switch (status) {
  20                 case WBC_ERR_SUCCESS:
  21                         return PAM_SUCCESS;
  22                 case WBC_ERR_NOT_IMPLEMENTED:
  23                         return PAM_SERVICE_ERR;
  24                 case WBC_ERR_UNKNOWN_FAILURE:
  25                         break;
  26                 case WBC_ERR_NO_MEMORY:
  27                         return PAM_BUF_ERR;
  28                 case WBC_ERR_INVALID_SID:
  29                 case WBC_ERR_INVALID_PARAM:
  30                         break;
  31                 case WBC_ERR_WINBIND_NOT_AVAILABLE:
  32                         return PAM_AUTHINFO_UNAVAIL;
  33                 case WBC_ERR_DOMAIN_NOT_FOUND:
  34                         return PAM_AUTHINFO_UNAVAIL;
  35                 case WBC_ERR_INVALID_RESPONSE:
  36                         return PAM_BUF_ERR;
  37                 case WBC_ERR_NSS_ERROR:
  38                         return PAM_USER_UNKNOWN;
  39                 case WBC_ERR_AUTH_ERROR:
  40                         return PAM_AUTH_ERR;
  41                 case WBC_ERR_UNKNOWN_USER:
  42                         return PAM_USER_UNKNOWN;
  43                 case WBC_ERR_UNKNOWN_GROUP:
  44                         return PAM_USER_UNKNOWN;
  45                 case WBC_ERR_PWD_CHANGE_FAILED:
  46                         break;
  47         }
  48
  49         /* be paranoid */
  50         return PAM_AUTH_ERR;
  51 }
  52
  53 static const char *_pam_error_code_str(int err)
  54 {
  55         switch (err) {
  56                 case PAM_SUCCESS:
  57                         return "PAM_SUCCESS";
  58                 case PAM_OPEN_ERR:
  59                         return "PAM_OPEN_ERR";
  60                 case PAM_SYMBOL_ERR:
  61                         return "PAM_SYMBOL_ERR";
  62                 case PAM_SERVICE_ERR:
  63                         return "PAM_SERVICE_ERR";
  64                 case PAM_SYSTEM_ERR:
  65                         return "PAM_SYSTEM_ERR";
  66                 case PAM_BUF_ERR:
  67                         return "PAM_BUF_ERR";
  68                 case PAM_PERM_DENIED:
  69                         return "PAM_PERM_DENIED";
  70                 case PAM_AUTH_ERR:
  71                         return "PAM_AUTH_ERR";
  72                 case PAM_CRED_INSUFFICIENT:
  73                         return "PAM_CRED_INSUFFICIENT";
  74                 case PAM_AUTHINFO_UNAVAIL:
  75                         return "PAM_AUTHINFO_UNAVAIL";
  76                 case PAM_USER_UNKNOWN:
  77                         return "PAM_USER_UNKNOWN";
  78                 case PAM_MAXTRIES:
  79                         return "PAM_MAXTRIES";
  80                 case PAM_NEW_AUTHTOK_REQD:
  81                         return "PAM_NEW_AUTHTOK_REQD";
  82                 case PAM_ACCT_EXPIRED:
  83                         return "PAM_ACCT_EXPIRED";
  84                 case PAM_SESSION_ERR:
  85                         return "PAM_SESSION_ERR";
  86                 case PAM_CRED_UNAVAIL:
  87                         return "PAM_CRED_UNAVAIL";
  88                 case PAM_CRED_EXPIRED:
  89                         return "PAM_CRED_EXPIRED";
  90                 case PAM_CRED_ERR:
  91                         return "PAM_CRED_ERR";
  92                 case PAM_NO_MODULE_DATA:
  93                         return "PAM_NO_MODULE_DATA";
  94                 case PAM_CONV_ERR:
  95                         return "PAM_CONV_ERR";
  96                 case PAM_AUTHTOK_ERR:
  97                         return "PAM_AUTHTOK_ERR";
  98                 case PAM_AUTHTOK_RECOVER_ERR:
  99                         return "PAM_AUTHTOK_RECOVER_ERR";
 100                 case PAM_AUTHTOK_LOCK_BUSY:
 101                         return "PAM_AUTHTOK_LOCK_BUSY";
 102                 case PAM_AUTHTOK_DISABLE_AGING:
 103                         return "PAM_AUTHTOK_DISABLE_AGING";
 104                 case PAM_TRY_AGAIN:
 105                         return "PAM_TRY_AGAIN";
 106                 case PAM_IGNORE:
 107                         return "PAM_IGNORE";
 108                 case PAM_ABORT:
 109                         return "PAM_ABORT";
 110                 case PAM_AUTHTOK_EXPIRED:
 111                         return "PAM_AUTHTOK_EXPIRED";
 112 #ifdef PAM_MODULE_UNKNOWN
 113                 case PAM_MODULE_UNKNOWN:
 114                         return "PAM_MODULE_UNKNOWN";
 115 #endif
 116 #ifdef PAM_BAD_ITEM
 117                 case PAM_BAD_ITEM:
 118                         return "PAM_BAD_ITEM";
 119 #endif
 120 #ifdef PAM_CONV_AGAIN
 121                 case PAM_CONV_AGAIN:
 122                         return "PAM_CONV_AGAIN";
 123 #endif
 124 #ifdef PAM_INCOMPLETE
 125                 case PAM_INCOMPLETE:
 126                         return "PAM_INCOMPLETE";
 127 #endif
 128                 default:
 129                         return NULL;
 130         }
 131 }
 132
 133 #define _PAM_LOG_FUNCTION_ENTER(function, ctx) \
 134         do { \
 135                 _pam_log_debug(ctx, LOG_DEBUG, "[pamh: %p] ENTER: " \
 136                                function " (flags: 0x%04x)", ctx->pamh, ctx->flags); \
 137                 _pam_log_state(ctx); \
 138         } while (0)
 139
 140 #define _PAM_LOG_FUNCTION_LEAVE(function, ctx, retval) \
 141         do { \
 142                 _pam_log_debug(ctx, LOG_DEBUG, "[pamh: %p] LEAVE: " \
 143                                function " returning %d (%s)", ctx->pamh, retval, \
 144                                _pam_error_code_str(retval)); \
 145                 _pam_log_state(ctx); \
 146         } while (0)
 147
 148 /* data tokens */
 149
 150 #define MAX_PASSWD_TRIES        3
 151
 152 #ifdef HAVE_GETTEXT
 153 static char initialized = 0;
 154
 155 static inline void textdomain_init(void);
 156 static inline void textdomain_init(void)
 157 {
 158         if (!initialized) {
 159                 bindtextdomain(MODULE_NAME, dyn_LOCALEDIR);
 160                 initialized = 1;
 161         }
 162         return;
 163 }
 164 #endif
 165
 166
 167 /*
 168  * Work around the pam API that has functions with void ** as parameters
 169  * These lead to strict aliasing warnings with gcc.
 170  */
 171 static int _pam_get_item(const pam_handle_t *pamh,
 172                          int item_type,
 173                          const void *_item)
 174 {
 175         const void **item = (const void **)_item;
 176         return pam_get_item(pamh, item_type, item);
 177 }
 178 static int _pam_get_data(const pam_handle_t *pamh,
 179                          const char *module_data_name,
 180                          const void *_data)
 181 {
 182         const void **data = (const void **)_data;
 183         return pam_get_data(pamh, module_data_name, data);
 184 }
 185
 186 /* some syslogging */
 187
 188 #ifdef HAVE_PAM_VSYSLOG
 189 static void _pam_log_int(const pam_handle_t *pamh,
 190                          int err,
 191                          const char *format,
 192                          va_list args)
 193 {
 194         pam_vsyslog(pamh, err, format, args);
 195 }
 196 #else
 197 static void _pam_log_int(const pam_handle_t *pamh,
 198                          int err,
 199                          const char *format,
 200                          va_list args)
 201 {
 202         char *format2 = NULL;
 203         const char *service;
 204
 205         _pam_get_item(pamh, PAM_SERVICE, &service);
 206
 207         format2 = (char *)malloc(strlen(MODULE_NAME)+strlen(format)+strlen(service)+5);
 208         if (format2 == NULL) {
 209                 /* what else todo ? */
 210                 vsyslog(err, format, args);
 211                 return;
 212         }
 213
 214         sprintf(format2, "%s(%s): %s", MODULE_NAME, service, format);
 215         vsyslog(err, format2, args);
 216         SAFE_FREE(format2);
 217 }
 218 #endif /* HAVE_PAM_VSYSLOG */
 219
 220 static bool _pam_log_is_silent(int ctrl)
 221 {
 222         return on(ctrl, WINBIND_SILENT);
 223 }
 224
 225 static void _pam_log(struct pwb_context *r, int err, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 226 static void _pam_log(struct pwb_context *r, int err, const char *format, ...)
 227 {
 228         va_list args;
 229
 230         if (_pam_log_is_silent(r->ctrl)) {
 231                 return;
 232         }
 233
 234         va_start(args, format);
 235         _pam_log_int(r->pamh, err, format, args);
 236         va_end(args);
 237 }
 238 static void __pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
 239 static void __pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
 240 {
 241         va_list args;
 242
 243         if (_pam_log_is_silent(ctrl)) {
 244                 return;
 245         }
 246
 247         va_start(args, format);
 248         _pam_log_int(pamh, err, format, args);
 249         va_end(args);
 250 }
 251
 252 static bool _pam_log_is_debug_enabled(int ctrl)
 253 {
 254         if (ctrl == -1) {
 255                 return false;
 256         }
 257
 258         if (_pam_log_is_silent(ctrl)) {
 259                 return false;
 260         }
 261
 262         if (!(ctrl & WINBIND_DEBUG_ARG)) {
 263                 return false;
 264         }
 265
 266         return true;
 267 }
 268
 269 static bool _pam_log_is_debug_state_enabled(int ctrl)
 270 {
 271         if (!(ctrl & WINBIND_DEBUG_STATE)) {
 272                 return false;
 273         }
 274
 275         return _pam_log_is_debug_enabled(ctrl);
 276 }
 277
 278 static void _pam_log_debug(struct pwb_context *r, int err, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 279 static void _pam_log_debug(struct pwb_context *r, int err, const char *format, ...)
 280 {
 281         va_list args;
 282
 283         if (!_pam_log_is_debug_enabled(r->ctrl)) {
 284                 return;
 285         }
 286
 287         va_start(args, format);
 288         _pam_log_int(r->pamh, err, format, args);
 289         va_end(args);
 290 }
 291 static void __pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
 292 static void __pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
 293 {
 294         va_list args;
 295
 296         if (!_pam_log_is_debug_enabled(ctrl)) {
 297                 return;
 298         }
 299
 300         va_start(args, format);
 301         _pam_log_int(pamh, err, format, args);
 302         va_end(args);
 303 }
 304
 305 static void _pam_log_state_datum(struct pwb_context *ctx,
 306                                  int item_type,
 307                                  const char *key,
 308                                  int is_string)
 309 {
 310         const void *data = NULL;
 311         if (item_type != 0) {
 312                 pam_get_item(ctx->pamh, item_type, &data);
 313         } else {
 314                 pam_get_data(ctx->pamh, key, &data);
 315         }
 316         if (data != NULL) {
 317                 const char *type = (item_type != 0) ? "ITEM" : "DATA";
 318                 if (is_string != 0) {
 319                         _pam_log_debug(ctx, LOG_DEBUG,
 320                                        "[pamh: %p] STATE: %s(%s) = \"%s\" (%p)",
 321                                        ctx->pamh, type, key, (const char *)data,
 322                                        data);
 323                 } else {
 324                         _pam_log_debug(ctx, LOG_DEBUG,
 325                                        "[pamh: %p] STATE: %s(%s) = %p",
 326                                        ctx->pamh, type, key, data);
 327                 }
 328         }
 329 }
 330
 331 #define _PAM_LOG_STATE_DATA_POINTER(ctx, module_data_name) \
 332         _pam_log_state_datum(ctx, 0, module_data_name, 0)
 333
 334 #define _PAM_LOG_STATE_DATA_STRING(ctx, module_data_name) \
 335         _pam_log_state_datum(ctx, 0, module_data_name, 1)
 336
 337 #define _PAM_LOG_STATE_ITEM_POINTER(ctx, item_type) \
 338         _pam_log_state_datum(ctx, item_type, #item_type, 0)
 339
 340 #define _PAM_LOG_STATE_ITEM_STRING(ctx, item_type) \
 341         _pam_log_state_datum(ctx, item_type, #item_type, 1)
 342
 343 #ifdef DEBUG_PASSWORD
 344 #define _LOG_PASSWORD_AS_STRING 1
 345 #else
 346 #define _LOG_PASSWORD_AS_STRING 0
 347 #endif
 348
 349 #define _PAM_LOG_STATE_ITEM_PASSWORD(ctx, item_type) \
 350         _pam_log_state_datum(ctx, item_type, #item_type, \
 351                              _LOG_PASSWORD_AS_STRING)
 352
 353 static void _pam_log_state(struct pwb_context *ctx)
 354 {
 355         if (!_pam_log_is_debug_state_enabled(ctx->ctrl)) {
 356                 return;
 357         }
 358
 359         _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_SERVICE);
 360         _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_USER);
 361         _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_TTY);
 362         _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_RHOST);
 363         _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_RUSER);
 364         _PAM_LOG_STATE_ITEM_PASSWORD(ctx, PAM_OLDAUTHTOK);
 365         _PAM_LOG_STATE_ITEM_PASSWORD(ctx, PAM_AUTHTOK);
 366         _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_USER_PROMPT);
 367         _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_CONV);
 368 #ifdef PAM_FAIL_DELAY
 369         _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_FAIL_DELAY);
 370 #endif
 371 #ifdef PAM_REPOSITORY
 372         _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_REPOSITORY);
 373 #endif
 374
 375         _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_HOMEDIR);
 376         _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_LOGONSCRIPT);
 377         _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_LOGONSERVER);
 378         _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_PROFILEPATH);
 379         _PAM_LOG_STATE_DATA_STRING(ctx,
 380                                    PAM_WINBIND_NEW_AUTHTOK_REQD);
 381                                    /* Use atoi to get PAM result code */
 382         _PAM_LOG_STATE_DATA_STRING(ctx,
 383                                    PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH);
 384         _PAM_LOG_STATE_DATA_POINTER(ctx, PAM_WINBIND_PWD_LAST_SET);
 385 }
 386
 387 static int _pam_parse(const pam_handle_t *pamh,
 388                       int flags,
 389                       int argc,
 390                       const char **argv,
 391                       dictionary **result_d)
 392 {
 393         int ctrl = 0;
 394         const char *config_file = NULL;
 395         int i;
 396         const char **v;
 397         dictionary *d = NULL;
 398
 399         if (flags & PAM_SILENT) {
 400                 ctrl |= WINBIND_SILENT;
 401         }
 402
 403         for (i=argc,v=argv; i-- > 0; ++v) {
 404                 if (!strncasecmp(*v, "config", strlen("config"))) {
 405                         ctrl |= WINBIND_CONFIG_FILE;
 406                         config_file = v[i];
 407                         break;
 408                 }
 409         }
 410
 411         if (config_file == NULL) {
 412                 config_file = PAM_WINBIND_CONFIG_FILE;
 413         }
 414
 415         d = iniparser_load(CONST_DISCARD(char *, config_file));
 416         if (d == NULL) {
 417                 goto config_from_pam;
 418         }
 419
 420         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:debug"), false)) {
 421                 ctrl |= WINBIND_DEBUG_ARG;
 422         }
 423
 424         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:debug_state"), false)) {
 425                 ctrl |= WINBIND_DEBUG_STATE;
 426         }
 427
 428         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:cached_login"), false)) {
 429                 ctrl |= WINBIND_CACHED_LOGIN;
 430         }
 431
 432         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:krb5_auth"), false)) {
 433                 ctrl |= WINBIND_KRB5_AUTH;
 434         }
 435
 436         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:silent"), false)) {
 437                 ctrl |= WINBIND_SILENT;
 438         }
 439
 440         if (iniparser_getstr(d, CONST_DISCARD(char *, "global:krb5_ccache_type")) != NULL) {
 441                 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
 442         }
 443
 444         if ((iniparser_getstr(d, CONST_DISCARD(char *, "global:require-membership-of"))
 445              != NULL) ||
 446             (iniparser_getstr(d, CONST_DISCARD(char *, "global:require_membership_of"))
 447              != NULL)) {
 448                 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
 449         }
 450
 451         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:try_first_pass"), false)) {
 452                 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
 453         }
 454
 455         if (iniparser_getint(d, CONST_DISCARD(char *, "global:warn_pwd_expire"), 0)) {
 456                 ctrl |= WINBIND_WARN_PWD_EXPIRE;
 457         }
 458
 459         if (iniparser_getboolean(d, CONST_DISCARD(char *, "global:mkhomedir"), false)) {
 460                 ctrl |= WINBIND_MKHOMEDIR;
 461         }
 462
 463 config_from_pam:
 464         /* step through arguments */
 465         for (i=argc,v=argv; i-- > 0; ++v) {
 466
 467                 /* generic options */
 468                 if (!strcmp(*v,"debug"))
 469                         ctrl |= WINBIND_DEBUG_ARG;
 470                 else if (!strcasecmp(*v, "debug_state"))
 471                         ctrl |= WINBIND_DEBUG_STATE;
 472                 else if (!strcasecmp(*v, "silent"))
 473                         ctrl |= WINBIND_SILENT;
 474                 else if (!strcasecmp(*v, "use_authtok"))
 475                         ctrl |= WINBIND_USE_AUTHTOK_ARG;
 476                 else if (!strcasecmp(*v, "use_first_pass"))
 477                         ctrl |= WINBIND_USE_FIRST_PASS_ARG;
 478                 else if (!strcasecmp(*v, "try_first_pass"))
 479                         ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
 480                 else if (!strcasecmp(*v, "unknown_ok"))
 481                         ctrl |= WINBIND_UNKNOWN_OK_ARG;
 482                 else if (!strncasecmp(*v, "require_membership_of",
 483                                       strlen("require_membership_of")))
 484                         ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
 485                 else if (!strncasecmp(*v, "require-membership-of",
 486                                       strlen("require-membership-of")))
 487                         ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
 488                 else if (!strcasecmp(*v, "krb5_auth"))
 489                         ctrl |= WINBIND_KRB5_AUTH;
 490                 else if (!strncasecmp(*v, "krb5_ccache_type",
 491                                       strlen("krb5_ccache_type")))
 492                         ctrl |= WINBIND_KRB5_CCACHE_TYPE;
 493                 else if (!strcasecmp(*v, "cached_login"))
 494                         ctrl |= WINBIND_CACHED_LOGIN;
 495                 else if (!strcasecmp(*v, "mkhomedir"))
 496                         ctrl |= WINBIND_MKHOMEDIR;
 497                 else {
 498                         __pam_log(pamh, ctrl, LOG_ERR,
 499                                  "pam_parse: unknown option: %s", *v);
 500                         return -1;
 501                 }
 502
 503         }
 504
 505         if (result_d) {
 506                 *result_d = d;
 507         } else {
 508                 if (d) {
 509                         iniparser_freedict(d);
 510                 }
 511         }
 512
 513         return ctrl;
 514 };
 515
 516 static int _pam_winbind_free_context(struct pwb_context *ctx)
 517 {
 518         if (!ctx) {
 519                 return 0;
 520         }
 521
 522         if (ctx->dict) {
 523                 iniparser_freedict(ctx->dict);
 524         }
 525
 526         return 0;
 527 }
 528
 529 static int _pam_winbind_init_context(pam_handle_t *pamh,
 530                                      int flags,
 531                                      int argc,
 532                                      const char **argv,
 533                                      struct pwb_context **ctx_p)
 534 {
 535         struct pwb_context *r = NULL;
 536
 537 #ifdef HAVE_GETTEXT
 538         textdomain_init();
 539 #endif
 540
 541         r = TALLOC_ZERO_P(NULL, struct pwb_context);
 542         if (!r) {
 543                 return PAM_BUF_ERR;
 544         }
 545
 546         talloc_set_destructor(r, _pam_winbind_free_context);
 547
 548         r->pamh = pamh;
 549         r->flags = flags;
 550         r->argc = argc;
 551         r->argv = argv;
 552         r->ctrl = _pam_parse(pamh, flags, argc, argv, &r->dict);
 553         if (r->ctrl == -1) {
 554                 TALLOC_FREE(r);
 555                 return PAM_SYSTEM_ERR;
 556         }
 557
 558         *ctx_p = r;
 559
 560         return PAM_SUCCESS;
 561 }
 562
 563 static void _pam_winbind_cleanup_func(pam_handle_t *pamh,
 564                                       void *data,
 565                                       int error_status)
 566 {
 567         int ctrl = _pam_parse(pamh, 0, 0, NULL, NULL);
 568         if (_pam_log_is_debug_state_enabled(ctrl)) {
 569                 __pam_log_debug(pamh, ctrl, LOG_DEBUG,
 570                                "[pamh: %p] CLEAN: cleaning up PAM data %p "
 571                                "(error_status = %d)", pamh, data,
 572                                error_status);
 573         }
 574         TALLOC_FREE(data);
 575 }
 576
 577
 578 static const struct ntstatus_errors {
 579         const char *ntstatus_string;
 580         const char *error_string;
 581 } ntstatus_errors[] = {
 582         {"NT_STATUS_OK",
 583                 N_("Success")},
 584         {"NT_STATUS_BACKUP_CONTROLLER",
 585                 N_("No primary Domain Controler available")},
 586         {"NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
 587                 N_("No domain controllers found")},
 588         {"NT_STATUS_NO_LOGON_SERVERS",
 589                 N_("No logon servers")},
 590         {"NT_STATUS_PWD_TOO_SHORT",
 591                 N_("Password too short")},
 592         {"NT_STATUS_PWD_TOO_RECENT",
 593                 N_("The password of this user is too recent to change")},
 594         {"NT_STATUS_PWD_HISTORY_CONFLICT",
 595                 N_("Password is already in password history")},
 596         {"NT_STATUS_PASSWORD_EXPIRED",
 597                 N_("Your password has expired")},
 598         {"NT_STATUS_PASSWORD_MUST_CHANGE",
 599                 N_("You need to change your password now")},
 600         {"NT_STATUS_INVALID_WORKSTATION",
 601                 N_("You are not allowed to logon from this workstation")},
 602         {"NT_STATUS_INVALID_LOGON_HOURS",
 603                 N_("You are not allowed to logon at this time")},
 604         {"NT_STATUS_ACCOUNT_EXPIRED",
 605                 N_("Your account has expired. "
 606                    "Please contact your System administrator")}, /* SCNR */
 607         {"NT_STATUS_ACCOUNT_DISABLED",
 608                 N_("Your account is disabled. "
 609                    "Please contact your System administrator")}, /* SCNR */
 610         {"NT_STATUS_ACCOUNT_LOCKED_OUT",
 611                 N_("Your account has been locked. "
 612                    "Please contact your System administrator")}, /* SCNR */
 613         {"NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
 614                 N_("Invalid Trust Account")},
 615         {"NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
 616                 N_("Invalid Trust Account")},
 617         {"NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
 618                 N_("Invalid Trust Account")},
 619         {"NT_STATUS_ACCESS_DENIED",
 620                 N_("Access is denied")},
 621         {NULL, NULL}
 622 };
 623
 624 static const char *_get_ntstatus_error_string(const char *nt_status_string)
 625 {
 626         int i;
 627         for (i=0; ntstatus_errors[i].ntstatus_string != NULL; i++) {
 628                 if (!strcasecmp(ntstatus_errors[i].ntstatus_string,
 629                                 nt_status_string)) {
 630                         return _(ntstatus_errors[i].error_string);
 631                 }
 632         }
 633         return NULL;
 634 }
 635
 636 /* --- authentication management functions --- */
 637
 638 /* Attempt a conversation */
 639
 640 static int converse(const pam_handle_t *pamh,
 641                     int nargs,
 642                     struct pam_message **message,
 643                     struct pam_response **response)
 644 {
 645         int retval;
 646         struct pam_conv *conv;
 647
 648         retval = _pam_get_item(pamh, PAM_CONV, &conv);
 649         if (retval == PAM_SUCCESS) {
 650                 retval = conv->conv(nargs,
 651                                     (const struct pam_message **)message,
 652                                     response, conv->appdata_ptr);
 653         }
 654
 655         return retval; /* propagate error status */
 656 }
 657
 658
 659 static int _make_remark(struct pwb_context *ctx,
 660                         int type,
 661                         const char *text)
 662 {
 663         int retval = PAM_SUCCESS;
 664
 665         struct pam_message *pmsg[1], msg[1];
 666         struct pam_response *resp;
 667
 668         if (ctx->flags & WINBIND_SILENT) {
 669                 return PAM_SUCCESS;
 670         }
 671
 672         pmsg[0] = &msg[0];
 673         msg[0].msg = discard_const_p(char, text);
 674         msg[0].msg_style = type;
 675
 676         resp = NULL;
 677         retval = converse(ctx->pamh, 1, pmsg, &resp);
 678
 679         if (resp) {
 680                 _pam_drop_reply(resp, 1);
 681         }
 682         return retval;
 683 }
 684
 685 static int _make_remark_v(struct pwb_context *ctx,
 686                           int type,
 687                           const char *format,
 688                           va_list args)
 689 {
 690         char *var;
 691         int ret;
 692
 693         ret = vasprintf(&var, format, args);
 694         if (ret < 0) {
 695                 _pam_log(ctx, LOG_ERR, "memory allocation failure");
 696                 return ret;
 697         }
 698
 699         ret = _make_remark(ctx, type, var);
 700         SAFE_FREE(var);
 701         return ret;
 702 }
 703
 704 static int _make_remark_format(struct pwb_context *ctx, int type, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 705 static int _make_remark_format(struct pwb_context *ctx, int type, const char *format, ...)
 706 {
 707         int ret;
 708         va_list args;
 709
 710         va_start(args, format);
 711         ret = _make_remark_v(ctx, type, format, args);
 712         va_end(args);
 713         return ret;
 714 }
 715
 716 static int pam_winbind_request_log(struct pwb_context *ctx,
 717                                    int retval,
 718                                    const char *user,
 719                                    const char *fn)
 720 {
 721         switch (retval) {
 722         case PAM_AUTH_ERR:
 723                 /* incorrect password */
 724                 _pam_log(ctx, LOG_WARNING, "user '%s' denied access "
 725                          "(incorrect password or invalid membership)", user);
 726                 return retval;
 727         case PAM_ACCT_EXPIRED:
 728                 /* account expired */
 729                 _pam_log(ctx, LOG_WARNING, "user '%s' account expired",
 730                          user);
 731                 return retval;
 732         case PAM_AUTHTOK_EXPIRED:
 733                 /* password expired */
 734                 _pam_log(ctx, LOG_WARNING, "user '%s' password expired",
 735                          user);
 736                 return retval;
 737         case PAM_NEW_AUTHTOK_REQD:
 738                 /* new password required */
 739                 _pam_log(ctx, LOG_WARNING, "user '%s' new password "
 740                          "required", user);
 741                 return retval;
 742         case PAM_USER_UNKNOWN:
 743                 /* the user does not exist */
 744                 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
 745                                user);
 746                 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
 747                         return PAM_IGNORE;
 748                 }
 749                 return retval;
 750         case PAM_SUCCESS:
 751                 /* Otherwise, the authentication looked good */
 752                 if (strcmp(fn, "wbcLogonUser") == 0) {
 753                         _pam_log(ctx, LOG_NOTICE,
 754                                  "user '%s' granted access", user);
 755                 } else {
 756                         _pam_log(ctx, LOG_NOTICE,
 757                                  "user '%s' OK", user);
 758                 }
 759                 return retval;
 760         default:
 761                 /* we don't know anything about this return value */
 762                 _pam_log(ctx, LOG_ERR,
 763                          "internal module error (retval = %s(%d), user = '%s')",
 764                         _pam_error_code_str(retval), retval, user);
 765                 return retval;
 766         }
 767 }
 768
 769 static int wbc_auth_error_to_pam_error(struct pwb_context *ctx,
 770                                        struct wbcAuthErrorInfo *e,
 771                                        wbcErr status,
 772                                        const char *username,
 773                                        const char *fn)
 774 {
 775         int ret = PAM_AUTH_ERR;
 776
 777         if (WBC_ERROR_IS_OK(status)) {
 778                 _pam_log_debug(ctx, LOG_DEBUG, "request %s succeeded",
 779                         fn);
 780                 ret = PAM_SUCCESS;
 781                 return pam_winbind_request_log(ctx, ret, username, fn);
 782         }
 783
 784         if (e) {
 785                 if (e->pam_error != PAM_SUCCESS) {
 786                         _pam_log(ctx, LOG_ERR,
 787                                  "request %s failed: %s, "
 788                                  "PAM error: %s (%d), NTSTATUS: %s, "
 789                                  "Error message was: %s",
 790                                  fn,
 791                                  wbcErrorString(status),
 792                                  _pam_error_code_str(e->pam_error),
 793                                  e->pam_error,
 794                                  e->nt_string,
 795                                  e->display_string);
 796                         ret = e->pam_error;
 797                         return pam_winbind_request_log(ctx, ret, username, fn);
 798                 }
 799
 800                 _pam_log(ctx, LOG_ERR, "request %s failed, but PAM error 0!", fn);
 801
 802                 ret = PAM_SERVICE_ERR;
 803                 return pam_winbind_request_log(ctx, ret, username, fn);
 804         }
 805
 806         ret = wbc_error_to_pam_error(status);
 807         return pam_winbind_request_log(ctx, ret, username, fn);
 808 }
 809
 810
 811 /**
 812  * send a password expiry message if required
 813  *
 814  * @param ctx PAM winbind context.
 815  * @param next_change expected (calculated) next expiry date.
 816  * @param already_expired pointer to a boolean to indicate if the password is
 817  *        already expired.
 818  *
 819  * @return boolean Returns true if message has been sent, false if not.
 820  */
 821
 822 static bool _pam_send_password_expiry_message(struct pwb_context *ctx,
 823                                               time_t next_change,
 824                                               time_t now,
 825                                               int warn_pwd_expire,
 826                                               bool *already_expired)
 827 {
 828         int days = 0;
 829         struct tm tm_now, tm_next_change;
 830
 831         if (already_expired) {
 832                 *already_expired = false;
 833         }
 834
 835         if (next_change <= now) {
 836                 PAM_WB_REMARK_DIRECT(ctx, "NT_STATUS_PASSWORD_EXPIRED");
 837                 if (already_expired) {
 838                         *already_expired = true;
 839                 }
 840                 return true;
 841         }
 842
 843         if ((next_change < 0) ||
 844             (next_change > now + warn_pwd_expire * SECONDS_PER_DAY)) {
 845                 return false;
 846         }
 847
 848         if ((localtime_r(&now, &tm_now) == NULL) ||
 849             (localtime_r(&next_change, &tm_next_change) == NULL)) {
 850                 return false;
 851         }
 852
 853         days = (tm_next_change.tm_yday+tm_next_change.tm_year*365) -
 854                (tm_now.tm_yday+tm_now.tm_year*365);
 855
 856         if (days == 0) {
 857                 _make_remark(ctx, PAM_TEXT_INFO,
 858                              _("Your password expires today"));
 859                 return true;
 860         }
 861
 862         if (days > 0 && days < warn_pwd_expire) {
 863                 _make_remark_format(ctx, PAM_TEXT_INFO,
 864                                     _("Your password will expire in %d %s"),
 865                                     days, (days > 1) ? _("days"):_("day"));
 866                 return true;
 867         }
 868
 869         return false;
 870 }
 871
 872 /**
 873  * Send a warning if the password expires in the near future
 874  *
 875  * @param ctx PAM winbind context.
 876  * @param response The full authentication response structure.
 877  * @param already_expired boolean, is the pwd already expired?
 878  *
 879  * @return void.
 880  */
 881
 882 static void _pam_warn_password_expiry(struct pwb_context *ctx,
 883                                       const struct wbcAuthUserInfo *info,
 884                                       const struct wbcUserPasswordPolicyInfo *policy,
 885                                       int warn_pwd_expire,
 886                                       bool *already_expired)
 887 {
 888         time_t now = time(NULL);
 889         time_t next_change = 0;
 890
 891         if (!info || !policy) {
 892                 return;
 893         }
 894
 895         if (already_expired) {
 896                 *already_expired = false;
 897         }
 898
 899         /* accounts with WBC_ACB_PWNOEXP set never receive a warning */
 900         if (info->acct_flags & WBC_ACB_PWNOEXP) {
 901                 return;
 902         }
 903
 904         /* no point in sending a warning if this is a grace logon */
 905         if (PAM_WB_GRACE_LOGON(info->user_flags)) {
 906                 return;
 907         }
 908
 909         /* check if the info3 must change timestamp has been set */
 910         next_change = info->pass_must_change_time;
 911
 912         if (_pam_send_password_expiry_message(ctx, next_change, now,
 913                                               warn_pwd_expire,
 914                                               already_expired)) {
 915                 return;
 916         }
 917
 918         /* now check for the global password policy */
 919         /* good catch from Ralf Haferkamp: an expiry of "never" is translated
 920          * to -1 */
 921         if ((policy->expire == (int64_t)-1) ||
 922             (policy->expire == 0)) {
 923                 return;
 924         }
 925
 926         next_change = info->pass_last_set_time + policy->expire;
 927
 928         if (_pam_send_password_expiry_message(ctx, next_change, now,
 929                                               warn_pwd_expire,
 930                                               already_expired)) {
 931                 return;
 932         }
 933
 934         /* no warning sent */
 935 }
 936
 937 #define IS_SID_STRING(name) (strncmp("S-", name, 2) == 0)
 938
 939 /**
 940  * Append a string, making sure not to overflow and to always return a
 941  * NULL-terminated string.
 942  *
 943  * @param dest Destination string buffer (must already be NULL-terminated).
 944  * @param src Source string buffer.
 945  * @param dest_buffer_size Size of dest buffer in bytes.
 946  *
 947  * @return false if dest buffer is not big enough (no bytes copied), true on
 948  * success.
 949  */
 950
 951 static bool safe_append_string(char *dest,
 952                                const char *src,
 953                                int dest_buffer_size)
 954 {
 955         int dest_length = strlen(dest);
 956         int src_length = strlen(src);
 957
 958         if (dest_length + src_length + 1 > dest_buffer_size) {
 959                 return false;
 960         }
 961
 962         memcpy(dest + dest_length, src, src_length + 1);
 963         return true;
 964 }
 965
 966 /**
 967  * Convert a names into a SID string, appending it to a buffer.
 968  *
 969  * @param ctx PAM winbind context.
 970  * @param user User in PAM request.
 971  * @param name Name to convert.
 972  * @param sid_list_buffer Where to append the string sid.
 973  * @param sid_list_buffer Size of sid_list_buffer (in bytes).
 974  *
 975  * @return false on failure, true on success.
 976  */
 977 static bool winbind_name_to_sid_string(struct pwb_context *ctx,
 978                                        const char *user,
 979                                        const char *name,
 980                                        char *sid_list_buffer,
 981                                        int sid_list_buffer_size)
 982 {
 983         const char* sid_string = NULL;
 984         char *sid_str = NULL;
 985
 986         /* lookup name? */
 987         if (IS_SID_STRING(name)) {
 988                 sid_string = name;
 989         } else {
 990                 wbcErr wbc_status;
 991                 struct wbcDomainSid sid;
 992                 enum wbcSidType type;
 993
 994                 _pam_log_debug(ctx, LOG_DEBUG,
 995                                "no sid given, looking up: %s\n", name);
 996
 997                 wbc_status = wbcLookupName("", name, &sid, &type);
 998                 if (!WBC_ERROR_IS_OK(wbc_status)) {
 999                         _pam_log(ctx, LOG_INFO,
1000                                  "could not lookup name: %s\n", name);
1001                         return false;
1002                 }
1003
1004                 wbc_status = wbcSidToString(&sid, &sid_str);
1005                 if (!WBC_ERROR_IS_OK(wbc_status)) {
1006                         return false;
1007                 }
1008
1009                 sid_string = sid_str;
1010         }
1011
1012         if (!safe_append_string(sid_list_buffer, sid_string,
1013                                 sid_list_buffer_size)) {
1014                 wbcFreeMemory(sid_str);
1015                 return false;
1016         }
1017
1018         wbcFreeMemory(sid_str);
1019         return true;
1020 }
1021
1022 /**
1023  * Convert a list of names into a list of sids.
1024  *
1025  * @param ctx PAM winbind context.
1026  * @param user User in PAM request.
1027  * @param name_list List of names or string sids, separated by commas.
1028  * @param sid_list_buffer Where to put the list of string sids.
1029  * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1030  *
1031  * @return false on failure, true on success.
1032  */
1033 static bool winbind_name_list_to_sid_string_list(struct pwb_context *ctx,
1034                                                  const char *user,
1035                                                  const char *name_list,
1036                                                  char *sid_list_buffer,
1037                                                  int sid_list_buffer_size)
1038 {
1039         bool result = false;
1040         char *current_name = NULL;
1041         const char *search_location;
1042         const char *comma;
1043
1044         if (sid_list_buffer_size > 0) {
1045                 sid_list_buffer[0] = 0;
1046         }
1047
1048         search_location = name_list;
1049         while ((comma = strstr(search_location, ",")) != NULL) {
1050                 current_name = strndup(search_location,
1051                                        comma - search_location);
1052                 if (NULL == current_name) {
1053                         goto out;
1054                 }
1055
1056                 if (!winbind_name_to_sid_string(ctx, user,
1057                                                 current_name,
1058                                                 sid_list_buffer,
1059                                                 sid_list_buffer_size)) {
1060                         /*
1061                          * If one group name failed, we must not fail
1062                          * the authentication totally, continue with
1063                          * the following group names. If user belongs to
1064                          * one of the valid groups, we must allow it
1065                          * login. -- BoYang
1066                          */
1067
1068                         _pam_log(ctx, LOG_INFO, "cannot convert group %s to sid, "
1069                                  "check if group %s is valid group.", current_name,
1070                                  current_name);
1071                         _make_remark_format(ctx, PAM_TEXT_INFO, _("Cannot convert group %s "
1072                                         "to sid, please contact your administrator to see "
1073                                         "if group %s is valid."), current_name, current_name);
1074                         SAFE_FREE(current_name);
1075                         search_location = comma + 1;
1076                         continue;
1077                 }
1078
1079                 SAFE_FREE(current_name);
1080
1081                 if (!safe_append_string(sid_list_buffer, ",",
1082                                         sid_list_buffer_size)) {
1083                         goto out;
1084                 }
1085
1086                 search_location = comma + 1;
1087         }
1088
1089         if (!winbind_name_to_sid_string(ctx, user, search_location,
1090                                         sid_list_buffer,
1091                                         sid_list_buffer_size)) {
1092                 _pam_log(ctx, LOG_INFO, "cannot convert group %s to sid, "
1093                          "check if group %s is valid group.", search_location,
1094                          search_location);
1095                 _make_remark_format(ctx, PAM_TEXT_INFO, _("Cannot convert group %s "
1096                                 "to sid, please contact your administrator to see "
1097                                 "if group %s is valid."), search_location, search_location);
1098         }
1099
1100         result = true;
1101
1102 out:
1103         SAFE_FREE(current_name);
1104         return result;
1105 }
1106
1107 /**
1108  * put krb5ccname variable into environment
1109  *
1110  * @param ctx PAM winbind context.
1111  * @param krb5ccname env variable retrieved from winbindd.
1112  *
1113  * @return void.
1114  */
1115
1116 static void _pam_setup_krb5_env(struct pwb_context *ctx,
1117                                 struct wbcLogonUserInfo *info)
1118 {
1119         char var[PATH_MAX];
1120         int ret;
1121         uint32_t i;
1122         const char *krb5ccname = NULL;
1123
1124         if (off(ctx->ctrl, WINBIND_KRB5_AUTH)) {
1125                 return;
1126         }
1127
1128         if (!info) {
1129                 return;
1130         }
1131
1132         for (i=0; i < info->num_blobs; i++) {
1133                 if (strcasecmp(info->blobs[i].name, "krb5ccname") == 0) {
1134                         krb5ccname = (const char *)info->blobs[i].blob.data;
1135                         break;
1136                 }
1137         }
1138
1139         if (!krb5ccname || (strlen(krb5ccname) == 0)) {
1140                 return;
1141         }
1142
1143         _pam_log_debug(ctx, LOG_DEBUG,
1144                        "request returned KRB5CCNAME: %s", krb5ccname);
1145
1146         if (snprintf(var, sizeof(var), "KRB5CCNAME=%s", krb5ccname) == -1) {
1147                 return;
1148         }
1149
1150         ret = pam_putenv(ctx->pamh, var);
1151         if (ret) {
1152                 _pam_log(ctx, LOG_ERR,
1153                          "failed to set KRB5CCNAME to %s: %s",
1154                          var, pam_strerror(ctx->pamh, ret));
1155         }
1156 }
1157
1158 /**
1159  * Copy unix username if available (further processed in PAM).
1160  *
1161  * @param ctx PAM winbind context
1162  * @param user_ret A pointer that holds a pointer to a string
1163  * @param unix_username A username
1164  *
1165  * @return void.
1166  */
1167
1168 static void _pam_setup_unix_username(struct pwb_context *ctx,
1169                                      char **user_ret,
1170                                      struct wbcLogonUserInfo *info)
1171 {
1172         const char *unix_username = NULL;
1173         uint32_t i;
1174
1175         if (!user_ret || !info) {
1176                 return;
1177         }
1178
1179         for (i=0; i < info->num_blobs; i++) {
1180                 if (strcasecmp(info->blobs[i].name, "unix_username") == 0) {
1181                         unix_username = (const char *)info->blobs[i].blob.data;
1182                         break;
1183                 }
1184         }
1185
1186         if (!unix_username || !unix_username[0]) {
1187                 return;
1188         }
1189
1190         *user_ret = strdup(unix_username);
1191 }
1192
1193 /**
1194  * Set string into the PAM stack.
1195  *
1196  * @param ctx PAM winbind context.
1197  * @param data_name Key name for pam_set_data.
1198  * @param value String value.
1199  *
1200  * @return void.
1201  */
1202
1203 static void _pam_set_data_string(struct pwb_context *ctx,
1204                                  const char *data_name,
1205                                  const char *value)
1206 {
1207         int ret;
1208
1209         if (!data_name || !value || (strlen(data_name) == 0) ||
1210              (strlen(value) == 0)) {
1211                 return;
1212         }
1213
1214         ret = pam_set_data(ctx->pamh, data_name, talloc_strdup(NULL, value),
1215                            _pam_winbind_cleanup_func);
1216         if (ret) {
1217                 _pam_log_debug(ctx, LOG_DEBUG,
1218                                "Could not set data %s: %s\n",
1219                                data_name, pam_strerror(ctx->pamh, ret));
1220         }
1221 }
1222
1223 /**
1224  * Set info3 strings into the PAM stack.
1225  *
1226  * @param ctx PAM winbind context.
1227  * @param data_name Key name for pam_set_data.
1228  * @param value String value.
1229  *
1230  * @return void.
1231  */
1232
1233 static void _pam_set_data_info3(struct pwb_context *ctx,
1234                                 const struct wbcAuthUserInfo *info)
1235 {
1236         _pam_set_data_string(ctx, PAM_WINBIND_HOMEDIR,
1237                              info->home_directory);
1238         _pam_set_data_string(ctx, PAM_WINBIND_LOGONSCRIPT,
1239                              info->logon_script);
1240         _pam_set_data_string(ctx, PAM_WINBIND_LOGONSERVER,
1241                              info->logon_server);
1242         _pam_set_data_string(ctx, PAM_WINBIND_PROFILEPATH,
1243                              info->profile_path);
1244 }
1245
1246 /**
1247  * Free info3 strings in the PAM stack.
1248  *
1249  * @param pamh PAM handle
1250  *
1251  * @return void.
1252  */
1253
1254 static void _pam_free_data_info3(pam_handle_t *pamh)
1255 {
1256         pam_set_data(pamh, PAM_WINBIND_HOMEDIR, NULL, NULL);
1257         pam_set_data(pamh, PAM_WINBIND_LOGONSCRIPT, NULL, NULL);
1258         pam_set_data(pamh, PAM_WINBIND_LOGONSERVER, NULL, NULL);
1259         pam_set_data(pamh, PAM_WINBIND_PROFILEPATH, NULL, NULL);
1260 }
1261
1262 /**
1263  * Send PAM_ERROR_MSG for cached or grace logons.
1264  *
1265  * @param ctx PAM winbind context.
1266  * @param username User in PAM request.
1267  * @param info3_user_flgs Info3 flags containing logon type bits.
1268  *
1269  * @return void.
1270  */
1271
1272 static void _pam_warn_logon_type(struct pwb_context *ctx,
1273                                  const char *username,
1274                                  uint32_t info3_user_flgs)
1275 {
1276         /* inform about logon type */
1277         if (PAM_WB_GRACE_LOGON(info3_user_flgs)) {
1278
1279                 _make_remark(ctx, PAM_ERROR_MSG,
1280                              _("Grace login. "
1281                                "Please change your password as soon you're "
1282                                "online again"));
1283                 _pam_log_debug(ctx, LOG_DEBUG,
1284                                "User %s logged on using grace logon\n",
1285                                username);
1286
1287         } else if (PAM_WB_CACHED_LOGON(info3_user_flgs)) {
1288
1289                 _make_remark(ctx, PAM_ERROR_MSG,
1290                              _("Domain Controller unreachable, "
1291                                "using cached credentials instead. "
1292                                "Network resources may be unavailable"));
1293                 _pam_log_debug(ctx, LOG_DEBUG,
1294                                "User %s logged on using cached credentials\n",
1295                                username);
1296         }
1297 }
1298
1299 /**
1300  * Send PAM_ERROR_MSG for krb5 errors.
1301  *
1302  * @param ctx PAM winbind context.
1303  * @param username User in PAM request.
1304  * @param info3_user_flgs Info3 flags containing logon type bits.
1305  *
1306  * @return void.
1307  */
1308
1309 static void _pam_warn_krb5_failure(struct pwb_context *ctx,
1310                                    const char *username,
1311                                    uint32_t info3_user_flgs)
1312 {
1313         if (PAM_WB_KRB5_CLOCK_SKEW(info3_user_flgs)) {
1314                 _make_remark(ctx, PAM_ERROR_MSG,
1315                              _("Failed to establish your Kerberos Ticket cache "
1316                                "due time differences\n"
1317                                "with the domain controller.  "
1318                                "Please verify the system time.\n"));
1319                 _pam_log_debug(ctx, LOG_DEBUG,
1320                                "User %s: Clock skew when getting Krb5 TGT\n",
1321                                username);
1322         }
1323 }
1324
1325 static bool _pam_check_remark_auth_err(struct pwb_context *ctx,
1326                                        const struct wbcAuthErrorInfo *e,
1327                                        const char *nt_status_string,
1328                                        int *pam_error)
1329 {
1330         const char *ntstatus = NULL;
1331         const char *error_string = NULL;
1332
1333         if (!e || !pam_error) {
1334                 return false;
1335         }
1336
1337         ntstatus = e->nt_string;
1338         if (!ntstatus) {
1339                 return false;
1340         }
1341
1342         if (strcasecmp(ntstatus, nt_status_string) == 0) {
1343
1344                 error_string = _get_ntstatus_error_string(nt_status_string);
1345                 if (error_string) {
1346                         _make_remark(ctx, PAM_ERROR_MSG, error_string);
1347                         *pam_error = e->pam_error;
1348                         return true;
1349                 }
1350
1351                 if (e->display_string) {
1352                         _make_remark(ctx, PAM_ERROR_MSG, e->display_string);
1353                         *pam_error = e->pam_error;
1354                         return true;
1355                 }
1356
1357                 _make_remark(ctx, PAM_ERROR_MSG, nt_status_string);
1358                 *pam_error = e->pam_error;
1359
1360                 return true;
1361         }
1362
1363         return false;
1364 };
1365
1366 /**
1367  * Compose Password Restriction String for a PAM_ERROR_MSG conversation.
1368  *
1369  * @param i The wbcUserPasswordPolicyInfo struct.
1370  *
1371  * @return string (caller needs to talloc_free).
1372  */
1373
1374 static char *_pam_compose_pwd_restriction_string(struct pwb_context *ctx,
1375                                                  struct wbcUserPasswordPolicyInfo *i)
1376 {
1377         char *str = NULL;
1378
1379         if (!i) {
1380                 goto failed;
1381         }
1382
1383         str = talloc_asprintf(ctx, _("Your password "));
1384         if (!str) {
1385                 goto failed;
1386         }
1387
1388         if (i->min_length_password > 0) {
1389                 str = talloc_asprintf_append(str,
1390                                _("must be at least %d characters; "),
1391                                i->min_length_password);
1392                 if (!str) {
1393                         goto failed;
1394                 }
1395         }
1396
1397         if (i->password_history > 0) {
1398                 str = talloc_asprintf_append(str,
1399                                _("cannot repeat any of your previous %d "
1400                                 "passwords; "),
1401                                i->password_history);
1402                 if (!str) {
1403                         goto failed;
1404                 }
1405         }
1406
1407         if (i->password_properties & WBC_DOMAIN_PASSWORD_COMPLEX) {
1408                 str = talloc_asprintf_append(str,
1409                                _("must contain capitals, numerals "
1410                                  "or punctuation; "
1411                                  "and cannot contain your account "
1412                                  "or full name; "));
1413                 if (!str) {
1414                         goto failed;
1415                 }
1416         }
1417
1418         str = talloc_asprintf_append(str,
1419                        _("Please type a different password. "
1420                          "Type a password which meets these requirements in "
1421                          "both text boxes."));
1422         if (!str) {
1423                 goto failed;
1424         }
1425
1426         return str;
1427
1428  failed:
1429         TALLOC_FREE(str);
1430         return NULL;
1431 }
1432
1433 static int _pam_create_homedir(struct pwb_context *ctx,
1434                                const char *dirname,
1435                                mode_t mode)
1436 {
1437         struct stat sbuf;
1438
1439         if (stat(dirname, &sbuf) == 0) {
1440                 return PAM_SUCCESS;
1441         }
1442
1443         if (mkdir(dirname, mode) != 0) {
1444
1445                 _make_remark_format(ctx, PAM_TEXT_INFO,
1446                                     _("Creating directory: %s failed: %s"),
1447                                     dirname, strerror(errno));
1448                 _pam_log(ctx, LOG_ERR, "could not create dir: %s (%s)",
1449                  dirname, strerror(errno));
1450                  return PAM_PERM_DENIED;
1451         }
1452
1453         return PAM_SUCCESS;
1454 }
1455
1456 static int _pam_chown_homedir(struct pwb_context *ctx,
1457                               const char *dirname,
1458                               uid_t uid,
1459                               gid_t gid)
1460 {
1461         if (chown(dirname, uid, gid) != 0) {
1462                 _pam_log(ctx, LOG_ERR, "failed to chown user homedir: %s (%s)",
1463                          dirname, strerror(errno));
1464                 return PAM_PERM_DENIED;
1465         }
1466
1467         return PAM_SUCCESS;
1468 }
1469
1470 static int _pam_mkhomedir(struct pwb_context *ctx)
1471 {
1472         struct passwd *pwd = NULL;
1473         char *token = NULL;
1474         char *create_dir = NULL;
1475         char *user_dir = NULL;
1476         int ret;
1477         const char *username;
1478         mode_t mode = 0700;
1479         char *safe_ptr = NULL;
1480         char *p = NULL;
1481
1482         /* Get the username */
1483         ret = pam_get_user(ctx->pamh, &username, NULL);
1484         if ((ret != PAM_SUCCESS) || (!username)) {
1485                 _pam_log_debug(ctx, LOG_DEBUG, "can not get the username");
1486                 return PAM_SERVICE_ERR;
1487         }
1488
1489         pwd = getpwnam(username);
1490         if (pwd == NULL) {
1491                 _pam_log_debug(ctx, LOG_DEBUG, "can not get the username");
1492                 return PAM_USER_UNKNOWN;
1493         }
1494         _pam_log_debug(ctx, LOG_DEBUG, "homedir is: %s", pwd->pw_dir);
1495
1496         ret = _pam_create_homedir(ctx, pwd->pw_dir, 0700);
1497         if (ret == PAM_SUCCESS) {
1498                 ret = _pam_chown_homedir(ctx, pwd->pw_dir,
1499                                          pwd->pw_uid,
1500                                          pwd->pw_gid);
1501         }
1502
1503         if (ret == PAM_SUCCESS) {
1504                 return ret;
1505         }
1506
1507         /* maybe we need to create parent dirs */
1508         create_dir = talloc_strdup(ctx, "/");
1509         if (!create_dir) {
1510                 return PAM_BUF_ERR;
1511         }
1512
1513         /* find final directory */
1514         user_dir = strrchr(pwd->pw_dir, '/');
1515         if (!user_dir) {
1516                 return PAM_BUF_ERR;
1517         }
1518         user_dir++;
1519
1520         _pam_log(ctx, LOG_DEBUG, "final directory: %s", user_dir);
1521
1522         p = pwd->pw_dir;
1523
1524         while ((token = strtok_r(p, "/", &safe_ptr)) != NULL) {
1525
1526                 mode = 0755;
1527
1528                 p = NULL;
1529
1530                 _pam_log_debug(ctx, LOG_DEBUG, "token is %s", token);
1531
1532                 create_dir = talloc_asprintf_append(create_dir, "%s/", token);
1533                 if (!create_dir) {
1534                         return PAM_BUF_ERR;
1535                 }
1536                 _pam_log_debug(ctx, LOG_DEBUG, "current_dir is %s", create_dir);
1537
1538                 if (strcmp(token, user_dir) == 0) {
1539                         _pam_log_debug(ctx, LOG_DEBUG, "assuming last directory: %s", token);
1540                         mode = 0700;
1541                 }
1542
1543                 ret = _pam_create_homedir(ctx, create_dir, mode);
1544                 if (ret) {
1545                         return ret;
1546                 }
1547         }
1548
1549         return _pam_chown_homedir(ctx, create_dir,
1550                                   pwd->pw_uid,
1551                                   pwd->pw_gid);
1552 }
1553
1554 /* talk to winbindd */
1555 static int winbind_auth_request(struct pwb_context *ctx,
1556                                 const char *user,
1557                                 const char *pass,
1558                                 const char *member,
1559                                 const char *cctype,
1560                                 const int warn_pwd_expire,
1561                                 struct wbcAuthErrorInfo **p_error,
1562                                 struct wbcLogonUserInfo **p_info,
1563                                 struct wbcUserPasswordPolicyInfo **p_policy,
1564                                 time_t *pwd_last_set,
1565                                 char **user_ret)
1566 {
1567         wbcErr wbc_status;
1568
1569         struct wbcLogonUserParams logon;
1570         char membership_of[1024];
1571         uid_t user_uid = -1;
1572         uint32_t flags = WBFLAG_PAM_INFO3_TEXT |
1573                          WBFLAG_PAM_GET_PWD_POLICY;
1574
1575         struct wbcLogonUserInfo *info = NULL;
1576         struct wbcAuthUserInfo *user_info = NULL;
1577         struct wbcAuthErrorInfo *error = NULL;
1578         struct wbcUserPasswordPolicyInfo *policy = NULL;
1579
1580         int ret = PAM_AUTH_ERR;
1581         int i;
1582         const char *codes[] = {
1583                 "NT_STATUS_PASSWORD_EXPIRED",
1584                 "NT_STATUS_PASSWORD_MUST_CHANGE",
1585                 "NT_STATUS_INVALID_WORKSTATION",
1586                 "NT_STATUS_INVALID_LOGON_HOURS",
1587                 "NT_STATUS_ACCOUNT_EXPIRED",
1588                 "NT_STATUS_ACCOUNT_DISABLED",
1589                 "NT_STATUS_ACCOUNT_LOCKED_OUT",
1590                 "NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
1591                 "NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
1592                 "NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
1593                 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1594                 "NT_STATUS_NO_LOGON_SERVERS",
1595                 "NT_STATUS_WRONG_PASSWORD",
1596                 "NT_STATUS_ACCESS_DENIED"
1597         };
1598
1599         if (pwd_last_set) {
1600                 *pwd_last_set = 0;
1601         }
1602
1603         /* Krb5 auth always has to go against the KDC of the user's realm */
1604
1605         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1606                 flags           |= WBFLAG_PAM_CONTACT_TRUSTDOM;
1607         }
1608
1609         if (ctx->ctrl & (WINBIND_KRB5_AUTH|WINBIND_CACHED_LOGIN)) {
1610                 struct passwd *pwd = NULL;
1611
1612                 pwd = getpwnam(user);
1613                 if (pwd == NULL) {
1614                         return PAM_USER_UNKNOWN;
1615                 }
1616                 user_uid        = pwd->pw_uid;
1617         }
1618
1619         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1620
1621                 _pam_log_debug(ctx, LOG_DEBUG,
1622                                "enabling krb5 login flag\n");
1623
1624                 flags           |= WBFLAG_PAM_KRB5 |
1625                                    WBFLAG_PAM_FALLBACK_AFTER_KRB5;
1626         }
1627
1628         if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1629                 _pam_log_debug(ctx, LOG_DEBUG,
1630                                "enabling cached login flag\n");
1631                 flags           |= WBFLAG_PAM_CACHED_LOGIN;
1632         }
1633
1634         if (user_ret) {
1635                 *user_ret = NULL;
1636                 flags           |= WBFLAG_PAM_UNIX_NAME;
1637         }
1638
1639         if (cctype != NULL) {
1640                 _pam_log_debug(ctx, LOG_DEBUG,
1641                                "enabling request for a %s krb5 ccache\n",
1642                                cctype);
1643         }
1644
1645         if (member != NULL) {
1646
1647                 ZERO_STRUCT(membership_of);
1648
1649                 if (!winbind_name_list_to_sid_string_list(ctx, user, member,
1650                                                           membership_of,
1651                                                           sizeof(membership_of))) {
1652                         _pam_log_debug(ctx, LOG_ERR,
1653                                        "failed to serialize membership of sid "
1654                                        "\"%s\"\n", member);
1655                         return PAM_AUTH_ERR;
1656                 }
1657         }
1658
1659         ZERO_STRUCT(logon);
1660
1661         logon.username                  = user;
1662         logon.password                  = pass;
1663
1664         if (cctype) {
1665                 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1666                                              &logon.blobs,
1667                                              "krb5_cc_type",
1668                                              0,
1669                                              (uint8_t *)cctype,
1670                                              strlen(cctype)+1);
1671                 if (!WBC_ERROR_IS_OK(wbc_status)) {
1672                         goto done;
1673                 }
1674         }
1675
1676         wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1677                                      &logon.blobs,
1678                                      "flags",
1679                                      0,
1680                                      (uint8_t *)&flags,
1681                                      sizeof(flags));
1682         if (!WBC_ERROR_IS_OK(wbc_status)) {
1683                 goto done;
1684         }
1685
1686         wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1687                                      &logon.blobs,
1688                                      "user_uid",
1689                                      0,
1690                                      (uint8_t *)&user_uid,
1691                                      sizeof(user_uid));
1692         if (!WBC_ERROR_IS_OK(wbc_status)) {
1693                 goto done;
1694         }
1695
1696         if (member) {
1697                 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1698                                              &logon.blobs,
1699                                              "membership_of",
1700                                              0,
1701                                              (uint8_t *)membership_of,
1702                                              sizeof(membership_of));
1703                 if (!WBC_ERROR_IS_OK(wbc_status)) {
1704                         goto done;
1705                 }
1706         }
1707
1708         wbc_status = wbcLogonUser(&logon, &info, &error, &policy);
1709         ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1710                                           user, "wbcLogonUser");
1711         wbcFreeMemory(logon.blobs);
1712         logon.blobs = NULL;
1713
1714         if (info && info->info) {
1715                 user_info = info->info;
1716         }
1717
1718         if (pwd_last_set && user_info) {
1719                 *pwd_last_set = user_info->pass_last_set_time;
1720         }
1721
1722         if (p_info && info) {
1723                 *p_info = info;
1724         }
1725
1726         if (p_policy && policy) {
1727                 *p_policy = policy;
1728         }
1729
1730         if (p_error && error) {
1731                 /* We want to process the error in the caller. */
1732                 *p_error = error;
1733                 return ret;
1734         }
1735
1736         for (i=0; i<ARRAY_SIZE(codes); i++) {
1737                 int _ret = ret;
1738                 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1739                         ret = _ret;
1740                         goto done;
1741                 }
1742         }
1743
1744         if ((ret == PAM_SUCCESS) && user_info && policy && info) {
1745
1746                 bool already_expired = false;
1747
1748                 /* warn a user if the password is about to expire soon */
1749                 _pam_warn_password_expiry(ctx, user_info, policy,
1750                                           warn_pwd_expire,
1751                                           &already_expired);
1752
1753                 if (already_expired == true) {
1754
1755                         SMB_TIME_T last_set = user_info->pass_last_set_time;
1756
1757                         _pam_log_debug(ctx, LOG_DEBUG,
1758                                        "Password has expired "
1759                                        "(Password was last set: %lld, "
1760                                        "the policy says it should expire here "
1761                                        "%lld (now it's: %ld))\n",
1762                                        (long long int)last_set,
1763                                        (long long int)last_set +
1764                                        policy->expire,
1765                                        (long)time(NULL));
1766
1767                         return PAM_AUTHTOK_EXPIRED;
1768                 }
1769
1770                 /* inform about logon type */
1771                 _pam_warn_logon_type(ctx, user, user_info->user_flags);
1772
1773                 /* inform about krb5 failures */
1774                 _pam_warn_krb5_failure(ctx, user, user_info->user_flags);
1775
1776                 /* set some info3 info for other modules in the stack */
1777                 _pam_set_data_info3(ctx, user_info);
1778
1779                 /* put krb5ccname into env */
1780                 _pam_setup_krb5_env(ctx, info);
1781
1782                 /* If winbindd returned a username, return the pointer to it
1783                  * here. */
1784                 _pam_setup_unix_username(ctx, user_ret, info);
1785         }
1786
1787  done:
1788         if (logon.blobs) {
1789                 wbcFreeMemory(logon.blobs);
1790         }
1791         if (info && info->blobs && !p_info) {
1792                 wbcFreeMemory(info->blobs);
1793         }
1794         if (error && !p_error) {
1795                 wbcFreeMemory(error);
1796         }
1797         if (info && !p_info) {
1798                 wbcFreeMemory(info);
1799         }
1800         if (policy && !p_policy) {
1801                 wbcFreeMemory(policy);
1802         }
1803
1804         return ret;
1805 }
1806
1807 /* talk to winbindd */
1808 static int winbind_chauthtok_request(struct pwb_context *ctx,
1809                                      const char *user,
1810                                      const char *oldpass,
1811                                      const char *newpass,
1812                                      time_t pwd_last_set)
1813 {
1814         wbcErr wbc_status;
1815         struct wbcChangePasswordParams params;
1816         struct wbcAuthErrorInfo *error = NULL;
1817         struct wbcUserPasswordPolicyInfo *policy = NULL;
1818         enum wbcPasswordChangeRejectReason reject_reason = -1;
1819         uint32_t flags = 0;
1820
1821         int i;
1822         const char *codes[] = {
1823                 "NT_STATUS_BACKUP_CONTROLLER",
1824                 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1825                 "NT_STATUS_NO_LOGON_SERVERS",
1826                 "NT_STATUS_ACCESS_DENIED",
1827                 "NT_STATUS_PWD_TOO_SHORT", /* TODO: tell the min pwd length ? */
1828                 "NT_STATUS_PWD_TOO_RECENT", /* TODO: tell the minage ? */
1829                 "NT_STATUS_PWD_HISTORY_CONFLICT" /* TODO: tell the history length ? */
1830         };
1831         int ret = PAM_AUTH_ERR;
1832
1833         ZERO_STRUCT(params);
1834
1835         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1836                 flags |= WBFLAG_PAM_KRB5 |
1837                          WBFLAG_PAM_CONTACT_TRUSTDOM;
1838         }
1839
1840         if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1841                 flags |= WBFLAG_PAM_CACHED_LOGIN;
1842         }
1843
1844         params.account_name             = user;
1845         params.level                    = WBC_AUTH_USER_LEVEL_PLAIN;
1846         params.old_password.plaintext   = oldpass;
1847         params.new_password.plaintext   = newpass;
1848         params.flags                    = flags;
1849
1850         wbc_status = wbcChangeUserPasswordEx(&params, &error, &reject_reason, &policy);
1851         ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1852                                           user, "wbcChangeUserPasswordEx");
1853
1854         if (WBC_ERROR_IS_OK(wbc_status)) {
1855                 _pam_log(ctx, LOG_NOTICE,
1856                          "user '%s' password changed", user);
1857                 return PAM_SUCCESS;
1858         }
1859
1860         if (!error) {
1861                 wbcFreeMemory(policy);
1862                 return ret;
1863         }
1864
1865         for (i=0; i<ARRAY_SIZE(codes); i++) {
1866                 int _ret = ret;
1867                 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1868                         ret = _ret;
1869                         goto done;
1870                 }
1871         }
1872
1873         if (!strcasecmp(error->nt_string,
1874                         "NT_STATUS_PASSWORD_RESTRICTION")) {
1875
1876                 char *pwd_restriction_string = NULL;
1877                 SMB_TIME_T min_pwd_age = 0;
1878
1879                 if (policy) {
1880                         min_pwd_age     = policy->min_passwordage;
1881                 }
1882
1883                 /* FIXME: avoid to send multiple PAM messages after another */
1884                 switch (reject_reason) {
1885                         case -1:
1886                                 break;
1887                         case WBC_PWD_CHANGE_NO_ERROR:
1888                                 if ((min_pwd_age > 0) &&
1889                                     (pwd_last_set + min_pwd_age > time(NULL))) {
1890                                         PAM_WB_REMARK_DIRECT(ctx,
1891                                              "NT_STATUS_PWD_TOO_RECENT");
1892                                 }
1893                                 break;
1894                         case WBC_PWD_CHANGE_PASSWORD_TOO_SHORT:
1895                                 PAM_WB_REMARK_DIRECT(ctx,
1896                                         "NT_STATUS_PWD_TOO_SHORT");
1897                                 break;
1898                         case WBC_PWD_CHANGE_PWD_IN_HISTORY:
1899                                 PAM_WB_REMARK_DIRECT(ctx,
1900                                         "NT_STATUS_PWD_HISTORY_CONFLICT");
1901                                 break;
1902                         case WBC_PWD_CHANGE_NOT_COMPLEX:
1903                                 _make_remark(ctx, PAM_ERROR_MSG,
1904                                              _("Password does not meet "
1905                                                "complexity requirements"));
1906                                 break;
1907                         default:
1908                                 _pam_log_debug(ctx, LOG_DEBUG,
1909                                                "unknown password change "
1910                                                "reject reason: %d",
1911                                                reject_reason);
1912                                 break;
1913                 }
1914
1915                 pwd_restriction_string =
1916                         _pam_compose_pwd_restriction_string(ctx, policy);
1917                 if (pwd_restriction_string) {
1918                         _make_remark(ctx, PAM_ERROR_MSG,
1919                                      pwd_restriction_string);
1920                         TALLOC_FREE(pwd_restriction_string);
1921                 }
1922         }
1923  done:
1924         wbcFreeMemory(error);
1925         wbcFreeMemory(policy);
1926
1927         return ret;
1928 }
1929
1930 /*
1931  * Checks if a user has an account
1932  *
1933  * return values:
1934  *       1  = User not found
1935  *       0  = OK
1936  *      -1  = System error
1937  */
1938 static int valid_user(struct pwb_context *ctx,
1939                       const char *user)
1940 {
1941         /* check not only if the user is available over NSS calls, also make
1942          * sure it's really a winbind user, this is important when stacking PAM
1943          * modules in the 'account' or 'password' facility. */
1944
1945         wbcErr wbc_status;
1946         struct passwd *pwd = NULL;
1947         struct passwd *wb_pwd = NULL;
1948
1949         pwd = getpwnam(user);
1950         if (pwd == NULL) {
1951                 return 1;
1952         }
1953
1954         wbc_status = wbcGetpwnam(user, &wb_pwd);
1955         wbcFreeMemory(wb_pwd);
1956         if (!WBC_ERROR_IS_OK(wbc_status)) {
1957                 _pam_log(ctx, LOG_DEBUG, "valid_user: wbcGetpwnam gave %s\n",
1958                         wbcErrorString(wbc_status));
1959         }
1960
1961         switch (wbc_status) {
1962                 case WBC_ERR_UNKNOWN_USER:
1963                         return 1;
1964                 case WBC_ERR_SUCCESS:
1965                         return 0;
1966                 default:
1967                         break;
1968         }
1969         return -1;
1970 }
1971
1972 static char *_pam_delete(register char *xx)
1973 {
1974         _pam_overwrite(xx);
1975         _pam_drop(xx);
1976         return NULL;
1977 }
1978
1979 /*
1980  * obtain a password from the user
1981  */
1982
1983 static int _winbind_read_password(struct pwb_context *ctx,
1984                                   unsigned int ctrl,
1985                                   const char *comment,
1986                                   const char *prompt1,
1987                                   const char *prompt2,
1988                                   const char **pass)
1989 {
1990         int authtok_flag;
1991         int retval;
1992         const char *item;
1993         char *token;
1994
1995         _pam_log(ctx, LOG_DEBUG, "getting password (0x%08x)", ctrl);
1996
1997         /*
1998          * make sure nothing inappropriate gets returned
1999          */
2000
2001         *pass = token = NULL;
2002
2003         /*
2004          * which authentication token are we getting?
2005          */
2006
2007         if (on(WINBIND__OLD_PASSWORD, ctrl)) {
2008                 authtok_flag = PAM_OLDAUTHTOK;
2009         } else {
2010                 authtok_flag = PAM_AUTHTOK;
2011         }
2012
2013         /*
2014          * should we obtain the password from a PAM item ?
2015          */
2016
2017         if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) ||
2018             on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
2019                 retval = _pam_get_item(ctx->pamh, authtok_flag, &item);
2020                 if (retval != PAM_SUCCESS) {
2021                         /* very strange. */
2022                         _pam_log(ctx, LOG_ALERT,
2023                                  "pam_get_item returned error "
2024                                  "to unix-read-password");
2025                         return retval;
2026                 } else if (item != NULL) {      /* we have a password! */
2027                         *pass = item;
2028                         item = NULL;
2029                         _pam_log(ctx, LOG_DEBUG,
2030                                  "pam_get_item returned a password");
2031                         return PAM_SUCCESS;
2032                 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
2033                         return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
2034                 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
2035                            && off(WINBIND__OLD_PASSWORD, ctrl)) {
2036                         return PAM_AUTHTOK_RECOVER_ERR;
2037                 }
2038         }
2039         /*
2040          * getting here implies we will have to get the password from the
2041          * user directly.
2042          */
2043
2044         {
2045                 struct pam_message msg[3], *pmsg[3];
2046                 struct pam_response *resp;
2047                 int i, replies;
2048
2049                 /* prepare to converse */
2050
2051                 if (comment != NULL && off(ctrl, WINBIND_SILENT)) {
2052                         pmsg[0] = &msg[0];
2053                         msg[0].msg_style = PAM_TEXT_INFO;
2054                         msg[0].msg = discard_const_p(char, comment);
2055                         i = 1;
2056                 } else {
2057                         i = 0;
2058                 }
2059
2060                 pmsg[i] = &msg[i];
2061                 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
2062                 msg[i++].msg = discard_const_p(char, prompt1);
2063                 replies = 1;
2064
2065                 if (prompt2 != NULL) {
2066                         pmsg[i] = &msg[i];
2067                         msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
2068                         msg[i++].msg = discard_const_p(char, prompt2);
2069                         ++replies;
2070                 }
2071                 /* so call the conversation expecting i responses */
2072                 resp = NULL;
2073                 retval = converse(ctx->pamh, i, pmsg, &resp);
2074                 if (resp == NULL) {
2075                         if (retval == PAM_SUCCESS) {
2076                                 retval = PAM_AUTHTOK_RECOVER_ERR;
2077                         }
2078                         goto done;
2079                 }
2080                 if (retval != PAM_SUCCESS) {
2081                         _pam_drop_reply(resp, i);
2082                         goto done;
2083                 }
2084
2085                 /* interpret the response */
2086
2087                 token = x_strdup(resp[i - replies].resp);
2088                 if (!token) {
2089                         _pam_log(ctx, LOG_NOTICE,
2090                                  "could not recover "
2091                                  "authentication token");
2092                         retval = PAM_AUTHTOK_RECOVER_ERR;
2093                         goto done;
2094                 }
2095
2096                 if (replies == 2) {
2097                         /* verify that password entered correctly */
2098                         if (!resp[i - 1].resp ||
2099                             strcmp(token, resp[i - 1].resp)) {
2100                                 _pam_delete(token);     /* mistyped */
2101                                 retval = PAM_AUTHTOK_RECOVER_ERR;
2102                                 _make_remark(ctx, PAM_ERROR_MSG,
2103                                              MISTYPED_PASS);
2104                         }
2105                 }
2106
2107                 /*
2108                  * tidy up the conversation (resp_retcode) is ignored
2109                  * -- what is it for anyway? AGM
2110                  */
2111                 _pam_drop_reply(resp, i);
2112         }
2113
2114  done:
2115         if (retval != PAM_SUCCESS) {
2116                 _pam_log_debug(ctx, LOG_DEBUG,
2117                                "unable to obtain a password");
2118                 return retval;
2119         }
2120         /* 'token' is the entered password */
2121
2122         /* we store this password as an item */
2123
2124         retval = pam_set_item(ctx->pamh, authtok_flag, token);
2125         _pam_delete(token);     /* clean it up */
2126         if (retval != PAM_SUCCESS ||
2127             (retval = _pam_get_item(ctx->pamh, authtok_flag, &item)) != PAM_SUCCESS) {
2128
2129                 _pam_log(ctx, LOG_CRIT, "error manipulating password");
2130                 return retval;
2131
2132         }
2133
2134         *pass = item;
2135         item = NULL;            /* break link to password */
2136
2137         return PAM_SUCCESS;
2138 }
2139
2140 static const char *get_conf_item_string(struct pwb_context *ctx,
2141                                         const char *item,
2142                                         int config_flag)
2143 {
2144         int i = 0;
2145         const char *parm_opt = NULL;
2146
2147         if (!(ctx->ctrl & config_flag)) {
2148                 goto out;
2149         }
2150
2151         /* let the pam opt take precedence over the pam_winbind.conf option */
2152         for (i=0; i<ctx->argc; i++) {
2153
2154                 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2155                         char *p;
2156
2157                         if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2158                                 _pam_log(ctx, LOG_INFO,
2159                                          "no \"=\" delimiter for \"%s\" found\n",
2160                                          item);
2161                                 goto out;
2162                         }
2163                         _pam_log_debug(ctx, LOG_INFO,
2164                                        "PAM config: %s '%s'\n", item, p+1);
2165                         return p + 1;
2166                 }
2167         }
2168
2169         if (ctx->dict) {
2170                 char *key = NULL;
2171
2172                 key = talloc_asprintf(ctx, "global:%s", item);
2173                 if (!key) {
2174                         goto out;
2175                 }
2176
2177                 parm_opt = iniparser_getstr(ctx->dict, key);
2178                 TALLOC_FREE(key);
2179
2180                 _pam_log_debug(ctx, LOG_INFO, "CONFIG file: %s '%s'\n",
2181                                item, parm_opt);
2182         }
2183 out:
2184         return parm_opt;
2185 }
2186
2187 static int get_config_item_int(struct pwb_context *ctx,
2188                                const char *item,
2189                                int config_flag)
2190 {
2191         int i, parm_opt = -1;
2192
2193         if (!(ctx->ctrl & config_flag)) {
2194                 goto out;
2195         }
2196
2197         /* let the pam opt take precedence over the pam_winbind.conf option */
2198         for (i = 0; i < ctx->argc; i++) {
2199
2200                 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2201                         char *p;
2202
2203                         if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2204                                 _pam_log(ctx, LOG_INFO,
2205                                          "no \"=\" delimiter for \"%s\" found\n",
2206                                          item);
2207                                 goto out;
2208                         }
2209                         parm_opt = atoi(p + 1);
2210                         _pam_log_debug(ctx, LOG_INFO,
2211                                        "PAM config: %s '%d'\n",
2212                                        item, parm_opt);
2213                         return parm_opt;
2214                 }
2215         }
2216
2217         if (ctx->dict) {
2218                 char *key = NULL;
2219
2220                 key = talloc_asprintf(ctx, "global:%s", item);
2221                 if (!key) {
2222                         goto out;
2223                 }
2224
2225                 parm_opt = iniparser_getint(ctx->dict, key, -1);
2226                 TALLOC_FREE(key);
2227
2228                 _pam_log_debug(ctx, LOG_INFO,
2229                                "CONFIG file: %s '%d'\n",
2230                                item, parm_opt);
2231         }
2232 out:
2233         return parm_opt;
2234 }
2235
2236 static const char *get_krb5_cc_type_from_config(struct pwb_context *ctx)
2237 {
2238         return get_conf_item_string(ctx, "krb5_ccache_type",
2239                                     WINBIND_KRB5_CCACHE_TYPE);
2240 }
2241
2242 static const char *get_member_from_config(struct pwb_context *ctx)
2243 {
2244         const char *ret = NULL;
2245         ret = get_conf_item_string(ctx, "require_membership_of",
2246                                    WINBIND_REQUIRED_MEMBERSHIP);
2247         if (ret) {
2248                 return ret;
2249         }
2250         return get_conf_item_string(ctx, "require-membership-of",
2251                                     WINBIND_REQUIRED_MEMBERSHIP);
2252 }
2253
2254 static int get_warn_pwd_expire_from_config(struct pwb_context *ctx)
2255 {
2256         int ret;
2257         ret = get_config_item_int(ctx, "warn_pwd_expire",
2258                                   WINBIND_WARN_PWD_EXPIRE);
2259         /* no or broken setting */
2260         if (ret <= 0) {
2261                 return DEFAULT_DAYS_TO_WARN_BEFORE_PWD_EXPIRES;
2262         }
2263         return ret;
2264 }
2265
2266 /**
2267  * Retrieve the winbind separator.
2268  *
2269  * @param ctx PAM winbind context.
2270  *
2271  * @return string separator character. NULL on failure.
2272  */
2273
2274 static char winbind_get_separator(struct pwb_context *ctx)
2275 {
2276         wbcErr wbc_status;
2277         static struct wbcInterfaceDetails *details = NULL;
2278
2279         wbc_status = wbcInterfaceDetails(&details);
2280         if (!WBC_ERROR_IS_OK(wbc_status)) {
2281                 _pam_log(ctx, LOG_ERR,
2282                          "Could not retrieve winbind interface details: %s",
2283                          wbcErrorString(wbc_status));
2284                 return '\0';
2285         }
2286
2287         if (!details) {
2288                 return '\0';
2289         }
2290
2291         return details->winbind_separator;
2292 }
2293
2294
2295 /**
2296  * Convert a upn to a name.
2297  *
2298  * @param ctx PAM winbind context.
2299  * @param upn  USer UPN to be trabslated.
2300  *
2301  * @return converted name. NULL pointer on failure. Caller needs to free.
2302  */
2303
2304 static char* winbind_upn_to_username(struct pwb_context *ctx,
2305                                      const char *upn)
2306 {
2307         char sep;
2308         wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
2309         struct wbcDomainSid sid;
2310         enum wbcSidType type;
2311         char *domain;
2312         char *name;
2313         char *p;
2314
2315         /* This cannot work when the winbind separator = @ */
2316
2317         sep = winbind_get_separator(ctx);
2318         if (!sep || sep == '@') {
2319                 return NULL;
2320         }
2321
2322         name = talloc_strdup(ctx, upn);
2323         if (!name) {
2324                 return NULL;
2325         }
2326         if ((p = strchr(name, '@')) != NULL) {
2327                 *p = 0;
2328                 domain = p + 1;
2329         }
2330
2331         /* Convert the UPN to a SID */
2332
2333         wbc_status = wbcLookupName(domain, name, &sid, &type);
2334         if (!WBC_ERROR_IS_OK(wbc_status)) {
2335                 return NULL;
2336         }
2337
2338         /* Convert the the SID back to the sAMAccountName */
2339
2340         wbc_status = wbcLookupSid(&sid, &domain, &name, &type);
2341         if (!WBC_ERROR_IS_OK(wbc_status)) {
2342                 return NULL;
2343         }
2344
2345         return talloc_asprintf(ctx, "%s\\%s", domain, name);
2346 }
2347
2348 static int _pam_delete_cred(pam_handle_t *pamh, int flags,
2349                          int argc, const char **argv)
2350 {
2351         int retval = PAM_SUCCESS;
2352         struct pwb_context *ctx = NULL;
2353         struct wbcLogoffUserParams logoff;
2354         struct wbcAuthErrorInfo *error = NULL;
2355         const char *user;
2356         wbcErr wbc_status = WBC_ERR_SUCCESS;
2357
2358         ZERO_STRUCT(logoff);
2359
2360         retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2361         if (retval) {
2362                 goto out;
2363         }
2364
2365         _PAM_LOG_FUNCTION_ENTER("_pam_delete_cred", ctx);
2366
2367         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2368
2369                 /* destroy the ccache here */
2370
2371                 uint32_t wbc_flags = 0;
2372                 const char *ccname = NULL;
2373                 struct passwd *pwd = NULL;
2374
2375                 retval = pam_get_user(pamh, &user, _("Username: "));
2376                 if (retval) {
2377                         _pam_log(ctx, LOG_ERR,
2378                                  "could not identify user");
2379                         goto out;
2380                 }
2381
2382                 if (user == NULL) {
2383                         _pam_log(ctx, LOG_ERR,
2384                                  "username was NULL!");
2385                         retval = PAM_USER_UNKNOWN;
2386                         goto out;
2387                 }
2388
2389                 _pam_log_debug(ctx, LOG_DEBUG,
2390                                "username [%s] obtained", user);
2391
2392                 ccname = pam_getenv(pamh, "KRB5CCNAME");
2393                 if (ccname == NULL) {
2394                         _pam_log_debug(ctx, LOG_DEBUG,
2395                                        "user has no KRB5CCNAME environment");
2396                 }
2397
2398                 pwd = getpwnam(user);
2399                 if (pwd == NULL) {
2400                         retval = PAM_USER_UNKNOWN;
2401                         goto out;
2402                 }
2403
2404                 wbc_flags = WBFLAG_PAM_KRB5 |
2405                         WBFLAG_PAM_CONTACT_TRUSTDOM;
2406
2407                 logoff.username         = user;
2408
2409                 if (ccname) {
2410                         wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2411                                                      &logoff.blobs,
2412                                                      "ccfilename",
2413                                                      0,
2414                                                      (uint8_t *)ccname,
2415                                                      strlen(ccname)+1);
2416                         if (!WBC_ERROR_IS_OK(wbc_status)) {
2417                                 goto out;
2418                         }
2419                 }
2420
2421                 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2422                                              &logoff.blobs,
2423                                              "flags",
2424                                              0,
2425                                              (uint8_t *)&wbc_flags,
2426                                              sizeof(wbc_flags));
2427                 if (!WBC_ERROR_IS_OK(wbc_status)) {
2428                         goto out;
2429                 }
2430
2431                 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2432                                              &logoff.blobs,
2433                                              "user_uid",
2434                                              0,
2435                                              (uint8_t *)&pwd->pw_uid,
2436                                              sizeof(pwd->pw_uid));
2437                 if (!WBC_ERROR_IS_OK(wbc_status)) {
2438                         goto out;
2439                 }
2440
2441                 wbc_status = wbcLogoffUserEx(&logoff, &error);
2442                 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2443                                                      user, "wbcLogoffUser");
2444                 wbcFreeMemory(error);
2445                 wbcFreeMemory(logoff.blobs);
2446                 logoff.blobs = NULL;
2447
2448                 if (!WBC_ERROR_IS_OK(wbc_status)) {
2449                         _pam_log(ctx, LOG_INFO,
2450                                  "failed to logoff user %s: %s\n",
2451                                          user, wbcErrorString(wbc_status));
2452                 }
2453         }
2454
2455 out:
2456         if (logoff.blobs) {
2457                 wbcFreeMemory(logoff.blobs);
2458         }
2459
2460         if (!WBC_ERROR_IS_OK(wbc_status)) {
2461                 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2462                      user, "wbcLogoffUser");
2463         }
2464
2465         /*
2466          * Delete the krb5 ccname variable from the PAM environment
2467          * if it was set by winbind.
2468          */
2469         if ((ctx->ctrl & WINBIND_KRB5_AUTH) && pam_getenv(pamh, "KRB5CCNAME")) {
2470                 pam_putenv(pamh, "KRB5CCNAME");
2471         }
2472
2473         _PAM_LOG_FUNCTION_LEAVE("_pam_delete_cred", ctx, retval);
2474
2475         TALLOC_FREE(ctx);
2476
2477         return retval;
2478 }
2479
2480 PAM_EXTERN
2481 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
2482                         int argc, const char **argv)
2483 {
2484         const char *username;
2485         const char *password;
2486         const char *member = NULL;
2487         const char *cctype = NULL;
2488         int warn_pwd_expire;
2489         int retval = PAM_AUTH_ERR;
2490         char *username_ret = NULL;
2491         char *new_authtok_required = NULL;
2492         char *real_username = NULL;
2493         struct pwb_context *ctx = NULL;
2494
2495         retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2496         if (retval) {
2497                 goto out;
2498         }
2499
2500         _PAM_LOG_FUNCTION_ENTER("pam_sm_authenticate", ctx);
2501
2502         /* Get the username */
2503         retval = pam_get_user(pamh, &username, NULL);
2504         if ((retval != PAM_SUCCESS) || (!username)) {
2505                 _pam_log_debug(ctx, LOG_DEBUG,
2506                                "can not get the username");
2507                 retval = PAM_SERVICE_ERR;
2508                 goto out;
2509         }
2510
2511
2512 #if defined(AIX)
2513         /* Decode the user name since AIX does not support logn user
2514            names by default.  The name is encoded as _#uid.  */
2515
2516         if (username[0] == '_') {
2517                 uid_t id = atoi(&username[1]);
2518                 struct passwd *pw = NULL;
2519
2520                 if ((id!=0) && ((pw = getpwuid(id)) != NULL)) {
2521                         real_username = strdup(pw->pw_name);
2522                 }
2523         }
2524 #endif
2525
2526         if (!real_username) {
2527                 /* Just making a copy of the username we got from PAM */
2528                 if ((real_username = strdup(username)) == NULL) {
2529                         _pam_log_debug(ctx, LOG_DEBUG,
2530                                        "memory allocation failure when copying "
2531                                        "username");
2532                         retval = PAM_SERVICE_ERR;
2533                         goto out;
2534                 }
2535         }
2536
2537         /* Maybe this was a UPN */
2538
2539         if (strchr(real_username, '@') != NULL) {
2540                 char *samaccountname = NULL;
2541
2542                 samaccountname = winbind_upn_to_username(ctx,
2543                                                          real_username);
2544                 if (samaccountname) {
2545                         free(real_username);
2546                         real_username = strdup(samaccountname);
2547                 }
2548         }
2549
2550         retval = _winbind_read_password(ctx, ctx->ctrl, NULL,
2551                                         _("Password: "), NULL,
2552                                         &password);
2553
2554         if (retval != PAM_SUCCESS) {
2555                 _pam_log(ctx, LOG_ERR,
2556                          "Could not retrieve user's password");
2557                 retval = PAM_AUTHTOK_ERR;
2558                 goto out;
2559         }
2560
2561         /* Let's not give too much away in the log file */
2562
2563 #ifdef DEBUG_PASSWORD
2564         _pam_log_debug(ctx, LOG_INFO,
2565                        "Verify user '%s' with password '%s'",
2566                        real_username, password);
2567 #else
2568         _pam_log_debug(ctx, LOG_INFO,
2569                        "Verify user '%s'", real_username);
2570 #endif
2571
2572         member = get_member_from_config(ctx);
2573         cctype = get_krb5_cc_type_from_config(ctx);
2574         warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2575
2576         /* Now use the username to look up password */
2577         retval = winbind_auth_request(ctx, real_username, password,
2578                                       member, cctype, warn_pwd_expire,
2579                                       NULL, NULL, NULL,
2580                                       NULL, &username_ret);
2581
2582         if (retval == PAM_NEW_AUTHTOK_REQD ||
2583             retval == PAM_AUTHTOK_EXPIRED) {
2584
2585                 char *new_authtok_required_during_auth = NULL;
2586
2587                 new_authtok_required = talloc_asprintf(NULL, "%d", retval);
2588                 if (!new_authtok_required) {
2589                         retval = PAM_BUF_ERR;
2590                         goto out;
2591                 }
2592
2593                 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2594                              new_authtok_required,
2595                              _pam_winbind_cleanup_func);
2596
2597                 retval = PAM_SUCCESS;
2598
2599                 new_authtok_required_during_auth = talloc_asprintf(NULL, "%d", true);
2600                 if (!new_authtok_required_during_auth) {
2601                         retval = PAM_BUF_ERR;
2602                         goto out;
2603                 }
2604
2605                 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2606                              new_authtok_required_during_auth,
2607                              _pam_winbind_cleanup_func);
2608
2609                 goto out;
2610         }
2611
2612 out:
2613         if (username_ret) {
2614                 pam_set_item (pamh, PAM_USER, username_ret);
2615                 _pam_log_debug(ctx, LOG_INFO,
2616                                "Returned user was '%s'", username_ret);
2617                 free(username_ret);
2618         }
2619
2620         if (real_username) {
2621                 free(real_username);
2622         }
2623
2624         if (!new_authtok_required) {
2625                 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, NULL, NULL);
2626         }
2627
2628         if (retval != PAM_SUCCESS) {
2629                 _pam_free_data_info3(pamh);
2630         }
2631
2632         _PAM_LOG_FUNCTION_LEAVE("pam_sm_authenticate", ctx, retval);
2633
2634         TALLOC_FREE(ctx);
2635
2636         return retval;
2637 }
2638
2639 PAM_EXTERN
2640 int pam_sm_setcred(pam_handle_t *pamh, int flags,
2641                    int argc, const char **argv)
2642 {
2643         int ret = PAM_SYSTEM_ERR;
2644         struct pwb_context *ctx = NULL;
2645
2646         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2647         if (ret) {
2648                 goto out;
2649         }
2650
2651         _PAM_LOG_FUNCTION_ENTER("pam_sm_setcred", ctx);
2652
2653         switch (flags & ~PAM_SILENT) {
2654
2655                 case PAM_DELETE_CRED:
2656                         ret = _pam_delete_cred(pamh, flags, argc, argv);
2657                         break;
2658                 case PAM_REFRESH_CRED:
2659                         _pam_log_debug(ctx, LOG_WARNING,
2660                                        "PAM_REFRESH_CRED not implemented");
2661                         ret = PAM_SUCCESS;
2662                         break;
2663                 case PAM_REINITIALIZE_CRED:
2664                         _pam_log_debug(ctx, LOG_WARNING,
2665                                        "PAM_REINITIALIZE_CRED not implemented");
2666                         ret = PAM_SUCCESS;
2667                         break;
2668                 case PAM_ESTABLISH_CRED:
2669                         _pam_log_debug(ctx, LOG_WARNING,
2670                                        "PAM_ESTABLISH_CRED not implemented");
2671                         ret = PAM_SUCCESS;
2672                         break;
2673                 default:
2674                         ret = PAM_SYSTEM_ERR;
2675                         break;
2676         }
2677
2678  out:
2679
2680         _PAM_LOG_FUNCTION_LEAVE("pam_sm_setcred", ctx, ret);
2681
2682         TALLOC_FREE(ctx);
2683
2684         return ret;
2685 }
2686
2687 /*
2688  * Account management. We want to verify that the account exists
2689  * before returning PAM_SUCCESS
2690  */
2691 PAM_EXTERN
2692 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
2693                    int argc, const char **argv)
2694 {
2695         const char *username;
2696         int ret = PAM_USER_UNKNOWN;
2697         void *tmp = NULL;
2698         struct pwb_context *ctx = NULL;
2699
2700         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2701         if (ret) {
2702                 goto out;
2703         }
2704
2705         _PAM_LOG_FUNCTION_ENTER("pam_sm_acct_mgmt", ctx);
2706
2707
2708         /* Get the username */
2709         ret = pam_get_user(pamh, &username, NULL);
2710         if ((ret != PAM_SUCCESS) || (!username)) {
2711                 _pam_log_debug(ctx, LOG_DEBUG,
2712                                "can not get the username");
2713                 ret = PAM_SERVICE_ERR;
2714                 goto out;
2715         }
2716
2717         /* Verify the username */
2718         ret = valid_user(ctx, username);
2719         switch (ret) {
2720         case -1:
2721                 /* some sort of system error. The log was already printed */
2722                 ret = PAM_SERVICE_ERR;
2723                 goto out;
2724         case 1:
2725                 /* the user does not exist */
2726                 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
2727                                username);
2728                 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
2729                         ret = PAM_IGNORE;
2730                         goto out;
2731                 }
2732                 ret = PAM_USER_UNKNOWN;
2733                 goto out;
2734         case 0:
2735                 pam_get_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2736                              (const void **)&tmp);
2737                 if (tmp != NULL) {
2738                         ret = atoi((const char *)tmp);
2739                         switch (ret) {
2740                         case PAM_AUTHTOK_EXPIRED:
2741                                 /* fall through, since new token is required in this case */
2742                         case PAM_NEW_AUTHTOK_REQD:
2743                                 _pam_log(ctx, LOG_WARNING,
2744                                          "pam_sm_acct_mgmt success but %s is set",
2745                                          PAM_WINBIND_NEW_AUTHTOK_REQD);
2746                                 _pam_log(ctx, LOG_NOTICE,
2747                                          "user '%s' needs new password",
2748                                          username);
2749                                 /* PAM_AUTHTOKEN_REQD does not exist, but is documented in the manpage */
2750                                 ret = PAM_NEW_AUTHTOK_REQD;
2751                                 goto out;
2752                         default:
2753                                 _pam_log(ctx, LOG_WARNING,
2754                                          "pam_sm_acct_mgmt success");
2755                                 _pam_log(ctx, LOG_NOTICE,
2756                                          "user '%s' granted access", username);
2757                                 ret = PAM_SUCCESS;
2758                                 goto out;
2759                         }
2760                 }
2761
2762                 /* Otherwise, the authentication looked good */
2763                 _pam_log(ctx, LOG_NOTICE,
2764                          "user '%s' granted access", username);
2765                 ret = PAM_SUCCESS;
2766                 goto out;
2767         default:
2768                 /* we don't know anything about this return value */
2769                 _pam_log(ctx, LOG_ERR,
2770                          "internal module error (ret = %d, user = '%s')",
2771                          ret, username);
2772                 ret = PAM_SERVICE_ERR;
2773                 goto out;
2774         }
2775
2776         /* should not be reached */
2777         ret = PAM_IGNORE;
2778
2779  out:
2780
2781         _PAM_LOG_FUNCTION_LEAVE("pam_sm_acct_mgmt", ctx, ret);
2782
2783         TALLOC_FREE(ctx);
2784
2785         return ret;
2786 }
2787
2788 PAM_EXTERN
2789 int pam_sm_open_session(pam_handle_t *pamh, int flags,
2790                         int argc, const char **argv)
2791 {
2792         int ret = PAM_SUCCESS;
2793         struct pwb_context *ctx = NULL;
2794
2795         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2796         if (ret) {
2797                 goto out;
2798         }
2799
2800         _PAM_LOG_FUNCTION_ENTER("pam_sm_open_session", ctx);
2801
2802         if (ctx->ctrl & WINBIND_MKHOMEDIR) {
2803                 /* check and create homedir */
2804                 ret = _pam_mkhomedir(ctx);
2805         }
2806  out:
2807         _PAM_LOG_FUNCTION_LEAVE("pam_sm_open_session", ctx, ret);
2808
2809         TALLOC_FREE(ctx);
2810
2811         return ret;
2812 }
2813
2814 PAM_EXTERN
2815 int pam_sm_close_session(pam_handle_t *pamh, int flags,
2816                          int argc, const char **argv)
2817 {
2818         int ret = PAM_SUCCESS;
2819         struct pwb_context *ctx = NULL;
2820
2821         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2822         if (ret) {
2823                 goto out;
2824         }
2825
2826         _PAM_LOG_FUNCTION_ENTER("pam_sm_close_session", ctx);
2827
2828 out:
2829         _PAM_LOG_FUNCTION_LEAVE("pam_sm_close_session", ctx, ret);
2830
2831         TALLOC_FREE(ctx);
2832
2833         return ret;
2834 }
2835
2836 /**
2837  * evaluate whether we need to re-authenticate with kerberos after a
2838  * password change
2839  *
2840  * @param ctx PAM winbind context.
2841  * @param user The username
2842  *
2843  * @return boolean Returns true if required, false if not.
2844  */
2845
2846 static bool _pam_require_krb5_auth_after_chauthtok(struct pwb_context *ctx,
2847                                                    const char *user)
2848 {
2849
2850         /* Make sure that we only do this if a) the chauthtok got initiated
2851          * during a logon attempt (authenticate->acct_mgmt->chauthtok) b) any
2852          * later password change via the "passwd" command if done by the user
2853          * itself
2854          * NB. If we login from gdm or xdm and the password expires,
2855          * we change the password, but there is no memory cache.
2856          * Thus, even for passthrough login, we should do the
2857          * authentication again to update memory cache.
2858          * --- BoYang
2859          * */
2860
2861         char *new_authtok_reqd_during_auth = NULL;
2862         struct passwd *pwd = NULL;
2863
2864         _pam_get_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2865                       &new_authtok_reqd_during_auth);
2866         pam_set_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2867                      NULL, NULL);
2868
2869         if (new_authtok_reqd_during_auth) {
2870                 return true;
2871         }
2872
2873         pwd = getpwnam(user);
2874         if (!pwd) {
2875                 return false;
2876         }
2877
2878         if (getuid() == pwd->pw_uid) {
2879                 return true;
2880         }
2881
2882         return false;
2883 }
2884
2885
2886 PAM_EXTERN
2887 int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
2888                      int argc, const char **argv)
2889 {
2890         unsigned int lctrl;
2891         int ret;
2892         bool cached_login = false;
2893
2894         /* <DO NOT free() THESE> */
2895         const char *user;
2896         char *pass_old, *pass_new;
2897         /* </DO NOT free() THESE> */
2898
2899         char *Announce;
2900
2901         int retry = 0;
2902         char *username_ret = NULL;
2903         struct wbcAuthErrorInfo *error = NULL;
2904         struct pwb_context *ctx = NULL;
2905
2906         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2907         if (ret) {
2908                 goto out;
2909         }
2910
2911         _PAM_LOG_FUNCTION_ENTER("pam_sm_chauthtok", ctx);
2912
2913         cached_login = (ctx->ctrl & WINBIND_CACHED_LOGIN);
2914
2915         /* clearing offline bit for auth */
2916         ctx->ctrl &= ~WINBIND_CACHED_LOGIN;
2917
2918         /*
2919          * First get the name of a user
2920          */
2921         ret = pam_get_user(pamh, &user, _("Username: "));
2922         if (ret) {
2923                 _pam_log(ctx, LOG_ERR,
2924                          "password - could not identify user");
2925                 goto out;
2926         }
2927
2928         if (user == NULL) {
2929                 _pam_log(ctx, LOG_ERR, "username was NULL!");
2930                 ret = PAM_USER_UNKNOWN;
2931                 goto out;
2932         }
2933
2934         _pam_log_debug(ctx, LOG_DEBUG, "username [%s] obtained", user);
2935
2936         /* check if this is really a user in winbindd, not only in NSS */
2937         ret = valid_user(ctx, user);
2938         switch (ret) {
2939                 case 1:
2940                         ret = PAM_USER_UNKNOWN;
2941                         goto out;
2942                 case -1:
2943                         ret = PAM_SYSTEM_ERR;
2944                         goto out;
2945                 default:
2946                         break;
2947         }
2948
2949         /*
2950          * obtain and verify the current password (OLDAUTHTOK) for
2951          * the user.
2952          */
2953
2954         if (flags & PAM_PRELIM_CHECK) {
2955                 time_t pwdlastset_prelim = 0;
2956
2957                 /* instruct user what is happening */
2958
2959 #define greeting _("Changing password for")
2960                 Announce = talloc_asprintf(ctx, "%s %s", greeting, user);
2961                 if (!Announce) {
2962                         _pam_log(ctx, LOG_CRIT,
2963                                  "password - out of memory");
2964                         ret = PAM_BUF_ERR;
2965                         goto out;
2966                 }
2967 #undef greeting
2968
2969                 lctrl = ctx->ctrl | WINBIND__OLD_PASSWORD;
2970                 ret = _winbind_read_password(ctx, lctrl,
2971                                                 Announce,
2972                                                 _("(current) NT password: "),
2973                                                 NULL,
2974                                                 (const char **) &pass_old);
2975                 TALLOC_FREE(Announce);
2976                 if (ret != PAM_SUCCESS) {
2977                         _pam_log(ctx, LOG_NOTICE,
2978                                  "password - (old) token not obtained");
2979                         goto out;
2980                 }
2981
2982                 /* verify that this is the password for this user */
2983
2984                 ret = winbind_auth_request(ctx, user, pass_old,
2985                                            NULL, NULL, 0,
2986                                            &error, NULL, NULL,
2987                                            &pwdlastset_prelim, NULL);
2988
2989                 if (ret != PAM_ACCT_EXPIRED &&
2990                     ret != PAM_AUTHTOK_EXPIRED &&
2991                     ret != PAM_NEW_AUTHTOK_REQD &&
2992                     ret != PAM_SUCCESS) {
2993                         pass_old = NULL;
2994                         goto out;
2995                 }
2996
2997                 pam_set_data(pamh, PAM_WINBIND_PWD_LAST_SET,
2998                              (void *)pwdlastset_prelim, NULL);
2999
3000                 ret = pam_set_item(pamh, PAM_OLDAUTHTOK,
3001                                    (const void *) pass_old);
3002                 pass_old = NULL;
3003                 if (ret != PAM_SUCCESS) {
3004                         _pam_log(ctx, LOG_CRIT,
3005                                  "failed to set PAM_OLDAUTHTOK");
3006                 }
3007         } else if (flags & PAM_UPDATE_AUTHTOK) {
3008
3009                 time_t pwdlastset_update = 0;
3010
3011                 /*
3012                  * obtain the proposed password
3013                  */
3014
3015                 /*
3016                  * get the old token back.
3017                  */
3018
3019                 ret = _pam_get_item(pamh, PAM_OLDAUTHTOK, &pass_old);
3020
3021                 if (ret != PAM_SUCCESS) {
3022                         _pam_log(ctx, LOG_NOTICE,
3023                                  "user not authenticated");
3024                         goto out;
3025                 }
3026
3027                 lctrl = ctx->ctrl & ~WINBIND_TRY_FIRST_PASS_ARG;
3028
3029                 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
3030                         lctrl |= WINBIND_USE_FIRST_PASS_ARG;
3031                 }
3032                 retry = 0;
3033                 ret = PAM_AUTHTOK_ERR;
3034                 while ((ret != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
3035                         /*
3036                          * use_authtok is to force the use of a previously entered
3037                          * password -- needed for pluggable password strength checking
3038                          */
3039
3040                         ret = _winbind_read_password(ctx, lctrl,
3041                                                      NULL,
3042                                                      _("Enter new NT password: "),
3043                                                      _("Retype new NT password: "),
3044                                                      (const char **)&pass_new);
3045
3046                         if (ret != PAM_SUCCESS) {
3047                                 _pam_log_debug(ctx, LOG_ALERT,
3048                                                "password - "
3049                                                "new password not obtained");
3050                                 pass_old = NULL;/* tidy up */
3051                                 goto out;
3052                         }
3053
3054                         /*
3055                          * At this point we know who the user is and what they
3056                          * propose as their new password. Verify that the new
3057                          * password is acceptable.
3058                          */
3059
3060                         if (pass_new[0] == '\0') {/* "\0" password = NULL */
3061                                 pass_new = NULL;
3062                         }
3063                 }
3064
3065                 /*
3066                  * By reaching here we have approved the passwords and must now
3067                  * rebuild the password database file.
3068                  */
3069                 _pam_get_data(pamh, PAM_WINBIND_PWD_LAST_SET,
3070                               &pwdlastset_update);
3071
3072                 /*
3073                  * if cached creds were enabled, make sure to set the
3074                  * WINBIND_CACHED_LOGIN bit here in order to have winbindd
3075                  * update the cached creds storage - gd
3076                  */
3077                 if (cached_login) {
3078                         ctx->ctrl |= WINBIND_CACHED_LOGIN;
3079                 }
3080
3081                 ret = winbind_chauthtok_request(ctx, user, pass_old,
3082                                                 pass_new, pwdlastset_update);
3083                 if (ret) {
3084                         pass_old = pass_new = NULL;
3085                         goto out;
3086                 }
3087
3088                 if (_pam_require_krb5_auth_after_chauthtok(ctx, user)) {
3089
3090                         const char *member = NULL;
3091                         const char *cctype = NULL;
3092                         int warn_pwd_expire;
3093                         struct wbcLogonUserInfo *info = NULL;
3094                         struct wbcUserPasswordPolicyInfo *policy = NULL;
3095
3096                         member = get_member_from_config(ctx);
3097                         cctype = get_krb5_cc_type_from_config(ctx);
3098                         warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
3099
3100                         /* Keep WINBIND_CACHED_LOGIN bit for
3101                          * authentication after changing the password.
3102                          * This will update the cached credentials in case
3103                          * that winbindd_dual_pam_chauthtok() fails
3104                          * to update them.
3105                          * --- BoYang
3106                          * */
3107
3108                         ret = winbind_auth_request(ctx, user, pass_new,
3109                                                    member, cctype, 0,
3110                                                    &error, &info, &policy,
3111                                                    NULL, &username_ret);
3112                         pass_old = pass_new = NULL;
3113
3114                         if (ret == PAM_SUCCESS) {
3115
3116                                 struct wbcAuthUserInfo *user_info = NULL;
3117
3118                                 if (info && info->info) {
3119                                         user_info = info->info;
3120                                 }
3121
3122                                 /* warn a user if the password is about to
3123                                  * expire soon */
3124                                 _pam_warn_password_expiry(ctx, user_info, policy,
3125                                                           warn_pwd_expire,
3126                                                           NULL);
3127
3128                                 /* set some info3 info for other modules in the
3129                                  * stack */
3130                                 _pam_set_data_info3(ctx, user_info);
3131
3132                                 /* put krb5ccname into env */
3133                                 _pam_setup_krb5_env(ctx, info);
3134
3135                                 if (username_ret) {
3136                                         pam_set_item(pamh, PAM_USER,
3137                                                      username_ret);
3138                                         _pam_log_debug(ctx, LOG_INFO,
3139                                                        "Returned user was '%s'",
3140                                                        username_ret);
3141                                         free(username_ret);
3142                                 }
3143
3144                         }
3145
3146                         if (info && info->blobs) {
3147                                 wbcFreeMemory(info->blobs);
3148                         }
3149                         wbcFreeMemory(info);
3150                         wbcFreeMemory(policy);
3151
3152                         goto out;
3153                 }
3154         } else {
3155                 ret = PAM_SERVICE_ERR;
3156         }
3157
3158 out:
3159         {
3160                 /* Deal with offline errors. */
3161                 int i;
3162                 const char *codes[] = {
3163                         "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
3164                         "NT_STATUS_NO_LOGON_SERVERS",
3165                         "NT_STATUS_ACCESS_DENIED"
3166                 };
3167
3168                 for (i=0; i<ARRAY_SIZE(codes); i++) {
3169                         int _ret;
3170                         if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
3171                                 break;
3172                         }
3173                 }
3174         }
3175
3176         wbcFreeMemory(error);
3177
3178         _PAM_LOG_FUNCTION_LEAVE("pam_sm_chauthtok", ctx, ret);
3179
3180         TALLOC_FREE(ctx);
3181
3182         return ret;
3183 }
3184
3185 #ifdef PAM_STATIC
3186
3187 /* static module data */
3188
3189 struct pam_module _pam_winbind_modstruct = {
3190         MODULE_NAME,
3191         pam_sm_authenticate,
3192         pam_sm_setcred,
3193         pam_sm_acct_mgmt,
3194         pam_sm_open_session,
3195         pam_sm_close_session,
3196         pam_sm_chauthtok
3197 };
3198
3199 #endif
3200
3201 /*
3202  * Copyright (c) Andrew Tridgell  <tridge@samba.org>   2000
3203  * Copyright (c) Tim Potter       <tpot@samba.org>     2000
3204  * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
3205  * Copyright (c) Guenther Deschner <gd@samba.org>      2005-2008
3206  * Copyright (c) Jan Rêkorajski 1999.
3207  * Copyright (c) Andrew G. Morgan 1996-8.
3208  * Copyright (c) Alex O. Yuriev, 1996.
3209  * Copyright (c) Cristian Gafton 1996.
3210  * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
3211  *
3212  * Redistribution and use in source and binary forms, with or without
3213  * modification, are permitted provided that the following conditions
3214  * are met:
3215  * 1. Redistributions of source code must retain the above copyright
3216  *    notice, and the entire permission notice in its entirety,
3217  *    including the disclaimer of warranties.
3218  * 2. Redistributions in binary form must reproduce the above copyright
3219  *    notice, this list of conditions and the following disclaimer in the
3220  *    documentation and/or other materials provided with the distribution.
3221  * 3. The name of the author may not be used to endorse or promote
3222  *    products derived from this software without specific prior
3223  *    written permission.
3224  *
3225  * ALTERNATIVELY, this product may be distributed under the terms of
3226  * the GNU Public License, in which case the provisions of the GPL are
3227  * required INSTEAD OF the above restrictions.  (This clause is
3228  * necessary due to a potential bad interaction between the GPL and
3229  * the restrictions contained in a BSD-style copyright.)
3230  *
3231  * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
3232  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
3233  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
3234  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
3235  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
3236  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
3237  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3238  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3239  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
3240  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
3241  * OF THE POSSIBILITY OF SUCH DAMAGE.
3242  */