pam_winbind: use libwbclient for WINBINDD_PAM_LOGOFF.
[Samba.git] / source / nsswitch / pam_winbind.c
blob235f3c09e5b36ce7ba6e096b1f4ab55ec2a7efb0
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 winbindd_response *response,
925 int warn_pwd_expire,
926 bool *already_expired)
928 time_t now = time(NULL);
929 time_t next_change = 0;
931 if (already_expired) {
932 *already_expired = false;
935 /* accounts with ACB_PWNOEXP set never receive a warning */
936 if (response->data.auth.info3.acct_flags & ACB_PWNOEXP) {
937 return;
940 /* no point in sending a warning if this is a grace logon */
941 if (PAM_WB_GRACE_LOGON(response->data.auth.info3.user_flgs)) {
942 return;
945 /* check if the info3 must change timestamp has been set */
946 next_change = response->data.auth.info3.pass_must_change_time;
948 if (_pam_send_password_expiry_message(ctx, next_change, now,
949 warn_pwd_expire,
950 already_expired)) {
951 return;
954 /* now check for the global password policy */
955 /* good catch from Ralf Haferkamp: an expiry of "never" is translated
956 * to -1 */
957 if (response->data.auth.policy.expire <= 0) {
958 return;
961 next_change = response->data.auth.info3.pass_last_set_time +
962 response->data.auth.policy.expire;
964 if (_pam_send_password_expiry_message(ctx, next_change, now,
965 warn_pwd_expire,
966 already_expired)) {
967 return;
970 /* no warning sent */
973 #define IS_SID_STRING(name) (strncmp("S-", name, 2) == 0)
976 * Append a string, making sure not to overflow and to always return a
977 * NULL-terminated string.
979 * @param dest Destination string buffer (must already be NULL-terminated).
980 * @param src Source string buffer.
981 * @param dest_buffer_size Size of dest buffer in bytes.
983 * @return false if dest buffer is not big enough (no bytes copied), true on
984 * success.
987 static bool safe_append_string(char *dest,
988 const char *src,
989 int dest_buffer_size)
991 int dest_length = strlen(dest);
992 int src_length = strlen(src);
994 if (dest_length + src_length + 1 > dest_buffer_size) {
995 return false;
998 memcpy(dest + dest_length, src, src_length + 1);
999 return true;
1003 * Convert a names into a SID string, appending it to a buffer.
1005 * @param ctx PAM winbind context.
1006 * @param user User in PAM request.
1007 * @param name Name to convert.
1008 * @param sid_list_buffer Where to append the string sid.
1009 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1011 * @return false on failure, true on success.
1013 static bool winbind_name_to_sid_string(struct pwb_context *ctx,
1014 const char *user,
1015 const char *name,
1016 char *sid_list_buffer,
1017 int sid_list_buffer_size)
1019 const char* sid_string;
1021 /* lookup name? */
1022 if (IS_SID_STRING(name)) {
1023 sid_string = name;
1024 } else {
1025 wbcErr wbc_status;
1026 struct wbcDomainSid sid;
1027 enum wbcSidType type;
1028 char *sid_str;
1030 _pam_log_debug(ctx, LOG_DEBUG,
1031 "no sid given, looking up: %s\n", name);
1033 wbc_status = wbcLookupName("", name, &sid, &type);
1034 if (!WBC_ERROR_IS_OK(wbc_status)) {
1035 _pam_log(ctx, LOG_INFO,
1036 "could not lookup name: %s\n", name);
1037 return false;
1040 wbc_status = wbcSidToString(&sid, &sid_str);
1041 if (!WBC_ERROR_IS_OK(wbc_status)) {
1042 return false;
1045 wbcFreeMemory(sid_str);
1046 sid_string = sid_str;
1049 if (!safe_append_string(sid_list_buffer, sid_string,
1050 sid_list_buffer_size)) {
1051 return false;
1054 return true;
1058 * Convert a list of names into a list of sids.
1060 * @param ctx PAM winbind context.
1061 * @param user User in PAM request.
1062 * @param name_list List of names or string sids, separated by commas.
1063 * @param sid_list_buffer Where to put the list of string sids.
1064 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
1066 * @return false on failure, true on success.
1068 static bool winbind_name_list_to_sid_string_list(struct pwb_context *ctx,
1069 const char *user,
1070 const char *name_list,
1071 char *sid_list_buffer,
1072 int sid_list_buffer_size)
1074 bool result = false;
1075 char *current_name = NULL;
1076 const char *search_location;
1077 const char *comma;
1079 if (sid_list_buffer_size > 0) {
1080 sid_list_buffer[0] = 0;
1083 search_location = name_list;
1084 while ((comma = strstr(search_location, ",")) != NULL) {
1085 current_name = strndup(search_location,
1086 comma - search_location);
1087 if (NULL == current_name) {
1088 goto out;
1091 if (!winbind_name_to_sid_string(ctx, user,
1092 current_name,
1093 sid_list_buffer,
1094 sid_list_buffer_size)) {
1095 goto out;
1098 SAFE_FREE(current_name);
1100 if (!safe_append_string(sid_list_buffer, ",",
1101 sid_list_buffer_size)) {
1102 goto out;
1105 search_location = comma + 1;
1108 if (!winbind_name_to_sid_string(ctx, user, search_location,
1109 sid_list_buffer,
1110 sid_list_buffer_size)) {
1111 goto out;
1114 result = true;
1116 out:
1117 SAFE_FREE(current_name);
1118 return result;
1122 * put krb5ccname variable into environment
1124 * @param ctx PAM winbind context.
1125 * @param krb5ccname env variable retrieved from winbindd.
1127 * @return void.
1130 static void _pam_setup_krb5_env(struct pwb_context *ctx,
1131 const char *krb5ccname)
1133 char var[PATH_MAX];
1134 int ret;
1136 if (off(ctx->ctrl, WINBIND_KRB5_AUTH)) {
1137 return;
1140 if (!krb5ccname || (strlen(krb5ccname) == 0)) {
1141 return;
1144 _pam_log_debug(ctx, LOG_DEBUG,
1145 "request returned KRB5CCNAME: %s", krb5ccname);
1147 if (snprintf(var, sizeof(var), "KRB5CCNAME=%s", krb5ccname) == -1) {
1148 return;
1151 ret = pam_putenv(ctx->pamh, var);
1152 if (ret) {
1153 _pam_log(ctx, LOG_ERR,
1154 "failed to set KRB5CCNAME to %s: %s",
1155 var, pam_strerror(ctx->pamh, ret));
1160 * Set string into the PAM stack.
1162 * @param ctx PAM winbind context.
1163 * @param data_name Key name for pam_set_data.
1164 * @param value String value.
1166 * @return void.
1169 static void _pam_set_data_string(struct pwb_context *ctx,
1170 const char *data_name,
1171 const char *value)
1173 int ret;
1175 if (!data_name || !value || (strlen(data_name) == 0) ||
1176 (strlen(value) == 0)) {
1177 return;
1180 ret = pam_set_data(ctx->pamh, data_name, talloc_strdup(NULL, value),
1181 _pam_winbind_cleanup_func);
1182 if (ret) {
1183 _pam_log_debug(ctx, LOG_DEBUG,
1184 "Could not set data %s: %s\n",
1185 data_name, pam_strerror(ctx->pamh, ret));
1190 * Set info3 strings into the PAM stack.
1192 * @param ctx PAM winbind context.
1193 * @param data_name Key name for pam_set_data.
1194 * @param value String value.
1196 * @return void.
1199 static void _pam_set_data_info3(struct pwb_context *ctx,
1200 struct winbindd_response *response)
1202 _pam_set_data_string(ctx, PAM_WINBIND_HOMEDIR,
1203 response->data.auth.info3.home_dir);
1204 _pam_set_data_string(ctx, PAM_WINBIND_LOGONSCRIPT,
1205 response->data.auth.info3.logon_script);
1206 _pam_set_data_string(ctx, PAM_WINBIND_LOGONSERVER,
1207 response->data.auth.info3.logon_srv);
1208 _pam_set_data_string(ctx, PAM_WINBIND_PROFILEPATH,
1209 response->data.auth.info3.profile_path);
1213 * Free info3 strings in the PAM stack.
1215 * @param pamh PAM handle
1217 * @return void.
1220 static void _pam_free_data_info3(pam_handle_t *pamh)
1222 pam_set_data(pamh, PAM_WINBIND_HOMEDIR, NULL, NULL);
1223 pam_set_data(pamh, PAM_WINBIND_LOGONSCRIPT, NULL, NULL);
1224 pam_set_data(pamh, PAM_WINBIND_LOGONSERVER, NULL, NULL);
1225 pam_set_data(pamh, PAM_WINBIND_PROFILEPATH, NULL, NULL);
1229 * Send PAM_ERROR_MSG for cached or grace logons.
1231 * @param ctx PAM winbind context.
1232 * @param username User in PAM request.
1233 * @param info3_user_flgs Info3 flags containing logon type bits.
1235 * @return void.
1238 static void _pam_warn_logon_type(struct pwb_context *ctx,
1239 const char *username,
1240 uint32_t info3_user_flgs)
1242 /* inform about logon type */
1243 if (PAM_WB_GRACE_LOGON(info3_user_flgs)) {
1245 _make_remark(ctx, PAM_ERROR_MSG,
1246 _("Grace login. "
1247 "Please change your password as soon you're "
1248 "online again"));
1249 _pam_log_debug(ctx, LOG_DEBUG,
1250 "User %s logged on using grace logon\n",
1251 username);
1253 } else if (PAM_WB_CACHED_LOGON(info3_user_flgs)) {
1255 _make_remark(ctx, PAM_ERROR_MSG,
1256 _("Domain Controller unreachable, "
1257 "using cached credentials instead. "
1258 "Network resources may be unavailable"));
1259 _pam_log_debug(ctx, LOG_DEBUG,
1260 "User %s logged on using cached credentials\n",
1261 username);
1266 * Send PAM_ERROR_MSG for krb5 errors.
1268 * @param ctx PAM winbind context.
1269 * @param username User in PAM request.
1270 * @param info3_user_flgs Info3 flags containing logon type bits.
1272 * @return void.
1275 static void _pam_warn_krb5_failure(struct pwb_context *ctx,
1276 const char *username,
1277 uint32_t info3_user_flgs)
1279 if (PAM_WB_KRB5_CLOCK_SKEW(info3_user_flgs)) {
1280 _make_remark(ctx, PAM_ERROR_MSG,
1281 _("Failed to establish your Kerberos Ticket cache "
1282 "due time differences\n"
1283 "with the domain controller. "
1284 "Please verify the system time.\n"));
1285 _pam_log_debug(ctx, LOG_DEBUG,
1286 "User %s: Clock skew when getting Krb5 TGT\n",
1287 username);
1291 static bool _pam_check_remark_auth_err(struct pwb_context *ctx,
1292 const struct wbcAuthErrorInfo *e,
1293 const char *nt_status_string,
1294 int *pam_error)
1296 const char *ntstatus = NULL;
1297 const char *error_string = NULL;
1299 if (!e || !pam_error) {
1300 return false;
1303 ntstatus = e->nt_string;
1304 if (!ntstatus) {
1305 return false;
1308 if (strcasecmp(ntstatus, nt_status_string) == 0) {
1310 error_string = _get_ntstatus_error_string(nt_status_string);
1311 if (error_string) {
1312 _make_remark(ctx, PAM_ERROR_MSG, error_string);
1313 *pam_error = e->pam_error;
1314 return true;
1317 if (e->display_string) {
1318 _make_remark(ctx, PAM_ERROR_MSG, e->display_string);
1319 *pam_error = e->pam_error;
1320 return true;
1323 _make_remark(ctx, PAM_ERROR_MSG, nt_status_string);
1324 *pam_error = e->pam_error;
1326 return true;
1329 return false;
1333 * Compose Password Restriction String for a PAM_ERROR_MSG conversation.
1335 * @param i The wbcUserPasswordPolicyInfo struct.
1337 * @return string (caller needs to talloc_free).
1340 static char *_pam_compose_pwd_restriction_string(struct pwb_context *ctx,
1341 struct wbcUserPasswordPolicyInfo *i)
1343 char *str = NULL;
1345 if (!i) {
1346 goto failed;
1349 str = talloc_asprintf(ctx, _("Your password "));
1350 if (!str) {
1351 goto failed;
1354 if (i->min_length_password > 0) {
1355 str = talloc_asprintf_append(str,
1356 _("must be at least %d characters; "),
1357 i->min_length_password);
1358 if (!str) {
1359 goto failed;
1363 if (i->password_history > 0) {
1364 str = talloc_asprintf_append(str,
1365 _("cannot repeat any of your previous %d "
1366 "passwords; "),
1367 i->password_history);
1368 if (!str) {
1369 goto failed;
1373 if (i->password_properties & WBC_DOMAIN_PASSWORD_COMPLEX) {
1374 str = talloc_asprintf_append(str,
1375 _("must contain capitals, numerals "
1376 "or punctuation; "
1377 "and cannot contain your account "
1378 "or full name; "));
1379 if (!str) {
1380 goto failed;
1384 str = talloc_asprintf_append(str,
1385 _("Please type a different password. "
1386 "Type a password which meets these requirements in "
1387 "both text boxes."));
1388 if (!str) {
1389 goto failed;
1392 return str;
1394 failed:
1395 TALLOC_FREE(str);
1396 return NULL;
1399 /* talk to winbindd */
1400 static int winbind_auth_request(struct pwb_context *ctx,
1401 const char *user,
1402 const char *pass,
1403 const char *member,
1404 const char *cctype,
1405 const int warn_pwd_expire,
1406 struct winbindd_response *p_response,
1407 time_t *pwd_last_set,
1408 char **user_ret)
1410 struct winbindd_request request;
1411 struct winbindd_response response;
1412 int ret;
1413 bool already_expired = false;
1415 ZERO_STRUCT(request);
1416 ZERO_STRUCT(response);
1418 if (pwd_last_set) {
1419 *pwd_last_set = 0;
1422 strncpy(request.data.auth.user, user,
1423 sizeof(request.data.auth.user)-1);
1425 strncpy(request.data.auth.pass, pass,
1426 sizeof(request.data.auth.pass)-1);
1428 request.data.auth.krb5_cc_type[0] = '\0';
1429 request.data.auth.uid = -1;
1431 request.flags = WBFLAG_PAM_INFO3_TEXT | WBFLAG_PAM_GET_PWD_POLICY;
1433 /* Krb5 auth always has to go against the KDC of the user's realm */
1435 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1436 request.flags |= WBFLAG_PAM_CONTACT_TRUSTDOM;
1439 if (ctx->ctrl & (WINBIND_KRB5_AUTH|WINBIND_CACHED_LOGIN)) {
1440 struct passwd *pwd = NULL;
1442 pwd = getpwnam(user);
1443 if (pwd == NULL) {
1444 return PAM_USER_UNKNOWN;
1446 request.data.auth.uid = pwd->pw_uid;
1449 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1451 _pam_log_debug(ctx, LOG_DEBUG,
1452 "enabling krb5 login flag\n");
1454 request.flags |= WBFLAG_PAM_KRB5 |
1455 WBFLAG_PAM_FALLBACK_AFTER_KRB5;
1458 if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1459 _pam_log_debug(ctx, LOG_DEBUG,
1460 "enabling cached login flag\n");
1461 request.flags |= WBFLAG_PAM_CACHED_LOGIN;
1464 if (user_ret) {
1465 *user_ret = NULL;
1466 request.flags |= WBFLAG_PAM_UNIX_NAME;
1469 if (cctype != NULL) {
1470 strncpy(request.data.auth.krb5_cc_type, cctype,
1471 sizeof(request.data.auth.krb5_cc_type) - 1);
1472 _pam_log_debug(ctx, LOG_DEBUG,
1473 "enabling request for a %s krb5 ccache\n",
1474 cctype);
1477 request.data.auth.require_membership_of_sid[0] = '\0';
1479 if (member != NULL) {
1481 if (!winbind_name_list_to_sid_string_list(ctx, user,
1482 member,
1483 request.data.auth.require_membership_of_sid,
1484 sizeof(request.data.auth.require_membership_of_sid))) {
1486 _pam_log_debug(ctx, LOG_ERR,
1487 "failed to serialize membership of sid "
1488 "\"%s\"\n", member);
1489 return PAM_AUTH_ERR;
1493 ret = pam_winbind_request_log(ctx, WINBINDD_PAM_AUTH,
1494 &request, &response, user);
1496 if (pwd_last_set) {
1497 *pwd_last_set = response.data.auth.info3.pass_last_set_time;
1500 if (p_response) {
1501 /* We want to process the response in the caller. */
1502 *p_response = response;
1503 return ret;
1506 if (ret) {
1507 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1508 "NT_STATUS_PASSWORD_EXPIRED");
1509 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1510 "NT_STATUS_PASSWORD_MUST_CHANGE");
1511 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1512 "NT_STATUS_INVALID_WORKSTATION");
1513 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1514 "NT_STATUS_INVALID_LOGON_HOURS");
1515 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1516 "NT_STATUS_ACCOUNT_EXPIRED");
1517 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1518 "NT_STATUS_ACCOUNT_DISABLED");
1519 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1520 "NT_STATUS_ACCOUNT_LOCKED_OUT");
1521 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1522 "NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT");
1523 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1524 "NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT");
1525 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1526 "NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT");
1527 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1528 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND");
1529 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1530 "NT_STATUS_NO_LOGON_SERVERS");
1531 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1532 "NT_STATUS_WRONG_PASSWORD");
1533 PAM_WB_REMARK_CHECK_RESPONSE_RET(ctx, response,
1534 "NT_STATUS_ACCESS_DENIED");
1537 if (ret == PAM_SUCCESS) {
1539 /* warn a user if the password is about to expire soon */
1540 _pam_warn_password_expiry(ctx, &response,
1541 warn_pwd_expire,
1542 &already_expired);
1544 if (already_expired == true) {
1545 SMB_TIME_T last_set;
1546 last_set = response.data.auth.info3.pass_last_set_time;
1547 _pam_log_debug(ctx, LOG_DEBUG,
1548 "Password has expired "
1549 "(Password was last set: %lld, "
1550 "the policy says it should expire here "
1551 "%lld (now it's: %lu))\n",
1552 (long long int)last_set,
1553 (long long int)last_set +
1554 response.data.auth.policy.expire,
1555 time(NULL));
1557 return PAM_AUTHTOK_EXPIRED;
1560 /* inform about logon type */
1561 _pam_warn_logon_type(ctx, user,
1562 response.data.auth.info3.user_flgs);
1564 /* inform about krb5 failures */
1565 _pam_warn_krb5_failure(ctx, user,
1566 response.data.auth.info3.user_flgs);
1568 /* set some info3 info for other modules in the stack */
1569 _pam_set_data_info3(ctx, &response);
1571 /* put krb5ccname into env */
1572 _pam_setup_krb5_env(ctx, response.data.auth.krb5ccname);
1574 /* If winbindd returned a username, return the pointer to it
1575 * here. */
1576 if (user_ret && response.data.auth.unix_username[0]) {
1577 /* We have to trust it's a null terminated string. */
1578 *user_ret = strndup(response.data.auth.unix_username,
1579 sizeof(response.data.auth.unix_username) - 1);
1583 return ret;
1586 /* talk to winbindd */
1587 static int winbind_chauthtok_request(struct pwb_context *ctx,
1588 const char *user,
1589 const char *oldpass,
1590 const char *newpass,
1591 time_t pwd_last_set)
1593 wbcErr wbc_status;
1594 struct wbcChangePasswordParams params;
1595 struct wbcAuthErrorInfo *error = NULL;
1596 struct wbcUserPasswordPolicyInfo *policy = NULL;
1597 enum wbcPasswordChangeRejectReason reject_reason = -1;
1598 uint32_t flags = 0;
1600 int i;
1601 const char *codes[] = {
1602 "NT_STATUS_BACKUP_CONTROLLER",
1603 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND",
1604 "NT_STATUS_NO_LOGON_SERVERS",
1605 "NT_STATUS_ACCESS_DENIED",
1606 "NT_STATUS_PWD_TOO_SHORT", /* TODO: tell the min pwd length ? */
1607 "NT_STATUS_PWD_TOO_RECENT", /* TODO: tell the minage ? */
1608 "NT_STATUS_PWD_HISTORY_CONFLICT" /* TODO: tell the history length ? */
1610 int ret = PAM_AUTH_ERR;
1612 ZERO_STRUCT(params);
1614 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
1615 flags |= WBFLAG_PAM_KRB5 |
1616 WBFLAG_PAM_CONTACT_TRUSTDOM;
1619 if (ctx->ctrl & WINBIND_CACHED_LOGIN) {
1620 flags |= WBFLAG_PAM_CACHED_LOGIN;
1623 params.account_name = user;
1624 params.level = WBC_AUTH_USER_LEVEL_PLAIN;
1625 params.old_password.plaintext = oldpass;
1626 params.new_password.plaintext = newpass;
1627 params.flags = flags;
1629 wbc_status = wbcChangeUserPasswordEx(&params, &error, &reject_reason, &policy);
1630 ret = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
1631 user, "wbcChangeUserPasswordEx");
1633 if (WBC_ERROR_IS_OK(wbc_status)) {
1634 _pam_log(ctx, LOG_NOTICE,
1635 "user '%s' password changed", user);
1636 return PAM_SUCCESS;
1639 if (!error) {
1640 wbcFreeMemory(policy);
1641 return ret;
1644 for (i=0; i<ARRAY_SIZE(codes); i++) {
1645 int _ret = ret;
1646 if (_pam_check_remark_auth_err(ctx, error, codes[i], &_ret)) {
1647 ret = _ret;
1648 goto done;
1652 if (!strcasecmp(error->nt_string,
1653 "NT_STATUS_PASSWORD_RESTRICTION")) {
1655 char *pwd_restriction_string = NULL;
1656 SMB_TIME_T min_pwd_age = 0;
1658 if (policy) {
1659 min_pwd_age = policy->min_passwordage;
1662 /* FIXME: avoid to send multiple PAM messages after another */
1663 switch (reject_reason) {
1664 case -1:
1665 break;
1666 case WBC_PWD_CHANGE_REJECT_OTHER:
1667 if ((min_pwd_age > 0) &&
1668 (pwd_last_set + min_pwd_age > time(NULL))) {
1669 PAM_WB_REMARK_DIRECT(ctx,
1670 "NT_STATUS_PWD_TOO_RECENT");
1672 break;
1673 case WBC_PWD_CHANGE_REJECT_TOO_SHORT:
1674 PAM_WB_REMARK_DIRECT(ctx,
1675 "NT_STATUS_PWD_TOO_SHORT");
1676 break;
1677 case WBC_PWD_CHANGE_REJECT_IN_HISTORY:
1678 PAM_WB_REMARK_DIRECT(ctx,
1679 "NT_STATUS_PWD_HISTORY_CONFLICT");
1680 break;
1681 case WBC_PWD_CHANGE_REJECT_COMPLEXITY:
1682 _make_remark(ctx, PAM_ERROR_MSG,
1683 _("Password does not meet "
1684 "complexity requirements"));
1685 break;
1686 default:
1687 _pam_log_debug(ctx, LOG_DEBUG,
1688 "unknown password change "
1689 "reject reason: %d",
1690 reject_reason);
1691 break;
1694 pwd_restriction_string =
1695 _pam_compose_pwd_restriction_string(ctx, policy);
1696 if (pwd_restriction_string) {
1697 _make_remark(ctx, PAM_ERROR_MSG,
1698 pwd_restriction_string);
1699 TALLOC_FREE(pwd_restriction_string);
1702 done:
1703 wbcFreeMemory(error);
1704 wbcFreeMemory(policy);
1706 return ret;
1710 * Checks if a user has an account
1712 * return values:
1713 * 1 = User not found
1714 * 0 = OK
1715 * -1 = System error
1717 static int valid_user(struct pwb_context *ctx,
1718 const char *user)
1720 /* check not only if the user is available over NSS calls, also make
1721 * sure it's really a winbind user, this is important when stacking PAM
1722 * modules in the 'account' or 'password' facility. */
1724 wbcErr wbc_status;
1725 struct passwd *pwd = NULL;
1726 struct passwd *wb_pwd = NULL;
1728 pwd = getpwnam(user);
1729 if (pwd == NULL) {
1730 return 1;
1733 wbc_status = wbcGetpwnam(user, &wb_pwd);
1734 wbcFreeMemory(wb_pwd);
1735 if (!WBC_ERROR_IS_OK(wbc_status)) {
1736 _pam_log(ctx, LOG_DEBUG, "valid_user: wbcGetpwnam gave %s\n",
1737 wbcErrorString(wbc_status));
1740 switch (wbc_status) {
1741 case WBC_ERR_UNKNOWN_USER:
1742 return 1;
1743 case WBC_ERR_SUCCESS:
1744 return 0;
1745 default:
1746 break;
1748 return -1;
1751 static char *_pam_delete(register char *xx)
1753 _pam_overwrite(xx);
1754 _pam_drop(xx);
1755 return NULL;
1759 * obtain a password from the user
1762 static int _winbind_read_password(struct pwb_context *ctx,
1763 unsigned int ctrl,
1764 const char *comment,
1765 const char *prompt1,
1766 const char *prompt2,
1767 const char **pass)
1769 int authtok_flag;
1770 int retval;
1771 const char *item;
1772 char *token;
1774 _pam_log(ctx, LOG_DEBUG, "getting password (0x%08x)", ctrl);
1777 * make sure nothing inappropriate gets returned
1780 *pass = token = NULL;
1783 * which authentication token are we getting?
1786 if (on(WINBIND__OLD_PASSWORD, ctrl)) {
1787 authtok_flag = PAM_OLDAUTHTOK;
1788 } else {
1789 authtok_flag = PAM_AUTHTOK;
1793 * should we obtain the password from a PAM item ?
1796 if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) ||
1797 on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
1798 retval = _pam_get_item(ctx->pamh, authtok_flag, &item);
1799 if (retval != PAM_SUCCESS) {
1800 /* very strange. */
1801 _pam_log(ctx, LOG_ALERT,
1802 "pam_get_item returned error "
1803 "to unix-read-password");
1804 return retval;
1805 } else if (item != NULL) { /* we have a password! */
1806 *pass = item;
1807 item = NULL;
1808 _pam_log(ctx, LOG_DEBUG,
1809 "pam_get_item returned a password");
1810 return PAM_SUCCESS;
1811 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
1812 return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
1813 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
1814 && off(WINBIND__OLD_PASSWORD, ctrl)) {
1815 return PAM_AUTHTOK_RECOVER_ERR;
1819 * getting here implies we will have to get the password from the
1820 * user directly.
1824 struct pam_message msg[3], *pmsg[3];
1825 struct pam_response *resp;
1826 int i, replies;
1828 /* prepare to converse */
1830 if (comment != NULL && off(ctrl, WINBIND_SILENT)) {
1831 pmsg[0] = &msg[0];
1832 msg[0].msg_style = PAM_TEXT_INFO;
1833 msg[0].msg = discard_const_p(char, comment);
1834 i = 1;
1835 } else {
1836 i = 0;
1839 pmsg[i] = &msg[i];
1840 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
1841 msg[i++].msg = discard_const_p(char, prompt1);
1842 replies = 1;
1844 if (prompt2 != NULL) {
1845 pmsg[i] = &msg[i];
1846 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
1847 msg[i++].msg = discard_const_p(char, prompt2);
1848 ++replies;
1850 /* so call the conversation expecting i responses */
1851 resp = NULL;
1852 retval = converse(ctx->pamh, i, pmsg, &resp);
1853 if (resp == NULL) {
1854 if (retval == PAM_SUCCESS) {
1855 retval = PAM_AUTHTOK_RECOVER_ERR;
1857 goto done;
1859 if (retval != PAM_SUCCESS) {
1860 _pam_drop_reply(resp, i);
1861 goto done;
1864 /* interpret the response */
1866 token = x_strdup(resp[i - replies].resp);
1867 if (!token) {
1868 _pam_log(ctx, LOG_NOTICE,
1869 "could not recover "
1870 "authentication token");
1871 retval = PAM_AUTHTOK_RECOVER_ERR;
1872 goto done;
1875 if (replies == 2) {
1876 /* verify that password entered correctly */
1877 if (!resp[i - 1].resp ||
1878 strcmp(token, resp[i - 1].resp)) {
1879 _pam_delete(token); /* mistyped */
1880 retval = PAM_AUTHTOK_RECOVER_ERR;
1881 _make_remark(ctx, PAM_ERROR_MSG,
1882 MISTYPED_PASS);
1887 * tidy up the conversation (resp_retcode) is ignored
1888 * -- what is it for anyway? AGM
1890 _pam_drop_reply(resp, i);
1893 done:
1894 if (retval != PAM_SUCCESS) {
1895 _pam_log_debug(ctx, LOG_DEBUG,
1896 "unable to obtain a password");
1897 return retval;
1899 /* 'token' is the entered password */
1901 /* we store this password as an item */
1903 retval = pam_set_item(ctx->pamh, authtok_flag, token);
1904 _pam_delete(token); /* clean it up */
1905 if (retval != PAM_SUCCESS ||
1906 (retval = _pam_get_item(ctx->pamh, authtok_flag, &item)) != PAM_SUCCESS) {
1908 _pam_log(ctx, LOG_CRIT, "error manipulating password");
1909 return retval;
1913 *pass = item;
1914 item = NULL; /* break link to password */
1916 return PAM_SUCCESS;
1919 static const char *get_conf_item_string(struct pwb_context *ctx,
1920 const char *item,
1921 int config_flag)
1923 int i = 0;
1924 const char *parm_opt = NULL;
1926 if (!(ctx->ctrl & config_flag)) {
1927 goto out;
1930 /* let the pam opt take precedence over the pam_winbind.conf option */
1931 for (i=0; i<ctx->argc; i++) {
1933 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
1934 char *p;
1936 if ((p = strchr(ctx->argv[i], '=')) == NULL) {
1937 _pam_log(ctx, LOG_INFO,
1938 "no \"=\" delimiter for \"%s\" found\n",
1939 item);
1940 goto out;
1942 _pam_log_debug(ctx, LOG_INFO,
1943 "PAM config: %s '%s'\n", item, p+1);
1944 return p + 1;
1948 if (ctx->dict) {
1949 char *key = NULL;
1951 key = talloc_asprintf(ctx, "global:%s", item);
1952 if (!key) {
1953 goto out;
1956 parm_opt = iniparser_getstr(ctx->dict, key);
1957 TALLOC_FREE(key);
1959 _pam_log_debug(ctx, LOG_INFO, "CONFIG file: %s '%s'\n",
1960 item, parm_opt);
1962 out:
1963 return parm_opt;
1966 static int get_config_item_int(struct pwb_context *ctx,
1967 const char *item,
1968 int config_flag)
1970 int i, parm_opt = -1;
1972 if (!(ctx->ctrl & config_flag)) {
1973 goto out;
1976 /* let the pam opt take precedence over the pam_winbind.conf option */
1977 for (i = 0; i < ctx->argc; i++) {
1979 if ((strncmp(ctx->argv[i], item, strlen(item)) == 0)) {
1980 char *p;
1982 if ((p = strchr(ctx->argv[i], '=')) == NULL) {
1983 _pam_log(ctx, LOG_INFO,
1984 "no \"=\" delimiter for \"%s\" found\n",
1985 item);
1986 goto out;
1988 parm_opt = atoi(p + 1);
1989 _pam_log_debug(ctx, LOG_INFO,
1990 "PAM config: %s '%d'\n",
1991 item, parm_opt);
1992 return parm_opt;
1996 if (ctx->dict) {
1997 char *key = NULL;
1999 key = talloc_asprintf(ctx, "global:%s", item);
2000 if (!key) {
2001 goto out;
2004 parm_opt = iniparser_getint(ctx->dict, key, -1);
2005 TALLOC_FREE(key);
2007 _pam_log_debug(ctx, LOG_INFO,
2008 "CONFIG file: %s '%d'\n",
2009 item, parm_opt);
2011 out:
2012 return parm_opt;
2015 static const char *get_krb5_cc_type_from_config(struct pwb_context *ctx)
2017 return get_conf_item_string(ctx, "krb5_ccache_type",
2018 WINBIND_KRB5_CCACHE_TYPE);
2021 static const char *get_member_from_config(struct pwb_context *ctx)
2023 const char *ret = NULL;
2024 ret = get_conf_item_string(ctx, "require_membership_of",
2025 WINBIND_REQUIRED_MEMBERSHIP);
2026 if (ret) {
2027 return ret;
2029 return get_conf_item_string(ctx, "require-membership-of",
2030 WINBIND_REQUIRED_MEMBERSHIP);
2033 static int get_warn_pwd_expire_from_config(struct pwb_context *ctx)
2035 int ret;
2036 ret = get_config_item_int(ctx, "warn_pwd_expire",
2037 WINBIND_WARN_PWD_EXPIRE);
2038 /* no or broken setting */
2039 if (ret <= 0) {
2040 return DEFAULT_DAYS_TO_WARN_BEFORE_PWD_EXPIRES;
2042 return ret;
2046 * Retrieve the winbind separator.
2048 * @param ctx PAM winbind context.
2050 * @return string separator character. NULL on failure.
2053 static char winbind_get_separator(struct pwb_context *ctx)
2055 wbcErr wbc_status;
2056 static struct wbcInterfaceDetails *details = NULL;
2058 wbc_status = wbcInterfaceDetails(&details);
2059 if (!WBC_ERROR_IS_OK(wbc_status)) {
2060 _pam_log(ctx, LOG_ERR,
2061 "Could not retrieve winbind interface details: %s",
2062 wbcErrorString(wbc_status));
2063 return '\0';
2066 if (!details) {
2067 return '\0';
2070 return details->winbind_separator;
2075 * Convert a upn to a name.
2077 * @param ctx PAM winbind context.
2078 * @param upn USer UPN to be trabslated.
2080 * @return converted name. NULL pointer on failure. Caller needs to free.
2083 static char* winbind_upn_to_username(struct pwb_context *ctx,
2084 const char *upn)
2086 char sep;
2087 wbcErr wbc_status = WBC_ERR_UNKNOWN_FAILURE;
2088 struct wbcDomainSid sid;
2089 enum wbcSidType type;
2090 char *domain;
2091 char *name;
2093 /* This cannot work when the winbind separator = @ */
2095 sep = winbind_get_separator(ctx);
2096 if (!sep || sep == '@') {
2097 return NULL;
2100 /* Convert the UPN to a SID */
2102 wbc_status = wbcLookupName("", upn, &sid, &type);
2103 if (!WBC_ERROR_IS_OK(wbc_status)) {
2104 return NULL;
2107 /* Convert the the SID back to the sAMAccountName */
2109 wbc_status = wbcLookupSid(&sid, &domain, &name, &type);
2110 if (!WBC_ERROR_IS_OK(wbc_status)) {
2111 return NULL;
2114 return talloc_asprintf(ctx, "%s\\%s", domain, name);
2117 PAM_EXTERN
2118 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
2119 int argc, const char **argv)
2121 const char *username;
2122 const char *password;
2123 const char *member = NULL;
2124 const char *cctype = NULL;
2125 int warn_pwd_expire;
2126 int retval = PAM_AUTH_ERR;
2127 char *username_ret = NULL;
2128 char *new_authtok_required = NULL;
2129 char *real_username = NULL;
2130 struct pwb_context *ctx = NULL;
2132 retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2133 if (retval) {
2134 goto out;
2137 _PAM_LOG_FUNCTION_ENTER("pam_sm_authenticate", ctx);
2139 /* Get the username */
2140 retval = pam_get_user(pamh, &username, NULL);
2141 if ((retval != PAM_SUCCESS) || (!username)) {
2142 _pam_log_debug(ctx, LOG_DEBUG,
2143 "can not get the username");
2144 retval = PAM_SERVICE_ERR;
2145 goto out;
2149 #if defined(AIX)
2150 /* Decode the user name since AIX does not support logn user
2151 names by default. The name is encoded as _#uid. */
2153 if (username[0] == '_') {
2154 uid_t id = atoi(&username[1]);
2155 struct passwd *pw = NULL;
2157 if ((id!=0) && ((pw = getpwuid(id)) != NULL)) {
2158 real_username = strdup(pw->pw_name);
2161 #endif
2163 if (!real_username) {
2164 /* Just making a copy of the username we got from PAM */
2165 if ((real_username = strdup(username)) == NULL) {
2166 _pam_log_debug(ctx, LOG_DEBUG,
2167 "memory allocation failure when copying "
2168 "username");
2169 retval = PAM_SERVICE_ERR;
2170 goto out;
2174 /* Maybe this was a UPN */
2176 if (strchr(real_username, '@') != NULL) {
2177 char *samaccountname = NULL;
2179 samaccountname = winbind_upn_to_username(ctx,
2180 real_username);
2181 if (samaccountname) {
2182 free(real_username);
2183 real_username = strdup(samaccountname);
2187 retval = _winbind_read_password(ctx, ctx->ctrl, NULL,
2188 _("Password: "), NULL,
2189 &password);
2191 if (retval != PAM_SUCCESS) {
2192 _pam_log(ctx, LOG_ERR,
2193 "Could not retrieve user's password");
2194 retval = PAM_AUTHTOK_ERR;
2195 goto out;
2198 /* Let's not give too much away in the log file */
2200 #ifdef DEBUG_PASSWORD
2201 _pam_log_debug(ctx, LOG_INFO,
2202 "Verify user '%s' with password '%s'",
2203 real_username, password);
2204 #else
2205 _pam_log_debug(ctx, LOG_INFO,
2206 "Verify user '%s'", real_username);
2207 #endif
2209 member = get_member_from_config(ctx);
2210 cctype = get_krb5_cc_type_from_config(ctx);
2211 warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2213 /* Now use the username to look up password */
2214 retval = winbind_auth_request(ctx, real_username, password,
2215 member, cctype, warn_pwd_expire, NULL,
2216 NULL, &username_ret);
2218 if (retval == PAM_NEW_AUTHTOK_REQD ||
2219 retval == PAM_AUTHTOK_EXPIRED) {
2221 char *new_authtok_required_during_auth = NULL;
2223 new_authtok_required = talloc_asprintf(NULL, "%d", retval);
2224 if (!new_authtok_required) {
2225 retval = PAM_BUF_ERR;
2226 goto out;
2229 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2230 new_authtok_required,
2231 _pam_winbind_cleanup_func);
2233 retval = PAM_SUCCESS;
2235 new_authtok_required_during_auth = talloc_asprintf(NULL, "%d", true);
2236 if (!new_authtok_required_during_auth) {
2237 retval = PAM_BUF_ERR;
2238 goto out;
2241 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2242 new_authtok_required_during_auth,
2243 _pam_winbind_cleanup_func);
2245 goto out;
2248 out:
2249 if (username_ret) {
2250 pam_set_item (pamh, PAM_USER, username_ret);
2251 _pam_log_debug(ctx, LOG_INFO,
2252 "Returned user was '%s'", username_ret);
2253 free(username_ret);
2256 if (real_username) {
2257 free(real_username);
2260 if (!new_authtok_required) {
2261 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, NULL, NULL);
2264 if (retval != PAM_SUCCESS) {
2265 _pam_free_data_info3(pamh);
2268 _PAM_LOG_FUNCTION_LEAVE("pam_sm_authenticate", ctx, retval);
2270 TALLOC_FREE(ctx);
2272 return retval;
2275 PAM_EXTERN
2276 int pam_sm_setcred(pam_handle_t *pamh, int flags,
2277 int argc, const char **argv)
2279 int ret = PAM_SYSTEM_ERR;
2280 struct pwb_context *ctx = NULL;
2282 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2283 if (ret) {
2284 goto out;
2287 _PAM_LOG_FUNCTION_ENTER("pam_sm_setcred", ctx);
2289 switch (flags & ~PAM_SILENT) {
2291 case PAM_DELETE_CRED:
2292 ret = pam_sm_close_session(pamh, flags, argc, argv);
2293 break;
2294 case PAM_REFRESH_CRED:
2295 _pam_log_debug(ctx, LOG_WARNING,
2296 "PAM_REFRESH_CRED not implemented");
2297 ret = PAM_SUCCESS;
2298 break;
2299 case PAM_REINITIALIZE_CRED:
2300 _pam_log_debug(ctx, LOG_WARNING,
2301 "PAM_REINITIALIZE_CRED not implemented");
2302 ret = PAM_SUCCESS;
2303 break;
2304 case PAM_ESTABLISH_CRED:
2305 _pam_log_debug(ctx, LOG_WARNING,
2306 "PAM_ESTABLISH_CRED not implemented");
2307 ret = PAM_SUCCESS;
2308 break;
2309 default:
2310 ret = PAM_SYSTEM_ERR;
2311 break;
2314 out:
2316 _PAM_LOG_FUNCTION_LEAVE("pam_sm_setcred", ctx, ret);
2318 TALLOC_FREE(ctx);
2320 return ret;
2324 * Account management. We want to verify that the account exists
2325 * before returning PAM_SUCCESS
2327 PAM_EXTERN
2328 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
2329 int argc, const char **argv)
2331 const char *username;
2332 int ret = PAM_USER_UNKNOWN;
2333 void *tmp = NULL;
2334 struct pwb_context *ctx = NULL;
2336 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2337 if (ret) {
2338 goto out;
2341 _PAM_LOG_FUNCTION_ENTER("pam_sm_acct_mgmt", ctx);
2344 /* Get the username */
2345 ret = pam_get_user(pamh, &username, NULL);
2346 if ((ret != PAM_SUCCESS) || (!username)) {
2347 _pam_log_debug(ctx, LOG_DEBUG,
2348 "can not get the username");
2349 ret = PAM_SERVICE_ERR;
2350 goto out;
2353 /* Verify the username */
2354 ret = valid_user(ctx, username);
2355 switch (ret) {
2356 case -1:
2357 /* some sort of system error. The log was already printed */
2358 ret = PAM_SERVICE_ERR;
2359 goto out;
2360 case 1:
2361 /* the user does not exist */
2362 _pam_log_debug(ctx, LOG_NOTICE, "user '%s' not found",
2363 username);
2364 if (ctx->ctrl & WINBIND_UNKNOWN_OK_ARG) {
2365 ret = PAM_IGNORE;
2366 goto out;
2368 ret = PAM_USER_UNKNOWN;
2369 goto out;
2370 case 0:
2371 pam_get_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD,
2372 (const void **)&tmp);
2373 if (tmp != NULL) {
2374 ret = atoi((const char *)tmp);
2375 switch (ret) {
2376 case PAM_AUTHTOK_EXPIRED:
2377 /* fall through, since new token is required in this case */
2378 case PAM_NEW_AUTHTOK_REQD:
2379 _pam_log(ctx, LOG_WARNING,
2380 "pam_sm_acct_mgmt success but %s is set",
2381 PAM_WINBIND_NEW_AUTHTOK_REQD);
2382 _pam_log(ctx, LOG_NOTICE,
2383 "user '%s' needs new password",
2384 username);
2385 /* PAM_AUTHTOKEN_REQD does not exist, but is documented in the manpage */
2386 ret = PAM_NEW_AUTHTOK_REQD;
2387 goto out;
2388 default:
2389 _pam_log(ctx, LOG_WARNING,
2390 "pam_sm_acct_mgmt success");
2391 _pam_log(ctx, LOG_NOTICE,
2392 "user '%s' granted access", username);
2393 ret = PAM_SUCCESS;
2394 goto out;
2398 /* Otherwise, the authentication looked good */
2399 _pam_log(ctx, LOG_NOTICE,
2400 "user '%s' granted access", username);
2401 ret = PAM_SUCCESS;
2402 goto out;
2403 default:
2404 /* we don't know anything about this return value */
2405 _pam_log(ctx, LOG_ERR,
2406 "internal module error (ret = %d, user = '%s')",
2407 ret, username);
2408 ret = PAM_SERVICE_ERR;
2409 goto out;
2412 /* should not be reached */
2413 ret = PAM_IGNORE;
2415 out:
2417 _PAM_LOG_FUNCTION_LEAVE("pam_sm_acct_mgmt", ctx, ret);
2419 TALLOC_FREE(ctx);
2421 return ret;
2424 PAM_EXTERN
2425 int pam_sm_open_session(pam_handle_t *pamh, int flags,
2426 int argc, const char **argv)
2428 int ret = PAM_SYSTEM_ERR;
2429 struct pwb_context *ctx = NULL;
2431 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2432 if (ret) {
2433 goto out;
2436 _PAM_LOG_FUNCTION_ENTER("pam_sm_open_session", ctx);
2438 ret = PAM_SUCCESS;
2440 out:
2441 _PAM_LOG_FUNCTION_LEAVE("pam_sm_open_session", ctx, ret);
2443 TALLOC_FREE(ctx);
2445 return ret;
2448 PAM_EXTERN
2449 int pam_sm_close_session(pam_handle_t *pamh, int flags,
2450 int argc, const char **argv)
2452 int retval = PAM_SUCCESS;
2453 struct pwb_context *ctx = NULL;
2454 struct wbcLogoffUserParams logoff;
2456 retval = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2457 if (retval) {
2458 goto out;
2461 _PAM_LOG_FUNCTION_ENTER("pam_sm_close_session", ctx);
2463 if (!(flags & PAM_DELETE_CRED)) {
2464 retval = PAM_SUCCESS;
2465 goto out;
2468 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2470 /* destroy the ccache here */
2472 wbcErr wbc_status;
2473 struct wbcAuthErrorInfo *error = NULL;
2475 uint32_t flags = 0;
2477 const char *user;
2478 const char *ccname = NULL;
2479 struct passwd *pwd = NULL;
2481 retval = pam_get_user(pamh, &user, _("Username: "));
2482 if (retval) {
2483 _pam_log(ctx, LOG_ERR,
2484 "could not identify user");
2485 goto out;
2488 if (user == NULL) {
2489 _pam_log(ctx, LOG_ERR,
2490 "username was NULL!");
2491 retval = PAM_USER_UNKNOWN;
2492 goto out;
2495 _pam_log_debug(ctx, LOG_DEBUG,
2496 "username [%s] obtained", user);
2498 ccname = pam_getenv(pamh, "KRB5CCNAME");
2499 if (ccname == NULL) {
2500 _pam_log_debug(ctx, LOG_DEBUG,
2501 "user has no KRB5CCNAME environment");
2504 flags = WBFLAG_PAM_KRB5 |
2505 WBFLAG_PAM_CONTACT_TRUSTDOM;
2507 ZERO_STRUCT(logoff);
2509 logoff.username = user;
2511 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2512 &logoff.blobs,
2513 "ccfilename",
2515 (uint8_t *)ccname,
2516 strlen(ccname)+1);
2517 if (!WBC_ERROR_IS_OK(wbc_status)) {
2518 goto out;
2521 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2522 &logoff.blobs,
2523 "flags",
2525 (uint8_t *)&flags,
2526 sizeof(flags));
2527 if (!WBC_ERROR_IS_OK(wbc_status)) {
2528 goto out;
2531 wbc_status = wbcAddNamedBlob(&logoff.num_blobs,
2532 &logoff.blobs,
2533 "user_uid",
2535 (uint8_t *)&pwd->pw_uid,
2536 sizeof(pwd->pw_uid));
2537 if (!WBC_ERROR_IS_OK(wbc_status)) {
2538 goto out;
2541 wbc_status = wbcLogoffUserEx(&logoff, &error);
2542 retval = wbc_auth_error_to_pam_error(ctx, error, wbc_status,
2543 user, "wbcLogoffUser");
2544 wbcFreeMemory(error);
2545 wbcFreeMemory(logoff.blobs);
2547 if (!WBC_ERROR_IS_OK(wbc_status)) {
2548 _pam_log(ctx, LOG_INFO,
2549 "failed to logoff user %s: %s\n",
2550 user, wbcErrorString(wbc_status));
2554 out:
2555 if (logoff.blobs) {
2556 wbcFreeMemory(logoff.blobs);
2560 * Delete the krb5 ccname variable from the PAM environment
2561 * if it was set by winbind.
2563 if (ctx->ctrl & WINBIND_KRB5_AUTH) {
2564 pam_putenv(pamh, "KRB5CCNAME");
2567 _PAM_LOG_FUNCTION_LEAVE("pam_sm_close_session", ctx, retval);
2569 TALLOC_FREE(ctx);
2571 return retval;
2575 * evaluate whether we need to re-authenticate with kerberos after a
2576 * password change
2578 * @param ctx PAM winbind context.
2579 * @param user The username
2581 * @return boolean Returns true if required, false if not.
2584 static bool _pam_require_krb5_auth_after_chauthtok(struct pwb_context *ctx,
2585 const char *user)
2588 /* Make sure that we only do this if a) the chauthtok got initiated
2589 * during a logon attempt (authenticate->acct_mgmt->chauthtok) b) any
2590 * later password change via the "passwd" command if done by the user
2591 * itself
2592 * NB. If we login from gdm or xdm and the password expires,
2593 * we change the password, but there is no memory cache.
2594 * Thus, even for passthrough login, we should do the
2595 * authentication again to update memory cache.
2596 * --- BoYang
2597 * */
2599 char *new_authtok_reqd_during_auth = NULL;
2600 struct passwd *pwd = NULL;
2602 _pam_get_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2603 &new_authtok_reqd_during_auth);
2604 pam_set_data(ctx->pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
2605 NULL, NULL);
2607 if (new_authtok_reqd_during_auth) {
2608 return true;
2611 pwd = getpwnam(user);
2612 if (!pwd) {
2613 return false;
2616 if (getuid() == pwd->pw_uid) {
2617 return true;
2620 return false;
2624 PAM_EXTERN
2625 int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
2626 int argc, const char **argv)
2628 unsigned int lctrl;
2629 int ret;
2630 bool cached_login = false;
2632 /* <DO NOT free() THESE> */
2633 const char *user;
2634 char *pass_old, *pass_new;
2635 /* </DO NOT free() THESE> */
2637 char *Announce;
2639 int retry = 0;
2640 char *username_ret = NULL;
2641 struct winbindd_response response;
2642 struct pwb_context *ctx = NULL;
2644 ZERO_STRUCT(response);
2646 ret = _pam_winbind_init_context(pamh, flags, argc, argv, &ctx);
2647 if (ret) {
2648 goto out;
2651 _PAM_LOG_FUNCTION_ENTER("pam_sm_chauthtok", ctx);
2653 cached_login = (ctx->ctrl & WINBIND_CACHED_LOGIN);
2655 /* clearing offline bit for auth */
2656 ctx->ctrl &= ~WINBIND_CACHED_LOGIN;
2659 * First get the name of a user
2661 ret = pam_get_user(pamh, &user, _("Username: "));
2662 if (ret) {
2663 _pam_log(ctx, LOG_ERR,
2664 "password - could not identify user");
2665 goto out;
2668 if (user == NULL) {
2669 _pam_log(ctx, LOG_ERR, "username was NULL!");
2670 ret = PAM_USER_UNKNOWN;
2671 goto out;
2674 _pam_log_debug(ctx, LOG_DEBUG, "username [%s] obtained", user);
2676 /* check if this is really a user in winbindd, not only in NSS */
2677 ret = valid_user(ctx, user);
2678 switch (ret) {
2679 case 1:
2680 ret = PAM_USER_UNKNOWN;
2681 goto out;
2682 case -1:
2683 ret = PAM_SYSTEM_ERR;
2684 goto out;
2685 default:
2686 break;
2690 * obtain and verify the current password (OLDAUTHTOK) for
2691 * the user.
2694 if (flags & PAM_PRELIM_CHECK) {
2695 time_t pwdlastset_prelim = 0;
2697 /* instruct user what is happening */
2699 #define greeting _("Changing password for ")
2700 Announce = talloc_asprintf(ctx, "%s %s", greeting, user);
2701 if (!Announce) {
2702 _pam_log(ctx, LOG_CRIT,
2703 "password - out of memory");
2704 ret = PAM_BUF_ERR;
2705 goto out;
2707 #undef greeting
2709 lctrl = ctx->ctrl | WINBIND__OLD_PASSWORD;
2710 ret = _winbind_read_password(ctx, lctrl,
2711 Announce,
2712 _("(current) NT password: "),
2713 NULL,
2714 (const char **) &pass_old);
2715 TALLOC_FREE(Announce);
2716 if (ret != PAM_SUCCESS) {
2717 _pam_log(ctx, LOG_NOTICE,
2718 "password - (old) token not obtained");
2719 goto out;
2722 /* verify that this is the password for this user */
2724 ret = winbind_auth_request(ctx, user, pass_old,
2725 NULL, NULL, 0, &response,
2726 &pwdlastset_prelim, NULL);
2728 if (ret != PAM_ACCT_EXPIRED &&
2729 ret != PAM_AUTHTOK_EXPIRED &&
2730 ret != PAM_NEW_AUTHTOK_REQD &&
2731 ret != PAM_SUCCESS) {
2732 pass_old = NULL;
2733 goto out;
2736 pam_set_data(pamh, PAM_WINBIND_PWD_LAST_SET,
2737 (void *)pwdlastset_prelim, NULL);
2739 ret = pam_set_item(pamh, PAM_OLDAUTHTOK,
2740 (const void *) pass_old);
2741 pass_old = NULL;
2742 if (ret != PAM_SUCCESS) {
2743 _pam_log(ctx, LOG_CRIT,
2744 "failed to set PAM_OLDAUTHTOK");
2746 } else if (flags & PAM_UPDATE_AUTHTOK) {
2748 time_t pwdlastset_update = 0;
2751 * obtain the proposed password
2755 * get the old token back.
2758 ret = _pam_get_item(pamh, PAM_OLDAUTHTOK, &pass_old);
2760 if (ret != PAM_SUCCESS) {
2761 _pam_log(ctx, LOG_NOTICE,
2762 "user not authenticated");
2763 goto out;
2766 lctrl = ctx->ctrl & ~WINBIND_TRY_FIRST_PASS_ARG;
2768 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
2769 lctrl |= WINBIND_USE_FIRST_PASS_ARG;
2771 retry = 0;
2772 ret = PAM_AUTHTOK_ERR;
2773 while ((ret != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
2775 * use_authtok is to force the use of a previously entered
2776 * password -- needed for pluggable password strength checking
2779 ret = _winbind_read_password(ctx, lctrl,
2780 NULL,
2781 _("Enter new NT password: "),
2782 _("Retype new NT password: "),
2783 (const char **)&pass_new);
2785 if (ret != PAM_SUCCESS) {
2786 _pam_log_debug(ctx, LOG_ALERT,
2787 "password - "
2788 "new password not obtained");
2789 pass_old = NULL;/* tidy up */
2790 goto out;
2794 * At this point we know who the user is and what they
2795 * propose as their new password. Verify that the new
2796 * password is acceptable.
2799 if (pass_new[0] == '\0') {/* "\0" password = NULL */
2800 pass_new = NULL;
2805 * By reaching here we have approved the passwords and must now
2806 * rebuild the password database file.
2808 _pam_get_data(pamh, PAM_WINBIND_PWD_LAST_SET,
2809 &pwdlastset_update);
2812 * if cached creds were enabled, make sure to set the
2813 * WINBIND_CACHED_LOGIN bit here in order to have winbindd
2814 * update the cached creds storage - gd
2816 if (cached_login) {
2817 ctx->ctrl |= WINBIND_CACHED_LOGIN;
2820 ret = winbind_chauthtok_request(ctx, user, pass_old,
2821 pass_new, pwdlastset_update);
2822 if (ret) {
2823 _pam_overwrite(pass_new);
2824 _pam_overwrite(pass_old);
2825 pass_old = pass_new = NULL;
2826 goto out;
2829 if (_pam_require_krb5_auth_after_chauthtok(ctx, user)) {
2831 const char *member = NULL;
2832 const char *cctype = NULL;
2833 int warn_pwd_expire;
2835 member = get_member_from_config(ctx);
2836 cctype = get_krb5_cc_type_from_config(ctx);
2837 warn_pwd_expire = get_warn_pwd_expire_from_config(ctx);
2839 /* Keep WINBIND_CACHED_LOGIN bit for
2840 * authentication after changing the password.
2841 * This will update the cached credentials in case
2842 * that winbindd_dual_pam_chauthtok() fails
2843 * to update them.
2844 * --- BoYang
2845 * */
2847 ret = winbind_auth_request(ctx, user, pass_new,
2848 member, cctype, 0, &response,
2849 NULL, &username_ret);
2850 _pam_overwrite(pass_new);
2851 _pam_overwrite(pass_old);
2852 pass_old = pass_new = NULL;
2854 if (ret == PAM_SUCCESS) {
2856 /* warn a user if the password is about to
2857 * expire soon */
2858 _pam_warn_password_expiry(ctx, &response,
2859 warn_pwd_expire,
2860 NULL);
2862 /* set some info3 info for other modules in the
2863 * stack */
2864 _pam_set_data_info3(ctx, &response);
2866 /* put krb5ccname into env */
2867 _pam_setup_krb5_env(ctx,
2868 response.data.auth.krb5ccname);
2870 if (username_ret) {
2871 pam_set_item(pamh, PAM_USER,
2872 username_ret);
2873 _pam_log_debug(ctx, LOG_INFO,
2874 "Returned user was '%s'",
2875 username_ret);
2876 free(username_ret);
2880 goto out;
2882 } else {
2883 ret = PAM_SERVICE_ERR;
2886 out:
2888 /* Deal with offline errors. */
2889 PAM_WB_REMARK_CHECK_RESPONSE(ctx, response,
2890 "NT_STATUS_NO_LOGON_SERVERS");
2891 PAM_WB_REMARK_CHECK_RESPONSE(ctx, response,
2892 "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND");
2893 PAM_WB_REMARK_CHECK_RESPONSE(ctx, response,
2894 "NT_STATUS_ACCESS_DENIED");
2896 _PAM_LOG_FUNCTION_LEAVE("pam_sm_chauthtok", ctx, ret);
2898 TALLOC_FREE(ctx);
2900 return ret;
2903 #ifdef PAM_STATIC
2905 /* static module data */
2907 struct pam_module _pam_winbind_modstruct = {
2908 MODULE_NAME,
2909 pam_sm_authenticate,
2910 pam_sm_setcred,
2911 pam_sm_acct_mgmt,
2912 pam_sm_open_session,
2913 pam_sm_close_session,
2914 pam_sm_chauthtok
2917 #endif
2920 * Copyright (c) Andrew Tridgell <tridge@samba.org> 2000
2921 * Copyright (c) Tim Potter <tpot@samba.org> 2000
2922 * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
2923 * Copyright (c) Guenther Deschner <gd@samba.org> 2005-2008
2924 * Copyright (c) Jan Rêkorajski 1999.
2925 * Copyright (c) Andrew G. Morgan 1996-8.
2926 * Copyright (c) Alex O. Yuriev, 1996.
2927 * Copyright (c) Cristian Gafton 1996.
2928 * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
2930 * Redistribution and use in source and binary forms, with or without
2931 * modification, are permitted provided that the following conditions
2932 * are met:
2933 * 1. Redistributions of source code must retain the above copyright
2934 * notice, and the entire permission notice in its entirety,
2935 * including the disclaimer of warranties.
2936 * 2. Redistributions in binary form must reproduce the above copyright
2937 * notice, this list of conditions and the following disclaimer in the
2938 * documentation and/or other materials provided with the distribution.
2939 * 3. The name of the author may not be used to endorse or promote
2940 * products derived from this software without specific prior
2941 * written permission.
2943 * ALTERNATIVELY, this product may be distributed under the terms of
2944 * the GNU Public License, in which case the provisions of the GPL are
2945 * required INSTEAD OF the above restrictions. (This clause is
2946 * necessary due to a potential bad interaction between the GPL and
2947 * the restrictions contained in a BSD-style copyright.)
2949 * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
2950 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
2951 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
2952 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
2953 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2954 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2955 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2956 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2957 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2958 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
2959 * OF THE POSSIBILITY OF SUCH DAMAGE.