smbd: Update comment for durable handles
[Samba.git] / nsswitch / pam_winbind.c
blob720a4b90d85e333e7f4c6bfee99433cbbab716eb
1 /* pam_winbind module
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
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)
13 #include "pam_winbind.h"
15 enum pam_winbind_request_type
17 PAM_WINBIND_AUTHENTICATE,
18 PAM_WINBIND_SETCRED,
19 PAM_WINBIND_ACCT_MGMT,
20 PAM_WINBIND_OPEN_SESSION,
21 PAM_WINBIND_CLOSE_SESSION,
22 PAM_WINBIND_CHAUTHTOK,
23 PAM_WINBIND_CLEANUP
26 static int wbc_error_to_pam_error(wbcErr status)
28 switch (status) {
29 case WBC_ERR_SUCCESS:
30 return PAM_SUCCESS;
31 case WBC_ERR_NOT_IMPLEMENTED:
32 return PAM_SERVICE_ERR;
33 case WBC_ERR_UNKNOWN_FAILURE:
34 break;
35 case WBC_ERR_NO_MEMORY:
36 return PAM_BUF_ERR;
37 case WBC_ERR_INVALID_SID:
38 case WBC_ERR_INVALID_PARAM:
39 break;
40 case WBC_ERR_WINBIND_NOT_AVAILABLE:
41 return PAM_AUTHINFO_UNAVAIL;
42 case WBC_ERR_DOMAIN_NOT_FOUND:
43 return PAM_AUTHINFO_UNAVAIL;
44 case WBC_ERR_INVALID_RESPONSE:
45 return PAM_BUF_ERR;
46 case WBC_ERR_NSS_ERROR:
47 return PAM_USER_UNKNOWN;
48 case WBC_ERR_AUTH_ERROR:
49 return PAM_AUTH_ERR;
50 case WBC_ERR_UNKNOWN_USER:
51 return PAM_USER_UNKNOWN;
52 case WBC_ERR_UNKNOWN_GROUP:
53 return PAM_USER_UNKNOWN;
54 case WBC_ERR_PWD_CHANGE_FAILED:
55 break;
58 /* be paranoid */
59 return PAM_AUTH_ERR;
62 static const char *_pam_error_code_str(int err)
64 switch (err) {
65 case PAM_SUCCESS:
66 return "PAM_SUCCESS";
67 case PAM_OPEN_ERR:
68 return "PAM_OPEN_ERR";
69 case PAM_SYMBOL_ERR:
70 return "PAM_SYMBOL_ERR";
71 case PAM_SERVICE_ERR:
72 return "PAM_SERVICE_ERR";
73 case PAM_SYSTEM_ERR:
74 return "PAM_SYSTEM_ERR";
75 case PAM_BUF_ERR:
76 return "PAM_BUF_ERR";
77 case PAM_PERM_DENIED:
78 return "PAM_PERM_DENIED";
79 case PAM_AUTH_ERR:
80 return "PAM_AUTH_ERR";
81 case PAM_CRED_INSUFFICIENT:
82 return "PAM_CRED_INSUFFICIENT";
83 case PAM_AUTHINFO_UNAVAIL:
84 return "PAM_AUTHINFO_UNAVAIL";
85 case PAM_USER_UNKNOWN:
86 return "PAM_USER_UNKNOWN";
87 case PAM_MAXTRIES:
88 return "PAM_MAXTRIES";
89 case PAM_NEW_AUTHTOK_REQD:
90 return "PAM_NEW_AUTHTOK_REQD";
91 case PAM_ACCT_EXPIRED:
92 return "PAM_ACCT_EXPIRED";
93 case PAM_SESSION_ERR:
94 return "PAM_SESSION_ERR";
95 case PAM_CRED_UNAVAIL:
96 return "PAM_CRED_UNAVAIL";
97 case PAM_CRED_EXPIRED:
98 return "PAM_CRED_EXPIRED";
99 case PAM_CRED_ERR:
100 return "PAM_CRED_ERR";
101 case PAM_NO_MODULE_DATA:
102 return "PAM_NO_MODULE_DATA";
103 case PAM_CONV_ERR:
104 return "PAM_CONV_ERR";
105 case PAM_AUTHTOK_ERR:
106 return "PAM_AUTHTOK_ERR";
107 case PAM_AUTHTOK_RECOVER_ERR:
108 return "PAM_AUTHTOK_RECOVER_ERR";
109 case PAM_AUTHTOK_LOCK_BUSY:
110 return "PAM_AUTHTOK_LOCK_BUSY";
111 case PAM_AUTHTOK_DISABLE_AGING:
112 return "PAM_AUTHTOK_DISABLE_AGING";
113 case PAM_TRY_AGAIN:
114 return "PAM_TRY_AGAIN";
115 case PAM_IGNORE:
116 return "PAM_IGNORE";
117 case PAM_ABORT:
118 return "PAM_ABORT";
119 case PAM_AUTHTOK_EXPIRED:
120 return "PAM_AUTHTOK_EXPIRED";
121 #ifdef PAM_MODULE_UNKNOWN
122 case PAM_MODULE_UNKNOWN:
123 return "PAM_MODULE_UNKNOWN";
124 #endif
125 #ifdef PAM_BAD_ITEM
126 case PAM_BAD_ITEM:
127 return "PAM_BAD_ITEM";
128 #endif
129 #ifdef PAM_CONV_AGAIN
130 case PAM_CONV_AGAIN:
131 return "PAM_CONV_AGAIN";
132 #endif
133 #ifdef PAM_INCOMPLETE
134 case PAM_INCOMPLETE:
135 return "PAM_INCOMPLETE";
136 #endif
137 default:
138 return NULL;
142 #define _PAM_LOG_FUNCTION_ENTER(function, ctx) \
143 do { \
144 _pam_log_debug(ctx, LOG_DEBUG, "[pamh: %p] ENTER: " \
145 function " (flags: 0x%04x)", ctx->pamh, ctx->flags); \
146 _pam_log_state(ctx); \
147 } while (0)
149 #define _PAM_LOG_FUNCTION_LEAVE(function, ctx, retval) \
150 do { \
151 _pam_log_debug(ctx, LOG_DEBUG, "[pamh: %p] LEAVE: " \
152 function " returning %d (%s)", ctx ? ctx->pamh : NULL, retval, \
153 _pam_error_code_str(retval)); \
154 _pam_log_state(ctx); \
155 } while (0)
157 /* data tokens */
159 #define MAX_PASSWD_TRIES 3
161 #ifdef HAVE_GETTEXT
162 static char initialized = 0;
164 static inline void textdomain_init(void);
165 static inline void textdomain_init(void)
167 if (!initialized) {
168 bindtextdomain(MODULE_NAME, LOCALEDIR);
169 initialized = 1;
171 return;
173 #endif
176 /* some syslogging */
177 static void _pam_log_int(const pam_handle_t *pamh,
178 int err,
179 const char *format,
180 va_list args) PRINTF_ATTRIBUTE(3, 0);
182 #ifdef HAVE_PAM_VSYSLOG
183 static void _pam_log_int(const pam_handle_t *pamh,
184 int err,
185 const char *format,
186 va_list args)
188 pam_vsyslog(pamh, err, format, args);
190 #else
191 static void _pam_log_int(const pam_handle_t *pamh,
192 int err,
193 const char *format,
194 va_list args)
196 char *base = NULL;
197 va_list args2;
198 const char *service;
199 int ret;
201 va_copy(args2, args);
203 pam_get_item(pamh, PAM_SERVICE, (const void **) &service);
205 ret = vasprintf(&base, format, args);
206 if (ret == -1) {
207 /* what else todo ? */
208 vsyslog(err, format, args2);
209 va_end(args2);
210 return;
213 syslog(err, "%s(%s): %s", MODULE_NAME, service, base);
214 SAFE_FREE(base);
215 va_end(args2);
217 #endif /* HAVE_PAM_VSYSLOG */
219 static bool _pam_log_is_silent(int ctrl)
221 return on(ctrl, WINBIND_SILENT);
224 static void _pam_log(struct pwb_context *r, int err, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
225 static void _pam_log(struct pwb_context *r, int err, const char *format, ...)
227 va_list args;
229 if (_pam_log_is_silent(r->ctrl)) {
230 return;
233 va_start(args, format);
234 _pam_log_int(r->pamh, err, format, args);
235 va_end(args);
237 static void __pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
238 static void __pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
240 va_list args;
242 if (_pam_log_is_silent(ctrl)) {
243 return;
246 va_start(args, format);
247 _pam_log_int(pamh, err, format, args);
248 va_end(args);
251 static bool _pam_log_is_debug_enabled(int ctrl)
253 if (ctrl == -1) {
254 return false;
257 if (_pam_log_is_silent(ctrl)) {
258 return false;
261 if (!(ctrl & WINBIND_DEBUG_ARG)) {
262 return false;
265 return true;
268 static bool _pam_log_is_debug_state_enabled(int ctrl)
270 if (!(ctrl & WINBIND_DEBUG_STATE)) {
271 return false;
274 return _pam_log_is_debug_enabled(ctrl);
277 static void _pam_log_debug(struct pwb_context *r, int err, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
278 static void _pam_log_debug(struct pwb_context *r, int err, const char *format, ...)
280 va_list args;
282 if (!r || !_pam_log_is_debug_enabled(r->ctrl)) {
283 return;
286 va_start(args, format);
287 _pam_log_int(r->pamh, err, format, args);
288 va_end(args);
290 static void __pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
291 static void __pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
293 va_list args;
295 if (!_pam_log_is_debug_enabled(ctrl)) {
296 return;
299 va_start(args, format);
300 _pam_log_int(pamh, err, format, args);
301 va_end(args);
304 static void _pam_log_state_datum(struct pwb_context *ctx,
305 int item_type,
306 const char *key,
307 int is_string)
309 const void *data = NULL;
310 if (item_type != 0) {
311 pam_get_item(ctx->pamh, item_type, &data);
312 } else {
313 pam_get_data(ctx->pamh, key, &data);
315 if (data != NULL) {
316 const char *type = (item_type != 0) ? "ITEM" : "DATA";
317 if (is_string != 0) {
318 _pam_log_debug(ctx, LOG_DEBUG,
319 "[pamh: %p] STATE: %s(%s) = \"%s\" (%p)",
320 ctx->pamh, type, key, (const char *)data,
321 data);
322 } else {
323 _pam_log_debug(ctx, LOG_DEBUG,
324 "[pamh: %p] STATE: %s(%s) = %p",
325 ctx->pamh, type, key, data);
330 #define _PAM_LOG_STATE_DATA_POINTER(ctx, module_data_name) \
331 _pam_log_state_datum(ctx, 0, module_data_name, 0)
333 #define _PAM_LOG_STATE_DATA_STRING(ctx, module_data_name) \
334 _pam_log_state_datum(ctx, 0, module_data_name, 1)
336 #define _PAM_LOG_STATE_ITEM_POINTER(ctx, item_type) \
337 _pam_log_state_datum(ctx, item_type, #item_type, 0)
339 #define _PAM_LOG_STATE_ITEM_STRING(ctx, item_type) \
340 _pam_log_state_datum(ctx, item_type, #item_type, 1)
342 #ifdef DEBUG_PASSWORD
343 #define _LOG_PASSWORD_AS_STRING 1
344 #else
345 #define _LOG_PASSWORD_AS_STRING 0
346 #endif
348 #define _PAM_LOG_STATE_ITEM_PASSWORD(ctx, item_type) \
349 _pam_log_state_datum(ctx, item_type, #item_type, \
350 _LOG_PASSWORD_AS_STRING)
352 * wrapper to preserve old behaviour of iniparser which ignored
353 * key values that had no value assigned like
354 * key =
355 * for a key like above newer iniparser will return a zero-length
356 * string, previously iniparser would return NULL
358 * JRA: For compatibility, tiniparser behaves like iniparser.
360 static const char *tiniparser_getstring_nonempty(struct tiniparser_dictionary *d,
361 const char *key,
362 const char *def)
364 const char *ret = tiniparser_getstring(d, key, def);
365 if (ret && strlen(ret) == 0) {
366 ret = NULL;
368 return ret;
371 static void _pam_log_state(struct pwb_context *ctx)
373 if (!ctx || !_pam_log_is_debug_state_enabled(ctx->ctrl)) {
374 return;
377 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_SERVICE);
378 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_USER);
379 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_TTY);
380 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_RHOST);
381 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_RUSER);
382 _PAM_LOG_STATE_ITEM_PASSWORD(ctx, PAM_OLDAUTHTOK);
383 _PAM_LOG_STATE_ITEM_PASSWORD(ctx, PAM_AUTHTOK);
384 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_USER_PROMPT);
385 _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_CONV);
386 #ifdef PAM_FAIL_DELAY
387 _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_FAIL_DELAY);
388 #endif
389 #ifdef PAM_REPOSITORY
390 _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_REPOSITORY);
391 #endif
393 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_HOMEDIR);
394 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_LOGONSCRIPT);
395 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_LOGONSERVER);
396 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_PROFILEPATH);
397 _PAM_LOG_STATE_DATA_STRING(ctx,
398 PAM_WINBIND_NEW_AUTHTOK_REQD);
399 /* Use atoi to get PAM result code */
400 _PAM_LOG_STATE_DATA_STRING(ctx,
401 PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH);
402 _PAM_LOG_STATE_DATA_POINTER(ctx, PAM_WINBIND_PWD_LAST_SET);
405 static int _pam_parse(const pam_handle_t *pamh,
406 int flags,
407 int argc,
408 const char **argv,
409 enum pam_winbind_request_type type,
410 struct tiniparser_dictionary **result_d)
412 int ctrl = 0;
413 const char *config_file = NULL;
414 int i;
415 const char **v;
416 struct tiniparser_dictionary *d = NULL;
418 if (flags & PAM_SILENT) {
419 ctrl |= WINBIND_SILENT;
422 for (i=argc,v=argv; i-- > 0; ++v) {
423 if (!strncasecmp(*v, "config", strlen("config"))) {
424 ctrl |= WINBIND_CONFIG_FILE;
425 config_file = v[i];
426 break;
430 if (config_file == NULL) {
431 config_file = PAM_WINBIND_CONFIG_FILE;
434 d = tiniparser_load(config_file);
435 if (d == NULL) {
436 goto config_from_pam;
439 if (tiniparser_getboolean(d, "global:debug", false)) {
440 ctrl |= WINBIND_DEBUG_ARG;
443 if (tiniparser_getboolean(d, "global:debug_state", false)) {
444 ctrl |= WINBIND_DEBUG_STATE;
447 if (tiniparser_getboolean(d, "global:cached_login", false)) {
448 ctrl |= WINBIND_CACHED_LOGIN;
451 if (tiniparser_getboolean(d, "global:krb5_auth", false)) {
452 ctrl |= WINBIND_KRB5_AUTH;
455 if (tiniparser_getboolean(d, "global:silent", false)) {
456 ctrl |= WINBIND_SILENT;
459 if (tiniparser_getstring_nonempty(d, "global:krb5_ccache_type", NULL) != NULL) {
460 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
463 if ((tiniparser_getstring_nonempty(d, "global:require-membership-of", NULL)
464 != NULL) ||
465 (tiniparser_getstring_nonempty(d, "global:require_membership_of", NULL)
466 != NULL)) {
467 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
470 if (tiniparser_getboolean(d, "global:try_first_pass", false)) {
471 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
474 if (tiniparser_getint(d, "global:warn_pwd_expire", 0)) {
475 ctrl |= WINBIND_WARN_PWD_EXPIRE;
478 if (tiniparser_getboolean(d, "global:mkhomedir", false)) {
479 ctrl |= WINBIND_MKHOMEDIR;
482 config_from_pam:
483 /* step through arguments */
484 for (i=argc,v=argv; i-- > 0; ++v) {
486 /* generic options */
487 if (!strcmp(*v,"debug"))
488 ctrl |= WINBIND_DEBUG_ARG;
489 else if (!strcasecmp(*v, "debug_state"))
490 ctrl |= WINBIND_DEBUG_STATE;
491 else if (!strcasecmp(*v, "silent"))
492 ctrl |= WINBIND_SILENT;
493 else if (!strcasecmp(*v, "use_authtok"))
494 ctrl |= WINBIND_USE_AUTHTOK_ARG;
495 else if (!strcasecmp(*v, "try_authtok"))
496 ctrl |= WINBIND_TRY_AUTHTOK_ARG;
497 else if (!strcasecmp(*v, "use_first_pass"))
498 ctrl |= WINBIND_USE_FIRST_PASS_ARG;
499 else if (!strcasecmp(*v, "try_first_pass"))
500 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
501 else if (!strcasecmp(*v, "unknown_ok"))
502 ctrl |= WINBIND_UNKNOWN_OK_ARG;
503 else if ((type == PAM_WINBIND_AUTHENTICATE
504 || type == PAM_WINBIND_SETCRED)
505 && !strncasecmp(*v, "require_membership_of",
506 strlen("require_membership_of")))
507 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
508 else if ((type == PAM_WINBIND_AUTHENTICATE
509 || type == PAM_WINBIND_SETCRED)
510 && !strncasecmp(*v, "require-membership-of",
511 strlen("require-membership-of")))
512 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
513 else if (!strcasecmp(*v, "krb5_auth"))
514 ctrl |= WINBIND_KRB5_AUTH;
515 else if (!strncasecmp(*v, "krb5_ccache_type",
516 strlen("krb5_ccache_type")))
517 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
518 else if (!strcasecmp(*v, "cached_login"))
519 ctrl |= WINBIND_CACHED_LOGIN;
520 else if (!strcasecmp(*v, "mkhomedir"))
521 ctrl |= WINBIND_MKHOMEDIR;
522 else if (!strncasecmp(*v, "warn_pwd_expire",
523 strlen("warn_pwd_expire")))
524 ctrl |= WINBIND_WARN_PWD_EXPIRE;
525 else if (type != PAM_WINBIND_CLEANUP) {
526 __pam_log(pamh, ctrl, LOG_ERR,
527 "pam_parse: unknown option: %s", *v);
528 return -1;
533 if (result_d) {
534 *result_d = d;
535 } else {
536 if (d) {
537 tiniparser_freedict(d);
541 return ctrl;
544 static int _pam_winbind_free_context(struct pwb_context *ctx)
546 if (!ctx) {
547 return 0;
550 if (ctx->dict) {
551 tiniparser_freedict(ctx->dict);
554 wbcCtxFree(ctx->wbc_ctx);
556 return 0;
559 static int _pam_winbind_init_context(pam_handle_t *pamh,
560 int flags,
561 int argc,
562 const char **argv,
563 enum pam_winbind_request_type type,
564 struct pwb_context **ctx_p)
566 struct pwb_context *r = NULL;
567 const char *service = NULL;
568 char service_name[32] = {0};
569 int ctrl_code;
571 #ifdef HAVE_GETTEXT
572 textdomain_init();
573 #endif
575 r = talloc_zero(NULL, struct pwb_context);
576 if (!r) {
577 return PAM_BUF_ERR;
580 talloc_set_destructor(r, _pam_winbind_free_context);
582 r->pamh = pamh;
583 r->flags = flags;
584 r->argc = argc;
585 r->argv = argv;
586 ctrl_code = _pam_parse(pamh, flags, argc, argv, type, &r->dict);
587 if (ctrl_code == -1) {
588 TALLOC_FREE(r);
589 return PAM_SYSTEM_ERR;
591 r->ctrl = ctrl_code;
593 r->wbc_ctx = wbcCtxCreate();
594 if (r->wbc_ctx == NULL) {
595 TALLOC_FREE(r);
596 return PAM_SYSTEM_ERR;
599 pam_get_item(pamh, PAM_SERVICE, (const void **)&service);
601 snprintf(service_name, sizeof(service_name), "PAM_WINBIND[%s]", service);
603 wbcSetClientProcessName(service_name);
605 *ctx_p = r;
607 return PAM_SUCCESS;
610 static void _pam_winbind_cleanup_func(pam_handle_t *pamh,
611 void *data,
612 int error_status)
614 int ctrl = _pam_parse(pamh, 0, 0, NULL, PAM_WINBIND_CLEANUP, NULL);
615 if (_pam_log_is_debug_state_enabled(ctrl)) {
616 __pam_log_debug(pamh, ctrl, LOG_DEBUG,
617 "[pamh: %p] CLEAN: cleaning up PAM data %p "
618 "(error_status = %d)", pamh, data,
619 error_status);
621 TALLOC_FREE(data);
625 static const struct ntstatus_errors {
626 const char *ntstatus_string;
627 const char *error_string;
628 } ntstatus_errors[] = {
629 {"NT_STATUS_OK",
630 N_("Success")},
631 {"NT_STATUS_BACKUP_CONTROLLER",
632 N_("No primary Domain Controller available")},
633 {"NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
634 N_("No domain controllers found")},
635 {"NT_STATUS_NO_LOGON_SERVERS",
636 N_("No logon servers")},
637 {"NT_STATUS_PWD_TOO_SHORT",
638 N_("Password too short")},
639 {"NT_STATUS_PWD_TOO_RECENT",
640 N_("The password was recently changed and cannot be changed again before %s")},
641 {"NT_STATUS_PWD_HISTORY_CONFLICT",
642 N_("Password is already in password history")},
643 {"NT_STATUS_PASSWORD_EXPIRED",
644 N_("Your password has expired")},
645 {"NT_STATUS_PASSWORD_MUST_CHANGE",
646 N_("You need to change your password now")},
647 {"NT_STATUS_INVALID_WORKSTATION",
648 N_("You are not allowed to logon from this workstation")},
649 {"NT_STATUS_INVALID_LOGON_HOURS",
650 N_("You are not allowed to logon at this time")},
651 {"NT_STATUS_ACCOUNT_EXPIRED",
652 N_("Your account has expired. "
653 "Please contact your System administrator")}, /* SCNR */
654 {"NT_STATUS_ACCOUNT_DISABLED",
655 N_("Your account is disabled. "
656 "Please contact your System administrator")}, /* SCNR */
657 {"NT_STATUS_ACCOUNT_LOCKED_OUT",
658 N_("Your account has been locked. "
659 "Please contact your System administrator")}, /* SCNR */
660 {"NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
661 N_("Invalid Trust Account")},
662 {"NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
663 N_("Invalid Trust Account")},
664 {"NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
665 N_("Invalid Trust Account")},
666 {"NT_STATUS_ACCESS_DENIED",
667 N_("Access is denied")},
668 {NULL, NULL}
671 static const char *_get_ntstatus_error_string(const char *nt_status_string)
673 int i;
674 for (i=0; ntstatus_errors[i].ntstatus_string != NULL; i++) {
675 if (!strcasecmp(ntstatus_errors[i].ntstatus_string,
676 nt_status_string)) {
677 return _(ntstatus_errors[i].error_string);
680 return NULL;
683 /* --- authentication management functions --- */
685 /* Attempt a conversation */
687 static int converse(const pam_handle_t *pamh,
688 int nargs,
689 const struct pam_message **message,
690 struct pam_response **response)
692 int retval;
693 const struct pam_conv *conv;
695 retval = pam_get_item(pamh, PAM_CONV, (const void **) &conv);
696 if (retval == PAM_SUCCESS) {
697 retval = conv->conv(nargs,
698 discard_const_p(const struct pam_message *, message),
699 response, conv->appdata_ptr);
702 return retval; /* propagate error status */
706 static int _make_remark(struct pwb_context *ctx,
707 int type,
708 const char *text)
710 int retval = PAM_SUCCESS;
712 const struct pam_message *pmsg[1];
713 struct pam_message msg[1];
714 struct pam_response *resp;
716 if (ctx->flags & WINBIND_SILENT) {
717 return PAM_SUCCESS;
720 pmsg[0] = &msg[0];
721 msg[0].msg = discard_const_p(char, text);
722 msg[0].msg_style = type;
724 resp = NULL;
725 retval = converse(ctx->pamh, 1, pmsg, &resp);
727 if (resp) {
728 _pam_drop_reply(resp, 1);
730 return retval;
733 static int _make_remark_v(struct pwb_context *ctx,
734 int type,
735 const char *format,
736 va_list args) PRINTF_ATTRIBUTE(3, 0);
738 static int _make_remark_v(struct pwb_context *ctx,
739 int type,
740 const char *format,
741 va_list args)
743 char *var;
744 int ret;
746 ret = vasprintf(&var, format, args);
747 if (ret < 0) {
748 _pam_log(ctx, LOG_ERR, "memory allocation failure");
749 return ret;
752 ret = _make_remark(ctx, type, var);
753 SAFE_FREE(var);
754 return ret;
757 static int _make_remark_format(struct pwb_context *ctx, int type, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
758 static int _make_remark_format(struct pwb_context *ctx, int type, const char *format, ...)
760 int ret;
761 va_list args;
763 va_start(args, format);
764 ret = _make_remark_v(ctx, type, format, args);
765 va_end(args);
766 return ret;
769 static int pam_winbind_request_log(struct pwb_context *ctx,
770 int retval,
771 const char *user,
772 const char *fn)
774 switch (retval) {
775 case PAM_AUTH_ERR:
776 /* incorrect password */
777 _pam_log(ctx, LOG_WARNING, "user '%s' denied access "
778 "(incorrect password or invalid membership)", user);
779 return retval;
780 case PAM_ACCT_EXPIRED:
781 /* account expired */
782 _pam_log(ctx, LOG_WARNING, "user '%s' account expired",
783 user);
784 return retval;
785 case PAM_AUTHTOK_EXPIRED:
786 /* password expired */
787 _pam_log(ctx, LOG_WARNING, "user '%s' password expired",
788 user);
789 return retval;
790 case PAM_NEW_AUTHTOK_REQD:
791 /* new password required */
792 _pam_log(ctx, LOG_WARNING, "user '%s' new password "
793 "required", user);
794 return retval;
795 case PAM_USER_UNKNOWN:
796 /* the user does not exist */
797 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
798 user);
799 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
800 return PAM_IGNORE;
802 return retval;
803 case PAM_AUTHTOK_ERR:
804 /* Authentication token manipulation error */
805 _pam_log(ctx, LOG_WARNING, "user `%s' authentication token change failed "
806 "(pwd complexity/history/min_age not met?)", user);
807 return retval;
808 case PAM_SUCCESS:
809 /* Otherwise, the authentication looked good */
810 if (strcmp(fn, "wbcLogonUser") == 0) {
811 _pam_log(ctx, LOG_NOTICE,
812 "user '%s' granted access", user);
813 } else {
814 _pam_log(ctx, LOG_NOTICE,
815 "user '%s' OK", user);
817 return retval;
818 default:
819 /* we don't know anything about this return value */
820 _pam_log(ctx, LOG_ERR,
821 "internal module error (retval = %s(%d), user = '%s')",
822 _pam_error_code_str(retval), retval, user);
823 return retval;
827 static int wbc_auth_error_to_pam_error(struct pwb_context *ctx,
828 struct wbcAuthErrorInfo *e,
829 wbcErr status,
830 const char *username,
831 const char *fn)
833 int ret = PAM_AUTH_ERR;
835 if (WBC_ERROR_IS_OK(status)) {
836 _pam_log_debug(ctx, LOG_DEBUG, "request %s succeeded",
837 fn);
838 ret = PAM_SUCCESS;
839 return pam_winbind_request_log(ctx, ret, username, fn);
842 if (e) {
843 if (e->pam_error != PAM_SUCCESS) {
844 _pam_log(ctx, LOG_ERR,
845 "request %s failed: %s, "
846 "PAM error: %s (%d), NTSTATUS: %s, "
847 "Error message was: %s",
849 wbcErrorString(status),
850 _pam_error_code_str(e->pam_error),
851 e->pam_error,
852 e->nt_string,
853 e->display_string);
854 ret = e->pam_error;
855 return pam_winbind_request_log(ctx, ret, username, fn);
858 _pam_log(ctx, LOG_ERR, "request %s failed, but PAM error 0!", fn);
860 ret = PAM_SERVICE_ERR;
861 return pam_winbind_request_log(ctx, ret, username, fn);
864 ret = wbc_error_to_pam_error(status);
865 _pam_log(ctx, LOG_ERR,
866 "request %s failed: %s, PAM error: %s (%d)!",
867 fn, wbcErrorString(status),
868 _pam_error_code_str(ret), ret);
869 return pam_winbind_request_log(ctx, ret, username, fn);
872 #if defined(HAVE_PAM_RADIO_TYPE)
873 static bool _pam_winbind_change_pwd(struct pwb_context *ctx)
875 struct pam_message msg;
876 const struct pam_message *pmsg;
877 struct pam_response *resp = NULL;
878 int ret;
879 bool retval = false;
880 pmsg = &msg;
881 msg.msg_style = PAM_RADIO_TYPE;
882 msg.msg = _("Do you want to change your password now?");
883 ret = converse(ctx->pamh, 1, &pmsg, &resp);
884 if (resp == NULL) {
885 if (ret == PAM_SUCCESS) {
886 _pam_log(ctx, LOG_CRIT, "pam_winbind: system error!\n");
887 return false;
890 if (ret != PAM_SUCCESS) {
891 return false;
893 _pam_log(ctx, LOG_CRIT, "Received [%s] reply from application.\n", resp->resp);
895 if ((resp->resp != NULL) && (strcasecmp(resp->resp, "yes") == 0)) {
896 retval = true;
899 _pam_drop_reply(resp, 1);
900 return retval;
902 #else
903 static bool _pam_winbind_change_pwd(struct pwb_context *ctx)
905 return false;
907 #endif
910 * send a password expiry message if required
912 * @param ctx PAM winbind context.
913 * @param next_change expected (calculated) next expiry date.
914 * @param already_expired pointer to a boolean to indicate if the password is
915 * already expired.
917 * @return boolean Returns true if message has been sent, false if not.
920 static bool _pam_send_password_expiry_message(struct pwb_context *ctx,
921 time_t next_change,
922 time_t now,
923 int warn_pwd_expire,
924 bool *already_expired,
925 bool *change_pwd)
927 int days = 0;
928 struct tm tm_now, tm_next_change;
929 bool retval = false;
930 int ret;
932 if (already_expired) {
933 *already_expired = false;
936 if (change_pwd) {
937 *change_pwd = false;
940 if (next_change <= now) {
941 PAM_WB_REMARK_DIRECT(ctx, "NT_STATUS_PASSWORD_EXPIRED");
942 if (already_expired) {
943 *already_expired = true;
945 return true;
948 if ((next_change < 0) ||
949 (next_change > now + warn_pwd_expire * SECONDS_PER_DAY)) {
950 return false;
953 if ((localtime_r(&now, &tm_now) == NULL) ||
954 (localtime_r(&next_change, &tm_next_change) == NULL)) {
955 return false;
958 days = (tm_next_change.tm_yday+tm_next_change.tm_year*365) -
959 (tm_now.tm_yday+tm_now.tm_year*365);
961 if (days == 0) {
962 ret = _make_remark(ctx, PAM_TEXT_INFO,
963 _("Your password expires today.\n"));
966 * If change_pwd and already_expired is null.
967 * We are just sending a notification message.
968 * We don't expect any response in this case.
971 if (!change_pwd && !already_expired) {
972 return true;
976 * successfully sent the warning message.
977 * Give the user a chance to change pwd.
979 if (ret == PAM_SUCCESS) {
980 if (change_pwd) {
981 retval = _pam_winbind_change_pwd(ctx);
982 if (retval) {
983 *change_pwd = true;
987 return true;
990 if (days > 0 && days < warn_pwd_expire) {
992 ret = _make_remark_format(ctx, PAM_TEXT_INFO,
993 _("Your password will expire in %d %s.\n"),
994 days, (days > 1) ? _("days"):_("day"));
996 * If change_pwd and already_expired is null.
997 * We are just sending a notification message.
998 * We don't expect any response in this case.
1001 if (!change_pwd && !already_expired) {
1002 return true;
1006 * successfully sent the warning message.
1007 * Give the user a chance to change pwd.
1009 if (ret == PAM_SUCCESS) {
1010 if (change_pwd) {
1011 retval = _pam_winbind_change_pwd(ctx);
1012 if (retval) {
1013 *change_pwd = true;
1017 return true;
1020 return false;
1024 * Send a warning if the password expires in the near future
1026 * @param ctx PAM winbind context.
1027 * @param response The full authentication response structure.
1028 * @param already_expired boolean, is the pwd already expired?
1030 * @return void.
1033 static void _pam_warn_password_expiry(struct pwb_context *ctx,
1034 const struct wbcAuthUserInfo *info,
1035 int warn_pwd_expire,
1036 bool *already_expired,
1037 bool *change_pwd)
1039 time_t now = time(NULL);
1040 time_t next_change = 0;
1042 if (info == NULL) {
1043 return;
1046 if (already_expired) {
1047 *already_expired = false;
1050 if (change_pwd) {
1051 *change_pwd = false;
1054 /* accounts with WBC_ACB_PWNOEXP set never receive a warning */
1055 if (info->acct_flags & WBC_ACB_PWNOEXP) {
1056 return;
1059 /* no point in sending a warning if this is a grace logon */
1060 if (PAM_WB_GRACE_LOGON(info->user_flags)) {
1061 return;
1064 /* check if the info3 must change timestamp has been set */
1065 next_change = info->pass_must_change_time;
1067 if (_pam_send_password_expiry_message(ctx, next_change, now,
1068 warn_pwd_expire,
1069 already_expired,
1070 change_pwd)) {
1071 return;
1074 /* no warning sent */
1077 #define IS_SID_STRING(name) (strncmp("S-", name, 2) == 0)
1080 * Append a string, making sure not to overflow and to always return a
1081 * NULL-terminated string.
1083 * @param dest Destination string buffer (must already be NULL-terminated).
1084 * @param src Source string buffer.
1085 * @param dest_buffer_size Size of dest buffer in bytes.
1087 * @return false if dest buffer is not big enough (no bytes copied), true on
1088 * success.
1091 static bool safe_append_string(char *dest,
1092 const char *src,
1093 int dest_buffer_size)
1095 size_t len;
1096 len = strlcat(dest, src, dest_buffer_size);
1097 return (len < dest_buffer_size);
1101 * Convert a names into a SID string, appending it to a buffer.
1103 * @param ctx PAM winbind context.
1104 * @param user User in PAM request.
1105 * @param name Name to convert.
1106 * @param sid_list_buffer Where to append the string sid.
1107 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1109 * @return false on failure, true on success.
1111 static bool winbind_name_to_sid_string(struct pwb_context *ctx,
1112 const char *user,
1113 const char *name,
1114 char *sid_list_buffer,
1115 int sid_list_buffer_size)
1117 char sid_string[WBC_SID_STRING_BUFLEN];
1119 /* lookup name? */
1120 if (IS_SID_STRING(name)) {
1121 strlcpy(sid_string, name, sizeof(sid_string));
1122 } else {
1123 wbcErr wbc_status;
1124 struct wbcDomainSid sid;
1125 enum wbcSidType type;
1127 _pam_log_debug(ctx, LOG_DEBUG,
1128 "no sid given, looking up: %s\n", name);
1130 wbc_status = wbcCtxLookupName(ctx->wbc_ctx,
1132 name,
1133 &sid,
1134 &type);
1135 if (!WBC_ERROR_IS_OK(wbc_status)) {
1136 _pam_log(ctx, LOG_INFO,
1137 "could not lookup name: %s\n", name);
1138 return false;
1141 wbcSidToStringBuf(&sid, sid_string, sizeof(sid_string));
1144 if (!safe_append_string(sid_list_buffer, sid_string,
1145 sid_list_buffer_size)) {
1146 return false;
1148 return true;
1152 * Convert a list of names into a list of sids.
1154 * @param ctx PAM winbind context.
1155 * @param user User in PAM request.
1156 * @param name_list List of names or string sids, separated by commas.
1157 * @param sid_list_buffer Where to put the list of string sids.
1158 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1160 * @return false on failure, true on success.
1162 static bool winbind_name_list_to_sid_string_list(struct pwb_context *ctx,
1163 const char *user,
1164 const char *name_list,
1165 char *sid_list_buffer,
1166 int sid_list_buffer_size)
1168 bool result = false;
1169 char *current_name = NULL;
1170 const char *search_location;
1171 const char *comma;
1172 int len;
1174 if (sid_list_buffer_size > 0) {
1175 sid_list_buffer[0] = 0;
1178 search_location = name_list;
1179 while ((comma = strchr(search_location, ',')) != NULL) {
1180 current_name = strndup(search_location,
1181 comma - search_location);
1182 if (NULL == current_name) {
1183 goto out;
1186 if (!winbind_name_to_sid_string(ctx, user,
1187 current_name,
1188 sid_list_buffer,
1189 sid_list_buffer_size)) {
1191 * If one group name failed, we must not fail
1192 * the authentication totally, continue with
1193 * the following group names. If user belongs to
1194 * one of the valid groups, we must allow it
1195 * login. -- BoYang
1198 _pam_log(ctx, LOG_INFO, "cannot convert group %s to sid, "
1199 "check if group %s is valid group.", current_name,
1200 current_name);
1201 _make_remark_format(ctx, PAM_TEXT_INFO, _("Cannot convert group %s "
1202 "to sid, please contact your administrator to see "
1203 "if group %s is valid."), current_name, current_name);
1204 SAFE_FREE(current_name);
1205 search_location = comma + 1;
1206 continue;
1209 SAFE_FREE(current_name);
1211 if (!safe_append_string(sid_list_buffer, ",",
1212 sid_list_buffer_size)) {
1213 goto out;
1216 search_location = comma + 1;
1219 if (!winbind_name_to_sid_string(ctx, user, search_location,
1220 sid_list_buffer,
1221 sid_list_buffer_size)) {
1222 _pam_log(ctx, LOG_INFO, "cannot convert group %s to sid, "
1223 "check if group %s is valid group.", search_location,
1224 search_location);
1225 _make_remark_format(ctx, PAM_TEXT_INFO, _("Cannot convert group %s "
1226 "to sid, please contact your administrator to see "
1227 "if group %s is valid."), search_location, search_location);
1229 /* If no valid groups were converted we should fail outright */
1230 if (name_list != NULL && strlen(sid_list_buffer) == 0) {
1231 result = false;
1232 goto out;
1235 * The lookup of the last name failed..
1236 * It results in require_member_of_sid ends with ','
1237 * It is malformatted parameter here, overwrite the last ','.
1239 len = strlen(sid_list_buffer);
1240 if ((len != 0) && (sid_list_buffer[len - 1] == ',')) {
1241 sid_list_buffer[len - 1] = '\0';
1245 result = true;
1247 out:
1248 SAFE_FREE(current_name);
1249 return result;
1253 * put krb5ccname variable into environment
1255 * @param ctx PAM winbind context.
1256 * @param krb5ccname env variable retrieved from winbindd.
1258 * @return void.
1261 static void _pam_setup_krb5_env(struct pwb_context *ctx,
1262 struct wbcLogonUserInfo *info)
1264 char *var = NULL;
1265 int ret;
1266 uint32_t i;
1267 const char *krb5ccname = NULL;
1269 if (off(ctx->ctrl, WINBIND_KRB5_AUTH)) {
1270 return;
1273 if (!info) {
1274 return;
1277 for (i=0; i < info->num_blobs; i++) {
1278 if (strcasecmp(info->blobs[i].name, "krb5ccname") == 0) {
1279 krb5ccname = (const char *)info->blobs[i].blob.data;
1280 break;
1284 if (!krb5ccname || (strlen(krb5ccname) == 0)) {
1285 return;
1288 _pam_log_debug(ctx, LOG_DEBUG,
1289 "request returned KRB5CCNAME: %s", krb5ccname);
1291 if (asprintf(&var, "KRB5CCNAME=%s", krb5ccname) == -1) {
1292 return;
1295 ret = pam_putenv(ctx->pamh, var);
1296 if (ret != PAM_SUCCESS) {
1297 _pam_log(ctx, LOG_ERR,
1298 "failed to set KRB5CCNAME to %s: %s",
1299 var, pam_strerror(ctx->pamh, ret));
1301 free(var);
1305 * Copy unix username if available (further processed in PAM).
1307 * @param ctx PAM winbind context
1308 * @param user_ret A pointer that holds a pointer to a string
1309 * @param unix_username A username
1311 * @return void.
1314 static void _pam_setup_unix_username(struct pwb_context *ctx,
1315 char **user_ret,
1316 struct wbcLogonUserInfo *info)
1318 const char *unix_username = NULL;
1319 uint32_t i;
1321 if (!user_ret || !info) {
1322 return;
1325 for (i=0; i < info->num_blobs; i++) {
1326 if (strcasecmp(info->blobs[i].name, "unix_username") == 0) {
1327 unix_username = (const char *)info->blobs[i].blob.data;
1328 break;
1332 if (!unix_username || !unix_username[0]) {
1333 return;
1336 *user_ret = strdup(unix_username);
1340 * Set string into the PAM stack.
1342 * @param ctx PAM winbind context.
1343 * @param data_name Key name for pam_set_data.
1344 * @param value String value.
1346 * @return void.
1349 static void _pam_set_data_string(struct pwb_context *ctx,
1350 const char *data_name,
1351 const char *value)
1353 int ret;
1355 if (!data_name || !value || (strlen(data_name) == 0) ||
1356 (strlen(value) == 0)) {
1357 return;
1360 ret = pam_set_data(ctx->pamh, data_name, talloc_strdup(NULL, value),
1361 _pam_winbind_cleanup_func);
1362 if (ret != PAM_SUCCESS) {
1363 _pam_log_debug(ctx, LOG_DEBUG,
1364 "Could not set data %s: %s\n",
1365 data_name, pam_strerror(ctx->pamh, ret));
1370 * Set info3 strings into the PAM stack.
1372 * @param ctx PAM winbind context.
1373 * @param data_name Key name for pam_set_data.
1374 * @param value String value.
1376 * @return void.
1379 static void _pam_set_data_info3(struct pwb_context *ctx,
1380 const struct wbcAuthUserInfo *info)
1382 if (info != NULL) {
1383 _pam_set_data_string(ctx, PAM_WINBIND_HOMEDIR,
1384 info->home_directory);
1385 _pam_set_data_string(ctx, PAM_WINBIND_LOGONSCRIPT,
1386 info->logon_script);
1387 _pam_set_data_string(ctx, PAM_WINBIND_LOGONSERVER,
1388 info->logon_server);
1389 _pam_set_data_string(ctx, PAM_WINBIND_PROFILEPATH,
1390 info->profile_path);
1395 * Free info3 strings in the PAM stack.
1397 * @param pamh PAM handle
1399 * @return void.
1402 static void _pam_free_data_info3(pam_handle_t *pamh)
1404 pam_set_data(pamh, PAM_WINBIND_HOMEDIR, NULL, NULL);
1405 pam_set_data(pamh, PAM_WINBIND_LOGONSCRIPT, NULL, NULL);
1406 pam_set_data(pamh, PAM_WINBIND_LOGONSERVER, NULL, NULL);
1407 pam_set_data(pamh, PAM_WINBIND_PROFILEPATH, NULL, NULL);
1411 * Send PAM_ERROR_MSG for cached or grace logons.
1413 * @param ctx PAM winbind context.
1414 * @param username User in PAM request.
1415 * @param info3_user_flgs Info3 flags containing logon type bits.
1417 * @return void.
1420 static void _pam_warn_logon_type(struct pwb_context *ctx,
1421 const char *username,
1422 uint32_t info3_user_flgs)
1424 /* inform about logon type */
1425 if (PAM_WB_GRACE_LOGON(info3_user_flgs)) {
1427 _make_remark(ctx, PAM_ERROR_MSG,
1428 _("Grace login. "
1429 "Please change your password as soon you're "
1430 "online again"));
1431 _pam_log_debug(ctx, LOG_DEBUG,
1432 "User %s logged on using grace logon\n",
1433 username);
1435 } else if (PAM_WB_CACHED_LOGON(info3_user_flgs)) {
1437 _make_remark(ctx, PAM_ERROR_MSG,
1438 _("Domain Controller unreachable, "
1439 "using cached credentials instead. "
1440 "Network resources may be unavailable"));
1441 _pam_log_debug(ctx, LOG_DEBUG,
1442 "User %s logged on using cached credentials\n",
1443 username);
1448 * Send PAM_ERROR_MSG for krb5 errors.
1450 * @param ctx PAM winbind context.
1451 * @param username User in PAM request.
1452 * @param info3_user_flgs Info3 flags containing logon type bits.
1454 * @return void.
1457 static void _pam_warn_krb5_failure(struct pwb_context *ctx,
1458 const char *username,
1459 uint32_t info3_user_flgs)
1461 if (PAM_WB_KRB5_CLOCK_SKEW(info3_user_flgs)) {
1462 _make_remark(ctx, PAM_ERROR_MSG,
1463 _("Failed to establish your Kerberos Ticket cache "
1464 "due time differences\n"
1465 "with the domain controller. "
1466 "Please verify the system time.\n"));
1467 _pam_log_debug(ctx, LOG_DEBUG,
1468 "User %s: Clock skew when getting Krb5 TGT\n",
1469 username);
1473 static bool _pam_check_remark_auth_err(struct pwb_context *ctx,
1474 const struct wbcAuthErrorInfo *e,
1475 const char *nt_status_string,
1476 int *pam_err)
1478 const char *ntstatus = NULL;
1479 const char *error_string = NULL;
1481 if (!e || !pam_err) {
1482 return false;
1485 ntstatus = e->nt_string;
1486 if (!ntstatus) {
1487 return false;
1490 if (strcasecmp(ntstatus, nt_status_string) == 0) {
1492 error_string = _get_ntstatus_error_string(nt_status_string);
1493 if (error_string) {
1494 _make_remark(ctx, PAM_ERROR_MSG, error_string);
1495 *pam_err = e->pam_error;
1496 return true;
1499 if (e->display_string) {
1500 _make_remark(ctx, PAM_ERROR_MSG, _(e->display_string));
1501 *pam_err = e->pam_error;
1502 return true;
1505 _make_remark(ctx, PAM_ERROR_MSG, nt_status_string);
1506 *pam_err = e->pam_error;
1508 return true;
1511 return false;
1515 * Compose Password Restriction String for a PAM_ERROR_MSG conversation.
1517 * @param i The wbcUserPasswordPolicyInfo struct.
1519 * @return string (caller needs to talloc_free).
1522 static char *_pam_compose_pwd_restriction_string(struct pwb_context *ctx,
1523 struct wbcUserPasswordPolicyInfo *i)
1525 char *str = NULL;
1527 if (!i) {
1528 goto failed;
1531 str = talloc_asprintf(ctx, _("Your password "));
1532 if (!str) {
1533 goto failed;
1536 if (i->min_length_password > 0) {
1537 str = talloc_asprintf_append(str,
1538 _("must be at least %d characters; "),
1539 i->min_length_password);
1540 if (!str) {
1541 goto failed;
1545 if (i->password_history > 0) {
1546 str = talloc_asprintf_append(str,
1547 _("cannot repeat any of your previous %d "
1548 "passwords; "),
1549 i->password_history);
1550 if (!str) {
1551 goto failed;
1555 if (i->password_properties & WBC_DOMAIN_PASSWORD_COMPLEX) {
1556 str = talloc_asprintf_append(str,
1557 _("must contain capitals, numerals "
1558 "or punctuation; "
1559 "and cannot contain your account "
1560 "or full name; "));
1561 if (!str) {
1562 goto failed;
1566 str = talloc_asprintf_append(str,
1567 _("Please type a different password. "
1568 "Type a password which meets these requirements in "
1569 "both text boxes."));
1570 if (!str) {
1571 goto failed;
1574 return str;
1576 failed:
1577 TALLOC_FREE(str);
1578 return NULL;
1581 static int _pam_create_homedir(struct pwb_context *ctx,
1582 const char *dirname,
1583 mode_t mode)
1585 int ret;
1587 ret = mkdir(dirname, mode);
1588 if (ret != 0 && errno == EEXIST) {
1589 struct stat sbuf;
1591 ret = stat(dirname, &sbuf);
1592 if (ret != 0) {
1593 return PAM_PERM_DENIED;
1596 if (!S_ISDIR(sbuf.st_mode)) {
1597 return PAM_PERM_DENIED;
1601 if (ret != 0) {
1602 _make_remark_format(ctx, PAM_TEXT_INFO,
1603 _("Creating directory: %s failed: %s"),
1604 dirname, strerror(errno));
1605 _pam_log(ctx, LOG_ERR, "could not create dir: %s (%s)",
1606 dirname, strerror(errno));
1607 return PAM_PERM_DENIED;
1610 return PAM_SUCCESS;
1613 static int _pam_chown_homedir(struct pwb_context *ctx,
1614 const char *dirname,
1615 uid_t uid,
1616 gid_t gid)
1618 if (chown(dirname, uid, gid) != 0) {
1619 _pam_log(ctx, LOG_ERR, "failed to chown user homedir: %s (%s)",
1620 dirname, strerror(errno));
1621 return PAM_PERM_DENIED;
1624 return PAM_SUCCESS;
1627 static int _pam_mkhomedir(struct pwb_context *ctx)
1629 struct passwd *pwd = NULL;
1630 char *token = NULL;
1631 char *create_dir = NULL;
1632 char *user_dir = NULL;
1633 int ret;
1634 const char *username;
1635 mode_t mode = 0700;
1636 char *safe_ptr = NULL;
1637 char *p = NULL;
1639 /* Get the username */
1640 ret = pam_get_user(ctx->pamh, &username, NULL);
1641 if ((ret != PAM_SUCCESS) || (!username)) {
1642 _pam_log_debug(ctx, LOG_DEBUG, "can not get the username");
1643 return PAM_SERVICE_ERR;
1646 pwd = getpwnam(username);
1647 if (pwd == NULL) {
1648 _pam_log_debug(ctx, LOG_DEBUG, "can not get the username");
1649 return PAM_USER_UNKNOWN;
1651 _pam_log_debug(ctx, LOG_DEBUG, "homedir is: %s", pwd->pw_dir);
1653 ret = _pam_create_homedir(ctx, pwd->pw_dir, 0700);
1654 if (ret == PAM_SUCCESS) {
1655 ret = _pam_chown_homedir(ctx, pwd->pw_dir,
1656 pwd->pw_uid,
1657 pwd->pw_gid);
1660 if (ret == PAM_SUCCESS) {
1661 return ret;
1664 /* maybe we need to create parent dirs */
1665 create_dir = talloc_strdup(ctx, "/");
1666 if (!create_dir) {
1667 return PAM_BUF_ERR;
1670 /* find final directory */
1671 user_dir = strrchr(pwd->pw_dir, '/');
1672 if (!user_dir) {
1673 return PAM_BUF_ERR;
1675 user_dir++;
1677 _pam_log(ctx, LOG_DEBUG, "final directory: %s", user_dir);
1679 p = pwd->pw_dir;
1681 while ((token = strtok_r(p, "/", &safe_ptr)) != NULL) {
1683 mode = 0755;
1685 p = NULL;
1687 _pam_log_debug(ctx, LOG_DEBUG, "token is %s", token);
1689 create_dir = talloc_asprintf_append(create_dir, "%s/", token);
1690 if (!create_dir) {
1691 return PAM_BUF_ERR;
1693 _pam_log_debug(ctx, LOG_DEBUG, "current_dir is %s", create_dir);
1695 if (strcmp(token, user_dir) == 0) {
1696 _pam_log_debug(ctx, LOG_DEBUG, "assuming last directory: %s", token);
1697 mode = 0700;
1700 ret = _pam_create_homedir(ctx, create_dir, mode);
1701 if (ret != PAM_SUCCESS) {
1702 return ret;
1706 return _pam_chown_homedir(ctx, create_dir,
1707 pwd->pw_uid,
1708 pwd->pw_gid);
1711 /* talk to winbindd */
1712 static int winbind_auth_request(struct pwb_context *ctx,
1713 const char *user,
1714 const char *pass,
1715 const char *member,
1716 const char *cctype,
1717 const int warn_pwd_expire,
1718 struct wbcAuthErrorInfo **p_error,
1719 struct wbcLogonUserInfo **p_info,
1720 time_t *pwd_last_set,
1721 char **user_ret)
1723 wbcErr wbc_status;
1724 struct wbcLogonUserParams logon;
1725 char membership_of[1024];
1726 uid_t user_uid = -1;
1727 uint32_t flags = WBFLAG_PAM_INFO3_TEXT;
1728 struct wbcLogonUserInfo *info = NULL;
1729 struct wbcAuthUserInfo *user_info = NULL;
1730 struct wbcAuthErrorInfo *error = NULL;
1731 int ret = PAM_AUTH_ERR;
1732 int i;
1733 const char *codes[] = {
1734 "NT_STATUS_PASSWORD_EXPIRED",
1735 "NT_STATUS_PASSWORD_MUST_CHANGE",
1736 "NT_STATUS_INVALID_WORKSTATION",
1737 "NT_STATUS_INVALID_LOGON_HOURS",
1738 "NT_STATUS_ACCOUNT_EXPIRED",
1739 "NT_STATUS_ACCOUNT_DISABLED",
1740 "NT_STATUS_ACCOUNT_LOCKED_OUT",
1741 "NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
1742 "NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
1743 "NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
1744 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1745 "NT_STATUS_NO_LOGON_SERVERS",
1746 "NT_STATUS_WRONG_PASSWORD",
1747 "NT_STATUS_ACCESS_DENIED"
1750 if (pwd_last_set) {
1751 *pwd_last_set = 0;
1754 /* Krb5 auth always has to go against the KDC of the user's realm */
1756 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1757 flags |= WBFLAG_PAM_CONTACT_TRUSTDOM;
1760 if (ctx->ctrl & (WINBIND_KRB5_AUTH|WINBIND_CACHED_LOGIN)) {
1761 struct passwd *pwd = NULL;
1763 pwd = getpwnam(user);
1764 if (pwd == NULL) {
1765 return PAM_USER_UNKNOWN;
1767 user_uid = pwd->pw_uid;
1770 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1772 _pam_log_debug(ctx, LOG_DEBUG,
1773 "enabling krb5 login flag\n");
1775 flags |= WBFLAG_PAM_KRB5 |
1776 WBFLAG_PAM_FALLBACK_AFTER_KRB5;
1779 if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1780 _pam_log_debug(ctx, LOG_DEBUG,
1781 "enabling cached login flag\n");
1782 flags |= WBFLAG_PAM_CACHED_LOGIN;
1785 if (user_ret) {
1786 *user_ret = NULL;
1787 flags |= WBFLAG_PAM_UNIX_NAME;
1790 if (cctype != NULL) {
1791 _pam_log_debug(ctx, LOG_DEBUG,
1792 "enabling request for a %s krb5 ccache\n",
1793 cctype);
1796 if (member != NULL) {
1798 ZERO_STRUCT(membership_of);
1800 if (!winbind_name_list_to_sid_string_list(ctx, user, member,
1801 membership_of,
1802 sizeof(membership_of))) {
1803 _pam_log_debug(ctx, LOG_ERR,
1804 "failed to serialize membership of sid "
1805 "\"%s\"\n", member);
1806 return PAM_AUTH_ERR;
1810 ZERO_STRUCT(logon);
1812 logon.username = user;
1813 logon.password = pass;
1815 if (cctype) {
1816 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1817 &logon.blobs,
1818 "krb5_cc_type",
1820 discard_const_p(uint8_t, cctype),
1821 strlen(cctype)+1);
1822 if (!WBC_ERROR_IS_OK(wbc_status)) {
1823 goto done;
1827 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1828 &logon.blobs,
1829 "flags",
1831 (uint8_t *)&flags,
1832 sizeof(flags));
1833 if (!WBC_ERROR_IS_OK(wbc_status)) {
1834 goto done;
1837 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1838 &logon.blobs,
1839 "user_uid",
1841 (uint8_t *)&user_uid,
1842 sizeof(user_uid));
1843 if (!WBC_ERROR_IS_OK(wbc_status)) {
1844 goto done;
1847 if (member) {
1848 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1849 &logon.blobs,
1850 "membership_of",
1852 (uint8_t *)membership_of,
1853 sizeof(membership_of));
1854 if (!WBC_ERROR_IS_OK(wbc_status)) {
1855 goto done;
1859 wbc_status = wbcCtxLogonUser(ctx->wbc_ctx,
1860 &logon,
1861 &info,
1862 &error,
1863 NULL);
1864 ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1865 user, "wbcLogonUser");
1866 wbcFreeMemory(logon.blobs);
1867 logon.blobs = NULL;
1869 if (info && info->info) {
1870 user_info = info->info;
1873 if (pwd_last_set && user_info) {
1874 *pwd_last_set = user_info->pass_last_set_time;
1877 if (p_info && info) {
1878 *p_info = info;
1881 if (p_error && error) {
1882 /* We want to process the error in the caller. */
1883 *p_error = error;
1884 return ret;
1887 for (i=0; i<ARRAY_SIZE(codes); i++) {
1888 int _ret = ret;
1889 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1890 ret = _ret;
1891 goto done;
1895 if ((ret == PAM_SUCCESS) && user_info && info) {
1897 bool already_expired = false;
1898 bool change_pwd = false;
1900 /* warn a user if the password is about to expire soon */
1901 _pam_warn_password_expiry(ctx, user_info,
1902 warn_pwd_expire,
1903 &already_expired,
1904 &change_pwd);
1906 if (already_expired == true) {
1908 SMB_TIME_T last_set = user_info->pass_last_set_time;
1909 SMB_TIME_T must_set = user_info->pass_must_change_time;
1911 _pam_log_debug(ctx, LOG_DEBUG,
1912 "Password has expired "
1913 "(Password was last set: %lld, "
1914 "it must be changed here "
1915 "%lld (now it's: %ld))\n",
1916 (long long int)last_set,
1917 (long long int)must_set,
1918 (long)time(NULL));
1920 return PAM_AUTHTOK_EXPIRED;
1923 if (change_pwd) {
1924 ret = PAM_NEW_AUTHTOK_REQD;
1925 goto done;
1928 /* inform about logon type */
1929 _pam_warn_logon_type(ctx, user, user_info->user_flags);
1931 /* inform about krb5 failures */
1932 _pam_warn_krb5_failure(ctx, user, user_info->user_flags);
1934 /* set some info3 info for other modules in the stack */
1935 _pam_set_data_info3(ctx, user_info);
1937 /* put krb5ccname into env */
1938 _pam_setup_krb5_env(ctx, info);
1940 /* If winbindd returned a username, return the pointer to it
1941 * here. */
1942 _pam_setup_unix_username(ctx, user_ret, info);
1945 done:
1946 wbcFreeMemory(logon.blobs);
1947 if (info && info->blobs && !p_info) {
1948 wbcFreeMemory(info->blobs);
1950 * We set blobs to NULL to prevent a use after free in the
1951 * in the wbcLogonUserInfoDestructor
1953 info->blobs = NULL;
1955 if (error && !p_error) {
1956 wbcFreeMemory(error);
1958 if (info && !p_info) {
1959 wbcFreeMemory(info);
1962 return ret;
1965 /* talk to winbindd */
1966 static int winbind_chauthtok_request(struct pwb_context *ctx,
1967 const char *user,
1968 const char *oldpass,
1969 const char *newpass,
1970 time_t pwd_last_set)
1972 wbcErr wbc_status;
1973 struct wbcChangePasswordParams params;
1974 struct wbcAuthErrorInfo *error = NULL;
1975 struct wbcUserPasswordPolicyInfo *policy = NULL;
1976 enum wbcPasswordChangeRejectReason reject_reason = -1;
1977 uint32_t flags = 0;
1979 int i;
1980 const char *codes[] = {
1981 "NT_STATUS_BACKUP_CONTROLLER",
1982 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1983 "NT_STATUS_NO_LOGON_SERVERS",
1984 "NT_STATUS_ACCESS_DENIED",
1985 "NT_STATUS_PWD_TOO_SHORT", /* TODO: tell the min pwd length ? */
1986 "NT_STATUS_PWD_TOO_RECENT", /* TODO: tell the minage ? */
1987 "NT_STATUS_PWD_HISTORY_CONFLICT" /* TODO: tell the history length ? */
1989 int ret = PAM_AUTH_ERR;
1991 ZERO_STRUCT(params);
1993 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1994 flags |= WBFLAG_PAM_KRB5 |
1995 WBFLAG_PAM_CONTACT_TRUSTDOM;
1998 if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1999 flags |= WBFLAG_PAM_CACHED_LOGIN;
2002 params.account_name = user;
2003 params.level = WBC_CHANGE_PASSWORD_LEVEL_PLAIN;
2004 params.old_password.plaintext = oldpass;
2005 params.new_password.plaintext = newpass;
2006 params.flags = flags;
2008 wbc_status = wbcCtxChangeUserPasswordEx(ctx->wbc_ctx,
2009 &params,
2010 &error,
2011 &reject_reason,
2012 &policy);
2013 ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2014 user, "wbcChangeUserPasswordEx");
2016 if (WBC_ERROR_IS_OK(wbc_status)) {
2017 _pam_log(ctx, LOG_NOTICE,
2018 "user '%s' password changed", user);
2019 return PAM_SUCCESS;
2022 if (!error) {
2023 wbcFreeMemory(policy);
2024 return ret;
2027 for (i=0; i<ARRAY_SIZE(codes); i++) {
2028 int _ret = ret;
2029 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
2030 ret = _ret;
2031 goto done;
2035 if (!strcasecmp(error->nt_string,
2036 "NT_STATUS_PASSWORD_RESTRICTION")) {
2038 char *pwd_restriction_string = NULL;
2039 SMB_TIME_T min_pwd_age = 0;
2041 if (policy) {
2042 min_pwd_age = policy->min_passwordage;
2045 /* FIXME: avoid to send multiple PAM messages after another */
2046 switch ((int)reject_reason) {
2047 case -1:
2048 break;
2049 case WBC_PWD_CHANGE_NO_ERROR:
2050 if ((min_pwd_age > 0) &&
2051 (pwd_last_set + min_pwd_age > time(NULL))) {
2052 time_t next_change = pwd_last_set + min_pwd_age;
2053 #if defined(__clang__)
2054 #pragma clang diagnostic push
2055 #pragma clang diagnostic ignored "-Wformat-nonliteral"
2056 #endif
2057 _make_remark_format(ctx, PAM_ERROR_MSG,
2058 _get_ntstatus_error_string("NT_STATUS_PWD_TOO_RECENT"),
2059 ctime(&next_change));
2060 #if defined(__clang__)
2061 #pragma clang diagnostic pop
2062 #endif
2063 goto done;
2065 break;
2066 case WBC_PWD_CHANGE_PASSWORD_TOO_SHORT:
2067 PAM_WB_REMARK_DIRECT(ctx,
2068 "NT_STATUS_PWD_TOO_SHORT");
2069 break;
2070 case WBC_PWD_CHANGE_PWD_IN_HISTORY:
2071 PAM_WB_REMARK_DIRECT(ctx,
2072 "NT_STATUS_PWD_HISTORY_CONFLICT");
2073 break;
2074 case WBC_PWD_CHANGE_NOT_COMPLEX:
2075 _make_remark(ctx, PAM_ERROR_MSG,
2076 _("Password does not meet "
2077 "complexity requirements"));
2078 break;
2079 default:
2080 _pam_log_debug(ctx, LOG_DEBUG,
2081 "unknown password change "
2082 "reject reason: %d",
2083 reject_reason);
2084 break;
2087 pwd_restriction_string =
2088 _pam_compose_pwd_restriction_string(ctx, policy);
2089 if (pwd_restriction_string) {
2090 _make_remark(ctx, PAM_ERROR_MSG,
2091 pwd_restriction_string);
2092 TALLOC_FREE(pwd_restriction_string);
2095 done:
2096 wbcFreeMemory(error);
2097 wbcFreeMemory(policy);
2099 return ret;
2103 * Checks if a user has an account
2105 * return values:
2106 * 1 = User not found
2107 * 0 = OK
2108 * -1 = System error
2110 static int valid_user(struct pwb_context *ctx,
2111 const char *user)
2113 /* check not only if the user is available over NSS calls, also make
2114 * sure it's really a winbind user, this is important when stacking PAM
2115 * modules in the 'account' or 'password' facility. */
2117 wbcErr wbc_status;
2118 struct passwd *pwd = NULL;
2119 struct passwd *wb_pwd = NULL;
2121 pwd = getpwnam(user);
2122 if (pwd == NULL) {
2123 return 1;
2126 wbc_status = wbcCtxGetpwnam(ctx->wbc_ctx, user, &wb_pwd);
2127 wbcFreeMemory(wb_pwd);
2128 if (!WBC_ERROR_IS_OK(wbc_status)) {
2129 _pam_log(ctx, LOG_DEBUG, "valid_user: wbcGetpwnam gave %s\n",
2130 wbcErrorString(wbc_status));
2133 switch (wbc_status) {
2134 case WBC_ERR_UNKNOWN_USER:
2135 /* match other insane libwbclient return codes */
2136 case WBC_ERR_WINBIND_NOT_AVAILABLE:
2137 case WBC_ERR_DOMAIN_NOT_FOUND:
2138 return 1;
2139 case WBC_ERR_SUCCESS:
2140 return 0;
2141 default:
2142 break;
2144 return -1;
2147 static char *_pam_delete(register char *xx)
2149 _pam_overwrite(xx);
2150 _pam_drop(xx);
2151 return NULL;
2155 * obtain a password from the user
2158 static int _winbind_read_password(struct pwb_context *ctx,
2159 unsigned int ctrl,
2160 const char *comment,
2161 const char *prompt1,
2162 const char *prompt2,
2163 const char **pass)
2165 int authtok_flag;
2166 int retval;
2167 const char *item;
2168 char *token;
2170 _pam_log(ctx, LOG_DEBUG, "getting password (0x%08x)", ctrl);
2173 * make sure nothing inappropriate gets returned
2176 *pass = token = NULL;
2179 * which authentication token are we getting?
2182 if (on(WINBIND__OLD_PASSWORD, ctrl)) {
2183 authtok_flag = PAM_OLDAUTHTOK;
2184 } else {
2185 authtok_flag = PAM_AUTHTOK;
2189 * should we obtain the password from a PAM item ?
2192 if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) ||
2193 on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
2194 retval = pam_get_item(ctx->pamh,
2195 authtok_flag,
2196 (const void **) &item);
2197 if (retval != PAM_SUCCESS) {
2198 /* very strange. */
2199 _pam_log(ctx, LOG_ALERT,
2200 "pam_get_item returned error "
2201 "to unix-read-password");
2202 return retval;
2203 } else if (item != NULL) { /* we have a password! */
2204 *pass = item;
2205 item = NULL;
2206 _pam_log(ctx, LOG_DEBUG,
2207 "pam_get_item returned a password");
2208 return PAM_SUCCESS;
2209 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
2210 return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
2211 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
2212 && off(WINBIND__OLD_PASSWORD, ctrl)) {
2213 return PAM_AUTHTOK_RECOVER_ERR;
2217 * getting here implies we will have to get the password from the
2218 * user directly.
2222 struct pam_message msg[3];
2223 const struct pam_message *pmsg[3];
2224 struct pam_response *resp;
2225 int i, replies;
2227 /* prepare to converse */
2229 if (comment != NULL && off(ctrl, WINBIND_SILENT)) {
2230 pmsg[0] = &msg[0];
2231 msg[0].msg_style = PAM_TEXT_INFO;
2232 msg[0].msg = discard_const_p(char, comment);
2233 i = 1;
2234 } else {
2235 i = 0;
2238 pmsg[i] = &msg[i];
2239 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
2240 msg[i++].msg = discard_const_p(char, prompt1);
2241 replies = 1;
2243 if (prompt2 != NULL) {
2244 pmsg[i] = &msg[i];
2245 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
2246 msg[i++].msg = discard_const_p(char, prompt2);
2247 ++replies;
2249 /* so call the conversation expecting i responses */
2250 resp = NULL;
2251 retval = converse(ctx->pamh, i, pmsg, &resp);
2252 if (resp == NULL) {
2253 if (retval == PAM_SUCCESS) {
2254 retval = PAM_AUTHTOK_RECOVER_ERR;
2256 goto done;
2258 if (retval != PAM_SUCCESS) {
2259 _pam_drop_reply(resp, i);
2260 goto done;
2263 /* interpret the response */
2265 token = x_strdup(resp[i - replies].resp);
2266 if (!token) {
2267 _pam_log(ctx, LOG_NOTICE,
2268 "could not recover "
2269 "authentication token");
2270 retval = PAM_AUTHTOK_RECOVER_ERR;
2271 goto done;
2274 if (replies == 2) {
2275 /* verify that password entered correctly */
2276 if (!resp[i - 1].resp ||
2277 strcmp(token, resp[i - 1].resp)) {
2278 _pam_delete(token); /* mistyped */
2279 retval = PAM_AUTHTOK_RECOVER_ERR;
2280 _make_remark(ctx, PAM_ERROR_MSG,
2281 MISTYPED_PASS);
2286 * tidy up the conversation (resp_retcode) is ignored
2287 * -- what is it for anyway? AGM
2289 _pam_drop_reply(resp, i);
2292 done:
2293 if (retval != PAM_SUCCESS) {
2294 _pam_log_debug(ctx, LOG_DEBUG,
2295 "unable to obtain a password");
2296 return retval;
2298 /* 'token' is the entered password */
2300 /* we store this password as an item */
2302 retval = pam_set_item(ctx->pamh, authtok_flag, token);
2303 _pam_delete(token); /* clean it up */
2304 if (retval != PAM_SUCCESS ||
2305 (retval = pam_get_item(ctx->pamh, authtok_flag, (const void **) &item)) != PAM_SUCCESS) {
2307 _pam_log(ctx, LOG_CRIT, "error manipulating password");
2308 return retval;
2312 *pass = item;
2313 item = NULL; /* break link to password */
2315 return PAM_SUCCESS;
2318 static const char *get_conf_item_string(struct pwb_context *ctx,
2319 const char *item,
2320 int config_flag)
2322 int i = 0;
2323 const char *parm_opt = NULL;
2325 if (!(ctx->ctrl & config_flag)) {
2326 goto out;
2329 /* let the pam opt take precedence over the pam_winbind.conf option */
2330 for (i=0; i<ctx->argc; i++) {
2332 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2333 char *p;
2335 if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2336 _pam_log(ctx, LOG_INFO,
2337 "no \"=\" delimiter for \"%s\" found\n",
2338 item);
2339 goto out;
2341 _pam_log_debug(ctx, LOG_INFO,
2342 "PAM config: %s '%s'\n", item, p+1);
2343 return p + 1;
2347 if (ctx->dict) {
2348 char *key = NULL;
2350 key = talloc_asprintf(ctx, "global:%s", item);
2351 if (!key) {
2352 goto out;
2355 parm_opt = tiniparser_getstring_nonempty(ctx->dict, key, NULL);
2356 TALLOC_FREE(key);
2358 _pam_log_debug(ctx, LOG_INFO, "CONFIG file: %s '%s'\n",
2359 item, parm_opt);
2361 out:
2362 return parm_opt;
2365 static int get_config_item_int(struct pwb_context *ctx,
2366 const char *item,
2367 int config_flag)
2369 int i, parm_opt = -1;
2371 if (!(ctx->ctrl & config_flag)) {
2372 goto out;
2375 /* let the pam opt take precedence over the pam_winbind.conf option */
2376 for (i = 0; i < ctx->argc; i++) {
2378 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2379 char *p;
2381 if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2382 _pam_log(ctx, LOG_INFO,
2383 "no \"=\" delimiter for \"%s\" found\n",
2384 item);
2385 goto out;
2387 parm_opt = atoi(p + 1);
2388 _pam_log_debug(ctx, LOG_INFO,
2389 "PAM config: %s '%d'\n",
2390 item, parm_opt);
2391 return parm_opt;
2395 if (ctx->dict) {
2396 char *key = NULL;
2398 key = talloc_asprintf(ctx, "global:%s", item);
2399 if (!key) {
2400 goto out;
2403 parm_opt = tiniparser_getint(ctx->dict, key, -1);
2404 TALLOC_FREE(key);
2406 _pam_log_debug(ctx, LOG_INFO,
2407 "CONFIG file: %s '%d'\n",
2408 item, parm_opt);
2410 out:
2411 return parm_opt;
2414 static const char *get_krb5_cc_type_from_config(struct pwb_context *ctx)
2416 return get_conf_item_string(ctx, "krb5_ccache_type",
2417 WINBIND_KRB5_CCACHE_TYPE);
2420 static const char *get_member_from_config(struct pwb_context *ctx)
2422 const char *ret = NULL;
2423 ret = get_conf_item_string(ctx, "require_membership_of",
2424 WINBIND_REQUIRED_MEMBERSHIP);
2425 if (ret != NULL) {
2426 return ret;
2428 return get_conf_item_string(ctx, "require-membership-of",
2429 WINBIND_REQUIRED_MEMBERSHIP);
2432 static int get_warn_pwd_expire_from_config(struct pwb_context *ctx)
2434 int ret;
2435 ret = get_config_item_int(ctx, "warn_pwd_expire",
2436 WINBIND_WARN_PWD_EXPIRE);
2437 /* no or broken setting */
2438 if (ret < 0) {
2439 return DEFAULT_DAYS_TO_WARN_BEFORE_PWD_EXPIRES;
2441 return ret;
2445 * Retrieve the winbind separator.
2447 * @param ctx PAM winbind context.
2449 * @return string separator character. NULL on failure.
2452 static char winbind_get_separator(struct pwb_context *ctx)
2454 wbcErr wbc_status;
2455 static struct wbcInterfaceDetails *details = NULL;
2457 wbc_status = wbcCtxInterfaceDetails(ctx->wbc_ctx, &details);
2458 if (!WBC_ERROR_IS_OK(wbc_status)) {
2459 _pam_log(ctx, LOG_ERR,
2460 "Could not retrieve winbind interface details: %s",
2461 wbcErrorString(wbc_status));
2462 return '\0';
2465 if (!details) {
2466 return '\0';
2469 return details->winbind_separator;
2474 * Convert a upn to a name.
2476 * @param ctx PAM winbind context.
2477 * @param upn User UPN to be translated.
2479 * @return converted name. NULL pointer on failure. Caller needs to free.
2482 static char* winbind_upn_to_username(struct pwb_context *ctx,
2483 const char *upn)
2485 char sep;
2486 wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
2487 struct wbcDomainSid sid;
2488 enum wbcSidType type;
2489 char *domain = NULL;
2490 char *name;
2491 char *p;
2492 char *result;
2494 /* This cannot work when the winbind separator = @ */
2496 sep = winbind_get_separator(ctx);
2497 if (!sep || sep == '@') {
2498 return NULL;
2501 name = talloc_strdup(ctx, upn);
2502 if (!name) {
2503 return NULL;
2506 p = strchr(name, '@');
2507 if (p == NULL) {
2508 TALLOC_FREE(name);
2509 return NULL;
2511 *p = '\0';
2512 domain = p + 1;
2514 /* Convert the UPN to a SID */
2516 wbc_status = wbcCtxLookupName(ctx->wbc_ctx, domain, name, &sid, &type);
2517 if (!WBC_ERROR_IS_OK(wbc_status)) {
2518 return NULL;
2521 /* Convert the the SID back to the sAMAccountName */
2523 wbc_status = wbcCtxLookupSid(ctx->wbc_ctx, &sid, &domain, &name, &type);
2524 if (!WBC_ERROR_IS_OK(wbc_status)) {
2525 return NULL;
2528 result = talloc_asprintf(ctx, "%s%c%s", domain, sep, name);
2529 wbcFreeMemory(domain);
2530 wbcFreeMemory(name);
2531 return result;
2534 static int _pam_delete_cred(pam_handle_t *pamh, int flags,
2535 int argc, enum pam_winbind_request_type type,
2536 const char **argv)
2538 int retval = PAM_SUCCESS;
2539 struct pwb_context *ctx = NULL;
2540 struct wbcLogoffUserParams logoff;
2541 struct wbcAuthErrorInfo *error = NULL;
2542 const char *user;
2543 wbcErr wbc_status = WBC_ERR_SUCCESS;
2545 ZERO_STRUCT(logoff);
2547 retval = _pam_winbind_init_context(pamh, flags, argc, argv, type, &ctx);
2548 if (retval != PAM_SUCCESS) {
2549 return retval;
2552 _PAM_LOG_FUNCTION_ENTER("_pam_delete_cred", ctx);
2554 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2556 /* destroy the ccache here */
2558 uint32_t wbc_flags = 0;
2559 const char *ccname = NULL;
2560 struct passwd *pwd = NULL;
2562 retval = pam_get_user(pamh, &user, _("Username: "));
2563 if (retval != PAM_SUCCESS) {
2564 _pam_log(ctx, LOG_ERR,
2565 "could not identify user");
2566 goto out;
2569 if (user == NULL) {
2570 _pam_log(ctx, LOG_ERR,
2571 "username was NULL!");
2572 retval = PAM_USER_UNKNOWN;
2573 goto out;
2576 _pam_log_debug(ctx, LOG_DEBUG,
2577 "username [%s] obtained", user);
2579 ccname = pam_getenv(pamh, "KRB5CCNAME");
2580 if (ccname == NULL) {
2581 _pam_log_debug(ctx, LOG_DEBUG,
2582 "user has no KRB5CCNAME environment");
2585 pwd = getpwnam(user);
2586 if (pwd == NULL) {
2587 retval = PAM_USER_UNKNOWN;
2588 goto out;
2591 wbc_flags = WBFLAG_PAM_KRB5 |
2592 WBFLAG_PAM_CONTACT_TRUSTDOM;
2594 logoff.username = user;
2596 if (ccname) {
2597 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2598 &logoff.blobs,
2599 "ccfilename",
2601 discard_const_p(uint8_t, ccname),
2602 strlen(ccname)+1);
2603 if (!WBC_ERROR_IS_OK(wbc_status)) {
2604 goto out;
2608 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2609 &logoff.blobs,
2610 "flags",
2612 (uint8_t *)&wbc_flags,
2613 sizeof(wbc_flags));
2614 if (!WBC_ERROR_IS_OK(wbc_status)) {
2615 goto out;
2618 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2619 &logoff.blobs,
2620 "user_uid",
2622 (uint8_t *)&pwd->pw_uid,
2623 sizeof(pwd->pw_uid));
2624 if (!WBC_ERROR_IS_OK(wbc_status)) {
2625 goto out;
2628 wbc_status = wbcCtxLogoffUserEx(ctx->wbc_ctx, &logoff, &error);
2629 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2630 user, "wbcLogoffUser");
2631 wbcFreeMemory(logoff.blobs);
2632 logoff.blobs = NULL;
2634 if (!WBC_ERROR_IS_OK(wbc_status)) {
2635 _pam_log(ctx, LOG_INFO,
2636 "failed to logoff user %s: %s\n",
2637 user, wbcErrorString(wbc_status));
2641 out:
2642 if (logoff.blobs) {
2643 wbcFreeMemory(logoff.blobs);
2646 if (!WBC_ERROR_IS_OK(wbc_status)) {
2647 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2648 user, "wbcLogoffUser");
2650 wbcFreeMemory(error);
2653 * Delete the krb5 ccname variable from the PAM environment
2654 * if it was set by winbind.
2656 if ((ctx->ctrl & WINBIND_KRB5_AUTH) && pam_getenv(pamh, "KRB5CCNAME")) {
2657 pam_putenv(pamh, "KRB5CCNAME");
2660 _PAM_LOG_FUNCTION_LEAVE("_pam_delete_cred", ctx, retval);
2662 TALLOC_FREE(ctx);
2664 return retval;
2667 #ifdef SECURITY_OPENPAM_H_INCLUDED
2669 * Logic below is copied from openpam_check_error_code() in
2670 *./contrib/openpam/lib/libpam/openpam_dispatch.c on FreeBSD.
2672 static int openpam_convert_error_code(struct pwb_context *ctx,
2673 enum pam_winbind_request_type req,
2674 int r)
2676 if (r == PAM_SUCCESS ||
2677 r == PAM_SYSTEM_ERR ||
2678 r == PAM_SERVICE_ERR ||
2679 r == PAM_BUF_ERR ||
2680 r == PAM_CONV_ERR ||
2681 r == PAM_PERM_DENIED ||
2682 r == PAM_ABORT) {
2683 return r;
2686 /* specific winbind request types */
2687 switch (req) {
2688 case PAM_WINBIND_AUTHENTICATE:
2689 if (r == PAM_AUTH_ERR ||
2690 r == PAM_CRED_INSUFFICIENT ||
2691 r == PAM_AUTHINFO_UNAVAIL ||
2692 r == PAM_USER_UNKNOWN ||
2693 r == PAM_MAXTRIES) {
2694 return r;
2696 break;
2697 case PAM_WINBIND_SETCRED:
2698 if (r == PAM_CRED_UNAVAIL ||
2699 r == PAM_CRED_EXPIRED ||
2700 r == PAM_USER_UNKNOWN ||
2701 r == PAM_CRED_ERR) {
2702 return r;
2704 break;
2705 case PAM_WINBIND_ACCT_MGMT:
2706 if (r == PAM_USER_UNKNOWN ||
2707 r == PAM_AUTH_ERR ||
2708 r == PAM_NEW_AUTHTOK_REQD ||
2709 r == PAM_ACCT_EXPIRED) {
2710 return r;
2712 break;
2713 case PAM_WINBIND_OPEN_SESSION:
2714 case PAM_WINBIND_CLOSE_SESSION:
2715 if (r == PAM_SESSION_ERR) {
2716 return r;
2718 break;
2719 case PAM_WINBIND_CHAUTHTOK:
2720 if (r == PAM_PERM_DENIED ||
2721 r == PAM_AUTHTOK_ERR ||
2722 r == PAM_AUTHTOK_RECOVERY_ERR ||
2723 r == PAM_AUTHTOK_LOCK_BUSY ||
2724 r == PAM_AUTHTOK_DISABLE_AGING ||
2725 r == PAM_TRY_AGAIN) {
2726 return r;
2728 break;
2729 default:
2730 break;
2732 _pam_log(ctx, LOG_INFO,
2733 "Converting PAM error [%d] to PAM_SERVICE_ERR.\n", r);
2734 return PAM_SERVICE_ERR;
2736 #define pam_error_code(a, b, c) openpam_convert_error_code(a, b, c)
2737 #else
2738 #define pam_error_code(a, b, c) (c)
2739 #endif
2741 PAM_EXTERN
2742 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
2743 int argc, const char **argv)
2745 const char *username;
2746 const char *password;
2747 const char *member = NULL;
2748 const char *cctype = NULL;
2749 int warn_pwd_expire;
2750 int retval = PAM_AUTH_ERR;
2751 char *username_ret = NULL;
2752 char *new_authtok_required = NULL;
2753 char *real_username = NULL;
2754 struct pwb_context *ctx = NULL;
2756 retval = _pam_winbind_init_context(pamh, flags, argc, argv,
2757 PAM_WINBIND_AUTHENTICATE, &ctx);
2758 if (retval != PAM_SUCCESS) {
2759 return retval;
2762 _PAM_LOG_FUNCTION_ENTER("pam_sm_authenticate", ctx);
2764 /* Get the username */
2765 retval = pam_get_user(pamh, &username, NULL);
2766 if ((retval != PAM_SUCCESS) || (!username)) {
2767 _pam_log_debug(ctx, LOG_DEBUG,
2768 "can not get the username");
2769 retval = PAM_SERVICE_ERR;
2770 goto out;
2774 #if defined(AIX)
2775 /* Decode the user name since AIX does not support logn user
2776 names by default. The name is encoded as _#uid. */
2778 if (username[0] == '_') {
2779 uid_t id = atoi(&username[1]);
2780 struct passwd *pw = NULL;
2782 if ((id!=0) && ((pw = getpwuid(id)) != NULL)) {
2783 real_username = strdup(pw->pw_name);
2786 #endif
2788 if (!real_username) {
2789 /* Just making a copy of the username we got from PAM */
2790 if ((real_username = strdup(username)) == NULL) {
2791 _pam_log_debug(ctx, LOG_DEBUG,
2792 "memory allocation failure when copying "
2793 "username");
2794 retval = PAM_SERVICE_ERR;
2795 goto out;
2799 /* Maybe this was a UPN */
2801 if (strchr(real_username, '@') != NULL) {
2802 char *samaccountname = NULL;
2804 samaccountname = winbind_upn_to_username(ctx,
2805 real_username);
2806 if (samaccountname) {
2807 free(real_username);
2808 real_username = strdup(samaccountname);
2812 retval = _winbind_read_password(ctx, ctx->ctrl, NULL,
2813 _("Password: "), NULL,
2814 &password);
2816 if (retval != PAM_SUCCESS) {
2817 _pam_log(ctx, LOG_ERR,
2818 "Could not retrieve user's password");
2819 retval = PAM_AUTHTOK_ERR;
2820 goto out;
2823 /* Let's not give too much away in the log file */
2825 #ifdef DEBUG_PASSWORD
2826 _pam_log_debug(ctx, LOG_INFO,
2827 "Verify user '%s' with password '%s'",
2828 real_username, password);
2829 #else
2830 _pam_log_debug(ctx, LOG_INFO,
2831 "Verify user '%s'", real_username);
2832 #endif
2834 member = get_member_from_config(ctx);
2835 cctype = get_krb5_cc_type_from_config(ctx);
2836 warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2838 /* Now use the username to look up password */
2839 retval = winbind_auth_request(ctx, real_username, password,
2840 member, cctype, warn_pwd_expire,
2841 NULL, NULL, NULL, &username_ret);
2843 if (retval == PAM_NEW_AUTHTOK_REQD ||
2844 retval == PAM_AUTHTOK_EXPIRED) {
2846 char *new_authtok_required_during_auth = NULL;
2848 new_authtok_required = talloc_asprintf(NULL, "%d", retval);
2849 if (!new_authtok_required) {
2850 retval = PAM_BUF_ERR;
2851 goto out;
2854 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2855 new_authtok_required,
2856 _pam_winbind_cleanup_func);
2858 retval = PAM_SUCCESS;
2860 new_authtok_required_during_auth = talloc_asprintf(NULL, "%d", true);
2861 if (!new_authtok_required_during_auth) {
2862 retval = PAM_BUF_ERR;
2863 goto out;
2866 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2867 new_authtok_required_during_auth,
2868 _pam_winbind_cleanup_func);
2870 goto out;
2873 out:
2874 if (username_ret) {
2875 pam_set_item (pamh, PAM_USER, username_ret);
2876 _pam_log_debug(ctx, LOG_INFO,
2877 "Returned user was '%s'", username_ret);
2878 free(username_ret);
2881 if (real_username) {
2882 free(real_username);
2885 if (!new_authtok_required) {
2886 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, NULL, NULL);
2889 if (retval != PAM_SUCCESS) {
2890 _pam_free_data_info3(pamh);
2893 _PAM_LOG_FUNCTION_LEAVE("pam_sm_authenticate", ctx, retval);
2895 TALLOC_FREE(ctx);
2897 return retval;
2900 PAM_EXTERN
2901 int pam_sm_setcred(pam_handle_t *pamh, int flags,
2902 int argc, const char **argv)
2904 int ret = PAM_SYSTEM_ERR;
2905 struct pwb_context *ctx = NULL;
2907 ret = _pam_winbind_init_context(pamh, flags, argc, argv,
2908 PAM_WINBIND_SETCRED, &ctx);
2909 if (ret != PAM_SUCCESS) {
2910 return ret;
2913 _PAM_LOG_FUNCTION_ENTER("pam_sm_setcred", ctx);
2915 switch (flags & ~PAM_SILENT) {
2917 case PAM_DELETE_CRED:
2918 ret = _pam_delete_cred(pamh, flags, argc,
2919 PAM_WINBIND_SETCRED, argv);
2920 break;
2921 case PAM_REFRESH_CRED:
2922 _pam_log_debug(ctx, LOG_WARNING,
2923 "PAM_REFRESH_CRED not implemented");
2924 ret = PAM_SUCCESS;
2925 break;
2926 case PAM_REINITIALIZE_CRED:
2927 _pam_log_debug(ctx, LOG_WARNING,
2928 "PAM_REINITIALIZE_CRED not implemented");
2929 ret = PAM_SUCCESS;
2930 break;
2931 case PAM_ESTABLISH_CRED:
2932 _pam_log_debug(ctx, LOG_WARNING,
2933 "PAM_ESTABLISH_CRED not implemented");
2934 ret = PAM_SUCCESS;
2935 break;
2936 default:
2937 ret = PAM_SYSTEM_ERR;
2938 break;
2941 _PAM_LOG_FUNCTION_LEAVE("pam_sm_setcred", ctx, ret);
2943 TALLOC_FREE(ctx);
2945 return pam_error_code(ctx, PAM_WINBIND_SETCRED, ret);
2949 * Account management. We want to verify that the account exists
2950 * before returning PAM_SUCCESS
2952 PAM_EXTERN
2953 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
2954 int argc, const char **argv)
2956 const char *username;
2957 int ret = PAM_USER_UNKNOWN;
2958 const char *tmp = NULL;
2959 struct pwb_context *ctx = NULL;
2961 ret = _pam_winbind_init_context(pamh, flags, argc, argv,
2962 PAM_WINBIND_ACCT_MGMT, &ctx);
2963 if (ret != PAM_SUCCESS) {
2964 return ret;
2967 _PAM_LOG_FUNCTION_ENTER("pam_sm_acct_mgmt", ctx);
2970 /* Get the username */
2971 ret = pam_get_user(pamh, &username, NULL);
2972 if ((ret != PAM_SUCCESS) || (!username)) {
2973 _pam_log_debug(ctx, LOG_DEBUG,
2974 "can not get the username");
2975 ret = PAM_SERVICE_ERR;
2976 goto out;
2979 /* Verify the username */
2980 ret = valid_user(ctx, username);
2981 switch (ret) {
2982 case -1:
2983 /* some sort of system error. The log was already printed */
2984 ret = PAM_SERVICE_ERR;
2985 goto out;
2986 case 1:
2987 /* the user does not exist */
2988 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
2989 username);
2990 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
2991 ret = PAM_IGNORE;
2992 goto out;
2994 ret = PAM_USER_UNKNOWN;
2995 goto out;
2996 case 0:
2997 pam_get_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2998 (const void **)&tmp);
2999 if (tmp != NULL) {
3000 ret = atoi(tmp);
3001 switch (ret) {
3002 case PAM_AUTHTOK_EXPIRED:
3003 /* Since new token is required in this case */
3004 FALL_THROUGH;
3005 case PAM_NEW_AUTHTOK_REQD:
3006 _pam_log(ctx, LOG_WARNING,
3007 "pam_sm_acct_mgmt success but %s is set",
3008 PAM_WINBIND_NEW_AUTHTOK_REQD);
3009 _pam_log(ctx, LOG_NOTICE,
3010 "user '%s' needs new password",
3011 username);
3012 /* PAM_AUTHTOKEN_REQD does not exist, but is documented in the manpage */
3013 ret = PAM_NEW_AUTHTOK_REQD;
3014 goto out;
3015 default:
3016 _pam_log(ctx, LOG_WARNING,
3017 "pam_sm_acct_mgmt success");
3018 _pam_log(ctx, LOG_NOTICE,
3019 "user '%s' granted access", username);
3020 ret = PAM_SUCCESS;
3021 goto out;
3025 /* Otherwise, the authentication looked good */
3026 _pam_log(ctx, LOG_NOTICE,
3027 "user '%s' granted access", username);
3028 ret = PAM_SUCCESS;
3029 goto out;
3030 default:
3031 /* we don't know anything about this return value */
3032 _pam_log(ctx, LOG_ERR,
3033 "internal module error (ret = %d, user = '%s')",
3034 ret, username);
3035 ret = PAM_SERVICE_ERR;
3036 goto out;
3039 /* should not be reached */
3040 ret = PAM_IGNORE;
3042 out:
3044 _PAM_LOG_FUNCTION_LEAVE("pam_sm_acct_mgmt", ctx, ret);
3046 TALLOC_FREE(ctx);
3048 return pam_error_code(ctx, PAM_WINBIND_ACCT_MGMT, ret);
3051 PAM_EXTERN
3052 int pam_sm_open_session(pam_handle_t *pamh, int flags,
3053 int argc, const char **argv)
3055 int ret = PAM_SUCCESS;
3056 struct pwb_context *ctx = NULL;
3058 ret = _pam_winbind_init_context(pamh, flags, argc, argv,
3059 PAM_WINBIND_OPEN_SESSION, &ctx);
3060 if (ret != PAM_SUCCESS) {
3061 return ret;
3064 _PAM_LOG_FUNCTION_ENTER("pam_sm_open_session", ctx);
3066 if (ctx->ctrl & WINBIND_MKHOMEDIR) {
3067 /* check and create homedir */
3068 ret = _pam_mkhomedir(ctx);
3071 _PAM_LOG_FUNCTION_LEAVE("pam_sm_open_session", ctx, ret);
3073 TALLOC_FREE(ctx);
3075 return pam_error_code(ctx, PAM_WINBIND_OPEN_SESSION, ret);
3078 PAM_EXTERN
3079 int pam_sm_close_session(pam_handle_t *pamh, int flags,
3080 int argc, const char **argv)
3082 int ret = PAM_SUCCESS;
3083 struct pwb_context *ctx = NULL;
3085 ret = _pam_winbind_init_context(pamh, flags, argc, argv,
3086 PAM_WINBIND_CLOSE_SESSION, &ctx);
3087 if (ret != PAM_SUCCESS) {
3088 return ret;
3091 _PAM_LOG_FUNCTION_ENTER("pam_sm_close_session", ctx);
3093 _PAM_LOG_FUNCTION_LEAVE("pam_sm_close_session", ctx, ret);
3095 TALLOC_FREE(ctx);
3097 return pam_error_code(ctx, PAM_WINBIND_CLOSE_SESSION, ret);
3101 * evaluate whether we need to re-authenticate with kerberos after a
3102 * password change
3104 * @param ctx PAM winbind context.
3105 * @param user The username
3107 * @return boolean Returns true if required, false if not.
3110 static bool _pam_require_krb5_auth_after_chauthtok(struct pwb_context *ctx,
3111 const char *user)
3114 /* Make sure that we only do this if a) the chauthtok got initiated
3115 * during a logon attempt (authenticate->acct_mgmt->chauthtok) b) any
3116 * later password change via the "passwd" command if done by the user
3117 * itself
3118 * NB. If we login from gdm or xdm and the password expires,
3119 * we change the password, but there is no memory cache.
3120 * Thus, even for passthrough login, we should do the
3121 * authentication again to update memory cache.
3122 * --- BoYang
3123 * */
3125 const char *new_authtok_reqd_during_auth = NULL;
3126 struct passwd *pwd = NULL;
3128 pam_get_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
3129 (const void **) &new_authtok_reqd_during_auth);
3130 pam_set_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
3131 NULL, NULL);
3133 if (new_authtok_reqd_during_auth) {
3134 return true;
3137 pwd = getpwnam(user);
3138 if (!pwd) {
3139 return false;
3142 if (getuid() == pwd->pw_uid) {
3143 return true;
3146 return false;
3150 PAM_EXTERN
3151 int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
3152 int argc, const char **argv)
3154 unsigned int lctrl;
3155 int ret;
3156 bool cached_login = false;
3158 /* <DO NOT free() THESE> */
3159 const char *user;
3160 const char *pass_old;
3161 const char *pass_new;
3162 /* </DO NOT free() THESE> */
3164 char *Announce;
3166 int retry = 0;
3167 char *username_ret = NULL;
3168 struct wbcAuthErrorInfo *error = NULL;
3169 struct pwb_context *ctx = NULL;
3171 ret = _pam_winbind_init_context(pamh, flags, argc, argv,
3172 PAM_WINBIND_CHAUTHTOK, &ctx);
3173 if (ret != PAM_SUCCESS) {
3174 return ret;
3177 _PAM_LOG_FUNCTION_ENTER("pam_sm_chauthtok", ctx);
3179 cached_login = (ctx->ctrl & WINBIND_CACHED_LOGIN);
3181 /* clearing offline bit for auth */
3182 ctx->ctrl &= ~WINBIND_CACHED_LOGIN;
3185 * First get the name of a user
3187 ret = pam_get_user(pamh, &user, _("Username: "));
3188 if (ret != PAM_SUCCESS) {
3189 _pam_log(ctx, LOG_ERR,
3190 "password - could not identify user");
3191 goto out;
3194 if (user == NULL) {
3195 _pam_log(ctx, LOG_ERR, "username was NULL!");
3196 ret = PAM_USER_UNKNOWN;
3197 goto out;
3200 _pam_log_debug(ctx, LOG_DEBUG, "username [%s] obtained", user);
3202 /* check if this is really a user in winbindd, not only in NSS */
3203 ret = valid_user(ctx, user);
3204 switch (ret) {
3205 case 1:
3206 ret = PAM_USER_UNKNOWN;
3207 goto out;
3208 case -1:
3209 ret = PAM_SYSTEM_ERR;
3210 goto out;
3211 default:
3212 break;
3216 * obtain and verify the current password (OLDAUTHTOK) for
3217 * the user.
3220 if (flags & PAM_PRELIM_CHECK) {
3221 time_t pwdlastset_prelim = 0;
3223 /* instruct user what is happening */
3225 #define greeting _("Changing password for")
3226 Announce = talloc_asprintf(ctx, "%s %s", greeting, user);
3227 if (!Announce) {
3228 _pam_log(ctx, LOG_CRIT,
3229 "password - out of memory");
3230 ret = PAM_BUF_ERR;
3231 goto out;
3233 #undef greeting
3235 lctrl = ctx->ctrl | WINBIND__OLD_PASSWORD;
3236 ret = _winbind_read_password(ctx, lctrl,
3237 Announce,
3238 _("(current) NT password: "),
3239 NULL,
3240 (const char **) &pass_old);
3241 TALLOC_FREE(Announce);
3242 if (ret != PAM_SUCCESS) {
3243 _pam_log(ctx, LOG_NOTICE,
3244 "password - (old) token not obtained");
3245 goto out;
3248 /* verify that this is the password for this user */
3250 ret = winbind_auth_request(ctx, user, pass_old,
3251 NULL, NULL, 0,
3252 &error, NULL,
3253 &pwdlastset_prelim, NULL);
3255 if (ret != PAM_ACCT_EXPIRED &&
3256 ret != PAM_AUTHTOK_EXPIRED &&
3257 ret != PAM_NEW_AUTHTOK_REQD &&
3258 ret != PAM_SUCCESS) {
3259 pass_old = NULL;
3260 goto out;
3263 pam_set_data(pamh, PAM_WINBIND_PWD_LAST_SET,
3264 (void *)pwdlastset_prelim, NULL);
3266 ret = pam_set_item(pamh, PAM_OLDAUTHTOK,
3267 (const void *) pass_old);
3268 pass_old = NULL;
3269 if (ret != PAM_SUCCESS) {
3270 _pam_log(ctx, LOG_CRIT,
3271 "failed to set PAM_OLDAUTHTOK");
3273 } else if (flags & PAM_UPDATE_AUTHTOK) {
3275 time_t pwdlastset_update = 0;
3278 * obtain the proposed password
3282 * get the old token back.
3285 ret = pam_get_item(pamh, PAM_OLDAUTHTOK, (const void **) &pass_old);
3287 if (ret != PAM_SUCCESS) {
3288 _pam_log(ctx, LOG_NOTICE,
3289 "user not authenticated");
3290 goto out;
3293 lctrl = ctx->ctrl & ~WINBIND_TRY_FIRST_PASS_ARG;
3295 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
3296 lctrl |= WINBIND_USE_FIRST_PASS_ARG;
3298 if (on(WINBIND_TRY_AUTHTOK_ARG, lctrl)) {
3299 lctrl |= WINBIND_TRY_FIRST_PASS_ARG;
3301 retry = 0;
3302 ret = PAM_AUTHTOK_ERR;
3303 while ((ret != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
3305 * use_authtok is to force the use of a previously entered
3306 * password -- needed for pluggable password strength checking
3309 ret = _winbind_read_password(ctx, lctrl,
3310 NULL,
3311 _("Enter new NT password: "),
3312 _("Retype new NT password: "),
3313 (const char **)&pass_new);
3315 if (ret != PAM_SUCCESS) {
3316 _pam_log_debug(ctx, LOG_ALERT,
3317 "password - "
3318 "new password not obtained");
3319 pass_old = NULL;/* tidy up */
3320 goto out;
3324 * At this point we know who the user is and what they
3325 * propose as their new password. Verify that the new
3326 * password is acceptable.
3329 if (pass_new[0] == '\0') {/* "\0" password = NULL */
3330 pass_new = NULL;
3335 * By reaching here we have approved the passwords and must now
3336 * rebuild the password database file.
3338 pam_get_data(pamh, PAM_WINBIND_PWD_LAST_SET,
3339 (const void **) &pwdlastset_update);
3342 * if cached creds were enabled, make sure to set the
3343 * WINBIND_CACHED_LOGIN bit here in order to have winbindd
3344 * update the cached creds storage - gd
3346 if (cached_login) {
3347 ctx->ctrl |= WINBIND_CACHED_LOGIN;
3350 ret = winbind_chauthtok_request(ctx, user, pass_old,
3351 pass_new, pwdlastset_update);
3352 if (ret != PAM_SUCCESS) {
3353 pass_old = pass_new = NULL;
3354 goto out;
3357 if (_pam_require_krb5_auth_after_chauthtok(ctx, user)) {
3359 const char *member = NULL;
3360 const char *cctype = NULL;
3361 int warn_pwd_expire;
3362 struct wbcLogonUserInfo *info = NULL;
3364 member = get_member_from_config(ctx);
3365 cctype = get_krb5_cc_type_from_config(ctx);
3366 warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
3368 /* Keep WINBIND_CACHED_LOGIN bit for
3369 * authentication after changing the password.
3370 * This will update the cached credentials in case
3371 * that winbindd_dual_pam_chauthtok() fails
3372 * to update them.
3373 * --- BoYang
3374 * */
3376 ret = winbind_auth_request(ctx, user, pass_new,
3377 member, cctype, 0,
3378 &error, &info,
3379 NULL, &username_ret);
3380 pass_old = pass_new = NULL;
3382 if (ret == PAM_SUCCESS) {
3384 struct wbcAuthUserInfo *user_info = NULL;
3386 if (info && info->info) {
3387 user_info = info->info;
3390 /* warn a user if the password is about to
3391 * expire soon */
3392 _pam_warn_password_expiry(ctx, user_info,
3393 warn_pwd_expire,
3394 NULL, NULL);
3396 /* set some info3 info for other modules in the
3397 * stack */
3398 _pam_set_data_info3(ctx, user_info);
3400 /* put krb5ccname into env */
3401 _pam_setup_krb5_env(ctx, info);
3403 if (username_ret) {
3404 pam_set_item(pamh, PAM_USER,
3405 username_ret);
3406 _pam_log_debug(ctx, LOG_INFO,
3407 "Returned user was '%s'",
3408 username_ret);
3409 free(username_ret);
3414 if (info && info->blobs) {
3415 wbcFreeMemory(info->blobs);
3417 wbcFreeMemory(info);
3419 goto out;
3421 } else {
3422 ret = PAM_SERVICE_ERR;
3425 out:
3427 /* Deal with offline errors. */
3428 int i;
3429 const char *codes[] = {
3430 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
3431 "NT_STATUS_NO_LOGON_SERVERS",
3432 "NT_STATUS_ACCESS_DENIED"
3435 for (i=0; i<ARRAY_SIZE(codes); i++) {
3436 int _ret;
3437 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
3438 break;
3443 wbcFreeMemory(error);
3445 _PAM_LOG_FUNCTION_LEAVE("pam_sm_chauthtok", ctx, ret);
3447 TALLOC_FREE(ctx);
3449 return pam_error_code(ctx, PAM_WINBIND_CHAUTHTOK, ret);
3452 #ifdef PAM_STATIC
3454 /* static module data */
3456 struct pam_module _pam_winbind_modstruct = {
3457 MODULE_NAME,
3458 pam_sm_authenticate,
3459 pam_sm_setcred,
3460 pam_sm_acct_mgmt,
3461 pam_sm_open_session,
3462 pam_sm_close_session,
3463 pam_sm_chauthtok
3466 #endif
3469 * Copyright (c) Andrew Tridgell <tridge@samba.org> 2000
3470 * Copyright (c) Tim Potter <tpot@samba.org> 2000
3471 * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
3472 * Copyright (c) Guenther Deschner <gd@samba.org> 2005-2008
3473 * Copyright (c) Jan Rêkorajski 1999.
3474 * Copyright (c) Andrew G. Morgan 1996-8.
3475 * Copyright (c) Alex O. Yuriev, 1996.
3476 * Copyright (c) Cristian Gafton 1996.
3477 * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
3479 * Redistribution and use in source and binary forms, with or without
3480 * modification, are permitted provided that the following conditions
3481 * are met:
3482 * 1. Redistributions of source code must retain the above copyright
3483 * notice, and the entire permission notice in its entirety,
3484 * including the disclaimer of warranties.
3485 * 2. Redistributions in binary form must reproduce the above copyright
3486 * notice, this list of conditions and the following disclaimer in the
3487 * documentation and/or other materials provided with the distribution.
3488 * 3. The name of the author may not be used to endorse or promote
3489 * products derived from this software without specific prior
3490 * written permission.
3492 * ALTERNATIVELY, this product may be distributed under the terms of
3493 * the GNU Public License, in which case the provisions of the GPL are
3494 * required INSTEAD OF the above restrictions. (This clause is
3495 * necessary due to a potential bad interaction between the GPL and
3496 * the restrictions contained in a BSD-style copyright.)
3498 * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
3499 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
3500 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
3501 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
3502 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
3503 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
3504 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3505 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3506 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
3507 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
3508 * OF THE POSSIBILITY OF SUCH DAMAGE.