2 Unix SMB/Netbios implementation.
5 Copyright (C) Andrew Tridgell 1992-2001
6 Copyright (C) John H Terpsta 1999-2001
7 Copyright (C) Andrew Bartlett 2001
8 Copyright (C) Jeremy Allison 2001
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 * This module provides PAM based functions for validation of
27 * username/password pairs, account managment, session and access control.
28 * Note: SMB password checking is done in smbpass.c
33 extern int DEBUGLEVEL;
37 /*******************************************************************
38 * Handle PAM authentication
39 * - Access, Authentication, Session, Password
40 * Note: See PAM Documentation and refer to local system PAM implementation
41 * which determines what actions/limitations/allowances become affected.
42 *********************************************************************/
44 #include <security/pam_appl.h>
47 * Structure used to communicate between the conversation function
48 * and the server_login/change password functions.
51 struct smb_pam_userdata {
54 char *PAM_newpassword;
57 typedef int (*smb_pam_conv_fn)(int, const struct pam_message **, struct pam_response **, void *appdata_ptr);
60 * Macros to help make life easy
62 #define COPY_STRING(s) (s) ? strdup(s) : NULL
64 /*******************************************************************
66 *********************************************************************/
68 static BOOL smb_pam_error_handler(pam_handle_t *pamh, int pam_error, char *msg, int dbglvl)
71 if( pam_error != PAM_SUCCESS) {
72 DEBUG(dbglvl, ("smb_pam_error_handler: PAM: %s : %s\n",
73 msg, pam_strerror(pamh, pam_error)));
79 /*******************************************************************
80 This function is a sanity check, to make sure that we NEVER report
82 *********************************************************************/
84 static BOOL smb_pam_nt_status_error_handler(pam_handle_t *pamh, int pam_error,
85 char *msg, int dbglvl, uint32 *nt_status)
87 if (smb_pam_error_handler(pamh, pam_error, msg, dbglvl))
90 if (*nt_status == NT_STATUS_NOPROBLEMO) {
92 DEBUG(0, ("smb_pam_nt_status_error_handler: PAM: BUG: PAM and NT_STATUS \
93 error MISMATCH, forcing to NT_STATUS_LOGON_FAILURE"));
94 *nt_status = NT_STATUS_LOGON_FAILURE;
100 * PAM conversation function
101 * Here we assume (for now, at least) that echo on means login name, and
102 * echo off means password.
105 static int smb_pam_conv(int num_msg,
106 const struct pam_message **msg,
107 struct pam_response **resp,
111 struct pam_response *reply = NULL;
112 struct smb_pam_userdata *udp = (struct smb_pam_userdata *)appdata_ptr;
120 * Apparantly HPUX has a buggy PAM that doesn't support the
121 * appdata_ptr. Fail if this is the case. JRA.
125 DEBUG(0,("smb_pam_conv: PAM on this system is broken - appdata_ptr == NULL !\n"));
129 reply = malloc(sizeof(struct pam_response) * num_msg);
133 for (replies = 0; replies < num_msg; replies++) {
134 switch (msg[replies]->msg_style) {
135 case PAM_PROMPT_ECHO_ON:
136 reply[replies].resp_retcode = PAM_SUCCESS;
137 reply[replies].resp = COPY_STRING(udp->PAM_username);
141 case PAM_PROMPT_ECHO_OFF:
142 reply[replies].resp_retcode = PAM_SUCCESS;
143 reply[replies].resp = COPY_STRING(udp->PAM_password);
152 reply[replies].resp_retcode = PAM_SUCCESS;
153 reply[replies].resp = NULL;
157 /* Must be an error of some sort... */
168 * PAM password change conversation function
169 * Here we assume (for now, at least) that echo on means login name, and
170 * echo off means password.
173 static int smb_pam_passchange_conv(int num_msg,
174 const struct pam_message **msg,
175 struct pam_response **resp,
179 struct pam_response *reply = NULL;
180 fstring newpw_prompt;
181 fstring repeatpw_prompt;
182 char *p = lp_passwd_chat();
183 struct smb_pam_userdata *udp = (struct smb_pam_userdata *)appdata_ptr;
191 * Apparantly HPUX has a buggy PAM that doesn't support the
192 * appdata_ptr. Fail if this is the case. JRA.
196 DEBUG(0,("smb_pam_passchange_conv: PAM on this system is broken - appdata_ptr == NULL !\n"));
200 /* Get the prompts. We're running as root so we only get 2 prompts. */
202 if (!next_token(&p, newpw_prompt, NULL, sizeof(fstring)))
204 if (!next_token(&p, repeatpw_prompt, NULL, sizeof(fstring)))
207 reply = malloc(sizeof(struct pam_response) * num_msg);
211 for (replies = 0; replies < num_msg; replies++) {
212 switch (msg[replies]->msg_style) {
213 case PAM_PROMPT_ECHO_ON:
214 DEBUG(10,("smb_pam_passchange_conv: PAM_PROMPT_ECHO_ON: Replied: %s\n", msg[replies]->msg));
215 reply[replies].resp_retcode = PAM_SUCCESS;
216 reply[replies].resp = COPY_STRING(udp->PAM_username);
220 case PAM_PROMPT_ECHO_OFF:
221 reply[replies].resp_retcode = PAM_SUCCESS;
222 DEBUG(10,("smb_pam_passchange_conv: PAM_PROMPT_ECHO_OFF: Replied: %s\n", msg[replies]->msg));
223 if (ms_fnmatch( newpw_prompt, msg[replies]->msg) == 0) {
224 reply[replies].resp = COPY_STRING(udp->PAM_newpassword);
225 } else if (ms_fnmatch(repeatpw_prompt, msg[replies]->msg) == 0) {
226 reply[replies].resp = COPY_STRING(udp->PAM_newpassword);
228 DEBUG(3,("smb_pam_passchange_conv: Could not find reply for PAM prompt: %s\n",msg[replies]->msg));
229 DEBUG(5,("smb_pam_passchange_conv: Prompts available:\n NewPW: \"%s\"\n \
230 RepeatPW: \"%s\"\n",newpw_prompt,repeatpw_prompt));
243 reply[replies].resp_retcode = PAM_SUCCESS;
244 reply[replies].resp = NULL;
248 /* Must be an error of some sort... */
260 /***************************************************************************
261 Free up a malloced pam_conv struct.
262 ****************************************************************************/
264 static void smb_free_pam_conv(struct pam_conv *pconv)
267 safe_free(pconv->appdata_ptr);
272 /***************************************************************************
273 Allocate a pam_conv struct.
274 ****************************************************************************/
276 static struct pam_conv *smb_setup_pam_conv(smb_pam_conv_fn smb_pam_conv_fnptr, char *user,
277 char *passwd, char *newpass)
279 struct pam_conv *pconv = (struct pam_conv *)malloc(sizeof(struct pam_conv));
280 struct smb_pam_userdata *udp = (struct smb_pam_userdata *)malloc(sizeof(struct smb_pam_userdata));
282 if (pconv == NULL || udp == NULL) {
288 udp->PAM_username = user;
289 udp->PAM_password = passwd;
290 udp->PAM_newpassword = newpass;
292 pconv->conv = smb_pam_conv_fnptr;
293 pconv->appdata_ptr = (void *)udp;
298 * PAM Closing out cleanup handler
301 static BOOL smb_pam_end(pam_handle_t *pamh, struct pam_conv *smb_pam_conv_ptr)
305 smb_free_pam_conv(smb_pam_conv_ptr);
308 pam_error = pam_end(pamh, 0);
309 if(smb_pam_error_handler(pamh, pam_error, "End Cleanup Failed", 2) == True) {
310 DEBUG(4, ("smb_pam_end: PAM: PAM_END OK.\n"));
314 DEBUG(2,("smb_pam_end: PAM: not initialised"));
319 * Start PAM authentication for specified account
322 static BOOL smb_pam_start(pam_handle_t **pamh, char *user, char *rhost, struct pam_conv *pconv)
326 *pamh = (pam_handle_t *)NULL;
328 DEBUG(4,("smb_pam_start: PAM: Init user: %s\n", user));
330 pam_error = pam_start("samba", user, pconv, pamh);
331 if( !smb_pam_error_handler(*pamh, pam_error, "Init Failed", 0)) {
332 *pamh = (pam_handle_t *)NULL;
337 rhost = client_name();
338 if (strequal(rhost,"UNKNOWN"))
339 rhost = client_addr();
343 DEBUG(4,("smb_pam_start: PAM: setting rhost to: %s\n", rhost));
344 pam_error = pam_set_item(*pamh, PAM_RHOST, rhost);
345 if(!smb_pam_error_handler(*pamh, pam_error, "set rhost failed", 0)) {
346 smb_pam_end(*pamh, pconv);
347 *pamh = (pam_handle_t *)NULL;
352 DEBUG(4,("smb_pam_start: PAM: setting tty\n"));
353 pam_error = pam_set_item(*pamh, PAM_TTY, "samba");
354 if (!smb_pam_error_handler(*pamh, pam_error, "set tty failed", 0)) {
355 smb_pam_end(*pamh, pconv);
356 *pamh = (pam_handle_t *)NULL;
360 DEBUG(4,("smb_pam_start: PAM: Init passed for user: %s\n", user));
365 * PAM Authentication Handler
367 static uint32 smb_pam_auth(pam_handle_t *pamh, char *user)
370 uint32 nt_status = NT_STATUS_LOGON_FAILURE;
373 * To enable debugging set in /etc/pam.d/samba:
374 * auth required /lib/security/pam_pwdb.so nullok shadow audit
377 DEBUG(4,("smb_pam_auth: PAM: Authenticate User: %s\n", user));
378 pam_error = pam_authenticate(pamh, PAM_SILENT | lp_null_passwords() ? 0 : PAM_DISALLOW_NULL_AUTHTOK);
381 DEBUG(2, ("smb_pam_auth: PAM: Athentication Error for user %s\n", user));
382 nt_status = NT_STATUS_WRONG_PASSWORD;
384 case PAM_CRED_INSUFFICIENT:
385 DEBUG(2, ("smb_pam_auth: PAM: Insufficient Credentials for user %s\n", user));
386 nt_status = NT_STATUS_INSUFFICIENT_LOGON_INFO;
388 case PAM_AUTHINFO_UNAVAIL:
389 DEBUG(2, ("smb_pam_auth: PAM: Authentication Information Unavailable for user %s\n", user));
390 nt_status = NT_STATUS_LOGON_FAILURE;
392 case PAM_USER_UNKNOWN:
393 DEBUG(2, ("smb_pam_auth: PAM: Username %s NOT known to Authentication system\n", user));
394 nt_status = NT_STATUS_NO_SUCH_USER;
397 DEBUG(2, ("smb_pam_auth: PAM: One or more authentication modules reports user limit for user %s exceeeded\n", user));
398 nt_status = NT_STATUS_REMOTE_SESSION_LIMIT;
401 DEBUG(0, ("smb_pam_auth: PAM: One or more PAM modules failed to load for user %s\n", user));
402 nt_status = NT_STATUS_LOGON_FAILURE;
405 DEBUG(4, ("smb_pam_auth: PAM: User %s Authenticated OK\n", user));
406 nt_status = NT_STATUS_NOPROBLEMO;
409 DEBUG(0, ("smb_pam_auth: PAM: UNKNOWN ERROR while authenticating user %s\n", user));
410 nt_status = NT_STATUS_LOGON_FAILURE;
414 smb_pam_nt_status_error_handler(pamh, pam_error, "Authentication Failure", 2, &nt_status);
419 * PAM Account Handler
421 static uint32 smb_pam_account(pam_handle_t *pamh, char * user)
424 uint32 nt_status = NT_STATUS_ACCOUNT_DISABLED;
426 DEBUG(4,("smb_pam_account: PAM: Account Management for User: %s\n", user));
427 pam_error = pam_acct_mgmt(pamh, PAM_SILENT); /* Is user account enabled? */
428 switch( pam_error ) {
429 case PAM_AUTHTOK_EXPIRED:
430 DEBUG(2, ("smb_pam_account: PAM: User %s is valid but password is expired\n", user));
431 nt_status = NT_STATUS_PASSWORD_EXPIRED;
433 case PAM_ACCT_EXPIRED:
434 DEBUG(2, ("smb_pam_account: PAM: User %s no longer permitted to access system\n", user));
435 nt_status = NT_STATUS_ACCOUNT_EXPIRED;
438 DEBUG(2, ("smb_pam_account: PAM: There was an authentication error for user %s\n", user));
439 nt_status = NT_STATUS_LOGON_FAILURE;
441 case PAM_PERM_DENIED:
442 DEBUG(0, ("smb_pam_account: PAM: User %s is NOT permitted to access system at this time\n", user));
443 nt_status = NT_STATUS_ACCOUNT_RESTRICTION;
445 case PAM_USER_UNKNOWN:
446 DEBUG(0, ("smb_pam_account: PAM: User \"%s\" is NOT known to account management\n", user));
447 nt_status = NT_STATUS_NO_SUCH_USER;
450 DEBUG(4, ("smb_pam_account: PAM: Account OK for User: %s\n", user));
451 nt_status = NT_STATUS_NOPROBLEMO;
454 nt_status = NT_STATUS_ACCOUNT_DISABLED;
455 DEBUG(0, ("smb_pam_account: PAM: UNKNOWN PAM ERROR (%d) during Account Management for User: %s\n", pam_error, user));
459 smb_pam_nt_status_error_handler(pamh, pam_error, "Account Check Failed", 2, &nt_status);
464 * PAM Credential Setting
467 static uint32 smb_pam_setcred(pam_handle_t *pamh, char * user)
470 uint32 nt_status = NT_STATUS_NO_TOKEN;
473 * This will allow samba to aquire a kerberos token. And, when
474 * exporting an AFS cell, be able to /write/ to this cell.
477 DEBUG(4,("PAM: Account Management SetCredentials for User: %s\n", user));
478 pam_error = pam_setcred(pamh, (PAM_ESTABLISH_CRED|PAM_SILENT));
479 switch( pam_error ) {
480 case PAM_CRED_UNAVAIL:
481 DEBUG(0, ("smb_pam_setcred: PAM: Credentials not found for user:%s\n", user ));
482 nt_status = NT_STATUS_NO_TOKEN;
484 case PAM_CRED_EXPIRED:
485 DEBUG(0, ("smb_pam_setcred: PAM: Credentials for user: \"%s\" EXPIRED!\n", user ));
486 nt_status = NT_STATUS_PASSWORD_EXPIRED;
488 case PAM_USER_UNKNOWN:
489 DEBUG(0, ("smb_pam_setcred: PAM: User: \"%s\" is NOT known so can not set credentials!\n", user ));
490 nt_status = NT_STATUS_NO_SUCH_USER;
493 DEBUG(0, ("smb_pam_setcred: PAM: Unknown setcredentials error - unable to set credentials for %s\n", user ));
494 nt_status = NT_STATUS_LOGON_FAILURE;
497 DEBUG(4, ("smb_pam_setcred: PAM: SetCredentials OK for User: %s\n", user));
498 nt_status = NT_STATUS_NOPROBLEMO;
501 DEBUG(0, ("smb_pam_setcred: PAM: UNKNOWN PAM ERROR (%d) during SetCredentials for User: %s\n", pam_error, user));
502 nt_status = NT_STATUS_NO_TOKEN;
506 smb_pam_nt_status_error_handler(pamh, pam_error, "Set Credential Failure", 2, &nt_status);
511 * PAM Internal Session Handler
513 static BOOL smb_internal_pam_session(pam_handle_t *pamh, char *user, char *tty, BOOL flag)
518 DEBUG(4,("smb_internal_pam_session: PAM: tty set to: %s\n", tty));
519 pam_error = pam_set_item(pamh, PAM_TTY, tty);
520 if (!smb_pam_error_handler(pamh, pam_error, "set tty failed", 0))
525 pam_error = pam_open_session(pamh, PAM_SILENT);
526 if (!smb_pam_error_handler(pamh, pam_error, "session setup failed", 0))
529 pam_setcred(pamh, (PAM_DELETE_CRED|PAM_SILENT)); /* We don't care if this fails */
530 pam_error = pam_close_session(pamh, PAM_SILENT); /* This will probably pick up the error anyway */
531 if (!smb_pam_error_handler(pamh, pam_error, "session close failed", 0))
538 * Internal PAM Password Changer.
541 static BOOL smb_pam_chauthtok(pam_handle_t *pamh, char * user)
545 DEBUG(4,("smb_pam_chauthtok: PAM: Password Change for User: %s\n", user));
547 pam_error = pam_chauthtok(pamh, PAM_SILENT); /* Change Password */
549 switch( pam_error ) {
550 case PAM_AUTHTOK_ERR:
551 DEBUG(2, ("PAM: unable to obtain the new authentication token - is password to weak?\n"));
554 /* This doesn't seem to be defined on Solaris. JRA */
555 #ifdef PAM_AUTHTOK_RECOVER_ERR
556 case PAM_AUTHTOK_RECOVER_ERR:
557 DEBUG(2, ("PAM: unable to obtain the old authentication token - was the old password wrong?.\n"));
561 case PAM_AUTHTOK_LOCK_BUSY:
562 DEBUG(2, ("PAM: unable to change the authentication token since it is currently locked.\n"));
564 case PAM_AUTHTOK_DISABLE_AGING:
565 DEBUG(2, ("PAM: Authentication token aging has been disabled.\n"));
567 case PAM_PERM_DENIED:
568 DEBUG(0, ("PAM: Permission denied.\n"));
571 DEBUG(0, ("PAM: Could not update all authentication token(s). No authentication tokens were updated.\n"));
573 case PAM_USER_UNKNOWN:
574 DEBUG(0, ("PAM: User not known to PAM\n"));
577 DEBUG(4, ("PAM: Account OK for User: %s\n", user));
580 DEBUG(0, ("PAM: UNKNOWN PAM ERROR (%d) for User: %s\n", pam_error, user));
583 if(!smb_pam_error_handler(pamh, pam_error, "Password Change Failed", 2)) {
587 /* If this point is reached, the password has changed. */
592 * PAM Externally accessible Session handler
595 BOOL smb_pam_claim_session(char *user, char *tty, char *rhost)
597 pam_handle_t *pamh = NULL;
598 struct pam_conv *pconv = NULL;
600 /* Ignore PAM if told to. */
602 if (!lp_obey_pam_restrictions())
605 if ((pconv = smb_setup_pam_conv(smb_pam_conv, user, NULL, NULL)) == NULL)
608 if (!smb_pam_start(&pamh, user, rhost, pconv))
611 if (!smb_internal_pam_session(pamh, user, tty, True)) {
612 smb_pam_end(pamh, pconv);
616 return smb_pam_end(pamh, pconv);
620 * PAM Externally accessible Session handler
623 BOOL smb_pam_close_session(char *user, char *tty, char *rhost)
625 pam_handle_t *pamh = NULL;
626 struct pam_conv *pconv = NULL;
628 /* Ignore PAM if told to. */
630 if (!lp_obey_pam_restrictions())
633 if ((pconv = smb_setup_pam_conv(smb_pam_conv, user, NULL, NULL)) == NULL)
636 if (!smb_pam_start(&pamh, user, rhost, pconv))
639 if (!smb_internal_pam_session(pamh, user, tty, False)) {
640 smb_pam_end(pamh, pconv);
644 return smb_pam_end(pamh, pconv);
648 * PAM Externally accessible Account handler
651 uint32 smb_pam_accountcheck(char * user)
653 uint32 nt_status = NT_STATUS_ACCOUNT_DISABLED;
654 pam_handle_t *pamh = NULL;
655 struct pam_conv *pconv = NULL;
657 /* Ignore PAM if told to. */
659 if (!lp_obey_pam_restrictions())
660 return NT_STATUS_NOPROBLEMO;
662 if ((pconv = smb_setup_pam_conv(smb_pam_conv, user, NULL, NULL)) == NULL)
665 if (!smb_pam_start(&pamh, user, NULL, pconv))
666 return NT_STATUS_ACCOUNT_DISABLED;
668 if ((nt_status = smb_pam_account(pamh, user)) != NT_STATUS_NOPROBLEMO)
669 DEBUG(0, ("smb_pam_accountcheck: PAM: Account Validation Failed - Rejecting User %s!\n", user));
671 smb_pam_end(pamh, pconv);
676 * PAM Password Validation Suite
679 uint32 smb_pam_passcheck(char * user, char * password)
681 pam_handle_t *pamh = NULL;
682 uint32 nt_status = NT_STATUS_LOGON_FAILURE;
683 struct pam_conv *pconv = NULL;
686 * Note we can't ignore PAM here as this is the only
687 * way of doing auths on plaintext passwords when
688 * compiled --with-pam.
691 if ((pconv = smb_setup_pam_conv(smb_pam_conv, user, password, NULL)) == NULL)
692 return NT_STATUS_LOGON_FAILURE;
694 if (!smb_pam_start(&pamh, user, NULL, pconv))
695 return NT_STATUS_LOGON_FAILURE;
697 if ((nt_status = smb_pam_auth(pamh, user)) != NT_STATUS_NOPROBLEMO) {
698 DEBUG(0, ("smb_pam_passcheck: PAM: smb_pam_auth failed - Rejecting User %s !\n", user));
699 smb_pam_end(pamh, pconv);
703 if ((nt_status = smb_pam_account(pamh, user)) != NT_STATUS_NOPROBLEMO) {
704 DEBUG(0, ("smb_pam_passcheck: PAM: smb_pam_account failed - Rejecting User %s !\n", user));
705 smb_pam_end(pamh, pconv);
709 if ((nt_status = smb_pam_setcred(pamh, user)) != NT_STATUS_NOPROBLEMO) {
710 DEBUG(0, ("smb_pam_passcheck: PAM: smb_pam_setcred failed - Rejecting User %s !\n", user));
711 smb_pam_end(pamh, pconv);
715 smb_pam_end(pamh, pconv);
720 * PAM Password Change Suite
723 BOOL smb_pam_passchange(char * user, char * oldpassword, char * newpassword)
725 /* Appropriate quantities of root should be obtained BEFORE calling this function */
726 struct pam_conv *pconv = NULL;
727 pam_handle_t *pamh = NULL;
729 if ((pconv = smb_setup_pam_conv(smb_pam_passchange_conv, user, oldpassword, newpassword)) == NULL)
732 if(!smb_pam_start(&pamh, user, NULL, pconv))
735 if (!smb_pam_chauthtok(pamh, user)) {
736 DEBUG(0, ("smb_pam_passchange: PAM: Password Change Failed for user %s!\n", user));
737 smb_pam_end(pamh, pconv);
741 return smb_pam_end(pamh, pconv);
746 /* If PAM not used, no PAM restrictions on accounts. */
747 uint32 smb_pam_accountcheck(char * user)
749 return NT_STATUS_NOPROBLEMO;
752 /* If PAM not used, also no PAM restrictions on sessions. */
753 BOOL smb_pam_claim_session(char *user, char *tty, char *rhost)
758 /* If PAM not used, also no PAM restrictions on sessions. */
759 BOOL smb_pam_close_session(char *in_user, char *tty, char *rhost)
763 #endif /* WITH_PAM */