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, 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_getstring(d, CONST_DISCARD(char *, "global:krb5_ccache_type"), NULL) != NULL) {
 441                 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
 442         }
 443
 444         if ((iniparser_getstring(d, CONST_DISCARD(char *, "global:require-membership-of"), NULL)
 445              != NULL) ||
 446             (iniparser_getstring(d, CONST_DISCARD(char *, "global:require_membership_of"), NULL)
 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 #if defined(HAVE_PAM_RADIO_TYPE)
 811 static bool _pam_winbind_change_pwd(struct pwb_context *ctx)
 812 {
 813         struct pam_message msg, *pmsg;
 814         struct pam_response *resp = NULL;
 815         const char *prompt;
 816         int ret;
 817         bool retval = false;
 818         prompt = _("Do you want to change your password now?");
 819         pmsg = &msg;
 820         msg.msg_style = PAM_RADIO_TYPE;
 821         msg.msg = prompt;
 822         ret = converse(ctx->pamh, 1, &pmsg, &resp);
 823         if (resp == NULL) {
 824                 if (ret == PAM_SUCCESS) {
 825                         _pam_log(ctx, LOG_CRIT, "pam_winbind: system error!\n");
 826                         return false;
 827                 }
 828         }
 829         if (ret != PAM_SUCCESS) {
 830                 return false;
 831         }
 832         _pam_log(ctx, LOG_CRIT, "Received [%s] reply from application.\n", resp->resp);
 833
 834         if ((resp->resp != NULL) && (strcasecmp(resp->resp, "yes") == 0)) {
 835                 retval = true;
 836         }
 837
 838         _pam_drop_reply(resp, 1);
 839         return retval;
 840 }
 841 #else
 842 static bool _pam_winbind_change_pwd(struct pwb_context *ctx)
 843 {
 844         return false;
 845 }
 846 #endif
 847
 848 /**
 849  * send a password expiry message if required
 850  *
 851  * @param ctx PAM winbind context.
 852  * @param next_change expected (calculated) next expiry date.
 853  * @param already_expired pointer to a boolean to indicate if the password is
 854  *        already expired.
 855  *
 856  * @return boolean Returns true if message has been sent, false if not.
 857  */
 858
 859 static bool _pam_send_password_expiry_message(struct pwb_context *ctx,
 860                                               time_t next_change,
 861                                               time_t now,
 862                                               int warn_pwd_expire,
 863                                               bool *already_expired,
 864                                               bool *change_pwd)
 865 {
 866         int days = 0;
 867         struct tm tm_now, tm_next_change;
 868         bool retval = false;
 869         int ret;
 870
 871         if (already_expired) {
 872                 *already_expired = false;
 873         }
 874
 875         if (change_pwd) {
 876                 *change_pwd = false;
 877         }
 878
 879         if (next_change <= now) {
 880                 PAM_WB_REMARK_DIRECT(ctx, "NT_STATUS_PASSWORD_EXPIRED");
 881                 if (already_expired) {
 882                         *already_expired = true;
 883                 }
 884                 return true;
 885         }
 886
 887         if ((next_change < 0) ||
 888             (next_change > now + warn_pwd_expire * SECONDS_PER_DAY)) {
 889                 return false;
 890         }
 891
 892         if ((localtime_r(&now, &tm_now) == NULL) ||
 893             (localtime_r(&next_change, &tm_next_change) == NULL)) {
 894                 return false;
 895         }
 896
 897         days = (tm_next_change.tm_yday+tm_next_change.tm_year*365) -
 898                (tm_now.tm_yday+tm_now.tm_year*365);
 899
 900         if (days == 0) {
 901                 ret = _make_remark(ctx, PAM_TEXT_INFO,
 902                                 _("Your password expires today.\n"));
 903
 904                 /*
 905                  * If change_pwd and already_expired is null.
 906                  * We are just sending a notification message.
 907                  * We don't expect any response in this case.
 908                  */
 909
 910                 if (!change_pwd && !already_expired) {
 911                         return true;
 912                 }
 913
 914                 /*
 915                  * successfully sent the warning message.
 916                  * Give the user a chance to change pwd.
 917                  */
 918                 if (ret == PAM_SUCCESS) {
 919                         if (change_pwd) {
 920                                 retval = _pam_winbind_change_pwd(ctx);
 921                                 if (retval) {
 922                                         *change_pwd = true;
 923                                 }
 924                         }
 925                 }
 926                 return true;
 927         }
 928
 929         if (days > 0 && days < warn_pwd_expire) {
 930
 931                 ret = _make_remark_format(ctx, PAM_TEXT_INFO,
 932                                         _("Your password will expire in %d %s.\n"),
 933                                         days, (days > 1) ? _("days"):_("day"));
 934                 /*
 935                  * If change_pwd and already_expired is null.
 936                  * We are just sending a notification message.
 937                  * We don't expect any response in this case.
 938                  */
 939
 940                 if (!change_pwd && !already_expired) {
 941                         return true;
 942                 }
 943
 944                 /*
 945                  * successfully sent the warning message.
 946                  * Give the user a chance to change pwd.
 947                  */
 948                 if (ret == PAM_SUCCESS) {
 949                         if (change_pwd) {
 950                                 retval = _pam_winbind_change_pwd(ctx);
 951                                 if (retval) {
 952                                         *change_pwd = true;
 953                                 }
 954                         }
 955                 }
 956                 return true;
 957         }
 958
 959         return false;
 960 }
 961
 962 /**
 963  * Send a warning if the password expires in the near future
 964  *
 965  * @param ctx PAM winbind context.
 966  * @param response The full authentication response structure.
 967  * @param already_expired boolean, is the pwd already expired?
 968  *
 969  * @return void.
 970  */
 971
 972 static void _pam_warn_password_expiry(struct pwb_context *ctx,
 973                                       const struct wbcAuthUserInfo *info,
 974                                       const struct wbcUserPasswordPolicyInfo *policy,
 975                                       int warn_pwd_expire,
 976                                       bool *already_expired,
 977                                       bool *change_pwd)
 978 {
 979         time_t now = time(NULL);
 980         time_t next_change = 0;
 981
 982         if (!info || !policy) {
 983                 return;
 984         }
 985
 986         if (already_expired) {
 987                 *already_expired = false;
 988         }
 989
 990         if (change_pwd) {
 991                 *change_pwd = false;
 992         }
 993
 994         /* accounts with WBC_ACB_PWNOEXP set never receive a warning */
 995         if (info->acct_flags & WBC_ACB_PWNOEXP) {
 996                 return;
 997         }
 998
 999         /* no point in sending a warning if this is a grace logon */
1000         if (PAM_WB_GRACE_LOGON(info->user_flags)) {
1001                 return;
1002         }
1003
1004         /* check if the info3 must change timestamp has been set */
1005         next_change = info->pass_must_change_time;
1006
1007         if (_pam_send_password_expiry_message(ctx, next_change, now,
1008                                               warn_pwd_expire,
1009                                               already_expired,
1010                                               change_pwd)) {
1011                 return;
1012         }
1013
1014         /* now check for the global password policy */
1015         /* good catch from Ralf Haferkamp: an expiry of "never" is translated
1016          * to -1 */
1017         if ((policy->expire == (int64_t)-1) ||
1018             (policy->expire == 0)) {
1019                 return;
1020         }
1021
1022         next_change = info->pass_last_set_time + policy->expire;
1023
1024         if (_pam_send_password_expiry_message(ctx, next_change, now,
1025                                               warn_pwd_expire,
1026                                               already_expired,
1027                                               change_pwd)) {
1028                 return;
1029         }
1030
1031         /* no warning sent */
1032 }
1033
1034 #define IS_SID_STRING(name) (strncmp("S-", name, 2) == 0)
1035
1036 /**
1037  * Append a string, making sure not to overflow and to always return a
1038  * NULL-terminated string.
1039  *
1040  * @param dest Destination string buffer (must already be NULL-terminated).
1041  * @param src Source string buffer.
1042  * @param dest_buffer_size Size of dest buffer in bytes.
1043  *
1044  * @return false if dest buffer is not big enough (no bytes copied), true on
1045  * success.
1046  */
1047
1048 static bool safe_append_string(char *dest,
1049                                const char *src,
1050                                int dest_buffer_size)
1051 {
1052         int dest_length = strlen(dest);
1053         int src_length = strlen(src);
1054
1055         if (dest_length + src_length + 1 > dest_buffer_size) {
1056                 return false;
1057         }
1058
1059         memcpy(dest + dest_length, src, src_length + 1);
1060         return true;
1061 }
1062
1063 /**
1064  * Convert a names into a SID string, appending it to a buffer.
1065  *
1066  * @param ctx PAM winbind context.
1067  * @param user User in PAM request.
1068  * @param name Name to convert.
1069  * @param sid_list_buffer Where to append the string sid.
1070  * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1071  *
1072  * @return false on failure, true on success.
1073  */
1074 static bool winbind_name_to_sid_string(struct pwb_context *ctx,
1075                                        const char *user,
1076                                        const char *name,
1077                                        char *sid_list_buffer,
1078                                        int sid_list_buffer_size)
1079 {
1080         char sid_string[WBC_SID_STRING_BUFLEN];
1081
1082         /* lookup name? */
1083         if (IS_SID_STRING(name)) {
1084                 strlcpy(sid_string, name, sizeof(sid_string));
1085         } else {
1086                 wbcErr wbc_status;
1087                 struct wbcDomainSid sid;
1088                 enum wbcSidType type;
1089
1090                 _pam_log_debug(ctx, LOG_DEBUG,
1091                                "no sid given, looking up: %s\n", name);
1092
1093                 wbc_status = wbcLookupName("", name, &sid, &type);
1094                 if (!WBC_ERROR_IS_OK(wbc_status)) {
1095                         _pam_log(ctx, LOG_INFO,
1096                                  "could not lookup name: %s\n", name);
1097                         return false;
1098                 }
1099
1100                 wbcSidToStringBuf(&sid, sid_string, sizeof(sid_string));
1101         }
1102
1103         if (!safe_append_string(sid_list_buffer, sid_string,
1104                                 sid_list_buffer_size)) {
1105                 return false;
1106         }
1107         return true;
1108 }
1109
1110 /**
1111  * Convert a list of names into a list of sids.
1112  *
1113  * @param ctx PAM winbind context.
1114  * @param user User in PAM request.
1115  * @param name_list List of names or string sids, separated by commas.
1116  * @param sid_list_buffer Where to put the list of string sids.
1117  * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1118  *
1119  * @return false on failure, true on success.
1120  */
1121 static bool winbind_name_list_to_sid_string_list(struct pwb_context *ctx,
1122                                                  const char *user,
1123                                                  const char *name_list,
1124                                                  char *sid_list_buffer,
1125                                                  int sid_list_buffer_size)
1126 {
1127         bool result = false;
1128         char *current_name = NULL;
1129         const char *search_location;
1130         const char *comma;
1131         int len;
1132
1133         if (sid_list_buffer_size > 0) {
1134                 sid_list_buffer[0] = 0;
1135         }
1136
1137         search_location = name_list;
1138         while ((comma = strchr(search_location, ',')) != NULL) {
1139                 current_name = strndup(search_location,
1140                                        comma - search_location);
1141                 if (NULL == current_name) {
1142                         goto out;
1143                 }
1144
1145                 if (!winbind_name_to_sid_string(ctx, user,
1146                                                 current_name,
1147                                                 sid_list_buffer,
1148                                                 sid_list_buffer_size)) {
1149                         /*
1150                          * If one group name failed, we must not fail
1151                          * the authentication totally, continue with
1152                          * the following group names. If user belongs to
1153                          * one of the valid groups, we must allow it
1154                          * login. -- BoYang
1155                          */
1156
1157                         _pam_log(ctx, LOG_INFO, "cannot convert group %s to sid, "
1158                                  "check if group %s is valid group.", current_name,
1159                                  current_name);
1160                         _make_remark_format(ctx, PAM_TEXT_INFO, _("Cannot convert group %s "
1161                                         "to sid, please contact your administrator to see "
1162                                         "if group %s is valid."), current_name, current_name);
1163                         SAFE_FREE(current_name);
1164                         search_location = comma + 1;
1165                         continue;
1166                 }
1167
1168                 SAFE_FREE(current_name);
1169
1170                 if (!safe_append_string(sid_list_buffer, ",",
1171                                         sid_list_buffer_size)) {
1172                         goto out;
1173                 }
1174
1175                 search_location = comma + 1;
1176         }
1177
1178         if (!winbind_name_to_sid_string(ctx, user, search_location,
1179                                         sid_list_buffer,
1180                                         sid_list_buffer_size)) {
1181                 _pam_log(ctx, LOG_INFO, "cannot convert group %s to sid, "
1182                          "check if group %s is valid group.", search_location,
1183                          search_location);
1184                 _make_remark_format(ctx, PAM_TEXT_INFO, _("Cannot convert group %s "
1185                                 "to sid, please contact your administrator to see "
1186                                 "if group %s is valid."), search_location, search_location);
1187
1188                 /* If no valid groups were converted we should fail outright */
1189                 if (name_list != NULL && strlen(sid_list_buffer) == 0) {
1190                         result = false;
1191                         goto out;
1192                 }
1193                 /*
1194                  * The lookup of the last name failed..
1195                  * It results in require_member_of_sid ends with ','
1196                  * It is malformated parameter here, overwrite the last ','.
1197                  */
1198                 len = strlen(sid_list_buffer);
1199                 if ((len != 0) && (sid_list_buffer[len - 1] == ',')) {
1200                         sid_list_buffer[len - 1] = '\0';
1201                 }
1202         }
1203
1204         result = true;
1205
1206 out:
1207         SAFE_FREE(current_name);
1208         return result;
1209 }
1210
1211 /**
1212  * put krb5ccname variable into environment
1213  *
1214  * @param ctx PAM winbind context.
1215  * @param krb5ccname env variable retrieved from winbindd.
1216  *
1217  * @return void.
1218  */
1219
1220 static void _pam_setup_krb5_env(struct pwb_context *ctx,
1221                                 struct wbcLogonUserInfo *info)
1222 {
1223         char var[PATH_MAX];
1224         int ret;
1225         uint32_t i;
1226         const char *krb5ccname = NULL;
1227
1228         if (off(ctx->ctrl, WINBIND_KRB5_AUTH)) {
1229                 return;
1230         }
1231
1232         if (!info) {
1233                 return;
1234         }
1235
1236         for (i=0; i < info->num_blobs; i++) {
1237                 if (strcasecmp(info->blobs[i].name, "krb5ccname") == 0) {
1238                         krb5ccname = (const char *)info->blobs[i].blob.data;
1239                         break;
1240                 }
1241         }
1242
1243         if (!krb5ccname || (strlen(krb5ccname) == 0)) {
1244                 return;
1245         }
1246
1247         _pam_log_debug(ctx, LOG_DEBUG,
1248                        "request returned KRB5CCNAME: %s", krb5ccname);
1249
1250         if (snprintf(var, sizeof(var), "KRB5CCNAME=%s", krb5ccname) == -1) {
1251                 return;
1252         }
1253
1254         ret = pam_putenv(ctx->pamh, var);
1255         if (ret) {
1256                 _pam_log(ctx, LOG_ERR,
1257                          "failed to set KRB5CCNAME to %s: %s",
1258                          var, pam_strerror(ctx->pamh, ret));
1259         }
1260 }
1261
1262 /**
1263  * Copy unix username if available (further processed in PAM).
1264  *
1265  * @param ctx PAM winbind context
1266  * @param user_ret A pointer that holds a pointer to a string
1267  * @param unix_username A username
1268  *
1269  * @return void.
1270  */
1271
1272 static void _pam_setup_unix_username(struct pwb_context *ctx,
1273                                      char **user_ret,
1274                                      struct wbcLogonUserInfo *info)
1275 {
1276         const char *unix_username = NULL;
1277         uint32_t i;
1278
1279         if (!user_ret || !info) {
1280                 return;
1281         }
1282
1283         for (i=0; i < info->num_blobs; i++) {
1284                 if (strcasecmp(info->blobs[i].name, "unix_username") == 0) {
1285                         unix_username = (const char *)info->blobs[i].blob.data;
1286                         break;
1287                 }
1288         }
1289
1290         if (!unix_username || !unix_username[0]) {
1291                 return;
1292         }
1293
1294         *user_ret = strdup(unix_username);
1295 }
1296
1297 /**
1298  * Set string into the PAM stack.
1299  *
1300  * @param ctx PAM winbind context.
1301  * @param data_name Key name for pam_set_data.
1302  * @param value String value.
1303  *
1304  * @return void.
1305  */
1306
1307 static void _pam_set_data_string(struct pwb_context *ctx,
1308                                  const char *data_name,
1309                                  const char *value)
1310 {
1311         int ret;
1312
1313         if (!data_name || !value || (strlen(data_name) == 0) ||
1314              (strlen(value) == 0)) {
1315                 return;
1316         }
1317
1318         ret = pam_set_data(ctx->pamh, data_name, talloc_strdup(NULL, value),
1319                            _pam_winbind_cleanup_func);
1320         if (ret) {
1321                 _pam_log_debug(ctx, LOG_DEBUG,
1322                                "Could not set data %s: %s\n",
1323                                data_name, pam_strerror(ctx->pamh, ret));
1324         }
1325 }
1326
1327 /**
1328  * Set info3 strings into the PAM stack.
1329  *
1330  * @param ctx PAM winbind context.
1331  * @param data_name Key name for pam_set_data.
1332  * @param value String value.
1333  *
1334  * @return void.
1335  */
1336
1337 static void _pam_set_data_info3(struct pwb_context *ctx,
1338                                 const struct wbcAuthUserInfo *info)
1339 {
1340         _pam_set_data_string(ctx, PAM_WINBIND_HOMEDIR,
1341                              info->home_directory);
1342         _pam_set_data_string(ctx, PAM_WINBIND_LOGONSCRIPT,
1343                              info->logon_script);
1344         _pam_set_data_string(ctx, PAM_WINBIND_LOGONSERVER,
1345                              info->logon_server);
1346         _pam_set_data_string(ctx, PAM_WINBIND_PROFILEPATH,
1347                              info->profile_path);
1348 }
1349
1350 /**
1351  * Free info3 strings in the PAM stack.
1352  *
1353  * @param pamh PAM handle
1354  *
1355  * @return void.
1356  */
1357
1358 static void _pam_free_data_info3(pam_handle_t *pamh)
1359 {
1360         pam_set_data(pamh, PAM_WINBIND_HOMEDIR, NULL, NULL);
1361         pam_set_data(pamh, PAM_WINBIND_LOGONSCRIPT, NULL, NULL);
1362         pam_set_data(pamh, PAM_WINBIND_LOGONSERVER, NULL, NULL);
1363         pam_set_data(pamh, PAM_WINBIND_PROFILEPATH, NULL, NULL);
1364 }
1365
1366 /**
1367  * Send PAM_ERROR_MSG for cached or grace logons.
1368  *
1369  * @param ctx PAM winbind context.
1370  * @param username User in PAM request.
1371  * @param info3_user_flgs Info3 flags containing logon type bits.
1372  *
1373  * @return void.
1374  */
1375
1376 static void _pam_warn_logon_type(struct pwb_context *ctx,
1377                                  const char *username,
1378                                  uint32_t info3_user_flgs)
1379 {
1380         /* inform about logon type */
1381         if (PAM_WB_GRACE_LOGON(info3_user_flgs)) {
1382
1383                 _make_remark(ctx, PAM_ERROR_MSG,
1384                              _("Grace login. "
1385                                "Please change your password as soon you're "
1386                                "online again"));
1387                 _pam_log_debug(ctx, LOG_DEBUG,
1388                                "User %s logged on using grace logon\n",
1389                                username);
1390
1391         } else if (PAM_WB_CACHED_LOGON(info3_user_flgs)) {
1392
1393                 _make_remark(ctx, PAM_ERROR_MSG,
1394                              _("Domain Controller unreachable, "
1395                                "using cached credentials instead. "
1396                                "Network resources may be unavailable"));
1397                 _pam_log_debug(ctx, LOG_DEBUG,
1398                                "User %s logged on using cached credentials\n",
1399                                username);
1400         }
1401 }
1402
1403 /**
1404  * Send PAM_ERROR_MSG for krb5 errors.
1405  *
1406  * @param ctx PAM winbind context.
1407  * @param username User in PAM request.
1408  * @param info3_user_flgs Info3 flags containing logon type bits.
1409  *
1410  * @return void.
1411  */
1412
1413 static void _pam_warn_krb5_failure(struct pwb_context *ctx,
1414                                    const char *username,
1415                                    uint32_t info3_user_flgs)
1416 {
1417         if (PAM_WB_KRB5_CLOCK_SKEW(info3_user_flgs)) {
1418                 _make_remark(ctx, PAM_ERROR_MSG,
1419                              _("Failed to establish your Kerberos Ticket cache "
1420                                "due time differences\n"
1421                                "with the domain controller.  "
1422                                "Please verify the system time.\n"));
1423                 _pam_log_debug(ctx, LOG_DEBUG,
1424                                "User %s: Clock skew when getting Krb5 TGT\n",
1425                                username);
1426         }
1427 }
1428
1429 static bool _pam_check_remark_auth_err(struct pwb_context *ctx,
1430                                        const struct wbcAuthErrorInfo *e,
1431                                        const char *nt_status_string,
1432                                        int *pam_err)
1433 {
1434         const char *ntstatus = NULL;
1435         const char *error_string = NULL;
1436
1437         if (!e || !pam_err) {
1438                 return false;
1439         }
1440
1441         ntstatus = e->nt_string;
1442         if (!ntstatus) {
1443                 return false;
1444         }
1445
1446         if (strcasecmp(ntstatus, nt_status_string) == 0) {
1447
1448                 error_string = _get_ntstatus_error_string(nt_status_string);
1449                 if (error_string) {
1450                         _make_remark(ctx, PAM_ERROR_MSG, error_string);
1451                         *pam_err = e->pam_error;
1452                         return true;
1453                 }
1454
1455                 if (e->display_string) {
1456                         _make_remark(ctx, PAM_ERROR_MSG, _(e->display_string));
1457                         *pam_err = e->pam_error;
1458                         return true;
1459                 }
1460
1461                 _make_remark(ctx, PAM_ERROR_MSG, nt_status_string);
1462                 *pam_err = e->pam_error;
1463
1464                 return true;
1465         }
1466
1467         return false;
1468 };
1469
1470 /**
1471  * Compose Password Restriction String for a PAM_ERROR_MSG conversation.
1472  *
1473  * @param i The wbcUserPasswordPolicyInfo struct.
1474  *
1475  * @return string (caller needs to talloc_free).
1476  */
1477
1478 static char *_pam_compose_pwd_restriction_string(struct pwb_context *ctx,
1479                                                  struct wbcUserPasswordPolicyInfo *i)
1480 {
1481         char *str = NULL;
1482
1483         if (!i) {
1484                 goto failed;
1485         }
1486
1487         str = talloc_asprintf(ctx, _("Your password "));
1488         if (!str) {
1489                 goto failed;
1490         }
1491
1492         if (i->min_length_password > 0) {
1493                 str = talloc_asprintf_append(str,
1494                                _("must be at least %d characters; "),
1495                                i->min_length_password);
1496                 if (!str) {
1497                         goto failed;
1498                 }
1499         }
1500
1501         if (i->password_history > 0) {
1502                 str = talloc_asprintf_append(str,
1503                                _("cannot repeat any of your previous %d "
1504                                 "passwords; "),
1505                                i->password_history);
1506                 if (!str) {
1507                         goto failed;
1508                 }
1509         }
1510
1511         if (i->password_properties & WBC_DOMAIN_PASSWORD_COMPLEX) {
1512                 str = talloc_asprintf_append(str,
1513                                _("must contain capitals, numerals "
1514                                  "or punctuation; "
1515                                  "and cannot contain your account "
1516                                  "or full name; "));
1517                 if (!str) {
1518                         goto failed;
1519                 }
1520         }
1521
1522         str = talloc_asprintf_append(str,
1523                        _("Please type a different password. "
1524                          "Type a password which meets these requirements in "
1525                          "both text boxes."));
1526         if (!str) {
1527                 goto failed;
1528         }
1529
1530         return str;
1531
1532  failed:
1533         TALLOC_FREE(str);
1534         return NULL;
1535 }
1536
1537 static int _pam_create_homedir(struct pwb_context *ctx,
1538                                const char *dirname,
1539                                mode_t mode)
1540 {
1541         struct stat sbuf;
1542
1543         if (stat(dirname, &sbuf) == 0) {
1544                 return PAM_SUCCESS;
1545         }
1546
1547         if (mkdir(dirname, mode) != 0) {
1548
1549                 _make_remark_format(ctx, PAM_TEXT_INFO,
1550                                     _("Creating directory: %s failed: %s"),
1551                                     dirname, strerror(errno));
1552                 _pam_log(ctx, LOG_ERR, "could not create dir: %s (%s)",
1553                  dirname, strerror(errno));
1554                  return PAM_PERM_DENIED;
1555         }
1556
1557         return PAM_SUCCESS;
1558 }
1559
1560 static int _pam_chown_homedir(struct pwb_context *ctx,
1561                               const char *dirname,
1562                               uid_t uid,
1563                               gid_t gid)
1564 {
1565         if (chown(dirname, uid, gid) != 0) {
1566                 _pam_log(ctx, LOG_ERR, "failed to chown user homedir: %s (%s)",
1567                          dirname, strerror(errno));
1568                 return PAM_PERM_DENIED;
1569         }
1570
1571         return PAM_SUCCESS;
1572 }
1573
1574 static int _pam_mkhomedir(struct pwb_context *ctx)
1575 {
1576         struct passwd *pwd = NULL;
1577         char *token = NULL;
1578         char *create_dir = NULL;
1579         char *user_dir = NULL;
1580         int ret;
1581         const char *username;
1582         mode_t mode = 0700;
1583         char *safe_ptr = NULL;
1584         char *p = NULL;
1585
1586         /* Get the username */
1587         ret = pam_get_user(ctx->pamh, &username, NULL);
1588         if ((ret != PAM_SUCCESS) || (!username)) {
1589                 _pam_log_debug(ctx, LOG_DEBUG, "can not get the username");
1590                 return PAM_SERVICE_ERR;
1591         }
1592
1593         pwd = getpwnam(username);
1594         if (pwd == NULL) {
1595                 _pam_log_debug(ctx, LOG_DEBUG, "can not get the username");
1596                 return PAM_USER_UNKNOWN;
1597         }
1598         _pam_log_debug(ctx, LOG_DEBUG, "homedir is: %s", pwd->pw_dir);
1599
1600         ret = _pam_create_homedir(ctx, pwd->pw_dir, 0700);
1601         if (ret == PAM_SUCCESS) {
1602                 ret = _pam_chown_homedir(ctx, pwd->pw_dir,
1603                                          pwd->pw_uid,
1604                                          pwd->pw_gid);
1605         }
1606
1607         if (ret == PAM_SUCCESS) {
1608                 return ret;
1609         }
1610
1611         /* maybe we need to create parent dirs */
1612         create_dir = talloc_strdup(ctx, "/");
1613         if (!create_dir) {
1614                 return PAM_BUF_ERR;
1615         }
1616
1617         /* find final directory */
1618         user_dir = strrchr(pwd->pw_dir, '/');
1619         if (!user_dir) {
1620                 return PAM_BUF_ERR;
1621         }
1622         user_dir++;
1623
1624         _pam_log(ctx, LOG_DEBUG, "final directory: %s", user_dir);
1625
1626         p = pwd->pw_dir;
1627
1628         while ((token = strtok_r(p, "/", &safe_ptr)) != NULL) {
1629
1630                 mode = 0755;
1631
1632                 p = NULL;
1633
1634                 _pam_log_debug(ctx, LOG_DEBUG, "token is %s", token);
1635
1636                 create_dir = talloc_asprintf_append(create_dir, "%s/", token);
1637                 if (!create_dir) {
1638                         return PAM_BUF_ERR;
1639                 }
1640                 _pam_log_debug(ctx, LOG_DEBUG, "current_dir is %s", create_dir);
1641
1642                 if (strcmp(token, user_dir) == 0) {
1643                         _pam_log_debug(ctx, LOG_DEBUG, "assuming last directory: %s", token);
1644                         mode = 0700;
1645                 }
1646
1647                 ret = _pam_create_homedir(ctx, create_dir, mode);
1648                 if (ret) {
1649                         return ret;
1650                 }
1651         }
1652
1653         return _pam_chown_homedir(ctx, create_dir,
1654                                   pwd->pw_uid,
1655                                   pwd->pw_gid);
1656 }
1657
1658 /* talk to winbindd */
1659 static int winbind_auth_request(struct pwb_context *ctx,
1660                                 const char *user,
1661                                 const char *pass,
1662                                 const char *member,
1663                                 const char *cctype,
1664                                 const int warn_pwd_expire,
1665                                 struct wbcAuthErrorInfo **p_error,
1666                                 struct wbcLogonUserInfo **p_info,
1667                                 struct wbcUserPasswordPolicyInfo **p_policy,
1668                                 time_t *pwd_last_set,
1669                                 char **user_ret)
1670 {
1671         wbcErr wbc_status;
1672
1673         struct wbcLogonUserParams logon;
1674         char membership_of[1024];
1675         uid_t user_uid = -1;
1676         uint32_t flags = WBFLAG_PAM_INFO3_TEXT |
1677                          WBFLAG_PAM_GET_PWD_POLICY;
1678
1679         struct wbcLogonUserInfo *info = NULL;
1680         struct wbcAuthUserInfo *user_info = NULL;
1681         struct wbcAuthErrorInfo *error = NULL;
1682         struct wbcUserPasswordPolicyInfo *policy = NULL;
1683
1684         int ret = PAM_AUTH_ERR;
1685         int i;
1686         const char *codes[] = {
1687                 "NT_STATUS_PASSWORD_EXPIRED",
1688                 "NT_STATUS_PASSWORD_MUST_CHANGE",
1689                 "NT_STATUS_INVALID_WORKSTATION",
1690                 "NT_STATUS_INVALID_LOGON_HOURS",
1691                 "NT_STATUS_ACCOUNT_EXPIRED",
1692                 "NT_STATUS_ACCOUNT_DISABLED",
1693                 "NT_STATUS_ACCOUNT_LOCKED_OUT",
1694                 "NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
1695                 "NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
1696                 "NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
1697                 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1698                 "NT_STATUS_NO_LOGON_SERVERS",
1699                 "NT_STATUS_WRONG_PASSWORD",
1700                 "NT_STATUS_ACCESS_DENIED"
1701         };
1702
1703         if (pwd_last_set) {
1704                 *pwd_last_set = 0;
1705         }
1706
1707         /* Krb5 auth always has to go against the KDC of the user's realm */
1708
1709         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1710                 flags           |= WBFLAG_PAM_CONTACT_TRUSTDOM;
1711         }
1712
1713         if (ctx->ctrl & (WINBIND_KRB5_AUTH|WINBIND_CACHED_LOGIN)) {
1714                 struct passwd *pwd = NULL;
1715
1716                 pwd = getpwnam(user);
1717                 if (pwd == NULL) {
1718                         return PAM_USER_UNKNOWN;
1719                 }
1720                 user_uid        = pwd->pw_uid;
1721         }
1722
1723         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1724
1725                 _pam_log_debug(ctx, LOG_DEBUG,
1726                                "enabling krb5 login flag\n");
1727
1728                 flags           |= WBFLAG_PAM_KRB5 |
1729                                    WBFLAG_PAM_FALLBACK_AFTER_KRB5;
1730         }
1731
1732         if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1733                 _pam_log_debug(ctx, LOG_DEBUG,
1734                                "enabling cached login flag\n");
1735                 flags           |= WBFLAG_PAM_CACHED_LOGIN;
1736         }
1737
1738         if (user_ret) {
1739                 *user_ret = NULL;
1740                 flags           |= WBFLAG_PAM_UNIX_NAME;
1741         }
1742
1743         if (cctype != NULL) {
1744                 _pam_log_debug(ctx, LOG_DEBUG,
1745                                "enabling request for a %s krb5 ccache\n",
1746                                cctype);
1747         }
1748
1749         if (member != NULL) {
1750
1751                 ZERO_STRUCT(membership_of);
1752
1753                 if (!winbind_name_list_to_sid_string_list(ctx, user, member,
1754                                                           membership_of,
1755                                                           sizeof(membership_of))) {
1756                         _pam_log_debug(ctx, LOG_ERR,
1757                                        "failed to serialize membership of sid "
1758                                        "\"%s\"\n", member);
1759                         return PAM_AUTH_ERR;
1760                 }
1761         }
1762
1763         ZERO_STRUCT(logon);
1764
1765         logon.username                  = user;
1766         logon.password                  = pass;
1767
1768         if (cctype) {
1769                 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1770                                              &logon.blobs,
1771                                              "krb5_cc_type",
1772                                              0,
1773                                              (uint8_t *)cctype,
1774                                              strlen(cctype)+1);
1775                 if (!WBC_ERROR_IS_OK(wbc_status)) {
1776                         goto done;
1777                 }
1778         }
1779
1780         wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1781                                      &logon.blobs,
1782                                      "flags",
1783                                      0,
1784                                      (uint8_t *)&flags,
1785                                      sizeof(flags));
1786         if (!WBC_ERROR_IS_OK(wbc_status)) {
1787                 goto done;
1788         }
1789
1790         wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1791                                      &logon.blobs,
1792                                      "user_uid",
1793                                      0,
1794                                      (uint8_t *)&user_uid,
1795                                      sizeof(user_uid));
1796         if (!WBC_ERROR_IS_OK(wbc_status)) {
1797                 goto done;
1798         }
1799
1800         if (member) {
1801                 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1802                                              &logon.blobs,
1803                                              "membership_of",
1804                                              0,
1805                                              (uint8_t *)membership_of,
1806                                              sizeof(membership_of));
1807                 if (!WBC_ERROR_IS_OK(wbc_status)) {
1808                         goto done;
1809                 }
1810         }
1811
1812         wbc_status = wbcLogonUser(&logon, &info, &error, &policy);
1813         ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1814                                           user, "wbcLogonUser");
1815         wbcFreeMemory(logon.blobs);
1816         logon.blobs = NULL;
1817
1818         if (info && info->info) {
1819                 user_info = info->info;
1820         }
1821
1822         if (pwd_last_set && user_info) {
1823                 *pwd_last_set = user_info->pass_last_set_time;
1824         }
1825
1826         if (p_info && info) {
1827                 *p_info = info;
1828         }
1829
1830         if (p_policy && policy) {
1831                 *p_policy = policy;
1832         }
1833
1834         if (p_error && error) {
1835                 /* We want to process the error in the caller. */
1836                 *p_error = error;
1837                 return ret;
1838         }
1839
1840         for (i=0; i<ARRAY_SIZE(codes); i++) {
1841                 int _ret = ret;
1842                 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1843                         ret = _ret;
1844                         goto done;
1845                 }
1846         }
1847
1848         if ((ret == PAM_SUCCESS) && user_info && policy && info) {
1849
1850                 bool already_expired = false;
1851                 bool change_pwd = false;
1852
1853                 /* warn a user if the password is about to expire soon */
1854                 _pam_warn_password_expiry(ctx, user_info, policy,
1855                                           warn_pwd_expire,
1856                                           &already_expired,
1857                                           &change_pwd);
1858
1859                 if (already_expired == true) {
1860
1861                         SMB_TIME_T last_set = user_info->pass_last_set_time;
1862
1863                         _pam_log_debug(ctx, LOG_DEBUG,
1864                                        "Password has expired "
1865                                        "(Password was last set: %lld, "
1866                                        "the policy says it should expire here "
1867                                        "%lld (now it's: %ld))\n",
1868                                        (long long int)last_set,
1869                                        (long long int)last_set +
1870                                        policy->expire,
1871                                        (long)time(NULL));
1872
1873                         return PAM_AUTHTOK_EXPIRED;
1874                 }
1875
1876                 if (change_pwd) {
1877                         ret = PAM_NEW_AUTHTOK_REQD;
1878                         goto done;
1879                 }
1880
1881                 /* inform about logon type */
1882                 _pam_warn_logon_type(ctx, user, user_info->user_flags);
1883
1884                 /* inform about krb5 failures */
1885                 _pam_warn_krb5_failure(ctx, user, user_info->user_flags);
1886
1887                 /* set some info3 info for other modules in the stack */
1888                 _pam_set_data_info3(ctx, user_info);
1889
1890                 /* put krb5ccname into env */
1891                 _pam_setup_krb5_env(ctx, info);
1892
1893                 /* If winbindd returned a username, return the pointer to it
1894                  * here. */
1895                 _pam_setup_unix_username(ctx, user_ret, info);
1896         }
1897
1898  done:
1899         wbcFreeMemory(logon.blobs);
1900         if (info && info->blobs && !p_info) {
1901                 wbcFreeMemory(info->blobs);
1902         }
1903         if (error && !p_error) {
1904                 wbcFreeMemory(error);
1905         }
1906         if (info && !p_info) {
1907                 wbcFreeMemory(info);
1908         }
1909         if (policy && !p_policy) {
1910                 wbcFreeMemory(policy);
1911         }
1912
1913         return ret;
1914 }
1915
1916 /* talk to winbindd */
1917 static int winbind_chauthtok_request(struct pwb_context *ctx,
1918                                      const char *user,
1919                                      const char *oldpass,
1920                                      const char *newpass,
1921                                      time_t pwd_last_set)
1922 {
1923         wbcErr wbc_status;
1924         struct wbcChangePasswordParams params;
1925         struct wbcAuthErrorInfo *error = NULL;
1926         struct wbcUserPasswordPolicyInfo *policy = NULL;
1927         enum wbcPasswordChangeRejectReason reject_reason = -1;
1928         uint32_t flags = 0;
1929
1930         int i;
1931         const char *codes[] = {
1932                 "NT_STATUS_BACKUP_CONTROLLER",
1933                 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1934                 "NT_STATUS_NO_LOGON_SERVERS",
1935                 "NT_STATUS_ACCESS_DENIED",
1936                 "NT_STATUS_PWD_TOO_SHORT", /* TODO: tell the min pwd length ? */
1937                 "NT_STATUS_PWD_TOO_RECENT", /* TODO: tell the minage ? */
1938                 "NT_STATUS_PWD_HISTORY_CONFLICT" /* TODO: tell the history length ? */
1939         };
1940         int ret = PAM_AUTH_ERR;
1941
1942         ZERO_STRUCT(params);
1943
1944         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1945                 flags |= WBFLAG_PAM_KRB5 |
1946                          WBFLAG_PAM_CONTACT_TRUSTDOM;
1947         }
1948
1949         if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1950                 flags |= WBFLAG_PAM_CACHED_LOGIN;
1951         }
1952
1953         params.account_name             = user;
1954         params.level                    = WBC_AUTH_USER_LEVEL_PLAIN;
1955         params.old_password.plaintext   = oldpass;
1956         params.new_password.plaintext   = newpass;
1957         params.flags                    = flags;
1958
1959         wbc_status = wbcChangeUserPasswordEx(&params, &error, &reject_reason, &policy);
1960         ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1961                                           user, "wbcChangeUserPasswordEx");
1962
1963         if (WBC_ERROR_IS_OK(wbc_status)) {
1964                 _pam_log(ctx, LOG_NOTICE,
1965                          "user '%s' password changed", user);
1966                 return PAM_SUCCESS;
1967         }
1968
1969         if (!error) {
1970                 wbcFreeMemory(policy);
1971                 return ret;
1972         }
1973
1974         for (i=0; i<ARRAY_SIZE(codes); i++) {
1975                 int _ret = ret;
1976                 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1977                         ret = _ret;
1978                         goto done;
1979                 }
1980         }
1981
1982         if (!strcasecmp(error->nt_string,
1983                         "NT_STATUS_PASSWORD_RESTRICTION")) {
1984
1985                 char *pwd_restriction_string = NULL;
1986                 SMB_TIME_T min_pwd_age = 0;
1987
1988                 if (policy) {
1989                         min_pwd_age     = policy->min_passwordage;
1990                 }
1991
1992                 /* FIXME: avoid to send multiple PAM messages after another */
1993                 switch (reject_reason) {
1994                         case -1:
1995                                 break;
1996                         case WBC_PWD_CHANGE_NO_ERROR:
1997                                 if ((min_pwd_age > 0) &&
1998                                     (pwd_last_set + min_pwd_age > time(NULL))) {
1999                                         PAM_WB_REMARK_DIRECT(ctx,
2000                                              "NT_STATUS_PWD_TOO_RECENT");
2001                                 }
2002                                 break;
2003                         case WBC_PWD_CHANGE_PASSWORD_TOO_SHORT:
2004                                 PAM_WB_REMARK_DIRECT(ctx,
2005                                         "NT_STATUS_PWD_TOO_SHORT");
2006                                 break;
2007                         case WBC_PWD_CHANGE_PWD_IN_HISTORY:
2008                                 PAM_WB_REMARK_DIRECT(ctx,
2009                                         "NT_STATUS_PWD_HISTORY_CONFLICT");
2010                                 break;
2011                         case WBC_PWD_CHANGE_NOT_COMPLEX:
2012                                 _make_remark(ctx, PAM_ERROR_MSG,
2013                                              _("Password does not meet "
2014                                                "complexity requirements"));
2015                                 break;
2016                         default:
2017                                 _pam_log_debug(ctx, LOG_DEBUG,
2018                                                "unknown password change "
2019                                                "reject reason: %d",
2020                                                reject_reason);
2021                                 break;
2022                 }
2023
2024                 pwd_restriction_string =
2025                         _pam_compose_pwd_restriction_string(ctx, policy);
2026                 if (pwd_restriction_string) {
2027                         _make_remark(ctx, PAM_ERROR_MSG,
2028                                      pwd_restriction_string);
2029                         TALLOC_FREE(pwd_restriction_string);
2030                 }
2031         }
2032  done:
2033         wbcFreeMemory(error);
2034         wbcFreeMemory(policy);
2035
2036         return ret;
2037 }
2038
2039 /*
2040  * Checks if a user has an account
2041  *
2042  * return values:
2043  *       1  = User not found
2044  *       0  = OK
2045  *      -1  = System error
2046  */
2047 static int valid_user(struct pwb_context *ctx,
2048                       const char *user)
2049 {
2050         /* check not only if the user is available over NSS calls, also make
2051          * sure it's really a winbind user, this is important when stacking PAM
2052          * modules in the 'account' or 'password' facility. */
2053
2054         wbcErr wbc_status;
2055         struct passwd *pwd = NULL;
2056         struct passwd *wb_pwd = NULL;
2057
2058         pwd = getpwnam(user);
2059         if (pwd == NULL) {
2060                 return 1;
2061         }
2062
2063         wbc_status = wbcGetpwnam(user, &wb_pwd);
2064         wbcFreeMemory(wb_pwd);
2065         if (!WBC_ERROR_IS_OK(wbc_status)) {
2066                 _pam_log(ctx, LOG_DEBUG, "valid_user: wbcGetpwnam gave %s\n",
2067                         wbcErrorString(wbc_status));
2068         }
2069
2070         switch (wbc_status) {
2071                 case WBC_ERR_UNKNOWN_USER:
2072                 /* match other insane libwbclient return codes */
2073                 case WBC_ERR_WINBIND_NOT_AVAILABLE:
2074                 case WBC_ERR_DOMAIN_NOT_FOUND:
2075                         return 1;
2076                 case WBC_ERR_SUCCESS:
2077                         return 0;
2078                 default:
2079                         break;
2080         }
2081         return -1;
2082 }
2083
2084 static char *_pam_delete(register char *xx)
2085 {
2086         _pam_overwrite(xx);
2087         _pam_drop(xx);
2088         return NULL;
2089 }
2090
2091 /*
2092  * obtain a password from the user
2093  */
2094
2095 static int _winbind_read_password(struct pwb_context *ctx,
2096                                   unsigned int ctrl,
2097                                   const char *comment,
2098                                   const char *prompt1,
2099                                   const char *prompt2,
2100                                   const char **pass)
2101 {
2102         int authtok_flag;
2103         int retval;
2104         const char *item;
2105         char *token;
2106
2107         _pam_log(ctx, LOG_DEBUG, "getting password (0x%08x)", ctrl);
2108
2109         /*
2110          * make sure nothing inappropriate gets returned
2111          */
2112
2113         *pass = token = NULL;
2114
2115         /*
2116          * which authentication token are we getting?
2117          */
2118
2119         if (on(WINBIND__OLD_PASSWORD, ctrl)) {
2120                 authtok_flag = PAM_OLDAUTHTOK;
2121         } else {
2122                 authtok_flag = PAM_AUTHTOK;
2123         }
2124
2125         /*
2126          * should we obtain the password from a PAM item ?
2127          */
2128
2129         if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) ||
2130             on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
2131                 retval = _pam_get_item(ctx->pamh, authtok_flag, &item);
2132                 if (retval != PAM_SUCCESS) {
2133                         /* very strange. */
2134                         _pam_log(ctx, LOG_ALERT,
2135                                  "pam_get_item returned error "
2136                                  "to unix-read-password");
2137                         return retval;
2138                 } else if (item != NULL) {      /* we have a password! */
2139                         *pass = item;
2140                         item = NULL;
2141                         _pam_log(ctx, LOG_DEBUG,
2142                                  "pam_get_item returned a password");
2143                         return PAM_SUCCESS;
2144                 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
2145                         return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
2146                 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
2147                            && off(WINBIND__OLD_PASSWORD, ctrl)) {
2148                         return PAM_AUTHTOK_RECOVER_ERR;
2149                 }
2150         }
2151         /*
2152          * getting here implies we will have to get the password from the
2153          * user directly.
2154          */
2155
2156         {
2157                 struct pam_message msg[3], *pmsg[3];
2158                 struct pam_response *resp;
2159                 int i, replies;
2160
2161                 /* prepare to converse */
2162
2163                 if (comment != NULL && off(ctrl, WINBIND_SILENT)) {
2164                         pmsg[0] = &msg[0];
2165                         msg[0].msg_style = PAM_TEXT_INFO;
2166                         msg[0].msg = discard_const_p(char, comment);
2167                         i = 1;
2168                 } else {
2169                         i = 0;
2170                 }
2171
2172                 pmsg[i] = &msg[i];
2173                 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
2174                 msg[i++].msg = discard_const_p(char, prompt1);
2175                 replies = 1;
2176
2177                 if (prompt2 != NULL) {
2178                         pmsg[i] = &msg[i];
2179                         msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
2180                         msg[i++].msg = discard_const_p(char, prompt2);
2181                         ++replies;
2182                 }
2183                 /* so call the conversation expecting i responses */
2184                 resp = NULL;
2185                 retval = converse(ctx->pamh, i, pmsg, &resp);
2186                 if (resp == NULL) {
2187                         if (retval == PAM_SUCCESS) {
2188                                 retval = PAM_AUTHTOK_RECOVER_ERR;
2189                         }
2190                         goto done;
2191                 }
2192                 if (retval != PAM_SUCCESS) {
2193                         _pam_drop_reply(resp, i);
2194                         goto done;
2195                 }
2196
2197                 /* interpret the response */
2198
2199                 token = x_strdup(resp[i - replies].resp);
2200                 if (!token) {
2201                         _pam_log(ctx, LOG_NOTICE,
2202                                  "could not recover "
2203                                  "authentication token");
2204                         retval = PAM_AUTHTOK_RECOVER_ERR;
2205                         goto done;
2206                 }
2207
2208                 if (replies == 2) {
2209                         /* verify that password entered correctly */
2210                         if (!resp[i - 1].resp ||
2211                             strcmp(token, resp[i - 1].resp)) {
2212                                 _pam_delete(token);     /* mistyped */
2213                                 retval = PAM_AUTHTOK_RECOVER_ERR;
2214                                 _make_remark(ctx, PAM_ERROR_MSG,
2215                                              MISTYPED_PASS);
2216                         }
2217                 }
2218
2219                 /*
2220                  * tidy up the conversation (resp_retcode) is ignored
2221                  * -- what is it for anyway? AGM
2222                  */
2223                 _pam_drop_reply(resp, i);
2224         }
2225
2226  done:
2227         if (retval != PAM_SUCCESS) {
2228                 _pam_log_debug(ctx, LOG_DEBUG,
2229                                "unable to obtain a password");
2230                 return retval;
2231         }
2232         /* 'token' is the entered password */
2233
2234         /* we store this password as an item */
2235
2236         retval = pam_set_item(ctx->pamh, authtok_flag, token);
2237         _pam_delete(token);     /* clean it up */
2238         if (retval != PAM_SUCCESS ||
2239             (retval = _pam_get_item(ctx->pamh, authtok_flag, &item)) != PAM_SUCCESS) {
2240
2241                 _pam_log(ctx, LOG_CRIT, "error manipulating password");
2242                 return retval;
2243
2244         }
2245
2246         *pass = item;
2247         item = NULL;            /* break link to password */
2248
2249         return PAM_SUCCESS;
2250 }
2251
2252 static const char *get_conf_item_string(struct pwb_context *ctx,
2253                                         const char *item,
2254                                         int config_flag)
2255 {
2256         int i = 0;
2257         const char *parm_opt = NULL;
2258
2259         if (!(ctx->ctrl & config_flag)) {
2260                 goto out;
2261         }
2262
2263         /* let the pam opt take precedence over the pam_winbind.conf option */
2264         for (i=0; i<ctx->argc; i++) {
2265
2266                 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2267                         char *p;
2268
2269                         if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2270                                 _pam_log(ctx, LOG_INFO,
2271                                          "no \"=\" delimiter for \"%s\" found\n",
2272                                          item);
2273                                 goto out;
2274                         }
2275                         _pam_log_debug(ctx, LOG_INFO,
2276                                        "PAM config: %s '%s'\n", item, p+1);
2277                         return p + 1;
2278                 }
2279         }
2280
2281         if (ctx->dict) {
2282                 char *key = NULL;
2283
2284                 key = talloc_asprintf(ctx, "global:%s", item);
2285                 if (!key) {
2286                         goto out;
2287                 }
2288
2289                 parm_opt = iniparser_getstring(ctx->dict, key, NULL);
2290                 TALLOC_FREE(key);
2291
2292                 _pam_log_debug(ctx, LOG_INFO, "CONFIG file: %s '%s'\n",
2293                                item, parm_opt);
2294         }
2295 out:
2296         return parm_opt;
2297 }
2298
2299 static int get_config_item_int(struct pwb_context *ctx,
2300                                const char *item,
2301                                int config_flag)
2302 {
2303         int i, parm_opt = -1;
2304
2305         if (!(ctx->ctrl & config_flag)) {
2306                 goto out;
2307         }
2308
2309         /* let the pam opt take precedence over the pam_winbind.conf option */
2310         for (i = 0; i < ctx->argc; i++) {
2311
2312                 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2313                         char *p;
2314
2315                         if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2316                                 _pam_log(ctx, LOG_INFO,
2317                                          "no \"=\" delimiter for \"%s\" found\n",
2318                                          item);
2319                                 goto out;
2320                         }
2321                         parm_opt = atoi(p + 1);
2322                         _pam_log_debug(ctx, LOG_INFO,
2323                                        "PAM config: %s '%d'\n",
2324                                        item, parm_opt);
2325                         return parm_opt;
2326                 }
2327         }
2328
2329         if (ctx->dict) {
2330                 char *key = NULL;
2331
2332                 key = talloc_asprintf(ctx, "global:%s", item);
2333                 if (!key) {
2334                         goto out;
2335                 }
2336
2337                 parm_opt = iniparser_getint(ctx->dict, key, -1);
2338                 TALLOC_FREE(key);
2339
2340                 _pam_log_debug(ctx, LOG_INFO,
2341                                "CONFIG file: %s '%d'\n",
2342                                item, parm_opt);
2343         }
2344 out:
2345         return parm_opt;
2346 }
2347
2348 static const char *get_krb5_cc_type_from_config(struct pwb_context *ctx)
2349 {
2350         return get_conf_item_string(ctx, "krb5_ccache_type",
2351                                     WINBIND_KRB5_CCACHE_TYPE);
2352 }
2353
2354 static const char *get_member_from_config(struct pwb_context *ctx)
2355 {
2356         const char *ret = NULL;
2357         ret = get_conf_item_string(ctx, "require_membership_of",
2358                                    WINBIND_REQUIRED_MEMBERSHIP);
2359         if (ret) {
2360                 return ret;
2361         }
2362         return get_conf_item_string(ctx, "require-membership-of",
2363                                     WINBIND_REQUIRED_MEMBERSHIP);
2364 }
2365
2366 static int get_warn_pwd_expire_from_config(struct pwb_context *ctx)
2367 {
2368         int ret;
2369         ret = get_config_item_int(ctx, "warn_pwd_expire",
2370                                   WINBIND_WARN_PWD_EXPIRE);
2371         /* no or broken setting */
2372         if (ret <= 0) {
2373                 return DEFAULT_DAYS_TO_WARN_BEFORE_PWD_EXPIRES;
2374         }
2375         return ret;
2376 }
2377
2378 /**
2379  * Retrieve the winbind separator.
2380  *
2381  * @param ctx PAM winbind context.
2382  *
2383  * @return string separator character. NULL on failure.
2384  */
2385
2386 static char winbind_get_separator(struct pwb_context *ctx)
2387 {
2388         wbcErr wbc_status;
2389         static struct wbcInterfaceDetails *details = NULL;
2390
2391         wbc_status = wbcInterfaceDetails(&details);
2392         if (!WBC_ERROR_IS_OK(wbc_status)) {
2393                 _pam_log(ctx, LOG_ERR,
2394                          "Could not retrieve winbind interface details: %s",
2395                          wbcErrorString(wbc_status));
2396                 return '\0';
2397         }
2398
2399         if (!details) {
2400                 return '\0';
2401         }
2402
2403         return details->winbind_separator;
2404 }
2405
2406
2407 /**
2408  * Convert a upn to a name.
2409  *
2410  * @param ctx PAM winbind context.
2411  * @param upn  USer UPN to be trabslated.
2412  *
2413  * @return converted name. NULL pointer on failure. Caller needs to free.
2414  */
2415
2416 static char* winbind_upn_to_username(struct pwb_context *ctx,
2417                                      const char *upn)
2418 {
2419         char sep;
2420         wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
2421         struct wbcDomainSid sid;
2422         enum wbcSidType type;
2423         char *domain = NULL;
2424         char *name;
2425         char *p;
2426
2427         /* This cannot work when the winbind separator = @ */
2428
2429         sep = winbind_get_separator(ctx);
2430         if (!sep || sep == '@') {
2431                 return NULL;
2432         }
2433
2434         name = talloc_strdup(ctx, upn);
2435         if (!name) {
2436                 return NULL;
2437         }
2438         if ((p = strchr(name, '@')) != NULL) {
2439                 *p = 0;
2440                 domain = p + 1;
2441         }
2442
2443         /* Convert the UPN to a SID */
2444
2445         wbc_status = wbcLookupName(domain, name, &sid, &type);
2446         if (!WBC_ERROR_IS_OK(wbc_status)) {
2447                 return NULL;
2448         }
2449
2450         /* Convert the the SID back to the sAMAccountName */
2451
2452         wbc_status = wbcLookupSid(&sid, &domain, &name, &type);
2453         if (!WBC_ERROR_IS_OK(wbc_status)) {
2454                 return NULL;
2455         }
2456
2457         return talloc_asprintf(ctx, "%s%c%s", domain, sep, name);
2458 }
2459
2460 static int _pam_delete_cred(pam_handle_t *pamh, int flags,
2461                          int argc, const char **argv)
2462 {
2463         int retval = PAM_SUCCESS;
2464         struct pwb_context *ctx = NULL;
2465         struct wbcLogoffUserParams logoff;
2466         struct wbcAuthErrorInfo *error = NULL;
2467         const char *user;
2468         wbcErr wbc_status = WBC_ERR_SUCCESS;
2469
2470         ZERO_STRUCT(logoff);
2471
2472         retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2473         if (retval) {
2474                 goto out;
2475         }
2476
2477         _PAM_LOG_FUNCTION_ENTER("_pam_delete_cred", ctx);
2478
2479         if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2480
2481                 /* destroy the ccache here */
2482
2483                 uint32_t wbc_flags = 0;
2484                 const char *ccname = NULL;
2485                 struct passwd *pwd = NULL;
2486
2487                 retval = pam_get_user(pamh, &user, _("Username: "));
2488                 if (retval) {
2489                         _pam_log(ctx, LOG_ERR,
2490                                  "could not identify user");
2491                         goto out;
2492                 }
2493
2494                 if (user == NULL) {
2495                         _pam_log(ctx, LOG_ERR,
2496                                  "username was NULL!");
2497                         retval = PAM_USER_UNKNOWN;
2498                         goto out;
2499                 }
2500
2501                 _pam_log_debug(ctx, LOG_DEBUG,
2502                                "username [%s] obtained", user);
2503
2504                 ccname = pam_getenv(pamh, "KRB5CCNAME");
2505                 if (ccname == NULL) {
2506                         _pam_log_debug(ctx, LOG_DEBUG,
2507                                        "user has no KRB5CCNAME environment");
2508                 }
2509
2510                 pwd = getpwnam(user);
2511                 if (pwd == NULL) {
2512                         retval = PAM_USER_UNKNOWN;
2513                         goto out;
2514                 }
2515
2516                 wbc_flags = WBFLAG_PAM_KRB5 |
2517                         WBFLAG_PAM_CONTACT_TRUSTDOM;
2518
2519                 logoff.username         = user;
2520
2521                 if (ccname) {
2522                         wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2523                                                      &logoff.blobs,
2524                                                      "ccfilename",
2525                                                      0,
2526                                                      (uint8_t *)ccname,
2527                                                      strlen(ccname)+1);
2528                         if (!WBC_ERROR_IS_OK(wbc_status)) {
2529                                 goto out;
2530                         }
2531                 }
2532
2533                 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2534                                              &logoff.blobs,
2535                                              "flags",
2536                                              0,
2537                                              (uint8_t *)&wbc_flags,
2538                                              sizeof(wbc_flags));
2539                 if (!WBC_ERROR_IS_OK(wbc_status)) {
2540                         goto out;
2541                 }
2542
2543                 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2544                                              &logoff.blobs,
2545                                              "user_uid",
2546                                              0,
2547                                              (uint8_t *)&pwd->pw_uid,
2548                                              sizeof(pwd->pw_uid));
2549                 if (!WBC_ERROR_IS_OK(wbc_status)) {
2550                         goto out;
2551                 }
2552
2553                 wbc_status = wbcLogoffUserEx(&logoff, &error);
2554                 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2555                                                      user, "wbcLogoffUser");
2556                 wbcFreeMemory(error);
2557                 wbcFreeMemory(logoff.blobs);
2558                 logoff.blobs = NULL;
2559
2560                 if (!WBC_ERROR_IS_OK(wbc_status)) {
2561                         _pam_log(ctx, LOG_INFO,
2562                                  "failed to logoff user %s: %s\n",
2563                                          user, wbcErrorString(wbc_status));
2564                 }
2565         }
2566
2567 out:
2568         if (logoff.blobs) {
2569                 wbcFreeMemory(logoff.blobs);
2570         }
2571
2572         if (!WBC_ERROR_IS_OK(wbc_status)) {
2573                 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2574                      user, "wbcLogoffUser");
2575         }
2576
2577         /*
2578          * Delete the krb5 ccname variable from the PAM environment
2579          * if it was set by winbind.
2580          */
2581         if ((ctx->ctrl & WINBIND_KRB5_AUTH) && pam_getenv(pamh, "KRB5CCNAME")) {
2582                 pam_putenv(pamh, "KRB5CCNAME");
2583         }
2584
2585         _PAM_LOG_FUNCTION_LEAVE("_pam_delete_cred", ctx, retval);
2586
2587         TALLOC_FREE(ctx);
2588
2589         return retval;
2590 }
2591
2592 PAM_EXTERN
2593 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
2594                         int argc, const char **argv)
2595 {
2596         const char *username;
2597         const char *password;
2598         const char *member = NULL;
2599         const char *cctype = NULL;
2600         int warn_pwd_expire;
2601         int retval = PAM_AUTH_ERR;
2602         char *username_ret = NULL;
2603         char *new_authtok_required = NULL;
2604         char *real_username = NULL;
2605         struct pwb_context *ctx = NULL;
2606
2607         retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2608         if (retval) {
2609                 goto out;
2610         }
2611
2612         _PAM_LOG_FUNCTION_ENTER("pam_sm_authenticate", ctx);
2613
2614         /* Get the username */
2615         retval = pam_get_user(pamh, &username, NULL);
2616         if ((retval != PAM_SUCCESS) || (!username)) {
2617                 _pam_log_debug(ctx, LOG_DEBUG,
2618                                "can not get the username");
2619                 retval = PAM_SERVICE_ERR;
2620                 goto out;
2621         }
2622
2623
2624 #if defined(AIX)
2625         /* Decode the user name since AIX does not support logn user
2626            names by default.  The name is encoded as _#uid.  */
2627
2628         if (username[0] == '_') {
2629                 uid_t id = atoi(&username[1]);
2630                 struct passwd *pw = NULL;
2631
2632                 if ((id!=0) && ((pw = getpwuid(id)) != NULL)) {
2633                         real_username = strdup(pw->pw_name);
2634                 }
2635         }
2636 #endif
2637
2638         if (!real_username) {
2639                 /* Just making a copy of the username we got from PAM */
2640                 if ((real_username = strdup(username)) == NULL) {
2641                         _pam_log_debug(ctx, LOG_DEBUG,
2642                                        "memory allocation failure when copying "
2643                                        "username");
2644                         retval = PAM_SERVICE_ERR;
2645                         goto out;
2646                 }
2647         }
2648
2649         /* Maybe this was a UPN */
2650
2651         if (strchr(real_username, '@') != NULL) {
2652                 char *samaccountname = NULL;
2653
2654                 samaccountname = winbind_upn_to_username(ctx,
2655                                                          real_username);
2656                 if (samaccountname) {
2657                         free(real_username);
2658                         real_username = strdup(samaccountname);
2659                 }
2660         }
2661
2662         retval = _winbind_read_password(ctx, ctx->ctrl, NULL,
2663                                         _("Password: "), NULL,
2664                                         &password);
2665
2666         if (retval != PAM_SUCCESS) {
2667                 _pam_log(ctx, LOG_ERR,
2668                          "Could not retrieve user's password");
2669                 retval = PAM_AUTHTOK_ERR;
2670                 goto out;
2671         }
2672
2673         /* Let's not give too much away in the log file */
2674
2675 #ifdef DEBUG_PASSWORD
2676         _pam_log_debug(ctx, LOG_INFO,
2677                        "Verify user '%s' with password '%s'",
2678                        real_username, password);
2679 #else
2680         _pam_log_debug(ctx, LOG_INFO,
2681                        "Verify user '%s'", real_username);
2682 #endif
2683
2684         member = get_member_from_config(ctx);
2685         cctype = get_krb5_cc_type_from_config(ctx);
2686         warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2687
2688         /* Now use the username to look up password */
2689         retval = winbind_auth_request(ctx, real_username, password,
2690                                       member, cctype, warn_pwd_expire,
2691                                       NULL, NULL, NULL,
2692                                       NULL, &username_ret);
2693
2694         if (retval == PAM_NEW_AUTHTOK_REQD ||
2695             retval == PAM_AUTHTOK_EXPIRED) {
2696
2697                 char *new_authtok_required_during_auth = NULL;
2698
2699                 new_authtok_required = talloc_asprintf(NULL, "%d", retval);
2700                 if (!new_authtok_required) {
2701                         retval = PAM_BUF_ERR;
2702                         goto out;
2703                 }
2704
2705                 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2706                              new_authtok_required,
2707                              _pam_winbind_cleanup_func);
2708
2709                 retval = PAM_SUCCESS;
2710
2711                 new_authtok_required_during_auth = talloc_asprintf(NULL, "%d", true);
2712                 if (!new_authtok_required_during_auth) {
2713                         retval = PAM_BUF_ERR;
2714                         goto out;
2715                 }
2716
2717                 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2718                              new_authtok_required_during_auth,
2719                              _pam_winbind_cleanup_func);
2720
2721                 goto out;
2722         }
2723
2724 out:
2725         if (username_ret) {
2726                 pam_set_item (pamh, PAM_USER, username_ret);
2727                 _pam_log_debug(ctx, LOG_INFO,
2728                                "Returned user was '%s'", username_ret);
2729                 free(username_ret);
2730         }
2731
2732         if (real_username) {
2733                 free(real_username);
2734         }
2735
2736         if (!new_authtok_required) {
2737                 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, NULL, NULL);
2738         }
2739
2740         if (retval != PAM_SUCCESS) {
2741                 _pam_free_data_info3(pamh);
2742         }
2743
2744         if (ctx != NULL) {
2745                 _PAM_LOG_FUNCTION_LEAVE("pam_sm_authenticate", ctx, retval);
2746                 TALLOC_FREE(ctx);
2747         }
2748
2749         return retval;
2750 }
2751
2752 PAM_EXTERN
2753 int pam_sm_setcred(pam_handle_t *pamh, int flags,
2754                    int argc, const char **argv)
2755 {
2756         int ret = PAM_SYSTEM_ERR;
2757         struct pwb_context *ctx = NULL;
2758
2759         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2760         if (ret) {
2761                 goto out;
2762         }
2763
2764         _PAM_LOG_FUNCTION_ENTER("pam_sm_setcred", ctx);
2765
2766         switch (flags & ~PAM_SILENT) {
2767
2768                 case PAM_DELETE_CRED:
2769                         ret = _pam_delete_cred(pamh, flags, argc, argv);
2770                         break;
2771                 case PAM_REFRESH_CRED:
2772                         _pam_log_debug(ctx, LOG_WARNING,
2773                                        "PAM_REFRESH_CRED not implemented");
2774                         ret = PAM_SUCCESS;
2775                         break;
2776                 case PAM_REINITIALIZE_CRED:
2777                         _pam_log_debug(ctx, LOG_WARNING,
2778                                        "PAM_REINITIALIZE_CRED not implemented");
2779                         ret = PAM_SUCCESS;
2780                         break;
2781                 case PAM_ESTABLISH_CRED:
2782                         _pam_log_debug(ctx, LOG_WARNING,
2783                                        "PAM_ESTABLISH_CRED not implemented");
2784                         ret = PAM_SUCCESS;
2785                         break;
2786                 default:
2787                         ret = PAM_SYSTEM_ERR;
2788                         break;
2789         }
2790
2791  out:
2792
2793         _PAM_LOG_FUNCTION_LEAVE("pam_sm_setcred", ctx, ret);
2794
2795         TALLOC_FREE(ctx);
2796
2797         return ret;
2798 }
2799
2800 /*
2801  * Account management. We want to verify that the account exists
2802  * before returning PAM_SUCCESS
2803  */
2804 PAM_EXTERN
2805 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
2806                    int argc, const char **argv)
2807 {
2808         const char *username;
2809         int ret = PAM_USER_UNKNOWN;
2810         void *tmp = NULL;
2811         struct pwb_context *ctx = NULL;
2812
2813         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2814         if (ret) {
2815                 goto out;
2816         }
2817
2818         _PAM_LOG_FUNCTION_ENTER("pam_sm_acct_mgmt", ctx);
2819
2820
2821         /* Get the username */
2822         ret = pam_get_user(pamh, &username, NULL);
2823         if ((ret != PAM_SUCCESS) || (!username)) {
2824                 _pam_log_debug(ctx, LOG_DEBUG,
2825                                "can not get the username");
2826                 ret = PAM_SERVICE_ERR;
2827                 goto out;
2828         }
2829
2830         /* Verify the username */
2831         ret = valid_user(ctx, username);
2832         switch (ret) {
2833         case -1:
2834                 /* some sort of system error. The log was already printed */
2835                 ret = PAM_SERVICE_ERR;
2836                 goto out;
2837         case 1:
2838                 /* the user does not exist */
2839                 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
2840                                username);
2841                 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
2842                         ret = PAM_IGNORE;
2843                         goto out;
2844                 }
2845                 ret = PAM_USER_UNKNOWN;
2846                 goto out;
2847         case 0:
2848                 pam_get_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2849                              (const void **)&tmp);
2850                 if (tmp != NULL) {
2851                         ret = atoi((const char *)tmp);
2852                         switch (ret) {
2853                         case PAM_AUTHTOK_EXPIRED:
2854                                 /* fall through, since new token is required in this case */
2855                         case PAM_NEW_AUTHTOK_REQD:
2856                                 _pam_log(ctx, LOG_WARNING,
2857                                          "pam_sm_acct_mgmt success but %s is set",
2858                                          PAM_WINBIND_NEW_AUTHTOK_REQD);
2859                                 _pam_log(ctx, LOG_NOTICE,
2860                                          "user '%s' needs new password",
2861                                          username);
2862                                 /* PAM_AUTHTOKEN_REQD does not exist, but is documented in the manpage */
2863                                 ret = PAM_NEW_AUTHTOK_REQD;
2864                                 goto out;
2865                         default:
2866                                 _pam_log(ctx, LOG_WARNING,
2867                                          "pam_sm_acct_mgmt success");
2868                                 _pam_log(ctx, LOG_NOTICE,
2869                                          "user '%s' granted access", username);
2870                                 ret = PAM_SUCCESS;
2871                                 goto out;
2872                         }
2873                 }
2874
2875                 /* Otherwise, the authentication looked good */
2876                 _pam_log(ctx, LOG_NOTICE,
2877                          "user '%s' granted access", username);
2878                 ret = PAM_SUCCESS;
2879                 goto out;
2880         default:
2881                 /* we don't know anything about this return value */
2882                 _pam_log(ctx, LOG_ERR,
2883                          "internal module error (ret = %d, user = '%s')",
2884                          ret, username);
2885                 ret = PAM_SERVICE_ERR;
2886                 goto out;
2887         }
2888
2889         /* should not be reached */
2890         ret = PAM_IGNORE;
2891
2892  out:
2893
2894         _PAM_LOG_FUNCTION_LEAVE("pam_sm_acct_mgmt", ctx, ret);
2895
2896         TALLOC_FREE(ctx);
2897
2898         return ret;
2899 }
2900
2901 PAM_EXTERN
2902 int pam_sm_open_session(pam_handle_t *pamh, int flags,
2903                         int argc, const char **argv)
2904 {
2905         int ret = PAM_SUCCESS;
2906         struct pwb_context *ctx = NULL;
2907
2908         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2909         if (ret) {
2910                 goto out;
2911         }
2912
2913         _PAM_LOG_FUNCTION_ENTER("pam_sm_open_session", ctx);
2914
2915         if (ctx->ctrl & WINBIND_MKHOMEDIR) {
2916                 /* check and create homedir */
2917                 ret = _pam_mkhomedir(ctx);
2918         }
2919  out:
2920         _PAM_LOG_FUNCTION_LEAVE("pam_sm_open_session", ctx, ret);
2921
2922         TALLOC_FREE(ctx);
2923
2924         return ret;
2925 }
2926
2927 PAM_EXTERN
2928 int pam_sm_close_session(pam_handle_t *pamh, int flags,
2929                          int argc, const char **argv)
2930 {
2931         int ret = PAM_SUCCESS;
2932         struct pwb_context *ctx = NULL;
2933
2934         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2935         if (ret) {
2936                 goto out;
2937         }
2938
2939         _PAM_LOG_FUNCTION_ENTER("pam_sm_close_session", ctx);
2940
2941 out:
2942         _PAM_LOG_FUNCTION_LEAVE("pam_sm_close_session", ctx, ret);
2943
2944         TALLOC_FREE(ctx);
2945
2946         return ret;
2947 }
2948
2949 /**
2950  * evaluate whether we need to re-authenticate with kerberos after a
2951  * password change
2952  *
2953  * @param ctx PAM winbind context.
2954  * @param user The username
2955  *
2956  * @return boolean Returns true if required, false if not.
2957  */
2958
2959 static bool _pam_require_krb5_auth_after_chauthtok(struct pwb_context *ctx,
2960                                                    const char *user)
2961 {
2962
2963         /* Make sure that we only do this if a) the chauthtok got initiated
2964          * during a logon attempt (authenticate->acct_mgmt->chauthtok) b) any
2965          * later password change via the "passwd" command if done by the user
2966          * itself
2967          * NB. If we login from gdm or xdm and the password expires,
2968          * we change the password, but there is no memory cache.
2969          * Thus, even for passthrough login, we should do the
2970          * authentication again to update memory cache.
2971          * --- BoYang
2972          * */
2973
2974         char *new_authtok_reqd_during_auth = NULL;
2975         struct passwd *pwd = NULL;
2976
2977         _pam_get_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2978                       &new_authtok_reqd_during_auth);
2979         pam_set_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2980                      NULL, NULL);
2981
2982         if (new_authtok_reqd_during_auth) {
2983                 return true;
2984         }
2985
2986         pwd = getpwnam(user);
2987         if (!pwd) {
2988                 return false;
2989         }
2990
2991         if (getuid() == pwd->pw_uid) {
2992                 return true;
2993         }
2994
2995         return false;
2996 }
2997
2998
2999 PAM_EXTERN
3000 int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
3001                      int argc, const char **argv)
3002 {
3003         unsigned int lctrl;
3004         int ret;
3005         bool cached_login = false;
3006
3007         /* <DO NOT free() THESE> */
3008         const char *user;
3009         char *pass_old, *pass_new;
3010         /* </DO NOT free() THESE> */
3011
3012         char *Announce;
3013
3014         int retry = 0;
3015         char *username_ret = NULL;
3016         struct wbcAuthErrorInfo *error = NULL;
3017         struct pwb_context *ctx = NULL;
3018
3019         ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
3020         if (ret) {
3021                 goto out;
3022         }
3023
3024         _PAM_LOG_FUNCTION_ENTER("pam_sm_chauthtok", ctx);
3025
3026         cached_login = (ctx->ctrl & WINBIND_CACHED_LOGIN);
3027
3028         /* clearing offline bit for auth */
3029         ctx->ctrl &= ~WINBIND_CACHED_LOGIN;
3030
3031         /*
3032          * First get the name of a user
3033          */
3034         ret = pam_get_user(pamh, &user, _("Username: "));
3035         if (ret) {
3036                 _pam_log(ctx, LOG_ERR,
3037                          "password - could not identify user");
3038                 goto out;
3039         }
3040
3041         if (user == NULL) {
3042                 _pam_log(ctx, LOG_ERR, "username was NULL!");
3043                 ret = PAM_USER_UNKNOWN;
3044                 goto out;
3045         }
3046
3047         _pam_log_debug(ctx, LOG_DEBUG, "username [%s] obtained", user);
3048
3049         /* check if this is really a user in winbindd, not only in NSS */
3050         ret = valid_user(ctx, user);
3051         switch (ret) {
3052                 case 1:
3053                         ret = PAM_USER_UNKNOWN;
3054                         goto out;
3055                 case -1:
3056                         ret = PAM_SYSTEM_ERR;
3057                         goto out;
3058                 default:
3059                         break;
3060         }
3061
3062         /*
3063          * obtain and verify the current password (OLDAUTHTOK) for
3064          * the user.
3065          */
3066
3067         if (flags & PAM_PRELIM_CHECK) {
3068                 time_t pwdlastset_prelim = 0;
3069
3070                 /* instruct user what is happening */
3071
3072 #define greeting _("Changing password for")
3073                 Announce = talloc_asprintf(ctx, "%s %s", greeting, user);
3074                 if (!Announce) {
3075                         _pam_log(ctx, LOG_CRIT,
3076                                  "password - out of memory");
3077                         ret = PAM_BUF_ERR;
3078                         goto out;
3079                 }
3080 #undef greeting
3081
3082                 lctrl = ctx->ctrl | WINBIND__OLD_PASSWORD;
3083                 ret = _winbind_read_password(ctx, lctrl,
3084                                                 Announce,
3085                                                 _("(current) NT password: "),
3086                                                 NULL,
3087                                                 (const char **) &pass_old);
3088                 TALLOC_FREE(Announce);
3089                 if (ret != PAM_SUCCESS) {
3090                         _pam_log(ctx, LOG_NOTICE,
3091                                  "password - (old) token not obtained");
3092                         goto out;
3093                 }
3094
3095                 /* verify that this is the password for this user */
3096
3097                 ret = winbind_auth_request(ctx, user, pass_old,
3098                                            NULL, NULL, 0,
3099                                            &error, NULL, NULL,
3100                                            &pwdlastset_prelim, NULL);
3101
3102                 if (ret != PAM_ACCT_EXPIRED &&
3103                     ret != PAM_AUTHTOK_EXPIRED &&
3104                     ret != PAM_NEW_AUTHTOK_REQD &&
3105                     ret != PAM_SUCCESS) {
3106                         pass_old = NULL;
3107                         goto out;
3108                 }
3109
3110                 pam_set_data(pamh, PAM_WINBIND_PWD_LAST_SET,
3111                              (void *)pwdlastset_prelim, NULL);
3112
3113                 ret = pam_set_item(pamh, PAM_OLDAUTHTOK,
3114                                    (const void *) pass_old);
3115                 pass_old = NULL;
3116                 if (ret != PAM_SUCCESS) {
3117                         _pam_log(ctx, LOG_CRIT,
3118                                  "failed to set PAM_OLDAUTHTOK");
3119                 }
3120         } else if (flags & PAM_UPDATE_AUTHTOK) {
3121
3122                 time_t pwdlastset_update = 0;
3123
3124                 /*
3125                  * obtain the proposed password
3126                  */
3127
3128                 /*
3129                  * get the old token back.
3130                  */
3131
3132                 ret = _pam_get_item(pamh, PAM_OLDAUTHTOK, &pass_old);
3133
3134                 if (ret != PAM_SUCCESS) {
3135                         _pam_log(ctx, LOG_NOTICE,
3136                                  "user not authenticated");
3137                         goto out;
3138                 }
3139
3140                 lctrl = ctx->ctrl & ~WINBIND_TRY_FIRST_PASS_ARG;
3141
3142                 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
3143                         lctrl |= WINBIND_USE_FIRST_PASS_ARG;
3144                 }
3145                 retry = 0;
3146                 ret = PAM_AUTHTOK_ERR;
3147                 while ((ret != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
3148                         /*
3149                          * use_authtok is to force the use of a previously entered
3150                          * password -- needed for pluggable password strength checking
3151                          */
3152
3153                         ret = _winbind_read_password(ctx, lctrl,
3154                                                      NULL,
3155                                                      _("Enter new NT password: "),
3156                                                      _("Retype new NT password: "),
3157                                                      (const char **)&pass_new);
3158
3159                         if (ret != PAM_SUCCESS) {
3160                                 _pam_log_debug(ctx, LOG_ALERT,
3161                                                "password - "
3162                                                "new password not obtained");
3163                                 pass_old = NULL;/* tidy up */
3164                                 goto out;
3165                         }
3166
3167                         /*
3168                          * At this point we know who the user is and what they
3169                          * propose as their new password. Verify that the new
3170                          * password is acceptable.
3171                          */
3172
3173                         if (pass_new[0] == '\0') {/* "\0" password = NULL */
3174                                 pass_new = NULL;
3175                         }
3176                 }
3177
3178                 /*
3179                  * By reaching here we have approved the passwords and must now
3180                  * rebuild the password database file.
3181                  */
3182                 _pam_get_data(pamh, PAM_WINBIND_PWD_LAST_SET,
3183                               &pwdlastset_update);
3184
3185                 /*
3186                  * if cached creds were enabled, make sure to set the
3187                  * WINBIND_CACHED_LOGIN bit here in order to have winbindd
3188                  * update the cached creds storage - gd
3189                  */
3190                 if (cached_login) {
3191                         ctx->ctrl |= WINBIND_CACHED_LOGIN;
3192                 }
3193
3194                 ret = winbind_chauthtok_request(ctx, user, pass_old,
3195                                                 pass_new, pwdlastset_update);
3196                 if (ret) {
3197                         pass_old = pass_new = NULL;
3198                         goto out;
3199                 }
3200
3201                 if (_pam_require_krb5_auth_after_chauthtok(ctx, user)) {
3202
3203                         const char *member = NULL;
3204                         const char *cctype = NULL;
3205                         int warn_pwd_expire;
3206                         struct wbcLogonUserInfo *info = NULL;
3207                         struct wbcUserPasswordPolicyInfo *policy = NULL;
3208
3209                         member = get_member_from_config(ctx);
3210                         cctype = get_krb5_cc_type_from_config(ctx);
3211                         warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
3212
3213                         /* Keep WINBIND_CACHED_LOGIN bit for
3214                          * authentication after changing the password.
3215                          * This will update the cached credentials in case
3216                          * that winbindd_dual_pam_chauthtok() fails
3217                          * to update them.
3218                          * --- BoYang
3219                          * */
3220
3221                         ret = winbind_auth_request(ctx, user, pass_new,
3222                                                    member, cctype, 0,
3223                                                    &error, &info, &policy,
3224                                                    NULL, &username_ret);
3225                         pass_old = pass_new = NULL;
3226
3227                         if (ret == PAM_SUCCESS) {
3228
3229                                 struct wbcAuthUserInfo *user_info = NULL;
3230
3231                                 if (info && info->info) {
3232                                         user_info = info->info;
3233                                 }
3234
3235                                 /* warn a user if the password is about to
3236                                  * expire soon */
3237                                 _pam_warn_password_expiry(ctx, user_info, policy,
3238                                                           warn_pwd_expire,
3239                                                           NULL, NULL);
3240
3241                                 /* set some info3 info for other modules in the
3242                                  * stack */
3243                                 _pam_set_data_info3(ctx, user_info);
3244
3245                                 /* put krb5ccname into env */
3246                                 _pam_setup_krb5_env(ctx, info);
3247
3248                                 if (username_ret) {
3249                                         pam_set_item(pamh, PAM_USER,
3250                                                      username_ret);
3251                                         _pam_log_debug(ctx, LOG_INFO,
3252                                                        "Returned user was '%s'",
3253                                                        username_ret);
3254                                         free(username_ret);
3255                                 }
3256
3257                         }
3258
3259                         if (info && info->blobs) {
3260                                 wbcFreeMemory(info->blobs);
3261                         }
3262                         wbcFreeMemory(info);
3263                         wbcFreeMemory(policy);
3264
3265                         goto out;
3266                 }
3267         } else {
3268                 ret = PAM_SERVICE_ERR;
3269         }
3270
3271 out:
3272         {
3273                 /* Deal with offline errors. */
3274                 int i;
3275                 const char *codes[] = {
3276                         "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
3277                         "NT_STATUS_NO_LOGON_SERVERS",
3278                         "NT_STATUS_ACCESS_DENIED"
3279                 };
3280
3281                 for (i=0; i<ARRAY_SIZE(codes); i++) {
3282                         int _ret;
3283                         if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
3284                                 break;
3285                         }
3286                 }
3287         }
3288
3289         wbcFreeMemory(error);
3290
3291         _PAM_LOG_FUNCTION_LEAVE("pam_sm_chauthtok", ctx, ret);
3292
3293         TALLOC_FREE(ctx);
3294
3295         return ret;
3296 }
3297
3298 #ifdef PAM_STATIC
3299
3300 /* static module data */
3301
3302 struct pam_module _pam_winbind_modstruct = {
3303         MODULE_NAME,
3304         pam_sm_authenticate,
3305         pam_sm_setcred,
3306         pam_sm_acct_mgmt,
3307         pam_sm_open_session,
3308         pam_sm_close_session,
3309         pam_sm_chauthtok
3310 };
3311
3312 #endif
3313
3314 /*
3315  * Copyright (c) Andrew Tridgell  <tridge@samba.org>   2000
3316  * Copyright (c) Tim Potter       <tpot@samba.org>     2000
3317  * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
3318  * Copyright (c) Guenther Deschner <gd@samba.org>      2005-2008
3319  * Copyright (c) Jan Rêkorajski 1999.
3320  * Copyright (c) Andrew G. Morgan 1996-8.
3321  * Copyright (c) Alex O. Yuriev, 1996.
3322  * Copyright (c) Cristian Gafton 1996.
3323  * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
3324  *
3325  * Redistribution and use in source and binary forms, with or without
3326  * modification, are permitted provided that the following conditions
3327  * are met:
3328  * 1. Redistributions of source code must retain the above copyright
3329  *    notice, and the entire permission notice in its entirety,
3330  *    including the disclaimer of warranties.
3331  * 2. Redistributions in binary form must reproduce the above copyright
3332  *    notice, this list of conditions and the following disclaimer in the
3333  *    documentation and/or other materials provided with the distribution.
3334  * 3. The name of the author may not be used to endorse or promote
3335  *    products derived from this software without specific prior
3336  *    written permission.
3337  *
3338  * ALTERNATIVELY, this product may be distributed under the terms of
3339  * the GNU Public License, in which case the provisions of the GPL are
3340  * required INSTEAD OF the above restrictions.  (This clause is
3341  * necessary due to a potential bad interaction between the GPL and
3342  * the restrictions contained in a BSD-style copyright.)
3343  *
3344  * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
3345  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
3346  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
3347  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
3348  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
3349  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
3350  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3351  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3352  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
3353  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
3354  * OF THE POSSIBILITY OF SUCH DAMAGE.
3355  */