3 Copyright Andrew Tridgell <tridge@samba.org> 2000
4 Copyright Tim Potter <tpot@samba.org> 2000
5 Copyright Andrew Bartlett <abartlet@samba.org> 2002
7 largely based on pam_userdb by Christian Gafton <gafton@redhat.com>
8 also contains large slabs of code from pam_unix by Elliot Lee <sopwith@redhat.com>
9 (see copyright below for full details)
12 #include "pam_winbind.h"
14 /* prototypes from common.c */
15 void init_request(struct winbindd_request *req,int rq_type);
16 int write_sock(void *buffer, int count);
17 int read_reply(struct winbindd_response *response);
21 #define MAX_PASSWD_TRIES 3
24 static void _pam_log(int err, const char *format, ...)
28 va_start(args, format);
29 openlog(MODULE_NAME, LOG_CONS|LOG_PID, LOG_AUTH);
30 vsyslog(err, format, args);
35 static int _pam_parse(int argc, const char **argv)
38 /* step through arguments */
39 for (ctrl = 0; argc-- > 0; ++argv) {
43 if (!strcmp(*argv,"debug"))
44 ctrl |= WINBIND_DEBUG_ARG;
45 else if (!strcasecmp(*argv, "use_authtok"))
46 ctrl |= WINBIND_USE_AUTHTOK_ARG;
47 else if (!strcasecmp(*argv, "use_first_pass"))
48 ctrl |= WINBIND_USE_FIRST_PASS_ARG;
49 else if (!strcasecmp(*argv, "try_first_pass"))
50 ctrl |= WINBIND_TRY_FIRST_PASS_ARG;
51 else if (!strcasecmp(*argv, "unknown_ok"))
52 ctrl |= WINBIND_UNKNOWN_OK_ARG;
54 _pam_log(LOG_ERR, "pam_parse: unknown option; %s", *argv);
61 /* --- authentication management functions --- */
63 /* Attempt a conversation */
65 static int converse(pam_handle_t *pamh, int nargs,
66 struct pam_message **message,
67 struct pam_response **response)
70 struct pam_conv *conv;
72 retval = pam_get_item(pamh, PAM_CONV, (const void **) &conv ) ;
73 if (retval == PAM_SUCCESS) {
74 retval = conv->conv(nargs, (const struct pam_message **)message,
75 response, conv->appdata_ptr);
78 return retval; /* propagate error status */
82 static int _make_remark(pam_handle_t * pamh, int type, const char *text)
84 int retval = PAM_SUCCESS;
86 struct pam_message *pmsg[1], msg[1];
87 struct pam_response *resp;
91 msg[0].msg_style = type;
94 retval = converse(pamh, 1, pmsg, &resp);
97 _pam_drop_reply(resp, 1);
102 static int winbind_request(enum winbindd_cmd req_type,
103 struct winbindd_request *request,
104 struct winbindd_response *response)
106 /* Fill in request and send down pipe */
107 init_request(request, req_type);
109 if (write_sock(request, sizeof(*request)) == -1) {
110 _pam_log(LOG_ERR, "write to socket failed!");
111 return PAM_SERVICE_ERR;
115 if (read_reply(response) == -1) {
116 _pam_log(LOG_ERR, "read from socket failed!");
117 return PAM_SERVICE_ERR;
120 /* Copy reply data from socket */
121 if (response->result != WINBINDD_OK) {
122 if (response->data.auth.pam_error != PAM_SUCCESS) {
123 _pam_log(LOG_ERR, "request failed, PAM error was %d, NT error was %s",
124 response->data.auth.pam_error,
125 response->data.auth.nt_status_string);
126 return response->data.auth.pam_error;
128 _pam_log(LOG_ERR, "request failed, but PAM error 0!");
129 return PAM_SERVICE_ERR;
136 /* talk to winbindd */
137 static int winbind_auth_request(const char *user, const char *pass, int ctrl)
139 struct winbindd_request request;
140 struct winbindd_response response;
143 ZERO_STRUCT(request);
145 strncpy(request.data.auth.user, user,
146 sizeof(request.data.auth.user)-1);
148 strncpy(request.data.auth.pass, pass,
149 sizeof(request.data.auth.pass)-1);
151 retval = winbind_request(WINBINDD_PAM_AUTH, &request, &response);
155 /* incorrect password */
156 _pam_log(LOG_WARNING, "user `%s' denied access (incorrect password)", user);
158 case PAM_ACCT_EXPIRED:
159 /* account expired */
160 _pam_log(LOG_WARNING, "user `%s' account expired", user);
162 case PAM_AUTHTOK_EXPIRED:
163 /* password expired */
164 _pam_log(LOG_WARNING, "user `%s' password expired", user);
166 case PAM_NEW_AUTHTOK_REQD:
167 /* password expired */
168 _pam_log(LOG_WARNING, "user `%s' new password required", user);
170 case PAM_USER_UNKNOWN:
171 /* the user does not exist */
172 if (ctrl & WINBIND_DEBUG_ARG)
173 _pam_log(LOG_NOTICE, "user `%s' not found",
175 if (ctrl & WINBIND_UNKNOWN_OK_ARG) {
180 /* Otherwise, the authentication looked good */
181 _pam_log(LOG_NOTICE, "user '%s' granted acces", user);
184 /* we don't know anything about this return value */
185 _pam_log(LOG_ERR, "internal module error (retval = %d, user = `%s'",
189 /* should not be reached */
192 /* talk to winbindd */
193 static int winbind_chauthtok_request(const char *user, const char *oldpass,
196 struct winbindd_request request;
197 struct winbindd_response response;
199 ZERO_STRUCT(request);
201 if (request.data.chauthtok.user == NULL) return -2;
203 strncpy(request.data.chauthtok.user, user,
204 sizeof(request.data.chauthtok.user) - 1);
206 if (oldpass != NULL) {
207 strncpy(request.data.chauthtok.oldpass, oldpass,
208 sizeof(request.data.chauthtok.oldpass) - 1);
210 request.data.chauthtok.oldpass[0] = '\0';
213 if (newpass != NULL) {
214 strncpy(request.data.chauthtok.newpass, newpass,
215 sizeof(request.data.chauthtok.newpass) - 1);
217 request.data.chauthtok.newpass[0] = '\0';
220 return winbind_request(WINBINDD_PAM_CHAUTHTOK, &request, &response);
224 * Checks if a user has an account
231 static int valid_user(const char *user)
233 if (getpwnam(user)) return 0;
237 static char *_pam_delete(register char *xx)
245 * obtain a password from the user
248 static int _winbind_read_password(pam_handle_t * pamh
261 * make sure nothing inappropriate gets returned
264 *pass = token = NULL;
267 * which authentication token are we getting?
270 authtok_flag = on(WINBIND__OLD_PASSWORD, ctrl) ? PAM_OLDAUTHTOK : PAM_AUTHTOK;
273 * should we obtain the password from a PAM item ?
276 if (on(WINBIND_TRY_FIRST_PASS_ARG, ctrl) || on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
277 retval = pam_get_item(pamh, authtok_flag, (const void **) &item);
278 if (retval != PAM_SUCCESS) {
281 "pam_get_item returned error to unix-read-password"
284 } else if (item != NULL) { /* we have a password! */
288 } else if (on(WINBIND_USE_FIRST_PASS_ARG, ctrl)) {
289 return PAM_AUTHTOK_RECOVER_ERR; /* didn't work */
290 } else if (on(WINBIND_USE_AUTHTOK_ARG, ctrl)
291 && off(WINBIND__OLD_PASSWORD, ctrl)) {
292 return PAM_AUTHTOK_RECOVER_ERR;
296 * getting here implies we will have to get the password from the
301 struct pam_message msg[3], *pmsg[3];
302 struct pam_response *resp;
305 /* prepare to converse */
307 if (comment != NULL) {
309 msg[0].msg_style = PAM_TEXT_INFO;
310 msg[0].msg = comment;
317 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
318 msg[i++].msg = prompt1;
321 if (prompt2 != NULL) {
323 msg[i].msg_style = PAM_PROMPT_ECHO_OFF;
324 msg[i++].msg = prompt2;
327 /* so call the conversation expecting i responses */
329 retval = converse(pamh, i, pmsg, &resp);
333 /* interpret the response */
335 if (retval == PAM_SUCCESS) { /* a good conversation */
337 token = x_strdup(resp[i - replies].resp);
341 /* verify that password entered correctly */
342 if (!resp[i - 1].resp
343 || strcmp(token, resp[i - 1].resp)) {
344 _pam_delete(token); /* mistyped */
345 retval = PAM_AUTHTOK_RECOVER_ERR;
346 _make_remark(pamh ,PAM_ERROR_MSG, MISTYPED_PASS);
351 ,"could not recover authentication token");
356 * tidy up the conversation (resp_retcode) is ignored
357 * -- what is it for anyway? AGM
360 _pam_drop_reply(resp, i);
363 retval = (retval == PAM_SUCCESS)
364 ? PAM_AUTHTOK_RECOVER_ERR : retval;
368 if (retval != PAM_SUCCESS) {
369 if (on(WINBIND_DEBUG_ARG, ctrl))
371 "unable to obtain a password");
374 /* 'token' is the entered password */
376 /* we store this password as an item */
378 retval = pam_set_item(pamh, authtok_flag, token);
379 _pam_delete(token); /* clean it up */
380 if (retval != PAM_SUCCESS
381 || (retval = pam_get_item(pamh, authtok_flag
382 ,(const void **) &item))
385 _pam_log(LOG_CRIT, "error manipulating password");
391 item = NULL; /* break link to password */
397 int pam_sm_authenticate(pam_handle_t *pamh, int flags,
398 int argc, const char **argv)
400 const char *username;
401 const char *password;
402 int retval = PAM_AUTH_ERR;
404 /* parse arguments */
405 int ctrl = _pam_parse(argc, argv);
407 /* Get the username */
408 retval = pam_get_user(pamh, &username, NULL);
409 if ((retval != PAM_SUCCESS) || (!username)) {
410 if (ctrl & WINBIND_DEBUG_ARG)
411 _pam_log(LOG_DEBUG,"can not get the username");
412 return PAM_SERVICE_ERR;
415 retval = _winbind_read_password(pamh, ctrl, NULL,
419 if (retval != PAM_SUCCESS) {
420 _pam_log(LOG_ERR, "Could not retrieve user's password");
421 return PAM_AUTHTOK_ERR;
424 if (ctrl & WINBIND_DEBUG_ARG) {
426 /* Let's not give too much away in the log file */
428 #ifdef DEBUG_PASSWORD
429 _pam_log(LOG_INFO, "Verify user `%s' with password `%s'",
432 _pam_log(LOG_INFO, "Verify user `%s'", username);
436 /* Now use the username to look up password */
437 return winbind_auth_request(username, password, ctrl);
441 int pam_sm_setcred(pam_handle_t *pamh, int flags,
442 int argc, const char **argv)
448 * Account management. We want to verify that the account exists
449 * before returning PAM_SUCCESS
452 int pam_sm_acct_mgmt(pam_handle_t *pamh, int flags,
453 int argc, const char **argv)
455 const char *username;
456 int retval = PAM_USER_UNKNOWN;
458 /* parse arguments */
459 int ctrl = _pam_parse(argc, argv);
461 /* Get the username */
462 retval = pam_get_user(pamh, &username, NULL);
463 if ((retval != PAM_SUCCESS) || (!username)) {
464 if (ctrl & WINBIND_DEBUG_ARG)
465 _pam_log(LOG_DEBUG,"can not get the username");
466 return PAM_SERVICE_ERR;
469 /* Verify the username */
470 retval = valid_user(username);
473 /* some sort of system error. The log was already printed */
474 return PAM_SERVICE_ERR;
476 /* the user does not exist */
477 if (ctrl & WINBIND_DEBUG_ARG)
478 _pam_log(LOG_NOTICE, "user `%s' not found",
480 if (ctrl & WINBIND_UNKNOWN_OK_ARG)
482 return PAM_USER_UNKNOWN;
484 /* Otherwise, the authentication looked good */
485 _pam_log(LOG_NOTICE, "user '%s' granted acces", username);
488 /* we don't know anything about this return value */
489 _pam_log(LOG_ERR, "internal module error (retval = %d, user = `%s'",
491 return PAM_SERVICE_ERR;
494 /* should not be reached */
498 int pam_sm_open_session(pam_handle_t *pamh, int flags,
499 int argc, const char **argv)
501 /* parse arguments */
502 int ctrl = _pam_parse(argc, argv);
503 if (ctrl & WINBIND_DEBUG_ARG)
504 _pam_log(LOG_DEBUG,"libpam_winbind:pam_sm_open_session handler");
508 int pam_sm_close_session(pam_handle_t *pamh, int flags,
509 int argc, const char **argv)
511 /* parse arguments */
512 int ctrl = _pam_parse(argc, argv);
513 if (ctrl & WINBIND_DEBUG_ARG)
514 _pam_log(LOG_DEBUG,"libpam_winbind:pam_sm_close_session handler");
520 PAM_EXTERN int pam_sm_chauthtok(pam_handle_t * pamh, int flags,
521 int argc, const char **argv)
525 unsigned int ctrl = _pam_parse(argc, argv);
527 /* <DO NOT free() THESE> */
529 char *pass_old, *pass_new;
530 /* </DO NOT free() THESE> */
537 * First get the name of a user
539 retval = pam_get_user(pamh, &user, "Username: ");
540 if (retval == PAM_SUCCESS) {
542 _pam_log(LOG_ERR, "username was NULL!");
543 return PAM_USER_UNKNOWN;
545 if (retval == PAM_SUCCESS && on(WINBIND_DEBUG_ARG, ctrl))
546 _pam_log(LOG_DEBUG, "username [%s] obtained",
549 if (on(WINBIND_DEBUG_ARG, ctrl))
551 "password - could not identify user");
556 * obtain and verify the current password (OLDAUTHTOK) for
560 if (flags & PAM_PRELIM_CHECK) {
562 /* instruct user what is happening */
563 #define greeting "Changing password for "
564 Announce = (char *) malloc(sizeof(greeting) + strlen(user));
565 if (Announce == NULL) {
567 "password - out of memory");
570 (void) strcpy(Announce, greeting);
571 (void) strcpy(Announce + sizeof(greeting) - 1, user);
574 lctrl = ctrl | WINBIND__OLD_PASSWORD;
575 retval = _winbind_read_password(pamh, lctrl
577 ,"(current) NT password: "
579 ,(const char **) &pass_old);
582 if (retval != PAM_SUCCESS) {
584 ,"password - (old) token not obtained");
587 /* verify that this is the password for this user */
589 retval = winbind_auth_request(user, pass_old, ctrl);
591 if (retval != PAM_ACCT_EXPIRED
592 && retval != PAM_AUTHTOK_EXPIRED
593 && retval != PAM_NEW_AUTHTOK_REQD
594 && retval != PAM_SUCCESS) {
599 retval = pam_set_item(pamh, PAM_OLDAUTHTOK, (const void *) pass_old);
601 if (retval != PAM_SUCCESS) {
603 "failed to set PAM_OLDAUTHTOK");
605 } else if (flags & PAM_UPDATE_AUTHTOK) {
608 * obtain the proposed password
612 * get the old token back.
615 retval = pam_get_item(pamh, PAM_OLDAUTHTOK
616 ,(const void **) &pass_old);
618 if (retval != PAM_SUCCESS) {
619 _pam_log(LOG_NOTICE, "user not authenticated");
625 if (on(WINBIND_USE_AUTHTOK_ARG, lctrl)) {
626 ctrl = WINBIND_USE_FIRST_PASS_ARG | lctrl;
629 retval = PAM_AUTHTOK_ERR;
630 while ((retval != PAM_SUCCESS) && (retry++ < MAX_PASSWD_TRIES)) {
632 * use_authtok is to force the use of a previously entered
633 * password -- needed for pluggable password strength checking
636 retval = _winbind_read_password(pamh, lctrl
638 ,"Enter new NT password: "
639 ,"Retype new NT password: "
640 ,(const char **) &pass_new);
642 if (retval != PAM_SUCCESS) {
643 if (on(WINBIND_DEBUG_ARG, ctrl)) {
645 ,"password - new password not obtained");
647 pass_old = NULL;/* tidy up */
652 * At this point we know who the user is and what they
653 * propose as their new password. Verify that the new
654 * password is acceptable.
657 if (pass_new[0] == '\0') {/* "\0" password = NULL */
663 * By reaching here we have approved the passwords and must now
664 * rebuild the password database file.
667 retval = winbind_chauthtok_request(user, pass_old, pass_new);
668 _pam_overwrite(pass_new);
669 _pam_overwrite(pass_old);
670 pass_old = pass_new = NULL;
672 retval = PAM_SERVICE_ERR;
680 /* static module data */
682 struct pam_module _pam_winbind_modstruct = {
688 pam_sm_close_session,
695 * Copyright (c) Andrew Tridgell <tridge@samba.org> 2000
696 * Copyright (c) Tim Potter <tpot@samba.org> 2000
697 * Copyright (c) Andrew Bartlettt <abartlet@samba.org> 2002
698 * Copyright (c) Jan Rêkorajski 1999.
699 * Copyright (c) Andrew G. Morgan 1996-8.
700 * Copyright (c) Alex O. Yuriev, 1996.
701 * Copyright (c) Cristian Gafton 1996.
702 * Copyright (C) Elliot Lee <sopwith@redhat.com> 1996, Red Hat Software.
704 * Redistribution and use in source and binary forms, with or without
705 * modification, are permitted provided that the following conditions
707 * 1. Redistributions of source code must retain the above copyright
708 * notice, and the entire permission notice in its entirety,
709 * including the disclaimer of warranties.
710 * 2. Redistributions in binary form must reproduce the above copyright
711 * notice, this list of conditions and the following disclaimer in the
712 * documentation and/or other materials provided with the distribution.
713 * 3. The name of the author may not be used to endorse or promote
714 * products derived from this software without specific prior
715 * written permission.
717 * ALTERNATIVELY, this product may be distributed under the terms of
718 * the GNU Public License, in which case the provisions of the GPL are
719 * required INSTEAD OF the above restrictions. (This clause is
720 * necessary due to a potential bad interaction between the GPL and
721 * the restrictions contained in a BSD-style copyright.)
723 * THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESS OR IMPLIED
724 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
725 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
726 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
727 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
728 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
729 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
730 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
731 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
732 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
733 * OF THE POSSIBILITY OF SUCH DAMAGE.