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-2007
8 largely based on pam_userdb by Cristian Gafton <gafton@redhat.com>
9 also contains large slabs of code from pam_unix by Elliot Lee <sopwith@redhat.com>
10 (see copyright below for full details)
13 #include "pam_winbind.h"
15 #define _PAM_LOG_FUNCTION_ENTER(function, pamh, ctrl, flags) \
17 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "[pamh: 0x%08x] ENTER: " function " (flags: 0x%04x)", (uint32) pamh, flags); \
18 _pam_log_state(pamh, ctrl); \
21 #define _PAM_LOG_FUNCTION_LEAVE(function, pamh, ctrl, retval) \
23 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "[pamh: 0x%08x] LEAVE: " function " returning %d", (uint32) pamh, retval); \
24 _pam_log_state(pamh, ctrl); \
29 #define MAX_PASSWD_TRIES 3
32 * Work around the pam API that has functions with void ** as parameters.
33 * These lead to strict aliasing warnings with gcc.
35 static int _pam_get_item(const pam_handle_t *pamh, int item_type,
38 const void **item = (const void **)_item;
39 return pam_get_item(pamh, item_type, item);
41 static int _pam_get_data(const pam_handle_t *pamh,
42 const char *module_data_name, const void *_data)
44 const void **data = (const void **)_data;
45 return pam_get_data(pamh, module_data_name, data);
50 #ifdef HAVE_PAM_VSYSLOG
51 static void _pam_log_int(const pam_handle_t *pamh, int err, const char *format, va_list args)
53 pam_vsyslog(pamh, err, format, args);
56 static void _pam_log_int(const pam_handle_t *pamh, int err, const char *format, va_list args)
61 _pam_get_item(pamh, PAM_SERVICE, &service);
63 format2 = malloc(strlen(MODULE_NAME)+strlen(format)+strlen(service)+5);
64 if (format2 == NULL) {
65 /* what else todo ? */
66 vsyslog(err, format, args);
70 sprintf(format2, "%s(%s): %s", MODULE_NAME, service, format);
71 vsyslog(err, format2, args);
74 #endif /* HAVE_PAM_VSYSLOG */
76 static BOOL _pam_log_is_silent(int ctrl)
78 return on(ctrl, WINBIND_SILENT);
81 static void _pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
82 static void _pam_log(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
86 if (_pam_log_is_silent(ctrl)) {
90 va_start(args, format);
91 _pam_log_int(pamh, err, format, args);
95 static BOOL _pam_log_is_debug_enabled(int ctrl)
101 if (_pam_log_is_silent(ctrl)) {
105 if (!(ctrl & WINBIND_DEBUG_ARG)) {
112 static BOOL _pam_log_is_debug_state_enabled(int ctrl)
114 if (!(ctrl & WINBIND_DEBUG_STATE)) {
118 return _pam_log_is_debug_enabled(ctrl);
121 static void _pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
122 static void _pam_log_debug(const pam_handle_t *pamh, int ctrl, int err, const char *format, ...)
126 if (!_pam_log_is_debug_enabled(ctrl)) {
130 va_start(args, format);
131 _pam_log_int(pamh, err, format, args);
135 static void _pam_log_state_datum(const pam_handle_t *pamh, int ctrl, int item_type, const char *key, int is_string)
137 const void *data = NULL;
138 if (item_type != 0) {
139 pam_get_item(pamh, item_type, &data);
141 pam_get_data(pamh, key, &data);
144 const char *type = (item_type != 0) ? "ITEM" : "DATA";
145 if (is_string != 0) {
146 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "[pamh: 0x%08x] STATE: %s(%s) = \"%s\" (0x%08x)", (uint32) pamh, type, key, (const char *) data, (uint32) data);
148 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "[pamh: 0x%08x] STATE: %s(%s) = 0x%08x", (uint32) pamh, type, key, (uint32) data);
153 #define _PAM_LOG_STATE_DATA_POINTER(pamh, ctrl, module_data_name) \
154 _pam_log_state_datum(pamh, ctrl, 0, module_data_name, 0)
156 #define _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, module_data_name) \
157 _pam_log_state_datum(pamh, ctrl, 0, module_data_name, 1)
159 #define _PAM_LOG_STATE_ITEM_POINTER(pamh, ctrl, item_type) \
160 _pam_log_state_datum(pamh, ctrl, item_type, #item_type, 0)
162 #define _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, item_type) \
163 _pam_log_state_datum(pamh, ctrl, item_type, #item_type, 1)
165 #ifdef DEBUG_PASSWORD
166 #define _LOG_PASSWORD_AS_STRING 1
168 #define _LOG_PASSWORD_AS_STRING 0
171 #define _PAM_LOG_STATE_ITEM_PASSWORD(pamh, ctrl, item_type) \
172 _pam_log_state_datum(pamh, ctrl, item_type, #item_type, _LOG_PASSWORD_AS_STRING)
174 static void _pam_log_state(const pam_handle_t *pamh, int ctrl)
176 if (!_pam_log_is_debug_state_enabled(ctrl)) {
180 _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, PAM_SERVICE);
181 _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, PAM_USER);
182 _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, PAM_TTY);
183 _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, PAM_RHOST);
184 _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, PAM_RUSER);
185 _PAM_LOG_STATE_ITEM_PASSWORD(pamh, ctrl, PAM_OLDAUTHTOK);
186 _PAM_LOG_STATE_ITEM_PASSWORD(pamh, ctrl, PAM_AUTHTOK);
187 _PAM_LOG_STATE_ITEM_STRING(pamh, ctrl, PAM_USER_PROMPT);
188 _PAM_LOG_STATE_ITEM_POINTER(pamh, ctrl, PAM_CONV);
189 #ifdef PAM_FAIL_DELAY
190 _PAM_LOG_STATE_ITEM_POINTER(pamh, ctrl, PAM_FAIL_DELAY);
192 #ifdef PAM_REPOSITORY
193 _PAM_LOG_STATE_ITEM_POINTER(pamh, ctrl, PAM_REPOSITORY);
196 _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, PAM_WINBIND_HOMEDIR);
197 _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, PAM_WINBIND_LOGONSCRIPT);
198 _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, PAM_WINBIND_LOGONSERVER);
199 _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, PAM_WINBIND_PROFILEPATH);
200 _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, PAM_WINBIND_NEW_AUTHTOK_REQD); /* Use atoi to get PAM result code */
201 _PAM_LOG_STATE_DATA_STRING(pamh, ctrl, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH);
202 _PAM_LOG_STATE_DATA_POINTER(pamh, ctrl, PAM_WINBIND_PWD_LAST_SET);
205 static int _pam_parse(const pam_handle_t *pamh, int flags, int argc, const char **argv, dictionary **result_d)
208 const char *config_file = NULL;
211 dictionary *d = NULL;
213 if (flags & PAM_SILENT) {
214 ctrl |= WINBIND_SILENT;
217 for (i=argc,v=argv; i-- > 0; ++v) {
218 if (!strncasecmp(*v, "config", strlen("config"))) {
219 ctrl |= WINBIND_CONFIG_FILE;
225 if (config_file == NULL) {
226 config_file = PAM_WINBIND_CONFIG_FILE;
229 d = iniparser_load(config_file);
231 goto config_from_pam;
234 if (iniparser_getboolean(d, "global:debug", False)) {
235 ctrl |= WINBIND_DEBUG_ARG;
238 if (iniparser_getboolean(d, "global:debug_state", False)) {
239 ctrl |= WINBIND_DEBUG_STATE;
242 if (iniparser_getboolean(d, "global:cached_login", False)) {
243 ctrl |= WINBIND_CACHED_LOGIN;
246 if (iniparser_getboolean(d, "global:krb5_auth", False)) {
247 ctrl |= WINBIND_KRB5_AUTH;
250 if (iniparser_getboolean(d, "global:silent", False)) {
251 ctrl |= WINBIND_SILENT;
254 if (iniparser_getstr(d, "global:krb5_ccache_type") != NULL) {
255 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
258 if ((iniparser_getstr(d, "global:require-membership-of") != NULL) ||
259 (iniparser_getstr(d, "global:require_membership_of") != NULL)) {
260 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
263 if (iniparser_getboolean(d, "global:try_first_pass", False)) {
264 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
268 /* step through arguments */
269 for (i=argc,v=argv; i-- > 0; ++v) {
271 /* generic options */
272 if (!strcmp(*v,"debug"))
273 ctrl |= WINBIND_DEBUG_ARG;
274 else if (!strcasecmp(*v, "debug_state"))
275 ctrl |= WINBIND_DEBUG_STATE;
276 else if (!strcasecmp(*v, "silent"))
277 ctrl |= WINBIND_SILENT;
278 else if (!strcasecmp(*v, "use_authtok"))
279 ctrl |= WINBIND_USE_AUTHTOK_ARG;
280 else if (!strcasecmp(*v, "use_first_pass"))
281 ctrl |= WINBIND_USE_FIRST_PASS_ARG;
282 else if (!strcasecmp(*v, "try_first_pass"))
283 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
284 else if (!strcasecmp(*v, "unknown_ok"))
285 ctrl |= WINBIND_UNKNOWN_OK_ARG;
286 else if (!strncasecmp(*v, "require_membership_of", strlen("require_membership_of")))
287 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
288 else if (!strncasecmp(*v, "require-membership-of", strlen("require-membership-of")))
289 ctrl |= WINBIND_REQUIRED_MEMBERSHIP;
290 else if (!strcasecmp(*v, "krb5_auth"))
291 ctrl |= WINBIND_KRB5_AUTH;
292 else if (!strncasecmp(*v, "krb5_ccache_type", strlen("krb5_ccache_type")))
293 ctrl |= WINBIND_KRB5_CCACHE_TYPE;
294 else if (!strcasecmp(*v, "cached_login"))
295 ctrl |= WINBIND_CACHED_LOGIN;
297 _pam_log(pamh, ctrl, LOG_ERR, "pam_parse: unknown option: %s", *v);
307 iniparser_freedict(d);
314 static void _pam_winbind_cleanup_func(pam_handle_t *pamh, void *data, int error_status)
316 int ctrl = _pam_parse(pamh, 0, 0, NULL, NULL);
317 if (_pam_log_is_debug_state_enabled(ctrl)) {
318 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "[pamh: 0x%08x] CLEAN: cleaning up PAM data 0x%08x (error_status = %d)", (uint32) pamh, (uint32) data, error_status);
324 static const struct ntstatus_errors {
325 const char *ntstatus_string;
326 const char *error_string;
327 } ntstatus_errors[] = {
328 {"NT_STATUS_OK", "Success"},
329 {"NT_STATUS_BACKUP_CONTROLLER", "No primary Domain Controler available"},
330 {"NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND", "No domain controllers found"},
331 {"NT_STATUS_NO_LOGON_SERVERS", "No logon servers"},
332 {"NT_STATUS_PWD_TOO_SHORT", "Password too short"},
333 {"NT_STATUS_PWD_TOO_RECENT", "The password of this user is too recent to change"},
334 {"NT_STATUS_PWD_HISTORY_CONFLICT", "Password is already in password history"},
335 {"NT_STATUS_PASSWORD_EXPIRED", "Your password has expired"},
336 {"NT_STATUS_PASSWORD_MUST_CHANGE", "You need to change your password now"},
337 {"NT_STATUS_INVALID_WORKSTATION", "You are not allowed to logon from this workstation"},
338 {"NT_STATUS_INVALID_LOGON_HOURS", "You are not allowed to logon at this time"},
339 {"NT_STATUS_ACCOUNT_EXPIRED", "Your account has expired. Please contact your System administrator"}, /* SCNR */
340 {"NT_STATUS_ACCOUNT_DISABLED", "Your account is disabled. Please contact your System administrator"}, /* SCNR */
341 {"NT_STATUS_ACCOUNT_LOCKED_OUT", "Your account has been locked. Please contact your System administrator"}, /* SCNR */
342 {"NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT", "Invalid Trust Account"},
343 {"NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT", "Invalid Trust Account"},
344 {"NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT", "Invalid Trust Account"},
345 {"NT_STATUS_ACCESS_DENIED", "Access is denied"},
349 const char *_get_ntstatus_error_string(const char *nt_status_string)
352 for (i=0; ntstatus_errors[i].ntstatus_string != NULL; i++) {
353 if (!strcasecmp(ntstatus_errors[i].ntstatus_string, nt_status_string)) {
354 return ntstatus_errors[i].error_string;
360 /* --- authentication management functions --- */
362 /* Attempt a conversation */
364 static int converse(pam_handle_t *pamh, int nargs,
365 struct pam_message **message,
366 struct pam_response **response)
369 struct pam_conv *conv;
371 retval = _pam_get_item(pamh, PAM_CONV, &conv );
372 if (retval == PAM_SUCCESS) {
373 retval = conv->conv(nargs, (const struct pam_message **)message,
374 response, conv->appdata_ptr);
377 return retval; /* propagate error status */
381 static int _make_remark(pam_handle_t * pamh, int flags, int type, const char *text)
383 int retval = PAM_SUCCESS;
385 struct pam_message *pmsg[1], msg[1];
386 struct pam_response *resp;
388 if (flags & WINBIND_SILENT) {
393 msg[0].msg = CONST_DISCARD(char *, text);
394 msg[0].msg_style = type;
397 retval = converse(pamh, 1, pmsg, &resp);
400 _pam_drop_reply(resp, 1);
405 static int _make_remark_v(pam_handle_t * pamh, int flags, int type, const char *format, va_list args)
410 ret = vasprintf(&var, format, args);
412 _pam_log(pamh, 0, LOG_ERR, "memory allocation failure");
416 ret = _make_remark(pamh, flags, type, var);
421 static int _make_remark_format(pam_handle_t * pamh, int flags, int type, const char *format, ...) PRINTF_ATTRIBUTE(4,5);
422 static int _make_remark_format(pam_handle_t * pamh, int flags, int type, const char *format, ...)
427 va_start(args, format);
428 ret = _make_remark_v(pamh, flags, type, format, args);
433 static int pam_winbind_request(pam_handle_t * pamh, int ctrl,
434 enum winbindd_cmd req_type,
435 struct winbindd_request *request,
436 struct winbindd_response *response)
438 /* Fill in request and send down pipe */
439 init_request(request, req_type);
441 if (write_sock(request, sizeof(*request), 0, 0) == -1) {
442 _pam_log(pamh, ctrl, LOG_ERR, "pam_winbind_request: write to socket failed!");
444 return PAM_SERVICE_ERR;
448 if (read_reply(response) == -1) {
449 _pam_log(pamh, ctrl, LOG_ERR, "pam_winbind_request: read from socket failed!");
451 return PAM_SERVICE_ERR;
454 /* We are done with the socket - close it and avoid mischeif */
457 /* Copy reply data from socket */
458 if (response->result == WINBINDD_OK) {
462 /* no need to check for pam_error codes for getpwnam() */
465 case WINBINDD_GETPWNAM:
466 case WINBINDD_LOOKUPNAME:
467 if (strlen(response->data.auth.nt_status_string) > 0) {
468 _pam_log(pamh, ctrl, LOG_ERR, "request failed, NT error was %s",
469 response->data.auth.nt_status_string);
471 _pam_log(pamh, ctrl, LOG_ERR, "request failed");
473 return PAM_USER_UNKNOWN;
478 if (response->data.auth.pam_error != PAM_SUCCESS) {
479 _pam_log(pamh, ctrl, LOG_ERR, "request failed: %s, PAM error was %s (%d), NT error was %s",
480 response->data.auth.error_string,
481 pam_strerror(pamh, response->data.auth.pam_error),
482 response->data.auth.pam_error,
483 response->data.auth.nt_status_string);
484 return response->data.auth.pam_error;
487 _pam_log(pamh, ctrl, LOG_ERR, "request failed, but PAM error 0!");
489 return PAM_SERVICE_ERR;
492 static int pam_winbind_request_log(pam_handle_t * pamh,
494 enum winbindd_cmd req_type,
495 struct winbindd_request *request,
496 struct winbindd_response *response,
501 retval = pam_winbind_request(pamh, ctrl, req_type, request, response);
505 /* incorrect password */
506 _pam_log(pamh, ctrl, LOG_WARNING, "user '%s' denied access (incorrect password or invalid membership)", user);
508 case PAM_ACCT_EXPIRED:
509 /* account expired */
510 _pam_log(pamh, ctrl, LOG_WARNING, "user '%s' account expired", user);
512 case PAM_AUTHTOK_EXPIRED:
513 /* password expired */
514 _pam_log(pamh, ctrl, LOG_WARNING, "user '%s' password expired", user);
516 case PAM_NEW_AUTHTOK_REQD:
517 /* new password required */
518 _pam_log(pamh, ctrl, LOG_WARNING, "user '%s' new password required", user);
520 case PAM_USER_UNKNOWN:
521 /* the user does not exist */
522 _pam_log_debug(pamh, ctrl, LOG_NOTICE, "user '%s' not found", user);
523 if (ctrl & WINBIND_UNKNOWN_OK_ARG) {
528 /* Otherwise, the authentication looked good */
532 case WINBINDD_PAM_AUTH:
533 _pam_log(pamh, ctrl, LOG_NOTICE, "user '%s' granted access", user);
535 case WINBINDD_PAM_CHAUTHTOK:
536 _pam_log(pamh, ctrl, LOG_NOTICE, "user '%s' password changed", user);
539 _pam_log(pamh, ctrl, LOG_NOTICE, "user '%s' OK", user);
545 /* we don't know anything about this return value */
546 _pam_log(pamh, ctrl, LOG_ERR, "internal module error (retval = %d, user = '%s')",
553 * send a password expiry message if required
555 * @param pamh PAM handle
556 * @param ctrl PAM winbind options.
557 * @param next_change expected (calculated) next expiry date.
558 * @param already_expired pointer to a boolean to indicate if the password is
561 * @return boolean Returns True if message has been sent, False if not.
564 static BOOL _pam_send_password_expiry_message(pam_handle_t *pamh,
569 BOOL *already_expired)
572 struct tm tm_now, tm_next_change;
574 if (already_expired) {
575 *already_expired = False;
578 if (next_change <= now) {
579 PAM_WB_REMARK_DIRECT(pamh, ctrl, "NT_STATUS_PASSWORD_EXPIRED");
580 if (already_expired) {
581 *already_expired = True;
586 if ((next_change < 0) ||
587 (next_change > now + warn_pwd_expire * SECONDS_PER_DAY)) {
591 if ((localtime_r(&now, &tm_now) == NULL) ||
592 (localtime_r(&next_change, &tm_next_change) == NULL)) {
596 days = (tm_next_change.tm_yday+tm_next_change.tm_year*365) - (tm_now.tm_yday+tm_now.tm_year*365);
599 _make_remark(pamh, ctrl, PAM_TEXT_INFO, "Your password expires today");
603 if (days > 0 && days < warn_pwd_expire) {
604 _make_remark_format(pamh, ctrl, PAM_TEXT_INFO, "Your password will expire in %d %s",
605 days, (days > 1) ? "days":"day");
613 * Send a warning if the password expires in the near future
615 * @param pamh PAM handle
616 * @param ctrl PAM winbind options.
617 * @param response The full authentication response structure.
618 * @param already_expired boolean, is the pwd already expired?
623 static void _pam_warn_password_expiry(pam_handle_t *pamh,
625 const struct winbindd_response *response,
627 BOOL *already_expired)
629 time_t now = time(NULL);
630 time_t next_change = 0;
632 if (already_expired) {
633 *already_expired = False;
636 /* accounts with ACB_PWNOEXP set never receive a warning */
637 if (response->data.auth.info3.acct_flags & ACB_PWNOEXP) {
641 /* no point in sending a warning if this is a grace logon */
642 if (PAM_WB_GRACE_LOGON(response->data.auth.info3.user_flgs)) {
646 /* check if the info3 must change timestamp has been set */
647 next_change = response->data.auth.info3.pass_must_change_time;
649 if (_pam_send_password_expiry_message(pamh, flags, next_change, now,
655 /* now check for the global password policy */
656 /* good catch from Ralf Haferkamp: an expiry of "never" is translated
658 if (response->data.auth.policy.expire <= 0) {
662 next_change = response->data.auth.info3.pass_last_set_time +
663 response->data.auth.policy.expire;
665 if (_pam_send_password_expiry_message(pamh, flags, next_change, now,
671 /* no warning sent */
674 #define IS_SID_STRING(name) (strncmp("S-", name, 2) == 0)
676 static BOOL safe_append_string(char *dest,
678 int dest_buffer_size)
680 * Append a string, making sure not to overflow and to always return a NULL-terminated
683 * @param dest Destination string buffer (must already be NULL-terminated).
684 * @param src Source string buffer.
685 * @param dest_buffer_size Size of dest buffer in bytes.
687 * @return False if dest buffer is not big enough (no bytes copied), True on success.
690 int dest_length = strlen(dest);
691 int src_length = strlen(src);
693 if ( dest_length + src_length + 1 > dest_buffer_size ) {
697 memcpy(dest + dest_length, src, src_length + 1);
701 static BOOL winbind_name_to_sid_string(pam_handle_t *pamh,
705 char *sid_list_buffer,
706 int sid_list_buffer_size)
708 * Convert a names into a SID string, appending it to a buffer.
710 * @param pamh PAM handle
711 * @param ctrl PAM winbind options.
712 * @param user User in PAM request.
713 * @param name Name to convert.
714 * @param sid_list_buffer Where to append the string sid.
715 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
717 * @return False on failure, True on success.
720 const char* sid_string;
721 struct winbindd_response sid_response;
724 if (IS_SID_STRING(name)) {
727 struct winbindd_request sid_request;
729 ZERO_STRUCT(sid_request);
730 ZERO_STRUCT(sid_response);
732 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "no sid given, looking up: %s\n", name);
734 /* fortunatly winbindd can handle non-separated names */
735 strncpy(sid_request.data.name.name, name,
736 sizeof(sid_request.data.name.name) - 1);
738 if (pam_winbind_request_log(pamh, ctrl, WINBINDD_LOOKUPNAME, &sid_request, &sid_response, user)) {
739 _pam_log(pamh, ctrl, LOG_INFO, "could not lookup name: %s\n", name);
743 sid_string = sid_response.data.sid.sid;
746 if (!safe_append_string(sid_list_buffer, sid_string, sid_list_buffer_size)) {
753 static BOOL winbind_name_list_to_sid_string_list(pam_handle_t *pamh,
756 const char *name_list,
757 char *sid_list_buffer,
758 int sid_list_buffer_size)
760 * Convert a list of names into a list of sids.
762 * @param pamh PAM handle
763 * @param ctrl PAM winbind options.
764 * @param user User in PAM request.
765 * @param name_list List of names or string sids, separated by commas.
766 * @param sid_list_buffer Where to put the list of string sids.
767 * @param sid_list_buffer Size of sid_list_buffer (in bytes).
769 * @return False on failure, True on success.
773 char *current_name = NULL;
774 const char *search_location;
777 if ( sid_list_buffer_size > 0 ) {
778 sid_list_buffer[0] = 0;
781 search_location = name_list;
782 while ( (comma = strstr(search_location, ",")) != NULL ) {
783 current_name = strndup(search_location, comma - search_location);
784 if (NULL == current_name) {
788 if (!winbind_name_to_sid_string(pamh, ctrl, user, current_name, sid_list_buffer, sid_list_buffer_size)) {
792 SAFE_FREE(current_name);
794 if (!safe_append_string(sid_list_buffer, ",", sid_list_buffer_size)) {
798 search_location = comma + 1;
801 if (!winbind_name_to_sid_string(pamh, ctrl, user, search_location, sid_list_buffer, sid_list_buffer_size)) {
808 SAFE_FREE(current_name);
813 * put krb5ccname variable into environment
815 * @param pamh PAM handle
816 * @param ctrl PAM winbind options.
817 * @param krb5ccname env variable retrieved from winbindd.
822 static void _pam_setup_krb5_env(pam_handle_t *pamh, int ctrl, const char *krb5ccname)
827 if (off(ctrl, WINBIND_KRB5_AUTH)) {
831 if (!krb5ccname || (strlen(krb5ccname) == 0)) {
835 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "request returned KRB5CCNAME: %s", krb5ccname);
837 if (snprintf(var, sizeof(var), "KRB5CCNAME=%s", krb5ccname) == -1) {
841 ret = pam_putenv(pamh, var);
843 _pam_log(pamh, ctrl, LOG_ERR, "failed to set KRB5CCNAME to %s: %s",
844 var, pam_strerror(pamh, ret));
849 * Set string into the PAM stack.
851 * @param pamh PAM handle
852 * @param ctrl PAM winbind options.
853 * @param data_name Key name for pam_set_data.
854 * @param value String value.
859 static void _pam_set_data_string(pam_handle_t *pamh, int ctrl, const char *data_name, const char *value)
863 if ( !data_name || !value || (strlen(data_name) == 0) || (strlen(value) == 0) ) {
867 ret = pam_set_data(pamh, data_name, (void *)strdup(value), _pam_winbind_cleanup_func);
869 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "Could not set data %s: %s\n",
870 data_name, pam_strerror(pamh, ret));
876 * Set info3 strings into the PAM stack.
878 * @param pamh PAM handle
879 * @param ctrl PAM winbind options.
880 * @param data_name Key name for pam_set_data.
881 * @param value String value.
886 static void _pam_set_data_info3(pam_handle_t *pamh, int ctrl, struct winbindd_response *response)
888 _pam_set_data_string(pamh, ctrl, PAM_WINBIND_HOMEDIR, response->data.auth.info3.home_dir);
889 _pam_set_data_string(pamh, ctrl, PAM_WINBIND_LOGONSCRIPT, response->data.auth.info3.logon_script);
890 _pam_set_data_string(pamh, ctrl, PAM_WINBIND_LOGONSERVER, response->data.auth.info3.logon_srv);
891 _pam_set_data_string(pamh, ctrl, PAM_WINBIND_PROFILEPATH, response->data.auth.info3.profile_path);
895 * Free info3 strings in the PAM stack.
897 * @param pamh PAM handle
902 static void _pam_free_data_info3(pam_handle_t *pamh)
904 pam_set_data(pamh, PAM_WINBIND_HOMEDIR, NULL, NULL);
905 pam_set_data(pamh, PAM_WINBIND_LOGONSCRIPT, NULL, NULL);
906 pam_set_data(pamh, PAM_WINBIND_LOGONSERVER, NULL, NULL);
907 pam_set_data(pamh, PAM_WINBIND_PROFILEPATH, NULL, NULL);
911 * Send PAM_ERROR_MSG for cached or grace logons.
913 * @param pamh PAM handle
914 * @param ctrl PAM winbind options.
915 * @param username User in PAM request.
916 * @param info3_user_flgs Info3 flags containing logon type bits.
921 static void _pam_warn_logon_type(pam_handle_t *pamh, int ctrl, const char *username, uint32 info3_user_flgs)
923 /* inform about logon type */
924 if (PAM_WB_GRACE_LOGON(info3_user_flgs)) {
926 _make_remark(pamh, ctrl, PAM_ERROR_MSG,
927 "Grace login. Please change your password as soon you're online again");
928 _pam_log_debug(pamh, ctrl, LOG_DEBUG,
929 "User %s logged on using grace logon\n", username);
931 } else if (PAM_WB_CACHED_LOGON(info3_user_flgs)) {
933 _make_remark(pamh, ctrl, PAM_ERROR_MSG,
934 "Domain Controller unreachable, using cached credentials instead. Network resources may be unavailable");
935 _pam_log_debug(pamh, ctrl, LOG_DEBUG,
936 "User %s logged on using cached credentials\n", username);
941 * Send PAM_ERROR_MSG for krb5 errors.
943 * @param pamh PAM handle
944 * @param ctrl PAM winbind options.
945 * @param username User in PAM request.
946 * @param info3_user_flgs Info3 flags containing logon type bits.
951 static void _pam_warn_krb5_failure(pam_handle_t *pamh, int ctrl, const char *username, uint32 info3_user_flgs)
953 if (PAM_WB_KRB5_CLOCK_SKEW(info3_user_flgs)) {
954 _make_remark(pamh, ctrl, PAM_ERROR_MSG,
955 "Failed to establish your Kerberos Ticket cache "
956 "due time differences\n"
957 "with the domain controller. "
958 "Please verify the system time.\n");
959 _pam_log_debug(pamh, ctrl, LOG_DEBUG,
960 "User %s: Clock skew when getting Krb5 TGT\n", username);
965 * Compose Password Restriction String for a PAM_ERROR_MSG conversation.
967 * @param response The struct winbindd_response.
969 * @return string (caller needs to free).
972 static char *_pam_compose_pwd_restriction_string(struct winbindd_response *response)
975 size_t offset = 0, ret = 0, str_size = 1024;
977 str = (char *)malloc(str_size);
982 memset(str, '\0', str_size);
984 offset = snprintf(str, str_size, "Your password ");
989 if (response->data.auth.policy.min_length_password > 0) {
990 ret = snprintf(str+offset, str_size-offset,
991 "must be at least %d characters; ",
992 response->data.auth.policy.min_length_password);
999 if (response->data.auth.policy.password_history > 0) {
1000 ret = snprintf(str+offset, str_size-offset,
1001 "cannot repeat any of your previous %d passwords; ",
1002 response->data.auth.policy.password_history);
1009 if (response->data.auth.policy.password_properties & DOMAIN_PASSWORD_COMPLEX) {
1010 ret = snprintf(str+offset, str_size-offset,
1011 "must contain capitals, numerals or punctuation; "
1012 "and cannot contain your account or full name; ");
1019 ret = snprintf(str+offset, str_size-offset,
1020 "Please type a different password. "
1021 "Type a password which meets these requirements in both text boxes.");
1033 /* talk to winbindd */
1034 static int winbind_auth_request(pam_handle_t * pamh,
1040 const int warn_pwd_expire,
1041 struct winbindd_response *p_response,
1042 time_t *pwd_last_set,
1045 struct winbindd_request request;
1046 struct winbindd_response response;
1048 BOOL already_expired = False;
1050 ZERO_STRUCT(request);
1051 ZERO_STRUCT(response);
1057 strncpy(request.data.auth.user, user,
1058 sizeof(request.data.auth.user)-1);
1060 strncpy(request.data.auth.pass, pass,
1061 sizeof(request.data.auth.pass)-1);
1063 request.data.auth.krb5_cc_type[0] = '\0';
1064 request.data.auth.uid = -1;
1066 request.flags = WBFLAG_PAM_INFO3_TEXT | WBFLAG_PAM_CONTACT_TRUSTDOM;
1068 if (ctrl & (WINBIND_KRB5_AUTH|WINBIND_CACHED_LOGIN)) {
1069 struct passwd *pwd = NULL;
1071 pwd = getpwnam(user);
1073 return PAM_USER_UNKNOWN;
1075 request.data.auth.uid = pwd->pw_uid;
1078 if (ctrl & WINBIND_KRB5_AUTH) {
1080 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "enabling krb5 login flag\n");
1082 request.flags |= WBFLAG_PAM_KRB5 | WBFLAG_PAM_FALLBACK_AFTER_KRB5;
1085 if (ctrl & WINBIND_CACHED_LOGIN) {
1086 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "enabling cached login flag\n");
1087 request.flags |= WBFLAG_PAM_CACHED_LOGIN;
1092 request.flags |= WBFLAG_PAM_UNIX_NAME;
1095 if (cctype != NULL) {
1096 strncpy(request.data.auth.krb5_cc_type, cctype,
1097 sizeof(request.data.auth.krb5_cc_type) - 1);
1098 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "enabling request for a %s krb5 ccache\n", cctype);
1101 request.data.auth.require_membership_of_sid[0] = '\0';
1103 if (member != NULL) {
1105 if (!winbind_name_list_to_sid_string_list(pamh, ctrl, user, member,
1106 request.data.auth.require_membership_of_sid,
1107 sizeof(request.data.auth.require_membership_of_sid))) {
1109 _pam_log_debug(pamh, ctrl, LOG_ERR, "failed to serialize membership of sid \"%s\"\n", member);
1110 return PAM_AUTH_ERR;
1114 ret = pam_winbind_request_log(pamh, ctrl, WINBINDD_PAM_AUTH, &request, &response, user);
1117 *pwd_last_set = response.data.auth.info3.pass_last_set_time;
1121 /* We want to process the response in the caller. */
1122 *p_response = response;
1127 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_PASSWORD_EXPIRED");
1128 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_PASSWORD_MUST_CHANGE");
1129 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_INVALID_WORKSTATION");
1130 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_INVALID_LOGON_HOURS");
1131 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_ACCOUNT_EXPIRED");
1132 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_ACCOUNT_DISABLED");
1133 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_ACCOUNT_LOCKED_OUT");
1134 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_NOLOGON_WORKSTATION_TRUST_ACCOUNT");
1135 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_NOLOGON_SERVER_TRUST_ACCOUNT");
1136 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT");
1137 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND");
1138 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_NO_LOGON_SERVERS");
1139 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_WRONG_PASSWORD");
1140 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_ACCESS_DENIED");
1143 if (ret == PAM_SUCCESS) {
1145 /* warn a user if the password is about to expire soon */
1146 _pam_warn_password_expiry(pamh, ctrl, &response,
1150 if (already_expired == True) {
1151 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "Password has expired "
1152 "(Password was last set: %lld, the policy says "
1153 "it should expire here %lld (now it's: %lu))\n",
1154 response.data.auth.info3.pass_last_set_time,
1155 response.data.auth.info3.pass_last_set_time +
1156 response.data.auth.policy.expire,
1159 return PAM_AUTHTOK_EXPIRED;
1162 /* inform about logon type */
1163 _pam_warn_logon_type(pamh, ctrl, user, response.data.auth.info3.user_flgs);
1165 /* inform about krb5 failures */
1166 _pam_warn_krb5_failure(pamh, ctrl, user, response.data.auth.info3.user_flgs);
1168 /* set some info3 info for other modules in the stack */
1169 _pam_set_data_info3(pamh, ctrl, &response);
1171 /* put krb5ccname into env */
1172 _pam_setup_krb5_env(pamh, ctrl, response.data.auth.krb5ccname);
1174 /* If winbindd returned a username, return the pointer to it here. */
1175 if (user_ret && response.extra_data.data) {
1176 /* We have to trust it's a null terminated string. */
1177 *user_ret = (char *)response.extra_data.data;
1184 /* talk to winbindd */
1185 static int winbind_chauthtok_request(pam_handle_t * pamh,
1188 const char *oldpass,
1189 const char *newpass,
1190 time_t pwd_last_set)
1192 struct winbindd_request request;
1193 struct winbindd_response response;
1196 ZERO_STRUCT(request);
1197 ZERO_STRUCT(response);
1199 if (request.data.chauthtok.user == NULL) return -2;
1201 strncpy(request.data.chauthtok.user, user,
1202 sizeof(request.data.chauthtok.user) - 1);
1204 if (oldpass != NULL) {
1205 strncpy(request.data.chauthtok.oldpass, oldpass,
1206 sizeof(request.data.chauthtok.oldpass) - 1);
1208 request.data.chauthtok.oldpass[0] = '\0';
1211 if (newpass != NULL) {
1212 strncpy(request.data.chauthtok.newpass, newpass,
1213 sizeof(request.data.chauthtok.newpass) - 1);
1215 request.data.chauthtok.newpass[0] = '\0';
1218 if (ctrl & WINBIND_KRB5_AUTH) {
1219 request.flags = WBFLAG_PAM_KRB5 | WBFLAG_PAM_CONTACT_TRUSTDOM;
1222 ret = pam_winbind_request_log(pamh, ctrl, WINBINDD_PAM_CHAUTHTOK, &request, &response, user);
1224 if (ret == PAM_SUCCESS) {
1228 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_BACKUP_CONTROLLER");
1229 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND");
1230 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_NO_LOGON_SERVERS");
1231 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_ACCESS_DENIED");
1233 /* TODO: tell the min pwd length ? */
1234 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_PWD_TOO_SHORT");
1236 /* TODO: tell the minage ? */
1237 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_PWD_TOO_RECENT");
1239 /* TODO: tell the history length ? */
1240 PAM_WB_REMARK_CHECK_RESPONSE_RET(pamh, ctrl, response, "NT_STATUS_PWD_HISTORY_CONFLICT");
1242 if (!strcasecmp(response.data.auth.nt_status_string, "NT_STATUS_PASSWORD_RESTRICTION")) {
1244 char *pwd_restriction_string = NULL;
1246 /* FIXME: avoid to send multiple PAM messages after another */
1247 switch (response.data.auth.reject_reason) {
1250 case REJECT_REASON_OTHER:
1251 if ((response.data.auth.policy.min_passwordage > 0) &&
1252 (pwd_last_set + response.data.auth.policy.min_passwordage > time(NULL))) {
1253 PAM_WB_REMARK_DIRECT(pamh, ctrl, "NT_STATUS_PWD_TOO_RECENT");
1256 case REJECT_REASON_TOO_SHORT:
1257 PAM_WB_REMARK_DIRECT(pamh, ctrl, "NT_STATUS_PWD_TOO_SHORT");
1259 case REJECT_REASON_IN_HISTORY:
1260 PAM_WB_REMARK_DIRECT(pamh, ctrl, "NT_STATUS_PWD_HISTORY_CONFLICT");
1262 case REJECT_REASON_NOT_COMPLEX:
1263 _make_remark(pamh, ctrl, PAM_ERROR_MSG, "Password does not meet complexity requirements");
1266 _pam_log_debug(pamh, ctrl, LOG_DEBUG,
1267 "unknown password change reject reason: %d",
1268 response.data.auth.reject_reason);
1272 pwd_restriction_string = _pam_compose_pwd_restriction_string(&response);
1273 if (pwd_restriction_string) {
1274 _make_remark(pamh, ctrl, PAM_ERROR_MSG, pwd_restriction_string);
1275 SAFE_FREE(pwd_restriction_string);
1283 * Checks if a user has an account
1286 * 1 = User not found
1290 static int valid_user(pam_handle_t *pamh, int ctrl, const char *user)
1292 /* check not only if the user is available over NSS calls, also make
1293 * sure it's really a winbind user, this is important when stacking PAM
1294 * modules in the 'account' or 'password' facility. */
1296 struct passwd *pwd = NULL;
1297 struct winbindd_request request;
1298 struct winbindd_response response;
1301 ZERO_STRUCT(request);
1302 ZERO_STRUCT(response);
1304 pwd = getpwnam(user);
1309 strncpy(request.data.username, user,
1310 sizeof(request.data.username) - 1);
1312 ret = pam_winbind_request_log(pamh, ctrl, WINBINDD_GETPWNAM, &request, &response, user);
1315 case PAM_USER_UNKNOWN:
1325 static char *_pam_delete(register char *xx)
1333 * obtain a password from the user
1336 static int _winbind_read_password(pam_handle_t * pamh,
1338 const char *comment,
1339 const char *prompt1,
1340 const char *prompt2,
1348 _pam_log(pamh, ctrl, LOG_DEBUG, "getting password (0x%08x)", ctrl);
1351 * make sure nothing inappropriate gets returned
1354 *pass = token = NULL;
1357 * which authentication token are we getting?
1360 authtok_flag = on(WINBIND__OLD_PASSWORD, ctrl) ? PAM_OLDAUTHTOK : PAM_AUTHTOK;
1363 * should we obtain the password from a PAM item ?
1366 if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) || on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
1367 retval = _pam_get_item(pamh, authtok_flag, &item);
1368 if (retval != PAM_SUCCESS) {
1370 _pam_log(pamh, ctrl, LOG_ALERT,
1371 "pam_get_item returned error to unix-read-password"
1374 } else if (item != NULL) { /* we have a password! */
1377 _pam_log(pamh, ctrl, LOG_DEBUG,
1378 "pam_get_item returned a password");
1380 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
1381 return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
1382 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
1383 && off(WINBIND__OLD_PASSWORD, ctrl)) {
1384 return PAM_AUTHTOK_RECOVER_ERR;
1388 * getting here implies we will have to get the password from the
1393 struct pam_message msg[3], *pmsg[3];
1394 struct pam_response *resp;
1397 /* prepare to converse */
1399 if (comment != NULL && off(ctrl, WINBIND_SILENT)) {
1401 msg[0].msg_style = PAM_TEXT_INFO;
1402 msg[0].msg = CONST_DISCARD(char *, comment);
1409 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
1410 msg[i++].msg = CONST_DISCARD(char *, prompt1);
1413 if (prompt2 != NULL) {
1415 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
1416 msg[i++].msg = CONST_DISCARD(char *, prompt2);
1419 /* so call the conversation expecting i responses */
1421 retval = converse(pamh, i, pmsg, &resp);
1425 /* interpret the response */
1427 if (retval == PAM_SUCCESS) { /* a good conversation */
1429 token = x_strdup(resp[i - replies].resp);
1430 if (token != NULL) {
1432 /* verify that password entered correctly */
1433 if (!resp[i - 1].resp
1434 || strcmp(token, resp[i - 1].resp)) {
1435 _pam_delete(token); /* mistyped */
1436 retval = PAM_AUTHTOK_RECOVER_ERR;
1437 _make_remark(pamh, ctrl, PAM_ERROR_MSG, MISTYPED_PASS);
1441 _pam_log(pamh, ctrl, LOG_NOTICE, "could not recover authentication token");
1442 retval = PAM_AUTHTOK_RECOVER_ERR;
1447 * tidy up the conversation (resp_retcode) is ignored
1448 * -- what is it for anyway? AGM
1451 _pam_drop_reply(resp, i);
1454 retval = (retval == PAM_SUCCESS)
1455 ? PAM_AUTHTOK_RECOVER_ERR : retval;
1459 if (retval != PAM_SUCCESS) {
1460 _pam_log_debug(pamh, ctrl, LOG_DEBUG,
1461 "unable to obtain a password");
1464 /* 'token' is the entered password */
1466 /* we store this password as an item */
1468 retval = pam_set_item(pamh, authtok_flag, token);
1469 _pam_delete(token); /* clean it up */
1470 if (retval != PAM_SUCCESS ||
1471 (retval = _pam_get_item(pamh, authtok_flag, &item)) != PAM_SUCCESS) {
1473 _pam_log(pamh, ctrl, LOG_CRIT, "error manipulating password");
1479 item = NULL; /* break link to password */
1484 const char *get_conf_item_string(const pam_handle_t *pamh,
1493 const char *parm_opt = NULL;
1495 if (!(ctrl & config_flag)) {
1499 /* let the pam opt take precedence over the pam_winbind.conf option */
1500 for ( i=0; i<argc; i++ ) {
1502 if ((strncmp(argv[i], item, strlen(item)) == 0)) {
1505 if ( (p = strchr( argv[i], '=' )) == NULL) {
1506 _pam_log(pamh, ctrl, LOG_INFO, "no \"=\" delimiter for \"%s\" found\n", item);
1509 _pam_log_debug(pamh, ctrl, LOG_INFO, "PAM config: %s '%s'\n", item, p+1);
1517 if (!asprintf(&key, "global:%s", item)) {
1521 parm_opt = iniparser_getstr(d, key);
1524 _pam_log_debug(pamh, ctrl, LOG_INFO, "CONFIG file: %s '%s'\n", item, parm_opt);
1530 int get_config_item_int(const pam_handle_t *pamh,
1537 int i, parm_opt = -1;
1539 /* let the pam opt take precedence over the pam_winbind.conf option */
1540 for (i = 0; i < argc; i++) {
1542 if ((strncmp(argv[i], item, strlen(item)) == 0)) {
1545 if ( (p = strchr( argv[i], '=' )) == NULL) {
1546 _pam_log(pamh, ctrl, LOG_INFO,
1547 "no \"=\" delimiter for \"%s\" found\n",
1551 parm_opt = atoi(p + 1);
1552 _pam_log_debug(pamh, ctrl, LOG_INFO,
1553 "PAM config: %s '%d'\n",
1562 if (!asprintf(&key, "global:%s", item)) {
1566 parm_opt = iniparser_getint(d, key, -1);
1569 _pam_log_debug(pamh, ctrl, LOG_INFO,
1570 "CONFIG file: %s '%d'\n",
1577 const char *get_krb5_cc_type_from_config(const pam_handle_t *pamh, int argc, const char **argv, int ctrl, dictionary *d)
1579 return get_conf_item_string(pamh, argc, argv, ctrl, d, "krb5_ccache_type", WINBIND_KRB5_CCACHE_TYPE);
1582 const char *get_member_from_config(const pam_handle_t *pamh, int argc, const char **argv, int ctrl, dictionary *d)
1584 const char *ret = NULL;
1585 ret = get_conf_item_string(pamh, argc, argv, ctrl, d, "require_membership_of", WINBIND_REQUIRED_MEMBERSHIP);
1589 return get_conf_item_string(pamh, argc, argv, ctrl, d, "require-membership-of", WINBIND_REQUIRED_MEMBERSHIP);
1592 int get_warn_pwd_expire_from_config(const pam_handle_t *pamh,
1599 ret = get_config_item_int(pamh, argc, argv, ctrl, d,
1601 /* no or broken setting */
1603 return DEFAULT_DAYS_TO_WARN_BEFORE_PWD_EXPIRES;
1609 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
1610 int argc, const char **argv)
1612 const char *username;
1613 const char *password;
1614 const char *member = NULL;
1615 const char *cctype = NULL;
1616 int warn_pwd_expire;
1617 int retval = PAM_AUTH_ERR;
1618 dictionary *d = NULL;
1619 char *username_ret = NULL;
1620 char *new_authtok_required = NULL;
1621 char *real_username = NULL;
1623 /* parse arguments */
1624 int ctrl = _pam_parse(pamh, flags, argc, argv, &d);
1626 retval = PAM_SYSTEM_ERR;
1630 _PAM_LOG_FUNCTION_ENTER("pam_sm_authenticate", pamh, ctrl, flags);
1632 /* Get the username */
1633 retval = pam_get_user(pamh, &username, NULL);
1634 if ((retval != PAM_SUCCESS) || (!username)) {
1635 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "can not get the username");
1636 retval = PAM_SERVICE_ERR;
1641 /* Decode the user name since AIX does not support logn user
1642 names by default. The name is encoded as _#uid. */
1644 if ( username[0] == '_' ) {
1645 uid_t id = atoi( &username[1] );
1646 struct passwd *pw = NULL;
1648 if ( (id!=0) && ((pw = getpwuid( id )) != NULL) ) {
1649 real_username = strdup( pw->pw_name );
1654 if ( !real_username ) {
1655 /* Just making a copy of the username we got from PAM */
1656 if ( (real_username = strdup( username )) == NULL ) {
1657 _pam_log_debug(pamh, ctrl, LOG_DEBUG,
1658 "memory allocation failure when copying username");
1659 retval = PAM_SERVICE_ERR;
1664 retval = _winbind_read_password(pamh, ctrl, NULL,
1668 if (retval != PAM_SUCCESS) {
1669 _pam_log(pamh, ctrl, LOG_ERR, "Could not retrieve user's password");
1670 retval = PAM_AUTHTOK_ERR;
1674 /* Let's not give too much away in the log file */
1676 #ifdef DEBUG_PASSWORD
1677 _pam_log_debug(pamh, ctrl, LOG_INFO, "Verify user '%s' with password '%s'",
1678 real_username, password);
1680 _pam_log_debug(pamh, ctrl, LOG_INFO, "Verify user '%s'", real_username);
1683 member = get_member_from_config(pamh, argc, argv, ctrl, d);
1685 cctype = get_krb5_cc_type_from_config(pamh, argc, argv, ctrl, d);
1687 warn_pwd_expire = get_warn_pwd_expire_from_config(pamh, argc, argv,
1690 /* Now use the username to look up password */
1691 retval = winbind_auth_request(pamh, ctrl, username, password, member,
1692 cctype, warn_pwd_expire, NULL, NULL,
1695 if (retval == PAM_NEW_AUTHTOK_REQD ||
1696 retval == PAM_AUTHTOK_EXPIRED) {
1698 char *new_authtok_required_during_auth = NULL;
1700 if (!asprintf(&new_authtok_required, "%d", retval)) {
1701 retval = PAM_BUF_ERR;
1705 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, new_authtok_required, _pam_winbind_cleanup_func);
1707 retval = PAM_SUCCESS;
1709 if (!asprintf(&new_authtok_required_during_auth, "%d", True)) {
1710 retval = PAM_BUF_ERR;
1714 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH,
1715 new_authtok_required_during_auth, _pam_winbind_cleanup_func);
1722 pam_set_item (pamh, PAM_USER, username_ret);
1723 _pam_log_debug(pamh, ctrl, LOG_INFO, "Returned user was '%s'", username_ret);
1727 if ( real_username ) {
1728 free( real_username );
1732 iniparser_freedict(d);
1735 if (!new_authtok_required) {
1736 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, NULL, NULL);
1739 if (retval != PAM_SUCCESS) {
1740 _pam_free_data_info3(pamh);
1743 _PAM_LOG_FUNCTION_LEAVE("pam_sm_authenticate", pamh, ctrl, retval);
1749 int pam_sm_setcred(pam_handle_t *pamh, int flags,
1750 int argc, const char **argv)
1752 int ret = PAM_SYSTEM_ERR;
1753 dictionary *d = NULL;
1755 /* parse arguments */
1756 int ctrl = _pam_parse(pamh, flags, argc, argv, &d);
1758 ret = PAM_SYSTEM_ERR;
1762 _PAM_LOG_FUNCTION_ENTER("pam_sm_setcred", pamh, ctrl, flags);
1764 switch (flags & ~PAM_SILENT) {
1766 case PAM_DELETE_CRED:
1767 ret = pam_sm_close_session(pamh, flags, argc, argv);
1769 case PAM_REFRESH_CRED:
1770 _pam_log_debug(pamh, ctrl, LOG_WARNING, "PAM_REFRESH_CRED not implemented");
1773 case PAM_REINITIALIZE_CRED:
1774 _pam_log_debug(pamh, ctrl, LOG_WARNING, "PAM_REINITIALIZE_CRED not implemented");
1777 case PAM_ESTABLISH_CRED:
1778 _pam_log_debug(pamh, ctrl, LOG_WARNING, "PAM_ESTABLISH_CRED not implemented");
1782 ret = PAM_SYSTEM_ERR;
1788 iniparser_freedict(d);
1791 _PAM_LOG_FUNCTION_LEAVE("pam_sm_setcred", pamh, ctrl, ret);
1797 * Account management. We want to verify that the account exists
1798 * before returning PAM_SUCCESS
1801 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
1802 int argc, const char **argv)
1804 const char *username;
1805 int ret = PAM_USER_UNKNOWN;
1807 dictionary *d = NULL;
1809 /* parse arguments */
1810 int ctrl = _pam_parse(pamh, flags, argc, argv, &d);
1812 return PAM_SYSTEM_ERR;
1815 _PAM_LOG_FUNCTION_ENTER("pam_sm_acct_mgmt", pamh, ctrl, flags);
1818 /* Get the username */
1819 ret = pam_get_user(pamh, &username, NULL);
1820 if ((ret != PAM_SUCCESS) || (!username)) {
1821 _pam_log_debug(pamh, ctrl, LOG_DEBUG,"can not get the username");
1822 ret = PAM_SERVICE_ERR;
1826 /* Verify the username */
1827 ret = valid_user(pamh, ctrl, username);
1830 /* some sort of system error. The log was already printed */
1831 ret = PAM_SERVICE_ERR;
1834 /* the user does not exist */
1835 _pam_log_debug(pamh, ctrl, LOG_NOTICE, "user '%s' not found", username);
1836 if (ctrl & WINBIND_UNKNOWN_OK_ARG) {
1840 ret = PAM_USER_UNKNOWN;
1843 pam_get_data( pamh, PAM_WINBIND_NEW_AUTHTOK_REQD, (const void **)&tmp);
1845 ret = atoi((const char *)tmp);
1847 case PAM_AUTHTOK_EXPIRED:
1848 /* fall through, since new token is required in this case */
1849 case PAM_NEW_AUTHTOK_REQD:
1850 _pam_log(pamh, ctrl, LOG_WARNING, "pam_sm_acct_mgmt success but %s is set",
1851 PAM_WINBIND_NEW_AUTHTOK_REQD);
1852 _pam_log(pamh, ctrl, LOG_NOTICE, "user '%s' needs new password", username);
1853 /* PAM_AUTHTOKEN_REQD does not exist, but is documented in the manpage */
1854 ret = PAM_NEW_AUTHTOK_REQD;
1857 _pam_log(pamh, ctrl, LOG_WARNING, "pam_sm_acct_mgmt success");
1858 _pam_log(pamh, ctrl, LOG_NOTICE, "user '%s' granted access", username);
1864 /* Otherwise, the authentication looked good */
1865 _pam_log(pamh, ctrl, LOG_NOTICE, "user '%s' granted access", username);
1869 /* we don't know anything about this return value */
1870 _pam_log(pamh, ctrl, LOG_ERR, "internal module error (ret = %d, user = '%s')",
1872 ret = PAM_SERVICE_ERR;
1876 /* should not be reached */
1882 iniparser_freedict(d);
1885 _PAM_LOG_FUNCTION_LEAVE("pam_sm_acct_mgmt", pamh, ctrl, ret);
1891 int pam_sm_open_session(pam_handle_t *pamh, int flags,
1892 int argc, const char **argv)
1894 int ret = PAM_SYSTEM_ERR;
1895 dictionary *d = NULL;
1897 /* parse arguments */
1898 int ctrl = _pam_parse(pamh, flags, argc, argv, &d);
1900 ret = PAM_SYSTEM_ERR;
1904 _PAM_LOG_FUNCTION_ENTER("pam_sm_open_session", pamh, ctrl, flags);
1910 iniparser_freedict(d);
1913 _PAM_LOG_FUNCTION_LEAVE("pam_sm_open_session", pamh, ctrl, ret);
1919 int pam_sm_close_session(pam_handle_t *pamh, int flags,
1920 int argc, const char **argv)
1922 dictionary *d = NULL;
1923 int retval = PAM_SUCCESS;
1925 /* parse arguments */
1926 int ctrl = _pam_parse(pamh, flags, argc, argv, &d);
1928 retval = PAM_SYSTEM_ERR;
1932 _PAM_LOG_FUNCTION_ENTER("pam_sm_close_session", pamh, ctrl, flags);
1934 if (!(flags & PAM_DELETE_CRED)) {
1935 retval = PAM_SUCCESS;
1939 if (ctrl & WINBIND_KRB5_AUTH) {
1941 /* destroy the ccache here */
1942 struct winbindd_request request;
1943 struct winbindd_response response;
1945 const char *ccname = NULL;
1946 struct passwd *pwd = NULL;
1948 ZERO_STRUCT(request);
1949 ZERO_STRUCT(response);
1951 retval = pam_get_user(pamh, &user, "Username: ");
1953 _pam_log(pamh, ctrl, LOG_ERR, "could not identify user");
1958 _pam_log(pamh, ctrl, LOG_ERR, "username was NULL!");
1959 retval = PAM_USER_UNKNOWN;
1963 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "username [%s] obtained", user);
1965 ccname = pam_getenv(pamh, "KRB5CCNAME");
1966 if (ccname == NULL) {
1967 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "user has no KRB5CCNAME environment");
1970 strncpy(request.data.logoff.user, user,
1971 sizeof(request.data.logoff.user) - 1);
1974 strncpy(request.data.logoff.krb5ccname, ccname,
1975 sizeof(request.data.logoff.krb5ccname) - 1);
1978 pwd = getpwnam(user);
1980 retval = PAM_USER_UNKNOWN;
1983 request.data.logoff.uid = pwd->pw_uid;
1985 request.flags = WBFLAG_PAM_KRB5 | WBFLAG_PAM_CONTACT_TRUSTDOM;
1987 retval = pam_winbind_request_log(pamh, ctrl, WINBINDD_PAM_LOGOFF, &request, &response, user);
1992 iniparser_freedict(d);
1995 _PAM_LOG_FUNCTION_LEAVE("pam_sm_close_session", pamh, ctrl, retval);
2001 * evaluate whether we need to re-authenticate with kerberos after a password change
2003 * @param pamh PAM handle
2004 * @param ctrl PAM winbind options.
2005 * @param user The username
2007 * @return boolean Returns True if required, False if not.
2010 static BOOL _pam_require_krb5_auth_after_chauthtok(pam_handle_t *pamh, int ctrl, const char *user)
2013 /* Make sure that we only do this if
2014 * a) the chauthtok got initiated during a logon attempt (authenticate->acct_mgmt->chauthtok)
2015 * b) any later password change via the "passwd" command if done by the user itself
2018 char *new_authtok_reqd_during_auth = NULL;
2019 struct passwd *pwd = NULL;
2021 if (!(ctrl & WINBIND_KRB5_AUTH)) {
2025 _pam_get_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH, &new_authtok_reqd_during_auth);
2026 pam_set_data(pamh, PAM_WINBIND_NEW_AUTHTOK_REQD_DURING_AUTH, NULL, NULL);
2028 if (new_authtok_reqd_during_auth) {
2032 pwd = getpwnam(user);
2037 if (getuid() == pwd->pw_uid) {
2046 int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
2047 int argc, const char **argv)
2053 /* <DO NOT free() THESE> */
2055 char *pass_old, *pass_new;
2056 /* </DO NOT free() THESE> */
2061 dictionary *d = NULL;
2062 char *username_ret = NULL;
2063 struct winbindd_response response;
2065 ZERO_STRUCT(response);
2067 ctrl = _pam_parse(pamh, flags, argc, argv, &d);
2069 ret = PAM_SYSTEM_ERR;
2073 _PAM_LOG_FUNCTION_ENTER("pam_sm_chauthtok", pamh, ctrl, flags);
2075 /* clearing offline bit for the auth in the password change */
2076 ctrl &= ~WINBIND_CACHED_LOGIN;
2079 * First get the name of a user
2081 ret = pam_get_user(pamh, &user, "Username: ");
2083 _pam_log(pamh, ctrl, LOG_ERR,
2084 "password - could not identify user");
2089 _pam_log(pamh, ctrl, LOG_ERR, "username was NULL!");
2090 ret = PAM_USER_UNKNOWN;
2094 _pam_log_debug(pamh, ctrl, LOG_DEBUG, "username [%s] obtained", user);
2096 /* check if this is really a user in winbindd, not only in NSS */
2097 ret = valid_user(pamh, ctrl, user);
2100 ret = PAM_USER_UNKNOWN;
2103 ret = PAM_SYSTEM_ERR;
2110 * obtain and verify the current password (OLDAUTHTOK) for
2114 if (flags & PAM_PRELIM_CHECK) {
2115 time_t pwdlastset_prelim = 0;
2117 /* instruct user what is happening */
2118 #define greeting "Changing password for "
2119 Announce = (char *) malloc(sizeof(greeting) + strlen(user));
2120 if (Announce == NULL) {
2121 _pam_log(pamh, ctrl, LOG_CRIT, "password - out of memory");
2125 (void) strcpy(Announce, greeting);
2126 (void) strcpy(Announce + sizeof(greeting) - 1, user);
2129 lctrl = ctrl | WINBIND__OLD_PASSWORD;
2130 ret = _winbind_read_password(pamh, lctrl,
2132 "(current) NT password: ",
2134 (const char **) &pass_old);
2135 if (ret != PAM_SUCCESS) {
2136 _pam_log(pamh, ctrl, LOG_NOTICE, "password - (old) token not obtained");
2140 /* verify that this is the password for this user */
2142 ret = winbind_auth_request(pamh, ctrl, user, pass_old,
2143 NULL, NULL, 0, &response,
2144 &pwdlastset_prelim, NULL);
2146 if (ret != PAM_ACCT_EXPIRED &&
2147 ret != PAM_AUTHTOK_EXPIRED &&
2148 ret != PAM_NEW_AUTHTOK_REQD &&
2149 ret != PAM_SUCCESS) {
2154 pam_set_data(pamh, PAM_WINBIND_PWD_LAST_SET, (void *)pwdlastset_prelim, NULL);
2156 ret = pam_set_item(pamh, PAM_OLDAUTHTOK, (const void *) pass_old);
2158 if (ret != PAM_SUCCESS) {
2159 _pam_log(pamh, ctrl, LOG_CRIT, "failed to set PAM_OLDAUTHTOK");
2161 } else if (flags & PAM_UPDATE_AUTHTOK) {
2163 time_t pwdlastset_update = 0;
2166 * obtain the proposed password
2170 * get the old token back.
2173 ret = _pam_get_item(pamh, PAM_OLDAUTHTOK, &pass_old);
2175 if (ret != PAM_SUCCESS) {
2176 _pam_log(pamh, ctrl, LOG_NOTICE, "user not authenticated");
2180 lctrl = ctrl & ~WINBIND_TRY_FIRST_PASS_ARG;
2182 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
2183 lctrl |= WINBIND_USE_FIRST_PASS_ARG;
2186 ret = PAM_AUTHTOK_ERR;
2187 while ((ret != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
2189 * use_authtok is to force the use of a previously entered
2190 * password -- needed for pluggable password strength checking
2193 ret = _winbind_read_password(pamh, lctrl,
2195 "Enter new NT password: ",
2196 "Retype new NT password: ",
2197 (const char **) &pass_new);
2199 if (ret != PAM_SUCCESS) {
2200 _pam_log_debug(pamh, ctrl, LOG_ALERT
2201 ,"password - new password not obtained");
2202 pass_old = NULL;/* tidy up */
2207 * At this point we know who the user is and what they
2208 * propose as their new password. Verify that the new
2209 * password is acceptable.
2212 if (pass_new[0] == '\0') {/* "\0" password = NULL */
2218 * By reaching here we have approved the passwords and must now
2219 * rebuild the password database file.
2221 _pam_get_data( pamh, PAM_WINBIND_PWD_LAST_SET,
2222 &pwdlastset_update);
2224 ret = winbind_chauthtok_request(pamh, ctrl, user, pass_old, pass_new, pwdlastset_update);
2226 _pam_overwrite(pass_new);
2227 _pam_overwrite(pass_old);
2228 pass_old = pass_new = NULL;
2232 if (_pam_require_krb5_auth_after_chauthtok(pamh, ctrl, user)) {
2234 const char *member = get_member_from_config(pamh, argc, argv, ctrl, d);
2235 const char *cctype = get_krb5_cc_type_from_config(pamh, argc, argv, ctrl, d);
2236 const int warn_pwd_expire =
2237 get_warn_pwd_expire_from_config(pamh, argc, argv, ctrl,
2240 ret = winbind_auth_request(pamh, ctrl, user, pass_new,
2241 member, cctype, 0, &response,
2242 NULL, &username_ret);
2243 _pam_overwrite(pass_new);
2244 _pam_overwrite(pass_old);
2245 pass_old = pass_new = NULL;
2247 if (ret == PAM_SUCCESS) {
2249 /* warn a user if the password is about to expire soon */
2250 _pam_warn_password_expiry(pamh, ctrl, &response,
2251 warn_pwd_expire , NULL);
2253 /* set some info3 info for other modules in the stack */
2254 _pam_set_data_info3(pamh, ctrl, &response);
2256 /* put krb5ccname into env */
2257 _pam_setup_krb5_env(pamh, ctrl, response.data.auth.krb5ccname);
2260 pam_set_item (pamh, PAM_USER, username_ret);
2261 _pam_log_debug(pamh, ctrl, LOG_INFO, "Returned user was '%s'", username_ret);
2269 ret = PAM_SERVICE_ERR;
2274 iniparser_freedict(d);
2277 /* Deal with offline errors. */
2278 PAM_WB_REMARK_CHECK_RESPONSE(pamh, ctrl, response, "NT_STATUS_NO_LOGON_SERVERS");
2279 PAM_WB_REMARK_CHECK_RESPONSE(pamh, ctrl, response, "NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND");
2280 PAM_WB_REMARK_CHECK_RESPONSE(pamh, ctrl, response, "NT_STATUS_ACCESS_DENIED");
2282 _PAM_LOG_FUNCTION_LEAVE("pam_sm_chauthtok", pamh, ctrl, ret);
2289 /* static module data */
2291 struct pam_module _pam_winbind_modstruct = {
2293 pam_sm_authenticate,
2296 pam_sm_open_session,
2297 pam_sm_close_session,
2304 * Copyright (c) Andrew Tridgell <tridge@samba.org> 2000
2305 * Copyright (c) Tim Potter <tpot@samba.org> 2000
2306 * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
2307 * Copyright (c) Guenther Deschner <gd@samba.org> 2005-2007
2308 * Copyright (c) Jan Rêkorajski 1999.
2309 * Copyright (c) Andrew G. Morgan 1996-8.
2310 * Copyright (c) Alex O. Yuriev, 1996.
2311 * Copyright (c) Cristian Gafton 1996.
2312 * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
2314 * Redistribution and use in source and binary forms, with or without
2315 * modification, are permitted provided that the following conditions
2317 * 1. Redistributions of source code must retain the above copyright
2318 * notice, and the entire permission notice in its entirety,
2319 * including the disclaimer of warranties.
2320 * 2. Redistributions in binary form must reproduce the above copyright
2321 * notice, this list of conditions and the following disclaimer in the
2322 * documentation and/or other materials provided with the distribution.
2323 * 3. The name of the author may not be used to endorse or promote
2324 * products derived from this software without specific prior
2325 * written permission.
2327 * ALTERNATIVELY, this product may be distributed under the terms of
2328 * the GNU Public License, in which case the provisions of the GPL are
2329 * required INSTEAD OF the above restrictions. (This clause is
2330 * necessary due to a potential bad interaction between the GPL and
2331 * the restrictions contained in a BSD-style copyright.)
2333 * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
2334 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
2335 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
2336 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
2337 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2338 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2339 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2340 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2341 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2342 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
2343 * OF THE POSSIBILITY OF SUCH DAMAGE.