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
;
116 reply
= malloc(sizeof(struct pam_response
) * num_msg
);
120 for (replies
= 0; replies
< num_msg
; replies
++) {
121 switch (msg
[replies
]->msg_style
) {
122 case PAM_PROMPT_ECHO_ON
:
123 reply
[replies
].resp_retcode
= PAM_SUCCESS
;
124 reply
[replies
].resp
= COPY_STRING(udp
->PAM_username
);
128 case PAM_PROMPT_ECHO_OFF
:
129 reply
[replies
].resp_retcode
= PAM_SUCCESS
;
130 reply
[replies
].resp
= COPY_STRING(udp
->PAM_password
);
139 reply
[replies
].resp_retcode
= PAM_SUCCESS
;
140 reply
[replies
].resp
= NULL
;
144 /* Must be an error of some sort... */
155 * PAM password change conversation function
156 * Here we assume (for now, at least) that echo on means login name, and
157 * echo off means password.
160 static int smb_pam_passchange_conv(int num_msg
,
161 const struct pam_message
**msg
,
162 struct pam_response
**resp
,
166 struct pam_response
*reply
= NULL
;
167 fstring currentpw_prompt
;
168 fstring newpw_prompt
;
169 fstring repeatpw_prompt
;
170 char *p
= lp_passwd_chat();
171 struct smb_pam_userdata
*udp
= (struct smb_pam_userdata
*)appdata_ptr
;
173 /* Get the prompts... */
175 if (!next_token(&p
, currentpw_prompt
, NULL
, sizeof(fstring
)))
177 if (!next_token(&p
, newpw_prompt
, NULL
, sizeof(fstring
)))
179 if (!next_token(&p
, repeatpw_prompt
, NULL
, sizeof(fstring
)))
184 reply
= malloc(sizeof(struct pam_response
) * num_msg
);
188 for (replies
= 0; replies
< num_msg
; replies
++) {
189 switch (msg
[replies
]->msg_style
) {
190 case PAM_PROMPT_ECHO_ON
:
191 reply
[replies
].resp_retcode
= PAM_SUCCESS
;
192 reply
[replies
].resp
= COPY_STRING(udp
->PAM_username
);
196 case PAM_PROMPT_ECHO_OFF
:
197 reply
[replies
].resp_retcode
= PAM_SUCCESS
;
198 DEBUG(10,("smb_pam_passchange_conv: PAM Replied: %s\n", msg
[replies
]->msg
));
199 if (strncmp(currentpw_prompt
, msg
[replies
]->msg
, strlen(currentpw_prompt
)) == 0) {
200 reply
[replies
].resp
= COPY_STRING(udp
->PAM_password
);
201 } else if (strncmp(newpw_prompt
, msg
[replies
]->msg
, strlen(newpw_prompt
)) == 0) {
202 reply
[replies
].resp
= COPY_STRING(udp
->PAM_newpassword
);
203 } else if (strncmp(repeatpw_prompt
, msg
[replies
]->msg
, strlen(repeatpw_prompt
)) == 0) {
204 reply
[replies
].resp
= COPY_STRING(udp
->PAM_newpassword
);
206 DEBUG(3,("smb_pam_passchange_conv: Could not find reply for PAM prompt: %s\n",msg
[replies
]->msg
));
207 DEBUG(5,("smb_pam_passchange_conv: Prompts available:\n CurrentPW: \"%s\"\n NewPW: \"%s\"\n \
208 RepeatPW: \"%s\"\n",currentpw_prompt
,newpw_prompt
,repeatpw_prompt
));
218 reply
[replies
].resp_retcode
= PAM_SUCCESS
;
219 reply
[replies
].resp
= NULL
;
223 /* Must be an error of some sort... */
235 /***************************************************************************
236 Free up a malloced pam_conv struct.
237 ****************************************************************************/
239 static void smb_free_pam_conv(struct pam_conv
*pconv
)
242 safe_free(pconv
->appdata_ptr
);
247 /***************************************************************************
248 Allocate a pam_conv struct.
249 ****************************************************************************/
251 static struct pam_conv
*smb_setup_pam_conv(smb_pam_conv_fn smb_pam_conv_fnptr
, char *user
,
252 char *passwd
, char *newpass
)
254 struct pam_conv
*pconv
= (struct pam_conv
*)malloc(sizeof(struct pam_conv
));
255 struct smb_pam_userdata
*udp
= (struct smb_pam_userdata
*)malloc(sizeof(struct smb_pam_userdata
));
257 if (pconv
== NULL
|| udp
== NULL
) {
263 udp
->PAM_username
= user
;
264 udp
->PAM_password
= passwd
;
265 udp
->PAM_newpassword
= newpass
;
267 pconv
->conv
= smb_pam_conv_fnptr
;
268 pconv
->appdata_ptr
= (void *)udp
;
273 * PAM Closing out cleanup handler
276 static BOOL
smb_pam_end(pam_handle_t
*pamh
, struct pam_conv
*smb_pam_conv_ptr
)
280 smb_free_pam_conv(smb_pam_conv_ptr
);
283 pam_error
= pam_end(pamh
, 0);
284 if(smb_pam_error_handler(pamh
, pam_error
, "End Cleanup Failed", 2) == True
) {
285 DEBUG(4, ("smb_pam_end: PAM: PAM_END OK.\n"));
289 DEBUG(2,("smb_pam_end: PAM: not initialised"));
294 * Start PAM authentication for specified account
297 static BOOL
smb_pam_start(pam_handle_t
**pamh
, char *user
, char *rhost
, struct pam_conv
*pconv
)
301 *pamh
= (pam_handle_t
*)NULL
;
303 DEBUG(4,("smb_pam_start: PAM: Init user: %s\n", user
));
305 pam_error
= pam_start("samba", user
, pconv
, pamh
);
306 if( !smb_pam_error_handler(*pamh
, pam_error
, "Init Failed", 0)) {
307 *pamh
= (pam_handle_t
*)NULL
;
312 rhost
= client_name();
313 if (strequal(rhost
,"UNKNOWN"))
314 rhost
= client_addr();
318 DEBUG(4,("smb_pam_start: PAM: setting rhost to: %s\n", rhost
));
319 pam_error
= pam_set_item(*pamh
, PAM_RHOST
, rhost
);
320 if(!smb_pam_error_handler(*pamh
, pam_error
, "set rhost failed", 0)) {
321 smb_pam_end(*pamh
, pconv
);
322 *pamh
= (pam_handle_t
*)NULL
;
327 DEBUG(4,("smb_pam_start: PAM: setting tty\n"));
328 pam_error
= pam_set_item(*pamh
, PAM_TTY
, "samba");
329 if (!smb_pam_error_handler(*pamh
, pam_error
, "set tty failed", 0)) {
330 smb_pam_end(*pamh
, pconv
);
331 *pamh
= (pam_handle_t
*)NULL
;
335 DEBUG(4,("smb_pam_start: PAM: Init passed for user: %s\n", user
));
340 * PAM Authentication Handler
342 static uint32
smb_pam_auth(pam_handle_t
*pamh
, char *user
)
345 uint32 nt_status
= NT_STATUS_LOGON_FAILURE
;
348 * To enable debugging set in /etc/pam.d/samba:
349 * auth required /lib/security/pam_pwdb.so nullok shadow audit
352 DEBUG(4,("smb_pam_auth: PAM: Authenticate User: %s\n", user
));
353 pam_error
= pam_authenticate(pamh
, PAM_SILENT
| lp_null_passwords() ? 0 : PAM_DISALLOW_NULL_AUTHTOK
);
356 DEBUG(2, ("smb_pam_auth: PAM: Athentication Error for user %s\n", user
));
357 nt_status
= NT_STATUS_WRONG_PASSWORD
;
359 case PAM_CRED_INSUFFICIENT
:
360 DEBUG(2, ("smb_pam_auth: PAM: Insufficient Credentials for user %s\n", user
));
361 nt_status
= NT_STATUS_INSUFFICIENT_LOGON_INFO
;
363 case PAM_AUTHINFO_UNAVAIL
:
364 DEBUG(2, ("smb_pam_auth: PAM: Authentication Information Unavailable for user %s\n", user
));
365 nt_status
= NT_STATUS_LOGON_FAILURE
;
367 case PAM_USER_UNKNOWN
:
368 DEBUG(2, ("smb_pam_auth: PAM: Username %s NOT known to Authentication system\n", user
));
369 nt_status
= NT_STATUS_NO_SUCH_USER
;
372 DEBUG(2, ("smb_pam_auth: PAM: One or more authentication modules reports user limit for user %s exceeeded\n", user
));
373 nt_status
= NT_STATUS_REMOTE_SESSION_LIMIT
;
376 DEBUG(0, ("smb_pam_auth: PAM: One or more PAM modules failed to load for user %s\n", user
));
377 nt_status
= NT_STATUS_LOGON_FAILURE
;
380 DEBUG(4, ("smb_pam_auth: PAM: User %s Authenticated OK\n", user
));
381 nt_status
= NT_STATUS_NOPROBLEMO
;
384 DEBUG(0, ("smb_pam_auth: PAM: UNKNOWN ERROR while authenticating user %s\n", user
));
385 nt_status
= NT_STATUS_LOGON_FAILURE
;
389 smb_pam_nt_status_error_handler(pamh
, pam_error
, "Authentication Failure", 2, &nt_status
);
394 * PAM Account Handler
396 static uint32
smb_pam_account(pam_handle_t
*pamh
, char * user
)
399 uint32 nt_status
= NT_STATUS_ACCOUNT_DISABLED
;
401 DEBUG(4,("smb_pam_account: PAM: Account Management for User: %s\n", user
));
402 pam_error
= pam_acct_mgmt(pamh
, PAM_SILENT
); /* Is user account enabled? */
403 switch( pam_error
) {
404 case PAM_AUTHTOK_EXPIRED
:
405 DEBUG(2, ("smb_pam_account: PAM: User %s is valid but password is expired\n", user
));
406 nt_status
= NT_STATUS_PASSWORD_EXPIRED
;
408 case PAM_ACCT_EXPIRED
:
409 DEBUG(2, ("smb_pam_account: PAM: User %s no longer permitted to access system\n", user
));
410 nt_status
= NT_STATUS_ACCOUNT_EXPIRED
;
413 DEBUG(2, ("smb_pam_account: PAM: There was an authentication error for user %s\n", user
));
414 nt_status
= NT_STATUS_LOGON_FAILURE
;
416 case PAM_PERM_DENIED
:
417 DEBUG(0, ("smb_pam_account: PAM: User %s is NOT permitted to access system at this time\n", user
));
418 nt_status
= NT_STATUS_ACCOUNT_RESTRICTION
;
420 case PAM_USER_UNKNOWN
:
421 DEBUG(0, ("smb_pam_account: PAM: User \"%s\" is NOT known to account management\n", user
));
422 nt_status
= NT_STATUS_NO_SUCH_USER
;
425 DEBUG(4, ("smb_pam_account: PAM: Account OK for User: %s\n", user
));
426 nt_status
= NT_STATUS_NOPROBLEMO
;
429 nt_status
= NT_STATUS_ACCOUNT_DISABLED
;
430 DEBUG(0, ("smb_pam_account: PAM: UNKNOWN PAM ERROR (%d) during Account Management for User: %s\n", pam_error
, user
));
434 smb_pam_nt_status_error_handler(pamh
, pam_error
, "Account Check Failed", 2, &nt_status
);
439 * PAM Credential Setting
442 static uint32
smb_pam_setcred(pam_handle_t
*pamh
, char * user
)
445 uint32 nt_status
= NT_STATUS_NO_TOKEN
;
448 * This will allow samba to aquire a kerberos token. And, when
449 * exporting an AFS cell, be able to /write/ to this cell.
452 DEBUG(4,("PAM: Account Management SetCredentials for User: %s\n", user
));
453 pam_error
= pam_setcred(pamh
, (PAM_ESTABLISH_CRED
|PAM_SILENT
));
454 switch( pam_error
) {
455 case PAM_CRED_UNAVAIL
:
456 DEBUG(0, ("smb_pam_setcred: PAM: Credentials not found for user:%s\n", user
));
457 nt_status
= NT_STATUS_NO_TOKEN
;
459 case PAM_CRED_EXPIRED
:
460 DEBUG(0, ("smb_pam_setcred: PAM: Credentials for user: \"%s\" EXPIRED!\n", user
));
461 nt_status
= NT_STATUS_PASSWORD_EXPIRED
;
463 case PAM_USER_UNKNOWN
:
464 DEBUG(0, ("smb_pam_setcred: PAM: User: \"%s\" is NOT known so can not set credentials!\n", user
));
465 nt_status
= NT_STATUS_NO_SUCH_USER
;
468 DEBUG(0, ("smb_pam_setcred: PAM: Unknown setcredentials error - unable to set credentials for %s\n", user
));
469 nt_status
= NT_STATUS_LOGON_FAILURE
;
472 DEBUG(4, ("smb_pam_setcred: PAM: SetCredentials OK for User: %s\n", user
));
473 nt_status
= NT_STATUS_NOPROBLEMO
;
476 DEBUG(0, ("smb_pam_setcred: PAM: UNKNOWN PAM ERROR (%d) during SetCredentials for User: %s\n", pam_error
, user
));
477 nt_status
= NT_STATUS_NO_TOKEN
;
481 smb_pam_nt_status_error_handler(pamh
, pam_error
, "Set Credential Failure", 2, &nt_status
);
486 * PAM Internal Session Handler
488 static BOOL
smb_internal_pam_session(pam_handle_t
*pamh
, char *user
, char *tty
, BOOL flag
)
493 DEBUG(4,("smb_internal_pam_session: PAM: tty set to: %s\n", tty
));
494 pam_error
= pam_set_item(pamh
, PAM_TTY
, tty
);
495 if (!smb_pam_error_handler(pamh
, pam_error
, "set tty failed", 0))
500 pam_error
= pam_open_session(pamh
, PAM_SILENT
);
501 if (!smb_pam_error_handler(pamh
, pam_error
, "session setup failed", 0))
504 pam_setcred(pamh
, (PAM_DELETE_CRED
|PAM_SILENT
)); /* We don't care if this fails */
505 pam_error
= pam_close_session(pamh
, PAM_SILENT
); /* This will probably pick up the error anyway */
506 if (!smb_pam_error_handler(pamh
, pam_error
, "session close failed", 0))
513 * Internal PAM Password Changer.
516 static BOOL
smb_pam_chauthtok(pam_handle_t
*pamh
, char * user
)
520 DEBUG(4,("smb_pam_chauthtok: PAM: Password Change for User: %s\n", user
));
522 pam_error
= pam_chauthtok(pamh
, PAM_SILENT
); /* Change Password */
524 switch( pam_error
) {
525 case PAM_AUTHTOK_ERR
:
526 DEBUG(2, ("PAM: unable to obtain the new authentication token - is password to weak?\n"));
528 case PAM_AUTHTOK_RECOVER_ERR
:
529 DEBUG(2, ("PAM: unable to obtain the old authentication token - was the old password wrong?.\n"));
531 case PAM_AUTHTOK_LOCK_BUSY
:
532 DEBUG(2, ("PAM: unable to change the authentication token since it is currently locked.\n"));
534 case PAM_AUTHTOK_DISABLE_AGING
:
535 DEBUG(2, ("PAM: Authentication token aging has been disabled.\n"));
537 case PAM_PERM_DENIED
:
538 DEBUG(0, ("PAM: Permission denied.\n"));
541 DEBUG(0, ("PAM: Could not update all authentication token(s). No authentication tokens were updated.\n"));
543 case PAM_USER_UNKNOWN
:
544 DEBUG(0, ("PAM: User not known to PAM\n"));
547 DEBUG(4, ("PAM: Account OK for User: %s\n", user
));
550 DEBUG(0, ("PAM: UNKNOWN PAM ERROR (%d) for User: %s\n", pam_error
, user
));
553 if(!smb_pam_error_handler(pamh
, pam_error
, "Password Change Failed", 2)) {
557 /* If this point is reached, the password has changed. */
562 * PAM Externally accessible Session handler
565 BOOL
smb_pam_claim_session(char *user
, char *tty
, char *rhost
)
567 pam_handle_t
*pamh
= NULL
;
568 struct pam_conv
*pconv
= NULL
;
570 /* Ignore PAM if told to. */
572 if (!lp_obey_pam_restrictions())
575 if ((pconv
= smb_setup_pam_conv(smb_pam_conv
, user
, NULL
, NULL
)) == NULL
)
578 if (!smb_pam_start(&pamh
, user
, rhost
, pconv
))
581 if (!smb_internal_pam_session(pamh
, user
, tty
, True
)) {
582 smb_pam_end(pamh
, pconv
);
586 return smb_pam_end(pamh
, pconv
);
590 * PAM Externally accessible Session handler
593 BOOL
smb_pam_close_session(char *user
, char *tty
, char *rhost
)
595 pam_handle_t
*pamh
= NULL
;
596 struct pam_conv
*pconv
= NULL
;
598 /* Ignore PAM if told to. */
600 if (!lp_obey_pam_restrictions())
603 if ((pconv
= smb_setup_pam_conv(smb_pam_conv
, user
, NULL
, NULL
)) == NULL
)
606 if (!smb_pam_start(&pamh
, user
, rhost
, pconv
))
609 if (!smb_internal_pam_session(pamh
, user
, tty
, False
)) {
610 smb_pam_end(pamh
, pconv
);
614 return smb_pam_end(pamh
, pconv
);
618 * PAM Externally accessible Account handler
621 uint32
smb_pam_accountcheck(char * user
)
623 uint32 nt_status
= NT_STATUS_ACCOUNT_DISABLED
;
624 pam_handle_t
*pamh
= NULL
;
625 struct pam_conv
*pconv
= NULL
;
627 /* Ignore PAM if told to. */
629 if (!lp_obey_pam_restrictions())
630 return NT_STATUS_NOPROBLEMO
;
632 if ((pconv
= smb_setup_pam_conv(smb_pam_conv
, user
, NULL
, NULL
)) == NULL
)
635 if (!smb_pam_start(&pamh
, user
, NULL
, pconv
))
636 return NT_STATUS_ACCOUNT_DISABLED
;
638 if ((nt_status
= smb_pam_account(pamh
, user
)) != NT_STATUS_NOPROBLEMO
)
639 DEBUG(0, ("smb_pam_accountcheck: PAM: Account Validation Failed - Rejecting User %s!\n", user
));
641 smb_pam_end(pamh
, pconv
);
646 * PAM Password Validation Suite
649 uint32
smb_pam_passcheck(char * user
, char * password
)
651 pam_handle_t
*pamh
= NULL
;
652 uint32 nt_status
= NT_STATUS_LOGON_FAILURE
;
653 struct pam_conv
*pconv
= NULL
;
656 * Note we can't ignore PAM here as this is the only
657 * way of doing auths on plaintext passwords when
658 * compiled --with-pam.
661 if ((pconv
= smb_setup_pam_conv(smb_pam_conv
, user
, password
, NULL
)) == NULL
)
664 if (!smb_pam_start(&pamh
, user
, NULL
, NULL
))
665 return NT_STATUS_LOGON_FAILURE
;
667 if ((nt_status
= smb_pam_auth(pamh
, user
)) != NT_STATUS_NOPROBLEMO
) {
668 DEBUG(0, ("smb_pam_passcheck: PAM: smb_pam_auth failed - Rejecting User %s !\n", user
));
669 smb_pam_end(pamh
, pconv
);
673 if ((nt_status
= smb_pam_account(pamh
, user
)) != NT_STATUS_NOPROBLEMO
) {
674 DEBUG(0, ("smb_pam_passcheck: PAM: smb_pam_account failed - Rejecting User %s !\n", user
));
675 smb_pam_end(pamh
, pconv
);
679 if ((nt_status
= smb_pam_setcred(pamh
, user
)) != NT_STATUS_NOPROBLEMO
) {
680 DEBUG(0, ("smb_pam_passcheck: PAM: smb_pam_setcred failed - Rejecting User %s !\n", user
));
681 smb_pam_end(pamh
, pconv
);
685 smb_pam_end(pamh
, pconv
);
690 * PAM Password Change Suite
693 BOOL
smb_pam_passchange(char * user
, char * oldpassword
, char * newpassword
)
695 /* Appropriate quantities of root should be obtained BEFORE calling this function */
696 struct pam_conv
*pconv
= NULL
;
697 pam_handle_t
*pamh
= NULL
;
699 if ((pconv
= smb_setup_pam_conv(smb_pam_passchange_conv
, user
, oldpassword
, newpassword
)) == NULL
)
702 if(!smb_pam_start(&pamh
, user
, NULL
, pconv
))
705 if (!smb_pam_chauthtok(pamh
, user
)) {
706 DEBUG(0, ("smb_pam_passchange: PAM: Password Change Failed for user %s!\n", user
));
707 smb_pam_end(pamh
, pconv
);
711 return smb_pam_end(pamh
, pconv
);
716 /* If PAM not used, no PAM restrictions on accounts. */
717 uint32
smb_pam_accountcheck(char * user
)
719 return NT_STATUS_NOPROBLEMO
;
722 /* If PAM not used, also no PAM restrictions on sessions. */
723 BOOL
smb_pam_claim_session(char *user
, char *tty
, char *rhost
)
728 /* If PAM not used, also no PAM restrictions on sessions. */
729 BOOL
smb_pam_close_session(char *in_user
, char *tty
, char *rhost
)
733 #endif /* WITH_PAM */