pam_winbind: use wbclient equivalents for ACB_PWNOEXP and some NETLOGON flags.
[Samba.git] / source / nsswitch / pam_winbind.c
blob835822a789b7907d37cfaf1de69669d1e136398a
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 static int wbc_error_to_pam_error(wbcErr status)
17 switch (status) {
18 case WBC_ERR_SUCCESS:
19 return PAM_SUCCESS;
20 case WBC_ERR_NOT_IMPLEMENTED:
21 return PAM_SERVICE_ERR;
22 case WBC_ERR_UNKNOWN_FAILURE:
23 break;
24 case WBC_ERR_NO_MEMORY:
25 return PAM_BUF_ERR;
26 case WBC_ERR_INVALID_SID:
27 case WBC_ERR_INVALID_PARAM:
28 break;
29 case WBC_ERR_WINBIND_NOT_AVAILABLE:
30 return PAM_AUTHINFO_UNAVAIL;
31 case WBC_ERR_DOMAIN_NOT_FOUND:
32 return PAM_AUTHINFO_UNAVAIL;
33 case WBC_ERR_INVALID_RESPONSE:
34 return PAM_BUF_ERR;
35 case WBC_ERR_NSS_ERROR:
36 return PAM_USER_UNKNOWN;
37 case WBC_ERR_AUTH_ERROR:
38 return PAM_AUTH_ERR;
39 case WBC_ERR_UNKNOWN_USER:
40 return PAM_USER_UNKNOWN;
41 case WBC_ERR_UNKNOWN_GROUP:
42 return PAM_USER_UNKNOWN;
43 case WBC_ERR_PWD_CHANGE_FAILED:
44 break;
47 /* be paranoid */
48 return PAM_AUTH_ERR;
51 static const char *_pam_error_code_str(int err)
53 switch (err) {
54 case PAM_SUCCESS:
55 return "PAM_SUCCESS";
56 case PAM_OPEN_ERR:
57 return "PAM_OPEN_ERR";
58 case PAM_SYMBOL_ERR:
59 return "PAM_SYMBOL_ERR";
60 case PAM_SERVICE_ERR:
61 return "PAM_SERVICE_ERR";
62 case PAM_SYSTEM_ERR:
63 return "PAM_SYSTEM_ERR";
64 case PAM_BUF_ERR:
65 return "PAM_BUF_ERR";
66 case PAM_PERM_DENIED:
67 return "PAM_PERM_DENIED";
68 case PAM_AUTH_ERR:
69 return "PAM_AUTH_ERR";
70 case PAM_CRED_INSUFFICIENT:
71 return "PAM_CRED_INSUFFICIENT";
72 case PAM_AUTHINFO_UNAVAIL:
73 return "PAM_AUTHINFO_UNAVAIL";
74 case PAM_USER_UNKNOWN:
75 return "PAM_USER_UNKNOWN";
76 case PAM_MAXTRIES:
77 return "PAM_MAXTRIES";
78 case PAM_NEW_AUTHTOK_REQD:
79 return "PAM_NEW_AUTHTOK_REQD";
80 case PAM_ACCT_EXPIRED:
81 return "PAM_ACCT_EXPIRED";
82 case PAM_SESSION_ERR:
83 return "PAM_SESSION_ERR";
84 case PAM_CRED_UNAVAIL:
85 return "PAM_CRED_UNAVAIL";
86 case PAM_CRED_EXPIRED:
87 return "PAM_CRED_EXPIRED";
88 case PAM_CRED_ERR:
89 return "PAM_CRED_ERR";
90 case PAM_NO_MODULE_DATA:
91 return "PAM_NO_MODULE_DATA";
92 case PAM_CONV_ERR:
93 return "PAM_CONV_ERR";
94 case PAM_AUTHTOK_ERR:
95 return "PAM_AUTHTOK_ERR";
96 case PAM_AUTHTOK_RECOVERY_ERR:
97 return "PAM_AUTHTOK_RECOVERY_ERR";
98 case PAM_AUTHTOK_LOCK_BUSY:
99 return "PAM_AUTHTOK_LOCK_BUSY";
100 case PAM_AUTHTOK_DISABLE_AGING:
101 return "PAM_AUTHTOK_DISABLE_AGING";
102 case PAM_TRY_AGAIN:
103 return "PAM_TRY_AGAIN";
104 case PAM_IGNORE:
105 return "PAM_IGNORE";
106 case PAM_ABORT:
107 return "PAM_ABORT";
108 case PAM_AUTHTOK_EXPIRED:
109 return "PAM_AUTHTOK_EXPIRED";
110 #ifdef PAM_MODULE_UNKNOWN
111 case PAM_MODULE_UNKNOWN:
112 return "PAM_MODULE_UNKNOWN";
113 #endif
114 #ifdef PAM_BAD_ITEM
115 case PAM_BAD_ITEM:
116 return "PAM_BAD_ITEM";
117 #endif
118 #ifdef PAM_CONV_AGAIN
119 case PAM_CONV_AGAIN:
120 return "PAM_CONV_AGAIN";
121 #endif
122 #ifdef PAM_INCOMPLETE
123 case PAM_INCOMPLETE:
124 return "PAM_INCOMPLETE";
125 #endif
126 default:
127 return NULL;
131 #define _PAM_LOG_FUNCTION_ENTER(function, ctx) \
132 do { \
133 _pam_log_debug(ctx, LOG_DEBUG, "[pamh: %p] ENTER: " \
134 function " (flags: 0x%04x)", ctx->pamh, ctx->flags); \
135 _pam_log_state(ctx); \
136 } while (0)
138 #define _PAM_LOG_FUNCTION_LEAVE(function, ctx, retval) \
139 do { \
140 _pam_log_debug(ctx, LOG_DEBUG, "[pamh: %p] LEAVE: " \
141 function " returning %d (%s)", ctx->pamh, retval, \
142 _pam_error_code_str(retval)); \
143 _pam_log_state(ctx); \
144 } while (0)
146 /* data tokens */
148 #define MAX_PASSWD_TRIES 3
150 #ifdef HAVE_GETTEXT
151 static char initialized = 0;
153 static inline void textdomain_init(void);
154 static inline void textdomain_init(void)
156 if (!initialized) {
157 bindtextdomain(MODULE_NAME, dyn_LOCALEDIR);
158 initialized = 1;
160 return;
162 #endif
166 * Work around the pam API that has functions with void ** as parameters
167 * These lead to strict aliasing warnings with gcc.
169 static int _pam_get_item(const pam_handle_t *pamh,
170 int item_type,
171 const void *_item)
173 const void **item = (const void **)_item;
174 return pam_get_item(pamh, item_type, item);
176 static int _pam_get_data(const pam_handle_t *pamh,
177 const char *module_data_name,
178 const void *_data)
180 const void **data = (const void **)_data;
181 return pam_get_data(pamh, module_data_name, data);
184 /* some syslogging */
186 #ifdef HAVE_PAM_VSYSLOG
187 static void _pam_log_int(const pam_handle_t *pamh,
188 int err,
189 const char *format,
190 va_list args)
192 pam_vsyslog(pamh, err, format, args);
194 #else
195 static void _pam_log_int(const pam_handle_t *pamh,
196 int err,
197 const char *format,
198 va_list args)
200 char *format2 = NULL;
201 const char *service;
203 _pam_get_item(pamh, PAM_SERVICE, &service);
205 format2 = (char *)malloc(strlen(MODULE_NAME)+strlen(format)+strlen(service)+5);
206 if (format2 == NULL) {
207 /* what else todo ? */
208 vsyslog(err, format, args);
209 return;
212 sprintf(format2, "%s(%s): %s", MODULE_NAME, service, format);
213 vsyslog(err, format2, args);
214 SAFE_FREE(format2);
216 #endif /* HAVE_PAM_VSYSLOG */
218 static bool _pam_log_is_silent(int ctrl)
220 return on(ctrl, WINBIND_SILENT);
223 static void _pam_log(struct pwb_context *r, int err, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
224 static void _pam_log(struct pwb_context *r, int err, const char *format, ...)
226 va_list args;
228 if (_pam_log_is_silent(r->ctrl)) {
229 return;
232 va_start(args, format);
233 _pam_log_int(r->pamh, err, format, args);
234 va_end(args);
236 static void __pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
237 static void __pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
239 va_list args;
241 if (_pam_log_is_silent(ctrl)) {
242 return;
245 va_start(args, format);
246 _pam_log_int(pamh, err, format, args);
247 va_end(args);
250 static bool _pam_log_is_debug_enabled(int ctrl)
252 if (ctrl == -1) {
253 return false;
256 if (_pam_log_is_silent(ctrl)) {
257 return false;
260 if (!(ctrl & WINBIND_DEBUG_ARG)) {
261 return false;
264 return true;
267 static bool _pam_log_is_debug_state_enabled(int ctrl)
269 if (!(ctrl & WINBIND_DEBUG_STATE)) {
270 return false;
273 return _pam_log_is_debug_enabled(ctrl);
276 static void _pam_log_debug(struct pwb_context *r, int err, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
277 static void _pam_log_debug(struct pwb_context *r, int err, const char *format, ...)
279 va_list args;
281 if (!_pam_log_is_debug_enabled(r->ctrl)) {
282 return;
285 va_start(args, format);
286 _pam_log_int(r->pamh, err, format, args);
287 va_end(args);
289 static void __pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
290 static void __pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
292 va_list args;
294 if (!_pam_log_is_debug_enabled(ctrl)) {
295 return;
298 va_start(args, format);
299 _pam_log_int(pamh, err, format, args);
300 va_end(args);
303 static void _pam_log_state_datum(struct pwb_context *ctx,
304 int item_type,
305 const char *key,
306 int is_string)
308 const void *data = NULL;
309 if (item_type != 0) {
310 pam_get_item(ctx->pamh, item_type, &data);
311 } else {
312 pam_get_data(ctx->pamh, key, &data);
314 if (data != NULL) {
315 const char *type = (item_type != 0) ? "ITEM" : "DATA";
316 if (is_string != 0) {
317 _pam_log_debug(ctx, LOG_DEBUG,
318 "[pamh: %p] STATE: %s(%s) = \"%s\" (%p)",
319 ctx->pamh, type, key, (const char *)data,
320 data);
321 } else {
322 _pam_log_debug(ctx, LOG_DEBUG,
323 "[pamh: %p] STATE: %s(%s) = %p",
324 ctx->pamh, type, key, data);
329 #define _PAM_LOG_STATE_DATA_POINTER(ctx, module_data_name) \
330 _pam_log_state_datum(ctx, 0, module_data_name, 0)
332 #define _PAM_LOG_STATE_DATA_STRING(ctx, module_data_name) \
333 _pam_log_state_datum(ctx, 0, module_data_name, 1)
335 #define _PAM_LOG_STATE_ITEM_POINTER(ctx, item_type) \
336 _pam_log_state_datum(ctx, item_type, #item_type, 0)
338 #define _PAM_LOG_STATE_ITEM_STRING(ctx, item_type) \
339 _pam_log_state_datum(ctx, item_type, #item_type, 1)
341 #ifdef DEBUG_PASSWORD
342 #define _LOG_PASSWORD_AS_STRING 1
343 #else
344 #define _LOG_PASSWORD_AS_STRING 0
345 #endif
347 #define _PAM_LOG_STATE_ITEM_PASSWORD(ctx, item_type) \
348 _pam_log_state_datum(ctx, item_type, #item_type, \
349 _LOG_PASSWORD_AS_STRING)
351 static void _pam_log_state(struct pwb_context *ctx)
353 if (!_pam_log_is_debug_state_enabled(ctx->ctrl)) {
354 return;
357 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_SERVICE);
358 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_USER);
359 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_TTY);
360 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_RHOST);
361 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_RUSER);
362 _PAM_LOG_STATE_ITEM_PASSWORD(ctx, PAM_OLDAUTHTOK);
363 _PAM_LOG_STATE_ITEM_PASSWORD(ctx, PAM_AUTHTOK);
364 _PAM_LOG_STATE_ITEM_STRING(ctx, PAM_USER_PROMPT);
365 _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_CONV);
366 #ifdef PAM_FAIL_DELAY
367 _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_FAIL_DELAY);
368 #endif
369 #ifdef PAM_REPOSITORY
370 _PAM_LOG_STATE_ITEM_POINTER(ctx, PAM_REPOSITORY);
371 #endif
373 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_HOMEDIR);
374 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_LOGONSCRIPT);
375 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_LOGONSERVER);
376 _PAM_LOG_STATE_DATA_STRING(ctx, PAM_WINBIND_PROFILEPATH);
377 _PAM_LOG_STATE_DATA_STRING(ctx,
378 PAM_WINBIND_NEW_AUTHTOK_REQD);
379 /* Use atoi to get PAM result code */
380 _PAM_LOG_STATE_DATA_STRING(ctx,
381 PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH);
382 _PAM_LOG_STATE_DATA_POINTER(ctx, PAM_WINBIND_PWD_LAST_SET);
385 static int _pam_parse(const pam_handle_t *pamh,
386 int flags,
387 int argc,
388 const char **argv,
389 dictionary **result_d)
391 int ctrl = 0;
392 const char *config_file = NULL;
393 int i;
394 const char **v;
395 dictionary *d = NULL;
397 if (flags & PAM_SILENT) {
398 ctrl |= WINBIND_SILENT;
401 for (i=argc,v=argv; i-- > 0; ++v) {
402 if (!strncasecmp(*v, "config", strlen("config"))) {
403 ctrl |= WINBIND_CONFIG_FILE;
404 config_file = v[i];
405 break;
409 if (config_file == NULL) {
410 config_file = PAM_WINBIND_CONFIG_FILE;
413 d = iniparser_load(config_file);
414 if (d == NULL) {
415 goto config_from_pam;
418 if (iniparser_getboolean(d, "global:debug", false)) {
419 ctrl |= WINBIND_DEBUG_ARG;
422 if (iniparser_getboolean(d, "global:debug_state", false)) {
423 ctrl |= WINBIND_DEBUG_STATE;
426 if (iniparser_getboolean(d, "global:cached_login", false)) {
427 ctrl |= WINBIND_CACHED_LOGIN;
430 if (iniparser_getboolean(d, "global:krb5_auth", false)) {
431 ctrl |= WINBIND_KRB5_AUTH;
434 if (iniparser_getboolean(d, "global:silent", false)) {
435 ctrl |= WINBIND_SILENT;
438 if (iniparser_getstr(d, "global:krb5_ccache_type") != NULL) {
439 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
442 if ((iniparser_getstr(d, "global:require-membership-of") != NULL) ||
443 (iniparser_getstr(d, "global:require_membership_of") != NULL)) {
444 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
447 if (iniparser_getboolean(d, "global:try_first_pass", false)) {
448 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
451 if (iniparser_getint(d, "global:warn_pwd_expire", 0)) {
452 ctrl |= WINBIND_WARN_PWD_EXPIRE;
455 config_from_pam:
456 /* step through arguments */
457 for (i=argc,v=argv; i-- > 0; ++v) {
459 /* generic options */
460 if (!strcmp(*v,"debug"))
461 ctrl |= WINBIND_DEBUG_ARG;
462 else if (!strcasecmp(*v, "debug_state"))
463 ctrl |= WINBIND_DEBUG_STATE;
464 else if (!strcasecmp(*v, "silent"))
465 ctrl |= WINBIND_SILENT;
466 else if (!strcasecmp(*v, "use_authtok"))
467 ctrl |= WINBIND_USE_AUTHTOK_ARG;
468 else if (!strcasecmp(*v, "use_first_pass"))
469 ctrl |= WINBIND_USE_FIRST_PASS_ARG;
470 else if (!strcasecmp(*v, "try_first_pass"))
471 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
472 else if (!strcasecmp(*v, "unknown_ok"))
473 ctrl |= WINBIND_UNKNOWN_OK_ARG;
474 else if (!strncasecmp(*v, "require_membership_of",
475 strlen("require_membership_of")))
476 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
477 else if (!strncasecmp(*v, "require-membership-of",
478 strlen("require-membership-of")))
479 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
480 else if (!strcasecmp(*v, "krb5_auth"))
481 ctrl |= WINBIND_KRB5_AUTH;
482 else if (!strncasecmp(*v, "krb5_ccache_type",
483 strlen("krb5_ccache_type")))
484 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
485 else if (!strcasecmp(*v, "cached_login"))
486 ctrl |= WINBIND_CACHED_LOGIN;
487 else {
488 __pam_log(pamh, ctrl, LOG_ERR,
489 "pam_parse: unknown option: %s", *v);
490 return -1;
495 if (result_d) {
496 *result_d = d;
497 } else {
498 if (d) {
499 iniparser_freedict(d);
503 return ctrl;
506 static int _pam_winbind_free_context(struct pwb_context *ctx)
508 if (!ctx) {
509 return 0;
512 if (ctx->dict) {
513 iniparser_freedict(ctx->dict);
516 return 0;
519 static int _pam_winbind_init_context(pam_handle_t *pamh,
520 int flags,
521 int argc,
522 const char **argv,
523 struct pwb_context **ctx_p)
525 struct pwb_context *r = NULL;
527 #ifdef HAVE_GETTEXT
528 textdomain_init();
529 #endif
531 r = TALLOC_ZERO_P(NULL, struct pwb_context);
532 if (!r) {
533 return PAM_BUF_ERR;
536 talloc_set_destructor(r, _pam_winbind_free_context);
538 r->pamh = pamh;
539 r->flags = flags;
540 r->argc = argc;
541 r->argv = argv;
542 r->ctrl = _pam_parse(pamh, flags, argc, argv, &r->dict);
543 if (r->ctrl == -1) {
544 TALLOC_FREE(r);
545 return PAM_SYSTEM_ERR;
548 *ctx_p = r;
550 return PAM_SUCCESS;
553 static void _pam_winbind_cleanup_func(pam_handle_t *pamh,
554 void *data,
555 int error_status)
557 int ctrl = _pam_parse(pamh, 0, 0, NULL, NULL);
558 if (_pam_log_is_debug_state_enabled(ctrl)) {
559 __pam_log_debug(pamh, ctrl, LOG_DEBUG,
560 "[pamh: %p] CLEAN: cleaning up PAM data %p "
561 "(error_status = %d)", pamh, data,
562 error_status);
564 TALLOC_FREE(data);
568 static const struct ntstatus_errors {
569 const char *ntstatus_string;
570 const char *error_string;
571 } ntstatus_errors[] = {
572 {"NT_STATUS_OK",
573 N_("Success")},
574 {"NT_STATUS_BACKUP_CONTROLLER",
575 N_("No primary Domain Controler available")},
576 {"NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
577 N_("No domain controllers found")},
578 {"NT_STATUS_NO_LOGON_SERVERS",
579 N_("No logon servers")},
580 {"NT_STATUS_PWD_TOO_SHORT",
581 N_("Password too short")},
582 {"NT_STATUS_PWD_TOO_RECENT",
583 N_("The password of this user is too recent to change")},
584 {"NT_STATUS_PWD_HISTORY_CONFLICT",
585 N_("Password is already in password history")},
586 {"NT_STATUS_PASSWORD_EXPIRED",
587 N_("Your password has expired")},
588 {"NT_STATUS_PASSWORD_MUST_CHANGE",
589 N_("You need to change your password now")},
590 {"NT_STATUS_INVALID_WORKSTATION",
591 N_("You are not allowed to logon from this workstation")},
592 {"NT_STATUS_INVALID_LOGON_HOURS",
593 N_("You are not allowed to logon at this time")},
594 {"NT_STATUS_ACCOUNT_EXPIRED",
595 N_("Your account has expired. "
596 "Please contact your System administrator")}, /* SCNR */
597 {"NT_STATUS_ACCOUNT_DISABLED",
598 N_("Your account is disabled. "
599 "Please contact your System administrator")}, /* SCNR */
600 {"NT_STATUS_ACCOUNT_LOCKED_OUT",
601 N_("Your account has been locked. "
602 "Please contact your System administrator")}, /* SCNR */
603 {"NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
604 N_("Invalid Trust Account")},
605 {"NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
606 N_("Invalid Trust Account")},
607 {"NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
608 N_("Invalid Trust Account")},
609 {"NT_STATUS_ACCESS_DENIED",
610 N_("Access is denied")},
611 {NULL, NULL}
614 static const char *_get_ntstatus_error_string(const char *nt_status_string)
616 int i;
617 for (i=0; ntstatus_errors[i].ntstatus_string != NULL; i++) {
618 if (!strcasecmp(ntstatus_errors[i].ntstatus_string,
619 nt_status_string)) {
620 return _(ntstatus_errors[i].error_string);
623 return NULL;
626 /* --- authentication management functions --- */
628 /* Attempt a conversation */
630 static int converse(const pam_handle_t *pamh,
631 int nargs,
632 struct pam_message **message,
633 struct pam_response **response)
635 int retval;
636 struct pam_conv *conv;
638 retval = _pam_get_item(pamh, PAM_CONV, &conv);
639 if (retval == PAM_SUCCESS) {
640 retval = conv->conv(nargs,
641 (const struct pam_message **)message,
642 response, conv->appdata_ptr);
645 return retval; /* propagate error status */
649 static int _make_remark(struct pwb_context *ctx,
650 int type,
651 const char *text)
653 int retval = PAM_SUCCESS;
655 struct pam_message *pmsg[1], msg[1];
656 struct pam_response *resp;
658 if (ctx->flags & WINBIND_SILENT) {
659 return PAM_SUCCESS;
662 pmsg[0] = &msg[0];
663 msg[0].msg = discard_const_p(char, text);
664 msg[0].msg_style = type;
666 resp = NULL;
667 retval = converse(ctx->pamh, 1, pmsg, &resp);
669 if (resp) {
670 _pam_drop_reply(resp, 1);
672 return retval;
675 static int _make_remark_v(struct pwb_context *ctx,
676 int type,
677 const char *format,
678 va_list args)
680 char *var;
681 int ret;
683 ret = vasprintf(&var, format, args);
684 if (ret < 0) {
685 _pam_log(ctx, LOG_ERR, "memory allocation failure");
686 return ret;
689 ret = _make_remark(ctx, type, var);
690 SAFE_FREE(var);
691 return ret;
694 static int _make_remark_format(struct pwb_context *ctx, int type, const char *format, ...) PRINTF_ATTRIBUTE(3,4);
695 static int _make_remark_format(struct pwb_context *ctx, int type, const char *format, ...)
697 int ret;
698 va_list args;
700 va_start(args, format);
701 ret = _make_remark_v(ctx, type, format, args);
702 va_end(args);
703 return ret;
706 static int pam_winbind_request(struct pwb_context *ctx,
707 enum winbindd_cmd req_type,
708 struct winbindd_request *request,
709 struct winbindd_response *response)
711 /* Fill in request and send down pipe */
712 winbindd_init_request(request, req_type);
714 if (winbind_write_sock(request, sizeof(*request), 0, 0) == -1) {
715 _pam_log(ctx, LOG_ERR,
716 "pam_winbind_request: write to socket failed!");
717 winbind_close_sock();
718 return PAM_SERVICE_ERR;
721 /* Wait for reply */
722 if (winbindd_read_reply(response) == -1) {
723 _pam_log(ctx, LOG_ERR,
724 "pam_winbind_request: read from socket failed!");
725 winbind_close_sock();
726 return PAM_SERVICE_ERR;
729 /* We are done with the socket - close it and avoid mischeif */
730 winbind_close_sock();
732 /* Copy reply data from socket */
733 if (response->result == WINBINDD_OK) {
734 return PAM_SUCCESS;
737 if (response->data.auth.pam_error != PAM_SUCCESS) {
738 _pam_log(ctx, LOG_ERR,
739 "request failed: %s, "
740 "PAM error was %s (%d), NT error was %s",
741 response->data.auth.error_string,
742 pam_strerror(ctx->pamh, response->data.auth.pam_error),
743 response->data.auth.pam_error,
744 response->data.auth.nt_status_string);
745 return response->data.auth.pam_error;
748 _pam_log(ctx, LOG_ERR, "request failed, but PAM error 0!");
750 return PAM_SERVICE_ERR;
753 static int pam_winbind_request_log(struct pwb_context *ctx,
754 int retval,
755 const char *user)
757 switch (retval) {
758 case PAM_AUTH_ERR:
759 /* incorrect password */
760 _pam_log(ctx, LOG_WARNING, "user '%s' denied access "
761 "(incorrect password or invalid membership)", user);
762 return retval;
763 case PAM_ACCT_EXPIRED:
764 /* account expired */
765 _pam_log(ctx, LOG_WARNING, "user '%s' account expired",
766 user);
767 return retval;
768 case PAM_AUTHTOK_EXPIRED:
769 /* password expired */
770 _pam_log(ctx, LOG_WARNING, "user '%s' password expired",
771 user);
772 return retval;
773 case PAM_NEW_AUTHTOK_REQD:
774 /* new password required */
775 _pam_log(ctx, LOG_WARNING, "user '%s' new password "
776 "required", user);
777 return retval;
778 case PAM_USER_UNKNOWN:
779 /* the user does not exist */
780 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
781 user);
782 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
783 return PAM_IGNORE;
785 return retval;
786 case PAM_SUCCESS:
787 /* Otherwise, the authentication looked good */
788 #if 0
789 switch (req_type) {
790 case WINBINDD_PAM_AUTH:
791 _pam_log(ctx, LOG_NOTICE,
792 "user '%s' granted access", user);
793 break;
794 default:
795 _pam_log(ctx, LOG_NOTICE,
796 "user '%s' OK", user);
797 break;
799 #endif
800 return retval;
801 default:
802 /* we don't know anything about this return value */
803 _pam_log(ctx, LOG_ERR,
804 "internal module error (retval = %d, user = '%s')",
805 retval, user);
806 return retval;
810 static int wbc_auth_error_to_pam_error(struct pwb_context *ctx,
811 struct wbcAuthErrorInfo *e,
812 wbcErr status,
813 const char *username,
814 const char *fn)
816 int ret = PAM_AUTH_ERR;
818 if (WBC_ERROR_IS_OK(status)) {
819 _pam_log_debug(ctx, LOG_DEBUG, "request %s succeeded",
820 fn);
821 ret = PAM_SUCCESS;
822 return pam_winbind_request_log(ctx, ret, username);
825 if (e) {
826 if (e->pam_error != PAM_SUCCESS) {
827 _pam_log(ctx, LOG_ERR,
828 "request %s failed: %s, "
829 "PAM error: %s (%d), NTSTATUS: %s, "
830 "Error message was: %s",
832 wbcErrorString(status),
833 _pam_error_code_str(e->pam_error),
834 e->pam_error,
835 e->nt_string,
836 e->display_string);
837 ret = e->pam_error;
838 return pam_winbind_request_log(ctx, ret, username);
841 _pam_log(ctx, LOG_ERR, "request %s failed, but PAM error 0!", fn);
843 ret = PAM_SERVICE_ERR;
844 return pam_winbind_request_log(ctx, ret, username);
847 ret = wbc_error_to_pam_error(status);
848 return pam_winbind_request_log(ctx, ret, username);
853 * send a password expiry message if required
855 * @param ctx PAM winbind context.
856 * @param next_change expected (calculated) next expiry date.
857 * @param already_expired pointer to a boolean to indicate if the password is
858 * already expired.
860 * @return boolean Returns true if message has been sent, false if not.
863 static bool _pam_send_password_expiry_message(struct pwb_context *ctx,
864 time_t next_change,
865 time_t now,
866 int warn_pwd_expire,
867 bool *already_expired)
869 int days = 0;
870 struct tm tm_now, tm_next_change;
872 if (already_expired) {
873 *already_expired = false;
876 if (next_change <= now) {
877 PAM_WB_REMARK_DIRECT(ctx, "NT_STATUS_PASSWORD_EXPIRED");
878 if (already_expired) {
879 *already_expired = true;
881 return true;
884 if ((next_change < 0) ||
885 (next_change > now + warn_pwd_expire * SECONDS_PER_DAY)) {
886 return false;
889 if ((localtime_r(&now, &tm_now) == NULL) ||
890 (localtime_r(&next_change, &tm_next_change) == NULL)) {
891 return false;
894 days = (tm_next_change.tm_yday+tm_next_change.tm_year*365) -
895 (tm_now.tm_yday+tm_now.tm_year*365);
897 if (days == 0) {
898 _make_remark(ctx, PAM_TEXT_INFO,
899 _("Your password expires today"));
900 return true;
903 if (days > 0 && days < warn_pwd_expire) {
904 _make_remark_format(ctx, PAM_TEXT_INFO,
905 _("Your password will expire in %d %s"),
906 days, (days > 1) ? _("days"):_("day"));
907 return true;
910 return false;
914 * Send a warning if the password expires in the near future
916 * @param ctx PAM winbind context.
917 * @param response The full authentication response structure.
918 * @param already_expired boolean, is the pwd already expired?
920 * @return void.
923 static void _pam_warn_password_expiry(struct pwb_context *ctx,
924 const struct wbcAuthUserInfo *info,
925 const struct wbcUserPasswordPolicyInfo *policy,
926 int warn_pwd_expire,
927 bool *already_expired)
929 time_t now = time(NULL);
930 time_t next_change = 0;
932 if (!info || !policy) {
933 return;
936 if (already_expired) {
937 *already_expired = false;
940 /* accounts with WBC_ACB_PWNOEXP set never receive a warning */
941 if (info->acct_flags & WBC_ACB_PWNOEXP) {
942 return;
945 /* no point in sending a warning if this is a grace logon */
946 if (PAM_WB_GRACE_LOGON(info->user_flags)) {
947 return;
950 /* check if the info3 must change timestamp has been set */
951 next_change = info->pass_must_change_time;
953 if (_pam_send_password_expiry_message(ctx, next_change, now,
954 warn_pwd_expire,
955 already_expired)) {
956 return;
959 /* now check for the global password policy */
960 /* good catch from Ralf Haferkamp: an expiry of "never" is translated
961 * to -1 */
962 if (policy->expire <= 0) {
963 return;
966 next_change = info->pass_last_set_time + policy->expire;
968 if (_pam_send_password_expiry_message(ctx, next_change, now,
969 warn_pwd_expire,
970 already_expired)) {
971 return;
974 /* no warning sent */
977 #define IS_SID_STRING(name) (strncmp("S-", name, 2) == 0)
980 * Append a string, making sure not to overflow and to always return a
981 * NULL-terminated string.
983 * @param dest Destination string buffer (must already be NULL-terminated).
984 * @param src Source string buffer.
985 * @param dest_buffer_size Size of dest buffer in bytes.
987 * @return false if dest buffer is not big enough (no bytes copied), true on
988 * success.
991 static bool safe_append_string(char *dest,
992 const char *src,
993 int dest_buffer_size)
995 int dest_length = strlen(dest);
996 int src_length = strlen(src);
998 if (dest_length + src_length + 1 > dest_buffer_size) {
999 return false;
1002 memcpy(dest + dest_length, src, src_length + 1);
1003 return true;
1007 * Convert a names into a SID string, appending it to a buffer.
1009 * @param ctx PAM winbind context.
1010 * @param user User in PAM request.
1011 * @param name Name to convert.
1012 * @param sid_list_buffer Where to append the string sid.
1013 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1015 * @return false on failure, true on success.
1017 static bool winbind_name_to_sid_string(struct pwb_context *ctx,
1018 const char *user,
1019 const char *name,
1020 char *sid_list_buffer,
1021 int sid_list_buffer_size)
1023 const char* sid_string;
1025 /* lookup name? */
1026 if (IS_SID_STRING(name)) {
1027 sid_string = name;
1028 } else {
1029 wbcErr wbc_status;
1030 struct wbcDomainSid sid;
1031 enum wbcSidType type;
1032 char *sid_str;
1034 _pam_log_debug(ctx, LOG_DEBUG,
1035 "no sid given, looking up: %s\n", name);
1037 wbc_status = wbcLookupName("", name, &sid, &type);
1038 if (!WBC_ERROR_IS_OK(wbc_status)) {
1039 _pam_log(ctx, LOG_INFO,
1040 "could not lookup name: %s\n", name);
1041 return false;
1044 wbc_status = wbcSidToString(&sid, &sid_str);
1045 if (!WBC_ERROR_IS_OK(wbc_status)) {
1046 return false;
1049 wbcFreeMemory(sid_str);
1050 sid_string = sid_str;
1053 if (!safe_append_string(sid_list_buffer, sid_string,
1054 sid_list_buffer_size)) {
1055 return false;
1058 return true;
1062 * Convert a list of names into a list of sids.
1064 * @param ctx PAM winbind context.
1065 * @param user User in PAM request.
1066 * @param name_list List of names or string sids, separated by commas.
1067 * @param sid_list_buffer Where to put the list of string sids.
1068 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1070 * @return false on failure, true on success.
1072 static bool winbind_name_list_to_sid_string_list(struct pwb_context *ctx,
1073 const char *user,
1074 const char *name_list,
1075 char *sid_list_buffer,
1076 int sid_list_buffer_size)
1078 bool result = false;
1079 char *current_name = NULL;
1080 const char *search_location;
1081 const char *comma;
1083 if (sid_list_buffer_size > 0) {
1084 sid_list_buffer[0] = 0;
1087 search_location = name_list;
1088 while ((comma = strstr(search_location, ",")) != NULL) {
1089 current_name = strndup(search_location,
1090 comma - search_location);
1091 if (NULL == current_name) {
1092 goto out;
1095 if (!winbind_name_to_sid_string(ctx, user,
1096 current_name,
1097 sid_list_buffer,
1098 sid_list_buffer_size)) {
1099 goto out;
1102 SAFE_FREE(current_name);
1104 if (!safe_append_string(sid_list_buffer, ",",
1105 sid_list_buffer_size)) {
1106 goto out;
1109 search_location = comma + 1;
1112 if (!winbind_name_to_sid_string(ctx, user, search_location,
1113 sid_list_buffer,
1114 sid_list_buffer_size)) {
1115 goto out;
1118 result = true;
1120 out:
1121 SAFE_FREE(current_name);
1122 return result;
1126 * put krb5ccname variable into environment
1128 * @param ctx PAM winbind context.
1129 * @param krb5ccname env variable retrieved from winbindd.
1131 * @return void.
1134 static void _pam_setup_krb5_env(struct pwb_context *ctx,
1135 struct wbcLogonUserInfo *info)
1137 char var[PATH_MAX];
1138 int ret;
1139 uint32_t i;
1140 const char *krb5ccname = NULL;
1142 if (off(ctx->ctrl, WINBIND_KRB5_AUTH)) {
1143 return;
1146 if (!info) {
1147 return;
1150 for (i=0; i < info->num_blobs; i++) {
1151 if (strcasecmp(info->blobs[i].name, "krb5ccname") == 0) {
1152 krb5ccname = (const char *)info->blobs[i].blob.data;
1153 break;
1157 if (!krb5ccname || (strlen(krb5ccname) == 0)) {
1158 return;
1161 _pam_log_debug(ctx, LOG_DEBUG,
1162 "request returned KRB5CCNAME: %s", krb5ccname);
1164 if (snprintf(var, sizeof(var), "KRB5CCNAME=%s", krb5ccname) == -1) {
1165 return;
1168 ret = pam_putenv(ctx->pamh, var);
1169 if (ret) {
1170 _pam_log(ctx, LOG_ERR,
1171 "failed to set KRB5CCNAME to %s: %s",
1172 var, pam_strerror(ctx->pamh, ret));
1177 * Copy unix username if available (further processed in PAM).
1179 * @param ctx PAM winbind context
1180 * @param user_ret A pointer that holds a pointer to a string
1181 * @param unix_username A username
1183 * @return void.
1186 static void _pam_setup_unix_username(struct pwb_context *ctx,
1187 char **user_ret,
1188 struct wbcLogonUserInfo *info)
1190 const char *unix_username = NULL;
1191 uint32_t i;
1193 if (!user_ret || !info) {
1194 return;
1197 for (i=0; i < info->num_blobs; i++) {
1198 if (strcasecmp(info->blobs[i].name, "unix_username") == 0) {
1199 unix_username = (const char *)info->blobs[i].blob.data;
1200 break;
1204 if (!unix_username || !unix_username[0]) {
1205 return;
1208 *user_ret = strdup(unix_username);
1212 * Set string into the PAM stack.
1214 * @param ctx PAM winbind context.
1215 * @param data_name Key name for pam_set_data.
1216 * @param value String value.
1218 * @return void.
1221 static void _pam_set_data_string(struct pwb_context *ctx,
1222 const char *data_name,
1223 const char *value)
1225 int ret;
1227 if (!data_name || !value || (strlen(data_name) == 0) ||
1228 (strlen(value) == 0)) {
1229 return;
1232 ret = pam_set_data(ctx->pamh, data_name, talloc_strdup(NULL, value),
1233 _pam_winbind_cleanup_func);
1234 if (ret) {
1235 _pam_log_debug(ctx, LOG_DEBUG,
1236 "Could not set data %s: %s\n",
1237 data_name, pam_strerror(ctx->pamh, ret));
1242 * Set info3 strings into the PAM stack.
1244 * @param ctx PAM winbind context.
1245 * @param data_name Key name for pam_set_data.
1246 * @param value String value.
1248 * @return void.
1251 static void _pam_set_data_info3(struct pwb_context *ctx,
1252 const struct wbcAuthUserInfo *info)
1254 _pam_set_data_string(ctx, PAM_WINBIND_HOMEDIR,
1255 info->home_directory);
1256 _pam_set_data_string(ctx, PAM_WINBIND_LOGONSCRIPT,
1257 info->logon_script);
1258 _pam_set_data_string(ctx, PAM_WINBIND_LOGONSERVER,
1259 info->logon_server);
1260 _pam_set_data_string(ctx, PAM_WINBIND_PROFILEPATH,
1261 info->profile_path);
1265 * Free info3 strings in the PAM stack.
1267 * @param pamh PAM handle
1269 * @return void.
1272 static void _pam_free_data_info3(pam_handle_t *pamh)
1274 pam_set_data(pamh, PAM_WINBIND_HOMEDIR, NULL, NULL);
1275 pam_set_data(pamh, PAM_WINBIND_LOGONSCRIPT, NULL, NULL);
1276 pam_set_data(pamh, PAM_WINBIND_LOGONSERVER, NULL, NULL);
1277 pam_set_data(pamh, PAM_WINBIND_PROFILEPATH, NULL, NULL);
1281 * Send PAM_ERROR_MSG for cached or grace logons.
1283 * @param ctx PAM winbind context.
1284 * @param username User in PAM request.
1285 * @param info3_user_flgs Info3 flags containing logon type bits.
1287 * @return void.
1290 static void _pam_warn_logon_type(struct pwb_context *ctx,
1291 const char *username,
1292 uint32_t info3_user_flgs)
1294 /* inform about logon type */
1295 if (PAM_WB_GRACE_LOGON(info3_user_flgs)) {
1297 _make_remark(ctx, PAM_ERROR_MSG,
1298 _("Grace login. "
1299 "Please change your password as soon you're "
1300 "online again"));
1301 _pam_log_debug(ctx, LOG_DEBUG,
1302 "User %s logged on using grace logon\n",
1303 username);
1305 } else if (PAM_WB_CACHED_LOGON(info3_user_flgs)) {
1307 _make_remark(ctx, PAM_ERROR_MSG,
1308 _("Domain Controller unreachable, "
1309 "using cached credentials instead. "
1310 "Network resources may be unavailable"));
1311 _pam_log_debug(ctx, LOG_DEBUG,
1312 "User %s logged on using cached credentials\n",
1313 username);
1318 * Send PAM_ERROR_MSG for krb5 errors.
1320 * @param ctx PAM winbind context.
1321 * @param username User in PAM request.
1322 * @param info3_user_flgs Info3 flags containing logon type bits.
1324 * @return void.
1327 static void _pam_warn_krb5_failure(struct pwb_context *ctx,
1328 const char *username,
1329 uint32_t info3_user_flgs)
1331 if (PAM_WB_KRB5_CLOCK_SKEW(info3_user_flgs)) {
1332 _make_remark(ctx, PAM_ERROR_MSG,
1333 _("Failed to establish your Kerberos Ticket cache "
1334 "due time differences\n"
1335 "with the domain controller. "
1336 "Please verify the system time.\n"));
1337 _pam_log_debug(ctx, LOG_DEBUG,
1338 "User %s: Clock skew when getting Krb5 TGT\n",
1339 username);
1343 static bool _pam_check_remark_auth_err(struct pwb_context *ctx,
1344 const struct wbcAuthErrorInfo *e,
1345 const char *nt_status_string,
1346 int *pam_error)
1348 const char *ntstatus = NULL;
1349 const char *error_string = NULL;
1351 if (!e || !pam_error) {
1352 return false;
1355 ntstatus = e->nt_string;
1356 if (!ntstatus) {
1357 return false;
1360 if (strcasecmp(ntstatus, nt_status_string) == 0) {
1362 error_string = _get_ntstatus_error_string(nt_status_string);
1363 if (error_string) {
1364 _make_remark(ctx, PAM_ERROR_MSG, error_string);
1365 *pam_error = e->pam_error;
1366 return true;
1369 if (e->display_string) {
1370 _make_remark(ctx, PAM_ERROR_MSG, e->display_string);
1371 *pam_error = e->pam_error;
1372 return true;
1375 _make_remark(ctx, PAM_ERROR_MSG, nt_status_string);
1376 *pam_error = e->pam_error;
1378 return true;
1381 return false;
1385 * Compose Password Restriction String for a PAM_ERROR_MSG conversation.
1387 * @param i The wbcUserPasswordPolicyInfo struct.
1389 * @return string (caller needs to talloc_free).
1392 static char *_pam_compose_pwd_restriction_string(struct pwb_context *ctx,
1393 struct wbcUserPasswordPolicyInfo *i)
1395 char *str = NULL;
1397 if (!i) {
1398 goto failed;
1401 str = talloc_asprintf(ctx, _("Your password "));
1402 if (!str) {
1403 goto failed;
1406 if (i->min_length_password > 0) {
1407 str = talloc_asprintf_append(str,
1408 _("must be at least %d characters; "),
1409 i->min_length_password);
1410 if (!str) {
1411 goto failed;
1415 if (i->password_history > 0) {
1416 str = talloc_asprintf_append(str,
1417 _("cannot repeat any of your previous %d "
1418 "passwords; "),
1419 i->password_history);
1420 if (!str) {
1421 goto failed;
1425 if (i->password_properties & WBC_DOMAIN_PASSWORD_COMPLEX) {
1426 str = talloc_asprintf_append(str,
1427 _("must contain capitals, numerals "
1428 "or punctuation; "
1429 "and cannot contain your account "
1430 "or full name; "));
1431 if (!str) {
1432 goto failed;
1436 str = talloc_asprintf_append(str,
1437 _("Please type a different password. "
1438 "Type a password which meets these requirements in "
1439 "both text boxes."));
1440 if (!str) {
1441 goto failed;
1444 return str;
1446 failed:
1447 TALLOC_FREE(str);
1448 return NULL;
1451 /* talk to winbindd */
1452 static int winbind_auth_request(struct pwb_context *ctx,
1453 const char *user,
1454 const char *pass,
1455 const char *member,
1456 const char *cctype,
1457 const int warn_pwd_expire,
1458 struct wbcAuthErrorInfo **p_error,
1459 struct wbcLogonUserInfo **p_info,
1460 struct wbcUserPasswordPolicyInfo **p_policy,
1461 time_t *pwd_last_set,
1462 char **user_ret)
1464 wbcErr wbc_status;
1466 struct wbcLogonUserParams logon;
1467 char membership_of[1024];
1468 uid_t user_uid = -1;
1469 uint32_t flags = WBFLAG_PAM_INFO3_TEXT |
1470 WBFLAG_PAM_GET_PWD_POLICY;
1472 struct wbcLogonUserInfo *info = NULL;
1473 struct wbcAuthUserInfo *user_info = NULL;
1474 struct wbcAuthErrorInfo *error = NULL;
1475 struct wbcUserPasswordPolicyInfo *policy = NULL;
1477 int ret = PAM_AUTH_ERR;
1478 int i;
1479 const char *codes[] = {
1480 "NT_STATUS_PASSWORD_EXPIRED",
1481 "NT_STATUS_PASSWORD_MUST_CHANGE",
1482 "NT_STATUS_INVALID_WORKSTATION",
1483 "NT_STATUS_INVALID_LOGON_HOURS",
1484 "NT_STATUS_ACCOUNT_EXPIRED",
1485 "NT_STATUS_ACCOUNT_DISABLED",
1486 "NT_STATUS_ACCOUNT_LOCKED_OUT",
1487 "NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT",
1488 "NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT",
1489 "NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT",
1490 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1491 "NT_STATUS_NO_LOGON_SERVERS",
1492 "NT_STATUS_WRONG_PASSWORD",
1493 "NT_STATUS_ACCESS_DENIED"
1496 if (pwd_last_set) {
1497 *pwd_last_set = 0;
1500 /* Krb5 auth always has to go against the KDC of the user's realm */
1502 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1503 flags |= WBFLAG_PAM_CONTACT_TRUSTDOM;
1506 if (ctx->ctrl & (WINBIND_KRB5_AUTH|WINBIND_CACHED_LOGIN)) {
1507 struct passwd *pwd = NULL;
1509 pwd = getpwnam(user);
1510 if (pwd == NULL) {
1511 return PAM_USER_UNKNOWN;
1513 user_uid = pwd->pw_uid;
1516 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1518 _pam_log_debug(ctx, LOG_DEBUG,
1519 "enabling krb5 login flag\n");
1521 flags |= WBFLAG_PAM_KRB5 |
1522 WBFLAG_PAM_FALLBACK_AFTER_KRB5;
1525 if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1526 _pam_log_debug(ctx, LOG_DEBUG,
1527 "enabling cached login flag\n");
1528 flags |= WBFLAG_PAM_CACHED_LOGIN;
1531 if (user_ret) {
1532 *user_ret = NULL;
1533 flags |= WBFLAG_PAM_UNIX_NAME;
1536 if (cctype != NULL) {
1537 _pam_log_debug(ctx, LOG_DEBUG,
1538 "enabling request for a %s krb5 ccache\n",
1539 cctype);
1542 if (member != NULL) {
1544 ZERO_STRUCT(membership_of);
1546 if (!winbind_name_list_to_sid_string_list(ctx, user, member,
1547 membership_of,
1548 sizeof(membership_of))) {
1549 _pam_log_debug(ctx, LOG_ERR,
1550 "failed to serialize membership of sid "
1551 "\"%s\"\n", member);
1552 return PAM_AUTH_ERR;
1556 ZERO_STRUCT(logon);
1558 logon.username = user;
1559 logon.password = pass;
1561 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1562 &logon.blobs,
1563 "krb5_cc_type",
1565 (uint8_t *)cctype,
1566 strlen(cctype)+1);
1567 if (!WBC_ERROR_IS_OK(wbc_status)) {
1568 goto done;
1571 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1572 &logon.blobs,
1573 "flags",
1575 (uint8_t *)&flags,
1576 sizeof(flags));
1577 if (!WBC_ERROR_IS_OK(wbc_status)) {
1578 goto done;
1581 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1582 &logon.blobs,
1583 "user_uid",
1585 (uint8_t *)&user_uid,
1586 sizeof(user_uid));
1587 if (!WBC_ERROR_IS_OK(wbc_status)) {
1588 goto done;
1591 wbc_status = wbcAddNamedBlob(&logon.num_blobs,
1592 &logon.blobs,
1593 "membership_of",
1595 (uint8_t *)membership_of,
1596 sizeof(membership_of));
1597 if (!WBC_ERROR_IS_OK(wbc_status)) {
1598 goto done;
1601 wbc_status = wbcLogonUser(&logon, &info, &error, &policy);
1602 ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1603 user, "wbcLogonUser");
1604 wbcFreeMemory(logon.blobs);
1605 logon.blobs = NULL;
1607 if (info && info->info) {
1608 user_info = info->info;
1611 if (pwd_last_set && user_info) {
1612 *pwd_last_set = user_info->pass_last_set_time;
1615 if (p_info && info) {
1616 *p_info = info;
1619 if (p_policy && policy) {
1620 *p_policy = policy;
1623 if (p_error && error) {
1624 /* We want to process the error in the caller. */
1625 *p_error = error;
1626 return ret;
1629 for (i=0; i<ARRAY_SIZE(codes); i++) {
1630 int _ret = ret;
1631 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1632 ret = _ret;
1633 goto done;
1637 if ((ret == PAM_SUCCESS) && user_info && policy && info) {
1639 bool already_expired = false;
1641 /* warn a user if the password is about to expire soon */
1642 _pam_warn_password_expiry(ctx, user_info, policy,
1643 warn_pwd_expire,
1644 &already_expired);
1646 if (already_expired == true) {
1648 SMB_TIME_T last_set = user_info->pass_last_set_time;
1650 _pam_log_debug(ctx, LOG_DEBUG,
1651 "Password has expired "
1652 "(Password was last set: %lld, "
1653 "the policy says it should expire here "
1654 "%lld (now it's: %lu))\n",
1655 (long long int)last_set,
1656 (long long int)last_set +
1657 policy->expire,
1658 time(NULL));
1660 return PAM_AUTHTOK_EXPIRED;
1663 /* inform about logon type */
1664 _pam_warn_logon_type(ctx, user, user_info->user_flags);
1666 /* inform about krb5 failures */
1667 _pam_warn_krb5_failure(ctx, user, user_info->user_flags);
1669 /* set some info3 info for other modules in the stack */
1670 _pam_set_data_info3(ctx, user_info);
1672 /* put krb5ccname into env */
1673 _pam_setup_krb5_env(ctx, info);
1675 /* If winbindd returned a username, return the pointer to it
1676 * here. */
1677 _pam_setup_unix_username(ctx, user_ret, info);
1680 done:
1681 if (logon.blobs) {
1682 wbcFreeMemory(logon.blobs);
1684 if (info && info->blobs) {
1685 wbcFreeMemory(info->blobs);
1687 if (error && !p_error) {
1688 wbcFreeMemory(error);
1690 if (info && !p_info) {
1691 wbcFreeMemory(info);
1693 if (policy && !p_policy) {
1694 wbcFreeMemory(policy);
1697 return ret;
1700 /* talk to winbindd */
1701 static int winbind_chauthtok_request(struct pwb_context *ctx,
1702 const char *user,
1703 const char *oldpass,
1704 const char *newpass,
1705 time_t pwd_last_set)
1707 wbcErr wbc_status;
1708 struct wbcChangePasswordParams params;
1709 struct wbcAuthErrorInfo *error = NULL;
1710 struct wbcUserPasswordPolicyInfo *policy = NULL;
1711 enum wbcPasswordChangeRejectReason reject_reason = -1;
1712 uint32_t flags = 0;
1714 int i;
1715 const char *codes[] = {
1716 "NT_STATUS_BACKUP_CONTROLLER",
1717 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1718 "NT_STATUS_NO_LOGON_SERVERS",
1719 "NT_STATUS_ACCESS_DENIED",
1720 "NT_STATUS_PWD_TOO_SHORT", /* TODO: tell the min pwd length ? */
1721 "NT_STATUS_PWD_TOO_RECENT", /* TODO: tell the minage ? */
1722 "NT_STATUS_PWD_HISTORY_CONFLICT" /* TODO: tell the history length ? */
1724 int ret = PAM_AUTH_ERR;
1726 ZERO_STRUCT(params);
1728 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1729 flags |= WBFLAG_PAM_KRB5 |
1730 WBFLAG_PAM_CONTACT_TRUSTDOM;
1733 if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1734 flags |= WBFLAG_PAM_CACHED_LOGIN;
1737 params.account_name = user;
1738 params.level = WBC_AUTH_USER_LEVEL_PLAIN;
1739 params.old_password.plaintext = oldpass;
1740 params.new_password.plaintext = newpass;
1741 params.flags = flags;
1743 wbc_status = wbcChangeUserPasswordEx(&params, &error, &reject_reason, &policy);
1744 ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1745 user, "wbcChangeUserPasswordEx");
1747 if (WBC_ERROR_IS_OK(wbc_status)) {
1748 _pam_log(ctx, LOG_NOTICE,
1749 "user '%s' password changed", user);
1750 return PAM_SUCCESS;
1753 if (!error) {
1754 wbcFreeMemory(policy);
1755 return ret;
1758 for (i=0; i<ARRAY_SIZE(codes); i++) {
1759 int _ret = ret;
1760 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1761 ret = _ret;
1762 goto done;
1766 if (!strcasecmp(error->nt_string,
1767 "NT_STATUS_PASSWORD_RESTRICTION")) {
1769 char *pwd_restriction_string = NULL;
1770 SMB_TIME_T min_pwd_age = 0;
1772 if (policy) {
1773 min_pwd_age = policy->min_passwordage;
1776 /* FIXME: avoid to send multiple PAM messages after another */
1777 switch (reject_reason) {
1778 case -1:
1779 break;
1780 case WBC_PWD_CHANGE_REJECT_OTHER:
1781 if ((min_pwd_age > 0) &&
1782 (pwd_last_set + min_pwd_age > time(NULL))) {
1783 PAM_WB_REMARK_DIRECT(ctx,
1784 "NT_STATUS_PWD_TOO_RECENT");
1786 break;
1787 case WBC_PWD_CHANGE_REJECT_TOO_SHORT:
1788 PAM_WB_REMARK_DIRECT(ctx,
1789 "NT_STATUS_PWD_TOO_SHORT");
1790 break;
1791 case WBC_PWD_CHANGE_REJECT_IN_HISTORY:
1792 PAM_WB_REMARK_DIRECT(ctx,
1793 "NT_STATUS_PWD_HISTORY_CONFLICT");
1794 break;
1795 case WBC_PWD_CHANGE_REJECT_COMPLEXITY:
1796 _make_remark(ctx, PAM_ERROR_MSG,
1797 _("Password does not meet "
1798 "complexity requirements"));
1799 break;
1800 default:
1801 _pam_log_debug(ctx, LOG_DEBUG,
1802 "unknown password change "
1803 "reject reason: %d",
1804 reject_reason);
1805 break;
1808 pwd_restriction_string =
1809 _pam_compose_pwd_restriction_string(ctx, policy);
1810 if (pwd_restriction_string) {
1811 _make_remark(ctx, PAM_ERROR_MSG,
1812 pwd_restriction_string);
1813 TALLOC_FREE(pwd_restriction_string);
1816 done:
1817 wbcFreeMemory(error);
1818 wbcFreeMemory(policy);
1820 return ret;
1824 * Checks if a user has an account
1826 * return values:
1827 * 1 = User not found
1828 * 0 = OK
1829 * -1 = System error
1831 static int valid_user(struct pwb_context *ctx,
1832 const char *user)
1834 /* check not only if the user is available over NSS calls, also make
1835 * sure it's really a winbind user, this is important when stacking PAM
1836 * modules in the 'account' or 'password' facility. */
1838 wbcErr wbc_status;
1839 struct passwd *pwd = NULL;
1840 struct passwd *wb_pwd = NULL;
1842 pwd = getpwnam(user);
1843 if (pwd == NULL) {
1844 return 1;
1847 wbc_status = wbcGetpwnam(user, &wb_pwd);
1848 wbcFreeMemory(wb_pwd);
1849 if (!WBC_ERROR_IS_OK(wbc_status)) {
1850 _pam_log(ctx, LOG_DEBUG, "valid_user: wbcGetpwnam gave %s\n",
1851 wbcErrorString(wbc_status));
1854 switch (wbc_status) {
1855 case WBC_ERR_UNKNOWN_USER:
1856 return 1;
1857 case WBC_ERR_SUCCESS:
1858 return 0;
1859 default:
1860 break;
1862 return -1;
1865 static char *_pam_delete(register char *xx)
1867 _pam_overwrite(xx);
1868 _pam_drop(xx);
1869 return NULL;
1873 * obtain a password from the user
1876 static int _winbind_read_password(struct pwb_context *ctx,
1877 unsigned int ctrl,
1878 const char *comment,
1879 const char *prompt1,
1880 const char *prompt2,
1881 const char **pass)
1883 int authtok_flag;
1884 int retval;
1885 const char *item;
1886 char *token;
1888 _pam_log(ctx, LOG_DEBUG, "getting password (0x%08x)", ctrl);
1891 * make sure nothing inappropriate gets returned
1894 *pass = token = NULL;
1897 * which authentication token are we getting?
1900 if (on(WINBIND__OLD_PASSWORD, ctrl)) {
1901 authtok_flag = PAM_OLDAUTHTOK;
1902 } else {
1903 authtok_flag = PAM_AUTHTOK;
1907 * should we obtain the password from a PAM item ?
1910 if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) ||
1911 on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
1912 retval = _pam_get_item(ctx->pamh, authtok_flag, &item);
1913 if (retval != PAM_SUCCESS) {
1914 /* very strange. */
1915 _pam_log(ctx, LOG_ALERT,
1916 "pam_get_item returned error "
1917 "to unix-read-password");
1918 return retval;
1919 } else if (item != NULL) { /* we have a password! */
1920 *pass = item;
1921 item = NULL;
1922 _pam_log(ctx, LOG_DEBUG,
1923 "pam_get_item returned a password");
1924 return PAM_SUCCESS;
1925 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
1926 return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
1927 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
1928 && off(WINBIND__OLD_PASSWORD, ctrl)) {
1929 return PAM_AUTHTOK_RECOVER_ERR;
1933 * getting here implies we will have to get the password from the
1934 * user directly.
1938 struct pam_message msg[3], *pmsg[3];
1939 struct pam_response *resp;
1940 int i, replies;
1942 /* prepare to converse */
1944 if (comment != NULL && off(ctrl, WINBIND_SILENT)) {
1945 pmsg[0] = &msg[0];
1946 msg[0].msg_style = PAM_TEXT_INFO;
1947 msg[0].msg = discard_const_p(char, comment);
1948 i = 1;
1949 } else {
1950 i = 0;
1953 pmsg[i] = &msg[i];
1954 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
1955 msg[i++].msg = discard_const_p(char, prompt1);
1956 replies = 1;
1958 if (prompt2 != NULL) {
1959 pmsg[i] = &msg[i];
1960 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
1961 msg[i++].msg = discard_const_p(char, prompt2);
1962 ++replies;
1964 /* so call the conversation expecting i responses */
1965 resp = NULL;
1966 retval = converse(ctx->pamh, i, pmsg, &resp);
1967 if (resp == NULL) {
1968 if (retval == PAM_SUCCESS) {
1969 retval = PAM_AUTHTOK_RECOVER_ERR;
1971 goto done;
1973 if (retval != PAM_SUCCESS) {
1974 _pam_drop_reply(resp, i);
1975 goto done;
1978 /* interpret the response */
1980 token = x_strdup(resp[i - replies].resp);
1981 if (!token) {
1982 _pam_log(ctx, LOG_NOTICE,
1983 "could not recover "
1984 "authentication token");
1985 retval = PAM_AUTHTOK_RECOVER_ERR;
1986 goto done;
1989 if (replies == 2) {
1990 /* verify that password entered correctly */
1991 if (!resp[i - 1].resp ||
1992 strcmp(token, resp[i - 1].resp)) {
1993 _pam_delete(token); /* mistyped */
1994 retval = PAM_AUTHTOK_RECOVER_ERR;
1995 _make_remark(ctx, PAM_ERROR_MSG,
1996 MISTYPED_PASS);
2001 * tidy up the conversation (resp_retcode) is ignored
2002 * -- what is it for anyway? AGM
2004 _pam_drop_reply(resp, i);
2007 done:
2008 if (retval != PAM_SUCCESS) {
2009 _pam_log_debug(ctx, LOG_DEBUG,
2010 "unable to obtain a password");
2011 return retval;
2013 /* 'token' is the entered password */
2015 /* we store this password as an item */
2017 retval = pam_set_item(ctx->pamh, authtok_flag, token);
2018 _pam_delete(token); /* clean it up */
2019 if (retval != PAM_SUCCESS ||
2020 (retval = _pam_get_item(ctx->pamh, authtok_flag, &item)) != PAM_SUCCESS) {
2022 _pam_log(ctx, LOG_CRIT, "error manipulating password");
2023 return retval;
2027 *pass = item;
2028 item = NULL; /* break link to password */
2030 return PAM_SUCCESS;
2033 static const char *get_conf_item_string(struct pwb_context *ctx,
2034 const char *item,
2035 int config_flag)
2037 int i = 0;
2038 const char *parm_opt = NULL;
2040 if (!(ctx->ctrl & config_flag)) {
2041 goto out;
2044 /* let the pam opt take precedence over the pam_winbind.conf option */
2045 for (i=0; i<ctx->argc; i++) {
2047 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2048 char *p;
2050 if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2051 _pam_log(ctx, LOG_INFO,
2052 "no \"=\" delimiter for \"%s\" found\n",
2053 item);
2054 goto out;
2056 _pam_log_debug(ctx, LOG_INFO,
2057 "PAM config: %s '%s'\n", item, p+1);
2058 return p + 1;
2062 if (ctx->dict) {
2063 char *key = NULL;
2065 key = talloc_asprintf(ctx, "global:%s", item);
2066 if (!key) {
2067 goto out;
2070 parm_opt = iniparser_getstr(ctx->dict, key);
2071 TALLOC_FREE(key);
2073 _pam_log_debug(ctx, LOG_INFO, "CONFIG file: %s '%s'\n",
2074 item, parm_opt);
2076 out:
2077 return parm_opt;
2080 static int get_config_item_int(struct pwb_context *ctx,
2081 const char *item,
2082 int config_flag)
2084 int i, parm_opt = -1;
2086 if (!(ctx->ctrl & config_flag)) {
2087 goto out;
2090 /* let the pam opt take precedence over the pam_winbind.conf option */
2091 for (i = 0; i < ctx->argc; i++) {
2093 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
2094 char *p;
2096 if ((p = strchr(ctx->argv[i], '=')) == NULL) {
2097 _pam_log(ctx, LOG_INFO,
2098 "no \"=\" delimiter for \"%s\" found\n",
2099 item);
2100 goto out;
2102 parm_opt = atoi(p + 1);
2103 _pam_log_debug(ctx, LOG_INFO,
2104 "PAM config: %s '%d'\n",
2105 item, parm_opt);
2106 return parm_opt;
2110 if (ctx->dict) {
2111 char *key = NULL;
2113 key = talloc_asprintf(ctx, "global:%s", item);
2114 if (!key) {
2115 goto out;
2118 parm_opt = iniparser_getint(ctx->dict, key, -1);
2119 TALLOC_FREE(key);
2121 _pam_log_debug(ctx, LOG_INFO,
2122 "CONFIG file: %s '%d'\n",
2123 item, parm_opt);
2125 out:
2126 return parm_opt;
2129 static const char *get_krb5_cc_type_from_config(struct pwb_context *ctx)
2131 return get_conf_item_string(ctx, "krb5_ccache_type",
2132 WINBIND_KRB5_CCACHE_TYPE);
2135 static const char *get_member_from_config(struct pwb_context *ctx)
2137 const char *ret = NULL;
2138 ret = get_conf_item_string(ctx, "require_membership_of",
2139 WINBIND_REQUIRED_MEMBERSHIP);
2140 if (ret) {
2141 return ret;
2143 return get_conf_item_string(ctx, "require-membership-of",
2144 WINBIND_REQUIRED_MEMBERSHIP);
2147 static int get_warn_pwd_expire_from_config(struct pwb_context *ctx)
2149 int ret;
2150 ret = get_config_item_int(ctx, "warn_pwd_expire",
2151 WINBIND_WARN_PWD_EXPIRE);
2152 /* no or broken setting */
2153 if (ret <= 0) {
2154 return DEFAULT_DAYS_TO_WARN_BEFORE_PWD_EXPIRES;
2156 return ret;
2160 * Retrieve the winbind separator.
2162 * @param ctx PAM winbind context.
2164 * @return string separator character. NULL on failure.
2167 static char winbind_get_separator(struct pwb_context *ctx)
2169 wbcErr wbc_status;
2170 static struct wbcInterfaceDetails *details = NULL;
2172 wbc_status = wbcInterfaceDetails(&details);
2173 if (!WBC_ERROR_IS_OK(wbc_status)) {
2174 _pam_log(ctx, LOG_ERR,
2175 "Could not retrieve winbind interface details: %s",
2176 wbcErrorString(wbc_status));
2177 return '\0';
2180 if (!details) {
2181 return '\0';
2184 return details->winbind_separator;
2189 * Convert a upn to a name.
2191 * @param ctx PAM winbind context.
2192 * @param upn USer UPN to be trabslated.
2194 * @return converted name. NULL pointer on failure. Caller needs to free.
2197 static char* winbind_upn_to_username(struct pwb_context *ctx,
2198 const char *upn)
2200 char sep;
2201 wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
2202 struct wbcDomainSid sid;
2203 enum wbcSidType type;
2204 char *domain;
2205 char *name;
2207 /* This cannot work when the winbind separator = @ */
2209 sep = winbind_get_separator(ctx);
2210 if (!sep || sep == '@') {
2211 return NULL;
2214 /* Convert the UPN to a SID */
2216 wbc_status = wbcLookupName("", upn, &sid, &type);
2217 if (!WBC_ERROR_IS_OK(wbc_status)) {
2218 return NULL;
2221 /* Convert the the SID back to the sAMAccountName */
2223 wbc_status = wbcLookupSid(&sid, &domain, &name, &type);
2224 if (!WBC_ERROR_IS_OK(wbc_status)) {
2225 return NULL;
2228 return talloc_asprintf(ctx, "%s\\%s", domain, name);
2231 PAM_EXTERN
2232 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
2233 int argc, const char **argv)
2235 const char *username;
2236 const char *password;
2237 const char *member = NULL;
2238 const char *cctype = NULL;
2239 int warn_pwd_expire;
2240 int retval = PAM_AUTH_ERR;
2241 char *username_ret = NULL;
2242 char *new_authtok_required = NULL;
2243 char *real_username = NULL;
2244 struct pwb_context *ctx = NULL;
2246 retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2247 if (retval) {
2248 goto out;
2251 _PAM_LOG_FUNCTION_ENTER("pam_sm_authenticate", ctx);
2253 /* Get the username */
2254 retval = pam_get_user(pamh, &username, NULL);
2255 if ((retval != PAM_SUCCESS) || (!username)) {
2256 _pam_log_debug(ctx, LOG_DEBUG,
2257 "can not get the username");
2258 retval = PAM_SERVICE_ERR;
2259 goto out;
2263 #if defined(AIX)
2264 /* Decode the user name since AIX does not support logn user
2265 names by default. The name is encoded as _#uid. */
2267 if (username[0] == '_') {
2268 uid_t id = atoi(&username[1]);
2269 struct passwd *pw = NULL;
2271 if ((id!=0) && ((pw = getpwuid(id)) != NULL)) {
2272 real_username = strdup(pw->pw_name);
2275 #endif
2277 if (!real_username) {
2278 /* Just making a copy of the username we got from PAM */
2279 if ((real_username = strdup(username)) == NULL) {
2280 _pam_log_debug(ctx, LOG_DEBUG,
2281 "memory allocation failure when copying "
2282 "username");
2283 retval = PAM_SERVICE_ERR;
2284 goto out;
2288 /* Maybe this was a UPN */
2290 if (strchr(real_username, '@') != NULL) {
2291 char *samaccountname = NULL;
2293 samaccountname = winbind_upn_to_username(ctx,
2294 real_username);
2295 if (samaccountname) {
2296 free(real_username);
2297 real_username = strdup(samaccountname);
2301 retval = _winbind_read_password(ctx, ctx->ctrl, NULL,
2302 _("Password: "), NULL,
2303 &password);
2305 if (retval != PAM_SUCCESS) {
2306 _pam_log(ctx, LOG_ERR,
2307 "Could not retrieve user's password");
2308 retval = PAM_AUTHTOK_ERR;
2309 goto out;
2312 /* Let's not give too much away in the log file */
2314 #ifdef DEBUG_PASSWORD
2315 _pam_log_debug(ctx, LOG_INFO,
2316 "Verify user '%s' with password '%s'",
2317 real_username, password);
2318 #else
2319 _pam_log_debug(ctx, LOG_INFO,
2320 "Verify user '%s'", real_username);
2321 #endif
2323 member = get_member_from_config(ctx);
2324 cctype = get_krb5_cc_type_from_config(ctx);
2325 warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2327 /* Now use the username to look up password */
2328 retval = winbind_auth_request(ctx, real_username, password,
2329 member, cctype, warn_pwd_expire,
2330 NULL, NULL, NULL,
2331 NULL, &username_ret);
2333 if (retval == PAM_NEW_AUTHTOK_REQD ||
2334 retval == PAM_AUTHTOK_EXPIRED) {
2336 char *new_authtok_required_during_auth = NULL;
2338 new_authtok_required = talloc_asprintf(NULL, "%d", retval);
2339 if (!new_authtok_required) {
2340 retval = PAM_BUF_ERR;
2341 goto out;
2344 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2345 new_authtok_required,
2346 _pam_winbind_cleanup_func);
2348 retval = PAM_SUCCESS;
2350 new_authtok_required_during_auth = talloc_asprintf(NULL, "%d", true);
2351 if (!new_authtok_required_during_auth) {
2352 retval = PAM_BUF_ERR;
2353 goto out;
2356 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2357 new_authtok_required_during_auth,
2358 _pam_winbind_cleanup_func);
2360 goto out;
2363 out:
2364 if (username_ret) {
2365 pam_set_item (pamh, PAM_USER, username_ret);
2366 _pam_log_debug(ctx, LOG_INFO,
2367 "Returned user was '%s'", username_ret);
2368 free(username_ret);
2371 if (real_username) {
2372 free(real_username);
2375 if (!new_authtok_required) {
2376 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, NULL, NULL);
2379 if (retval != PAM_SUCCESS) {
2380 _pam_free_data_info3(pamh);
2383 _PAM_LOG_FUNCTION_LEAVE("pam_sm_authenticate", ctx, retval);
2385 TALLOC_FREE(ctx);
2387 return retval;
2390 PAM_EXTERN
2391 int pam_sm_setcred(pam_handle_t *pamh, int flags,
2392 int argc, const char **argv)
2394 int ret = PAM_SYSTEM_ERR;
2395 struct pwb_context *ctx = NULL;
2397 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2398 if (ret) {
2399 goto out;
2402 _PAM_LOG_FUNCTION_ENTER("pam_sm_setcred", ctx);
2404 switch (flags & ~PAM_SILENT) {
2406 case PAM_DELETE_CRED:
2407 ret = pam_sm_close_session(pamh, flags, argc, argv);
2408 break;
2409 case PAM_REFRESH_CRED:
2410 _pam_log_debug(ctx, LOG_WARNING,
2411 "PAM_REFRESH_CRED not implemented");
2412 ret = PAM_SUCCESS;
2413 break;
2414 case PAM_REINITIALIZE_CRED:
2415 _pam_log_debug(ctx, LOG_WARNING,
2416 "PAM_REINITIALIZE_CRED not implemented");
2417 ret = PAM_SUCCESS;
2418 break;
2419 case PAM_ESTABLISH_CRED:
2420 _pam_log_debug(ctx, LOG_WARNING,
2421 "PAM_ESTABLISH_CRED not implemented");
2422 ret = PAM_SUCCESS;
2423 break;
2424 default:
2425 ret = PAM_SYSTEM_ERR;
2426 break;
2429 out:
2431 _PAM_LOG_FUNCTION_LEAVE("pam_sm_setcred", ctx, ret);
2433 TALLOC_FREE(ctx);
2435 return ret;
2439 * Account management. We want to verify that the account exists
2440 * before returning PAM_SUCCESS
2442 PAM_EXTERN
2443 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
2444 int argc, const char **argv)
2446 const char *username;
2447 int ret = PAM_USER_UNKNOWN;
2448 void *tmp = NULL;
2449 struct pwb_context *ctx = NULL;
2451 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2452 if (ret) {
2453 goto out;
2456 _PAM_LOG_FUNCTION_ENTER("pam_sm_acct_mgmt", ctx);
2459 /* Get the username */
2460 ret = pam_get_user(pamh, &username, NULL);
2461 if ((ret != PAM_SUCCESS) || (!username)) {
2462 _pam_log_debug(ctx, LOG_DEBUG,
2463 "can not get the username");
2464 ret = PAM_SERVICE_ERR;
2465 goto out;
2468 /* Verify the username */
2469 ret = valid_user(ctx, username);
2470 switch (ret) {
2471 case -1:
2472 /* some sort of system error. The log was already printed */
2473 ret = PAM_SERVICE_ERR;
2474 goto out;
2475 case 1:
2476 /* the user does not exist */
2477 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
2478 username);
2479 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
2480 ret = PAM_IGNORE;
2481 goto out;
2483 ret = PAM_USER_UNKNOWN;
2484 goto out;
2485 case 0:
2486 pam_get_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2487 (const void **)&tmp);
2488 if (tmp != NULL) {
2489 ret = atoi((const char *)tmp);
2490 switch (ret) {
2491 case PAM_AUTHTOK_EXPIRED:
2492 /* fall through, since new token is required in this case */
2493 case PAM_NEW_AUTHTOK_REQD:
2494 _pam_log(ctx, LOG_WARNING,
2495 "pam_sm_acct_mgmt success but %s is set",
2496 PAM_WINBIND_NEW_AUTHTOK_REQD);
2497 _pam_log(ctx, LOG_NOTICE,
2498 "user '%s' needs new password",
2499 username);
2500 /* PAM_AUTHTOKEN_REQD does not exist, but is documented in the manpage */
2501 ret = PAM_NEW_AUTHTOK_REQD;
2502 goto out;
2503 default:
2504 _pam_log(ctx, LOG_WARNING,
2505 "pam_sm_acct_mgmt success");
2506 _pam_log(ctx, LOG_NOTICE,
2507 "user '%s' granted access", username);
2508 ret = PAM_SUCCESS;
2509 goto out;
2513 /* Otherwise, the authentication looked good */
2514 _pam_log(ctx, LOG_NOTICE,
2515 "user '%s' granted access", username);
2516 ret = PAM_SUCCESS;
2517 goto out;
2518 default:
2519 /* we don't know anything about this return value */
2520 _pam_log(ctx, LOG_ERR,
2521 "internal module error (ret = %d, user = '%s')",
2522 ret, username);
2523 ret = PAM_SERVICE_ERR;
2524 goto out;
2527 /* should not be reached */
2528 ret = PAM_IGNORE;
2530 out:
2532 _PAM_LOG_FUNCTION_LEAVE("pam_sm_acct_mgmt", ctx, ret);
2534 TALLOC_FREE(ctx);
2536 return ret;
2539 PAM_EXTERN
2540 int pam_sm_open_session(pam_handle_t *pamh, int flags,
2541 int argc, const char **argv)
2543 int ret = PAM_SYSTEM_ERR;
2544 struct pwb_context *ctx = NULL;
2546 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2547 if (ret) {
2548 goto out;
2551 _PAM_LOG_FUNCTION_ENTER("pam_sm_open_session", ctx);
2553 ret = PAM_SUCCESS;
2555 out:
2556 _PAM_LOG_FUNCTION_LEAVE("pam_sm_open_session", ctx, ret);
2558 TALLOC_FREE(ctx);
2560 return ret;
2563 PAM_EXTERN
2564 int pam_sm_close_session(pam_handle_t *pamh, int flags,
2565 int argc, const char **argv)
2567 int retval = PAM_SUCCESS;
2568 struct pwb_context *ctx = NULL;
2569 struct wbcLogoffUserParams logoff;
2571 retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2572 if (retval) {
2573 goto out;
2576 _PAM_LOG_FUNCTION_ENTER("pam_sm_close_session", ctx);
2578 if (!(flags & PAM_DELETE_CRED)) {
2579 retval = PAM_SUCCESS;
2580 goto out;
2583 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2585 /* destroy the ccache here */
2587 wbcErr wbc_status;
2588 struct wbcAuthErrorInfo *error = NULL;
2590 uint32_t flags = 0;
2592 const char *user;
2593 const char *ccname = NULL;
2594 struct passwd *pwd = NULL;
2596 retval = pam_get_user(pamh, &user, _("Username: "));
2597 if (retval) {
2598 _pam_log(ctx, LOG_ERR,
2599 "could not identify user");
2600 goto out;
2603 if (user == NULL) {
2604 _pam_log(ctx, LOG_ERR,
2605 "username was NULL!");
2606 retval = PAM_USER_UNKNOWN;
2607 goto out;
2610 _pam_log_debug(ctx, LOG_DEBUG,
2611 "username [%s] obtained", user);
2613 ccname = pam_getenv(pamh, "KRB5CCNAME");
2614 if (ccname == NULL) {
2615 _pam_log_debug(ctx, LOG_DEBUG,
2616 "user has no KRB5CCNAME environment");
2619 flags = WBFLAG_PAM_KRB5 |
2620 WBFLAG_PAM_CONTACT_TRUSTDOM;
2622 ZERO_STRUCT(logoff);
2624 logoff.username = user;
2626 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2627 &logoff.blobs,
2628 "ccfilename",
2630 (uint8_t *)ccname,
2631 strlen(ccname)+1);
2632 if (!WBC_ERROR_IS_OK(wbc_status)) {
2633 goto out;
2636 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2637 &logoff.blobs,
2638 "flags",
2640 (uint8_t *)&flags,
2641 sizeof(flags));
2642 if (!WBC_ERROR_IS_OK(wbc_status)) {
2643 goto out;
2646 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2647 &logoff.blobs,
2648 "user_uid",
2650 (uint8_t *)&pwd->pw_uid,
2651 sizeof(pwd->pw_uid));
2652 if (!WBC_ERROR_IS_OK(wbc_status)) {
2653 goto out;
2656 wbc_status = wbcLogoffUserEx(&logoff, &error);
2657 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2658 user, "wbcLogoffUser");
2659 wbcFreeMemory(error);
2660 wbcFreeMemory(logoff.blobs);
2662 if (!WBC_ERROR_IS_OK(wbc_status)) {
2663 _pam_log(ctx, LOG_INFO,
2664 "failed to logoff user %s: %s\n",
2665 user, wbcErrorString(wbc_status));
2669 out:
2670 if (logoff.blobs) {
2671 wbcFreeMemory(logoff.blobs);
2675 * Delete the krb5 ccname variable from the PAM environment
2676 * if it was set by winbind.
2678 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2679 pam_putenv(pamh, "KRB5CCNAME");
2682 _PAM_LOG_FUNCTION_LEAVE("pam_sm_close_session", ctx, retval);
2684 TALLOC_FREE(ctx);
2686 return retval;
2690 * evaluate whether we need to re-authenticate with kerberos after a
2691 * password change
2693 * @param ctx PAM winbind context.
2694 * @param user The username
2696 * @return boolean Returns true if required, false if not.
2699 static bool _pam_require_krb5_auth_after_chauthtok(struct pwb_context *ctx,
2700 const char *user)
2703 /* Make sure that we only do this if a) the chauthtok got initiated
2704 * during a logon attempt (authenticate->acct_mgmt->chauthtok) b) any
2705 * later password change via the "passwd" command if done by the user
2706 * itself
2707 * NB. If we login from gdm or xdm and the password expires,
2708 * we change the password, but there is no memory cache.
2709 * Thus, even for passthrough login, we should do the
2710 * authentication again to update memory cache.
2711 * --- BoYang
2712 * */
2714 char *new_authtok_reqd_during_auth = NULL;
2715 struct passwd *pwd = NULL;
2717 _pam_get_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2718 &new_authtok_reqd_during_auth);
2719 pam_set_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2720 NULL, NULL);
2722 if (new_authtok_reqd_during_auth) {
2723 return true;
2726 pwd = getpwnam(user);
2727 if (!pwd) {
2728 return false;
2731 if (getuid() == pwd->pw_uid) {
2732 return true;
2735 return false;
2739 PAM_EXTERN
2740 int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
2741 int argc, const char **argv)
2743 unsigned int lctrl;
2744 int ret;
2745 bool cached_login = false;
2747 /* <DO NOT free() THESE> */
2748 const char *user;
2749 char *pass_old, *pass_new;
2750 /* </DO NOT free() THESE> */
2752 char *Announce;
2754 int retry = 0;
2755 char *username_ret = NULL;
2756 struct wbcAuthErrorInfo *error = NULL;
2757 struct pwb_context *ctx = NULL;
2759 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2760 if (ret) {
2761 goto out;
2764 _PAM_LOG_FUNCTION_ENTER("pam_sm_chauthtok", ctx);
2766 cached_login = (ctx->ctrl & WINBIND_CACHED_LOGIN);
2768 /* clearing offline bit for auth */
2769 ctx->ctrl &= ~WINBIND_CACHED_LOGIN;
2772 * First get the name of a user
2774 ret = pam_get_user(pamh, &user, _("Username: "));
2775 if (ret) {
2776 _pam_log(ctx, LOG_ERR,
2777 "password - could not identify user");
2778 goto out;
2781 if (user == NULL) {
2782 _pam_log(ctx, LOG_ERR, "username was NULL!");
2783 ret = PAM_USER_UNKNOWN;
2784 goto out;
2787 _pam_log_debug(ctx, LOG_DEBUG, "username [%s] obtained", user);
2789 /* check if this is really a user in winbindd, not only in NSS */
2790 ret = valid_user(ctx, user);
2791 switch (ret) {
2792 case 1:
2793 ret = PAM_USER_UNKNOWN;
2794 goto out;
2795 case -1:
2796 ret = PAM_SYSTEM_ERR;
2797 goto out;
2798 default:
2799 break;
2803 * obtain and verify the current password (OLDAUTHTOK) for
2804 * the user.
2807 if (flags & PAM_PRELIM_CHECK) {
2808 time_t pwdlastset_prelim = 0;
2810 /* instruct user what is happening */
2812 #define greeting _("Changing password for ")
2813 Announce = talloc_asprintf(ctx, "%s %s", greeting, user);
2814 if (!Announce) {
2815 _pam_log(ctx, LOG_CRIT,
2816 "password - out of memory");
2817 ret = PAM_BUF_ERR;
2818 goto out;
2820 #undef greeting
2822 lctrl = ctx->ctrl | WINBIND__OLD_PASSWORD;
2823 ret = _winbind_read_password(ctx, lctrl,
2824 Announce,
2825 _("(current) NT password: "),
2826 NULL,
2827 (const char **) &pass_old);
2828 TALLOC_FREE(Announce);
2829 if (ret != PAM_SUCCESS) {
2830 _pam_log(ctx, LOG_NOTICE,
2831 "password - (old) token not obtained");
2832 goto out;
2835 /* verify that this is the password for this user */
2837 ret = winbind_auth_request(ctx, user, pass_old,
2838 NULL, NULL, 0,
2839 &error, NULL, NULL,
2840 &pwdlastset_prelim, NULL);
2842 if (ret != PAM_ACCT_EXPIRED &&
2843 ret != PAM_AUTHTOK_EXPIRED &&
2844 ret != PAM_NEW_AUTHTOK_REQD &&
2845 ret != PAM_SUCCESS) {
2846 pass_old = NULL;
2847 goto out;
2850 pam_set_data(pamh, PAM_WINBIND_PWD_LAST_SET,
2851 (void *)pwdlastset_prelim, NULL);
2853 ret = pam_set_item(pamh, PAM_OLDAUTHTOK,
2854 (const void *) pass_old);
2855 pass_old = NULL;
2856 if (ret != PAM_SUCCESS) {
2857 _pam_log(ctx, LOG_CRIT,
2858 "failed to set PAM_OLDAUTHTOK");
2860 } else if (flags & PAM_UPDATE_AUTHTOK) {
2862 time_t pwdlastset_update = 0;
2865 * obtain the proposed password
2869 * get the old token back.
2872 ret = _pam_get_item(pamh, PAM_OLDAUTHTOK, &pass_old);
2874 if (ret != PAM_SUCCESS) {
2875 _pam_log(ctx, LOG_NOTICE,
2876 "user not authenticated");
2877 goto out;
2880 lctrl = ctx->ctrl & ~WINBIND_TRY_FIRST_PASS_ARG;
2882 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
2883 lctrl |= WINBIND_USE_FIRST_PASS_ARG;
2885 retry = 0;
2886 ret = PAM_AUTHTOK_ERR;
2887 while ((ret != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
2889 * use_authtok is to force the use of a previously entered
2890 * password -- needed for pluggable password strength checking
2893 ret = _winbind_read_password(ctx, lctrl,
2894 NULL,
2895 _("Enter new NT password: "),
2896 _("Retype new NT password: "),
2897 (const char **)&pass_new);
2899 if (ret != PAM_SUCCESS) {
2900 _pam_log_debug(ctx, LOG_ALERT,
2901 "password - "
2902 "new password not obtained");
2903 pass_old = NULL;/* tidy up */
2904 goto out;
2908 * At this point we know who the user is and what they
2909 * propose as their new password. Verify that the new
2910 * password is acceptable.
2913 if (pass_new[0] == '\0') {/* "\0" password = NULL */
2914 pass_new = NULL;
2919 * By reaching here we have approved the passwords and must now
2920 * rebuild the password database file.
2922 _pam_get_data(pamh, PAM_WINBIND_PWD_LAST_SET,
2923 &pwdlastset_update);
2926 * if cached creds were enabled, make sure to set the
2927 * WINBIND_CACHED_LOGIN bit here in order to have winbindd
2928 * update the cached creds storage - gd
2930 if (cached_login) {
2931 ctx->ctrl |= WINBIND_CACHED_LOGIN;
2934 ret = winbind_chauthtok_request(ctx, user, pass_old,
2935 pass_new, pwdlastset_update);
2936 if (ret) {
2937 _pam_overwrite(pass_new);
2938 _pam_overwrite(pass_old);
2939 pass_old = pass_new = NULL;
2940 goto out;
2943 if (_pam_require_krb5_auth_after_chauthtok(ctx, user)) {
2945 const char *member = NULL;
2946 const char *cctype = NULL;
2947 int warn_pwd_expire;
2948 struct wbcLogonUserInfo *info = NULL;
2949 struct wbcUserPasswordPolicyInfo *policy = NULL;
2951 member = get_member_from_config(ctx);
2952 cctype = get_krb5_cc_type_from_config(ctx);
2953 warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2955 /* Keep WINBIND_CACHED_LOGIN bit for
2956 * authentication after changing the password.
2957 * This will update the cached credentials in case
2958 * that winbindd_dual_pam_chauthtok() fails
2959 * to update them.
2960 * --- BoYang
2961 * */
2963 ret = winbind_auth_request(ctx, user, pass_new,
2964 member, cctype, 0,
2965 &error, &info, &policy,
2966 NULL, &username_ret);
2967 _pam_overwrite(pass_new);
2968 _pam_overwrite(pass_old);
2969 pass_old = pass_new = NULL;
2971 if (ret == PAM_SUCCESS) {
2973 struct wbcAuthUserInfo *user_info = NULL;
2975 if (info && info->info) {
2976 user_info = info->info;
2979 /* warn a user if the password is about to
2980 * expire soon */
2981 _pam_warn_password_expiry(ctx, user_info, policy,
2982 warn_pwd_expire,
2983 NULL);
2985 /* set some info3 info for other modules in the
2986 * stack */
2987 _pam_set_data_info3(ctx, user_info);
2989 /* put krb5ccname into env */
2990 _pam_setup_krb5_env(ctx, info);
2992 if (username_ret) {
2993 pam_set_item(pamh, PAM_USER,
2994 username_ret);
2995 _pam_log_debug(ctx, LOG_INFO,
2996 "Returned user was '%s'",
2997 username_ret);
2998 free(username_ret);
3001 wbcFreeMemory(info);
3002 wbcFreeMemory(policy);
3005 goto out;
3007 } else {
3008 ret = PAM_SERVICE_ERR;
3011 out:
3013 /* Deal with offline errors. */
3014 int i;
3015 const char *codes[] = {
3016 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
3017 "NT_STATUS_NO_LOGON_SERVERS",
3018 "NT_STATUS_ACCESS_DENIED"
3021 for (i=0; i<ARRAY_SIZE(codes); i++) {
3022 int _ret;
3023 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
3024 break;
3029 wbcFreeMemory(error);
3031 _PAM_LOG_FUNCTION_LEAVE("pam_sm_chauthtok", ctx, ret);
3033 TALLOC_FREE(ctx);
3035 return ret;
3038 #ifdef PAM_STATIC
3040 /* static module data */
3042 struct pam_module _pam_winbind_modstruct = {
3043 MODULE_NAME,
3044 pam_sm_authenticate,
3045 pam_sm_setcred,
3046 pam_sm_acct_mgmt,
3047 pam_sm_open_session,
3048 pam_sm_close_session,
3049 pam_sm_chauthtok
3052 #endif
3055 * Copyright (c) Andrew Tridgell <tridge@samba.org> 2000
3056 * Copyright (c) Tim Potter <tpot@samba.org> 2000
3057 * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
3058 * Copyright (c) Guenther Deschner <gd@samba.org> 2005-2008
3059 * Copyright (c) Jan Rêkorajski 1999.
3060 * Copyright (c) Andrew G. Morgan 1996-8.
3061 * Copyright (c) Alex O. Yuriev, 1996.
3062 * Copyright (c) Cristian Gafton 1996.
3063 * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
3065 * Redistribution and use in source and binary forms, with or without
3066 * modification, are permitted provided that the following conditions
3067 * are met:
3068 * 1. Redistributions of source code must retain the above copyright
3069 * notice, and the entire permission notice in its entirety,
3070 * including the disclaimer of warranties.
3071 * 2. Redistributions in binary form must reproduce the above copyright
3072 * notice, this list of conditions and the following disclaimer in the
3073 * documentation and/or other materials provided with the distribution.
3074 * 3. The name of the author may not be used to endorse or promote
3075 * products derived from this software without specific prior
3076 * written permission.
3078 * ALTERNATIVELY, this product may be distributed under the terms of
3079 * the GNU Public License, in which case the provisions of the GPL are
3080 * required INSTEAD OF the above restrictions. (This clause is
3081 * necessary due to a potential bad interaction between the GPL and
3082 * the restrictions contained in a BSD-style copyright.)
3084 * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
3085 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
3086 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
3087 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
3088 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
3089 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
3090 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3091 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
3092 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
3093 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
3094 * OF THE POSSIBILITY OF SUCH DAMAGE.