[openssh.git] / auth-pam.c

/*
 * Copyright (c) 2000 Damien Miller.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "includes.h"

#ifdef USE_PAM
#include "xmalloc.h"
#include "log.h"
#include "auth.h"
#include "auth-options.h"
#include "auth-pam.h"
#include "servconf.h"
#include "canohost.h"
#include "readpass.h"

extern char *__progname;

extern int use_privsep;

RCSID("$Id$");

#define NEW_AUTHTOK_MSG \
	"Warning: Your password has expired, please change it now."
#define NEW_AUTHTOK_MSG_PRIVSEP \
	"Your password has expired, the session cannot proceed."

static int do_pam_conversation(int num_msg, const struct pam_message **msg,
	struct pam_response **resp, void *appdata_ptr);

/* module-local variables */
static struct pam_conv conv = {
	(int (*)())do_pam_conversation,
	NULL
};
static char *__pam_msg = NULL;
static pam_handle_t *__pamh = NULL;
static const char *__pampasswd = NULL;

/* states for do_pam_conversation() */
enum { INITIAL_LOGIN, OTHER } pamstate = INITIAL_LOGIN;
/* remember whether pam_acct_mgmt() returned PAM_NEW_AUTHTOK_REQD */
static int password_change_required = 0;
/* remember whether the last pam_authenticate() succeeded or not */
static int was_authenticated = 0;

/* Remember what has been initialised */
static int session_opened = 0;
static int creds_set = 0;

/* accessor which allows us to switch conversation structs according to
 * the authentication method being used */
void do_pam_set_conv(struct pam_conv *conv)
{
	pam_set_item(__pamh, PAM_CONV, conv);
}

/* start an authentication run */
int do_pam_authenticate(int flags)
{
	int retval = pam_authenticate(__pamh, flags);
	was_authenticated = (retval == PAM_SUCCESS);
	return retval;
}

/*
 * PAM conversation function.
 * There are two states this can run in.
 *
 * INITIAL_LOGIN mode simply feeds the password from the client into
 * PAM in response to PAM_PROMPT_ECHO_OFF, and collects output
 * messages with into __pam_msg.  This is used during initial
 * authentication to bypass the normal PAM password prompt.
 *
 * OTHER mode handles PAM_PROMPT_ECHO_OFF with read_passphrase()
 * and outputs messages to stderr. This mode is used if pam_chauthtok()
 * is called to update expired passwords.
 */
static int do_pam_conversation(int num_msg, const struct pam_message **msg,
	struct pam_response **resp, void *appdata_ptr)
{
	struct pam_response *reply;
	int count;
	char buf[1024];

	/* PAM will free this later */
	reply = xmalloc(num_msg * sizeof(*reply));

	for (count = 0; count < num_msg; count++) {
		if (pamstate == INITIAL_LOGIN) {
			/*
			 * We can't use stdio yet, queue messages for 
			 * printing later
			 */
			switch(PAM_MSG_MEMBER(msg, count, msg_style)) {
			case PAM_PROMPT_ECHO_ON:
				xfree(reply);
				return PAM_CONV_ERR;
			case PAM_PROMPT_ECHO_OFF:
				if (__pampasswd == NULL) {
					xfree(reply);
					return PAM_CONV_ERR;
				}
				reply[count].resp = xstrdup(__pampasswd);
				reply[count].resp_retcode = PAM_SUCCESS;
				break;
			case PAM_ERROR_MSG:
			case PAM_TEXT_INFO:
				if (PAM_MSG_MEMBER(msg, count, msg) != NULL) {
					message_cat(&__pam_msg, 
					    PAM_MSG_MEMBER(msg, count, msg));
				}
				reply[count].resp = xstrdup("");
				reply[count].resp_retcode = PAM_SUCCESS;
				break;
			default:
				xfree(reply);
				return PAM_CONV_ERR;
			}
		} else {
			/*
			 * stdio is connected, so interact directly
			 */
			switch(PAM_MSG_MEMBER(msg, count, msg_style)) {
			case PAM_PROMPT_ECHO_ON:
				fputs(PAM_MSG_MEMBER(msg, count, msg), stderr);
				fgets(buf, sizeof(buf), stdin);
				reply[count].resp = xstrdup(buf);
				reply[count].resp_retcode = PAM_SUCCESS;
				break;
			case PAM_PROMPT_ECHO_OFF:
				reply[count].resp = 
				    read_passphrase(PAM_MSG_MEMBER(msg, count,
					msg), RP_ALLOW_STDIN);
				reply[count].resp_retcode = PAM_SUCCESS;
				break;
			case PAM_ERROR_MSG:
			case PAM_TEXT_INFO:
				if (PAM_MSG_MEMBER(msg, count, msg) != NULL)
					fprintf(stderr, "%s\n", 
					    PAM_MSG_MEMBER(msg, count, msg));
				reply[count].resp = xstrdup("");
				reply[count].resp_retcode = PAM_SUCCESS;
				break;
			default:
				xfree(reply);
				return PAM_CONV_ERR;
			}
		}
	}

	*resp = reply;

	return PAM_SUCCESS;
}

/* Called at exit to cleanly shutdown PAM */
void do_pam_cleanup_proc(void *context)
{
	int pam_retval = PAM_SUCCESS;

	if (__pamh && session_opened) {
		pam_retval = pam_close_session(__pamh, 0);
		if (pam_retval != PAM_SUCCESS)
			log("Cannot close PAM session[%d]: %.200s",
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
	}

	if (__pamh && creds_set) {
		pam_retval = pam_setcred(__pamh, PAM_DELETE_CRED);
		if (pam_retval != PAM_SUCCESS)
			debug("Cannot delete credentials[%d]: %.200s", 
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
	}

	if (__pamh) {
		pam_retval = pam_end(__pamh, pam_retval);
		if (pam_retval != PAM_SUCCESS)
			log("Cannot release PAM authentication[%d]: %.200s",
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
	}
}

/* Attempt password authentation using PAM */
int auth_pam_password(Authctxt *authctxt, const char *password)
{
	extern ServerOptions options;
	int pam_retval;
	struct passwd *pw = authctxt->pw;

	do_pam_set_conv(&conv);

	/* deny if no user. */
	if (pw == NULL)
		return 0;
	if (pw->pw_uid == 0 && options.permit_root_login == PERMIT_NO_PASSWD)
		return 0;
	if (*password == '\0' && options.permit_empty_passwd == 0)
		return 0;

	__pampasswd = password;

	pamstate = INITIAL_LOGIN;
	pam_retval = do_pam_authenticate(
	    options.permit_empty_passwd == 0 ? PAM_DISALLOW_NULL_AUTHTOK : 0);
	if (pam_retval == PAM_SUCCESS) {
		debug("PAM Password authentication accepted for "
		    "user \"%.100s\"", pw->pw_name);
		return 1;
	} else {
		debug("PAM Password authentication for \"%.100s\" "
		    "failed[%d]: %s", pw->pw_name, pam_retval, 
		    PAM_STRERROR(__pamh, pam_retval));
		return 0;
	}
}

/* Do account management using PAM */
int do_pam_account(char *username, char *remote_user)
{
	int pam_retval;

	do_pam_set_conv(&conv);

	if (remote_user) {
		debug("PAM setting ruser to \"%.200s\"", remote_user);
		pam_retval = pam_set_item(__pamh, PAM_RUSER, remote_user);
		if (pam_retval != PAM_SUCCESS)
			fatal("PAM set ruser failed[%d]: %.200s", pam_retval, 
			    PAM_STRERROR(__pamh, pam_retval));
	}

	pam_retval = pam_acct_mgmt(__pamh, 0);
	debug2("pam_acct_mgmt() = %d", pam_retval);
	switch (pam_retval) {
		case PAM_SUCCESS:
			/* This is what we want */
			break;
#if 0
		case PAM_NEW_AUTHTOK_REQD:
			message_cat(&__pam_msg, use_privsep ?
			    NEW_AUTHTOK_MSG_PRIVSEP : NEW_AUTHTOK_MSG);
			/* flag that password change is necessary */
			password_change_required = 1;
			/* disallow other functionality for now */
			no_port_forwarding_flag |= 2;
			no_agent_forwarding_flag |= 2;
			no_x11_forwarding_flag |= 2;
			break;
#endif
		default:
			log("PAM rejected by account configuration[%d]: "
			    "%.200s", pam_retval, PAM_STRERROR(__pamh, 
			    pam_retval));
			return(0);
	}

	return(1);
}

/* Do PAM-specific session initialisation */
void do_pam_session(char *username, const char *ttyname)
{
	int pam_retval;

	do_pam_set_conv(&conv);

	if (ttyname != NULL) {
		debug("PAM setting tty to \"%.200s\"", ttyname);
		pam_retval = pam_set_item(__pamh, PAM_TTY, ttyname);
		if (pam_retval != PAM_SUCCESS)
			fatal("PAM set tty failed[%d]: %.200s",
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
	}

	pam_retval = pam_open_session(__pamh, 0);
	if (pam_retval != PAM_SUCCESS)
		fatal("PAM session setup failed[%d]: %.200s",
		    pam_retval, PAM_STRERROR(__pamh, pam_retval));

	session_opened = 1;
}

/* Set PAM credentials */
void do_pam_setcred(int init)
{
	int pam_retval;

	if (__pamh == NULL)
		return;

	do_pam_set_conv(&conv);

	debug("PAM establishing creds");
	pam_retval = pam_setcred(__pamh, 
	    init ? PAM_ESTABLISH_CRED : PAM_REINITIALIZE_CRED);
	if (pam_retval != PAM_SUCCESS) {
		if (was_authenticated)
			fatal("PAM setcred failed[%d]: %.200s",
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
		else
			debug("PAM setcred failed[%d]: %.200s",
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
	} else
		creds_set = 1;
}

/* accessor function for file scope static variable */
int is_pam_password_change_required(void)
{
	return password_change_required;
}

/*
 * Have user change authentication token if pam_acct_mgmt() indicated
 * it was expired.  This needs to be called after an interactive
 * session is established and the user's pty is connected to
 * stdin/stdout/stderr.
 */
void do_pam_chauthtok(void)
{
	int pam_retval;

	do_pam_set_conv(&conv);

	if (password_change_required) {
		if (use_privsep)
			fatal("Password changing is currently unsupported"
			    " with privilege separation");
		pamstate = OTHER;
		pam_retval = pam_chauthtok(__pamh, PAM_CHANGE_EXPIRED_AUTHTOK);
		if (pam_retval != PAM_SUCCESS)
			fatal("PAM pam_chauthtok failed[%d]: %.200s",
			    pam_retval, PAM_STRERROR(__pamh, pam_retval));
#if 0
		/* XXX: This would need to be done in the parent process,
		 * but there's currently no way to pass such request. */
		no_port_forwarding_flag &= ~2;
		no_agent_forwarding_flag &= ~2;
		no_x11_forwarding_flag &= ~2;
		if (!no_port_forwarding_flag && options.allow_tcp_forwarding)
			channel_permit_all_opens();
#endif
	}
}

/* Cleanly shutdown PAM */
void finish_pam(void)
{
	do_pam_cleanup_proc(NULL);
	fatal_remove_cleanup(&do_pam_cleanup_proc, NULL);
}

/* Start PAM authentication for specified account */
void start_pam(const char *user)
{
	int pam_retval;
	extern ServerOptions options;
	extern u_int utmp_len;
	const char *rhost;

	debug("Starting up PAM with username \"%.200s\"", user);

	pam_retval = pam_start(SSHD_PAM_SERVICE, user, &conv, &__pamh);

	if (pam_retval != PAM_SUCCESS)
		fatal("PAM initialisation failed[%d]: %.200s",
		    pam_retval, PAM_STRERROR(__pamh, pam_retval));

	rhost = get_remote_name_or_ip(utmp_len, options.verify_reverse_mapping);
	debug("PAM setting rhost to \"%.200s\"", rhost);

	pam_retval = pam_set_item(__pamh, PAM_RHOST, rhost);
	if (pam_retval != PAM_SUCCESS)
		fatal("PAM set rhost failed[%d]: %.200s", pam_retval,
		    PAM_STRERROR(__pamh, pam_retval));
#ifdef PAM_TTY_KLUDGE
	/*
	 * Some PAM modules (e.g. pam_time) require a TTY to operate,
	 * and will fail in various stupid ways if they don't get one.
	 * sshd doesn't set the tty until too late in the auth process and may
	 * not even need one (for tty-less connections)
	 * Kludge: Set a fake PAM_TTY
	 */
	pam_retval = pam_set_item(__pamh, PAM_TTY, "NODEVssh");
	if (pam_retval != PAM_SUCCESS)
		fatal("PAM set tty failed[%d]: %.200s",
		    pam_retval, PAM_STRERROR(__pamh, pam_retval));
#endif /* PAM_TTY_KLUDGE */

	fatal_add_cleanup(&do_pam_cleanup_proc, NULL);
}

/* Return list of PAM environment strings */
char **fetch_pam_environment(void)
{
#ifdef HAVE_PAM_GETENVLIST
	return(pam_getenvlist(__pamh));
#else /* HAVE_PAM_GETENVLIST */
	return(NULL);
#endif /* HAVE_PAM_GETENVLIST */
}

void free_pam_environment(char **env)
{
	int i;

	if (env != NULL) {
		for (i = 0; env[i] != NULL; i++)
			xfree(env[i]);
	}
}

/* Print any messages that have been generated during authentication */
/* or account checking to stderr */
void print_pam_messages(void)
{
	if (__pam_msg != NULL)
		fputs(__pam_msg, stderr);
}

/* Append a message to buffer */
void message_cat(char **p, const char *a)
{
	char *cp;
	size_t new_len;

	new_len = strlen(a);

	if (*p) {
		size_t len = strlen(*p);

		*p = xrealloc(*p, new_len + len + 2);
		cp = *p + len;
	} else
		*p = cp = xmalloc(new_len + 2);

	memcpy(cp, a, new_len);
	cp[new_len] = '\n';
	cp[new_len + 1] = '\0';
}

#endif /* USE_PAM */
Commit	Line	Data
a5c9cd31	1	/*
09564242	2	* Copyright (c) 2000 Damien Miller. All rights reserved.
	3	*
	4	* Redistribution and use in source and binary forms, with or without
	5	* modification, are permitted provided that the following conditions
	6	* are met:
	7	* 1. Redistributions of source code must retain the above copyright
	8	* notice, this list of conditions and the following disclaimer.
	9	* 2. Redistributions in binary form must reproduce the above copyright
	10	* notice, this list of conditions and the following disclaimer in the
	11	* documentation and/or other materials provided with the distribution.
09564242	12	*
	13	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	14	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	15	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	16	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	17	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	18	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	19	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	20	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	21	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	22	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
a5c9cd31	23	*/
	24
	25	#include "includes.h"
	26
	27	#ifdef USE_PAM
a5c9cd31	28	#include "xmalloc.h"
42f11eb2	29	#include "log.h"
fde58bd4	30	#include "auth.h"
277f55cf	31	#include "auth-options.h"
5c377b3b	32	#include "auth-pam.h"
a5c9cd31	33	#include "servconf.h"
42f11eb2	34	#include "canohost.h"
42f11eb2	35	#include "readpass.h"
a5c9cd31	36
1ddee76b	37	extern char *__progname;
1ddee76b	38
277f55cf	39	extern int use_privsep;
277f55cf	40
a5c9cd31	41	RCSID("$Id$");
a5c9cd31	42
5daf7064	43	#define NEW_AUTHTOK_MSG \
b992432e	44	"Warning: Your password has expired, please change it now."
277f55cf	45	#define NEW_AUTHTOK_MSG_PRIVSEP \
277f55cf	46	"Your password has expired, the session cannot proceed."
5daf7064	47
5c377b3b	48	static int do_pam_conversation(int num_msg, const struct pam_message **msg,
5c377b3b	49	struct pam_response *resp, void appdata_ptr);
a5c9cd31	50
	51	/* module-local variables */
	52	static struct pam_conv conv = {
f7808a93	53	(int (*)())do_pam_conversation,
a5c9cd31	54	NULL
a5c9cd31	55	};
e11aab29	56	static char *__pam_msg = NULL;
	57	static pam_handle_t *__pamh = NULL;
	58	static const char *__pampasswd = NULL;
a5c9cd31	59
5c377b3b	60	/* states for do_pam_conversation() */
8c9fe09e	61	enum { INITIAL_LOGIN, OTHER } pamstate = INITIAL_LOGIN;
b992432e	62	/* remember whether pam_acct_mgmt() returned PAM_NEW_AUTHTOK_REQD */
ad55cd03	63	static int password_change_required = 0;
8c9fe09e	64	/* remember whether the last pam_authenticate() succeeded or not */
	65	static int was_authenticated = 0;
	66
e11aab29	67	/* Remember what has been initialised */
	68	static int session_opened = 0;
	69	static int creds_set = 0;
	70
8c9fe09e	71	/* accessor which allows us to switch conversation structs according to
8c9fe09e	72	* the authentication method being used */
e11aab29	73	void do_pam_set_conv(struct pam_conv *conv)
8c9fe09e	74	{
e11aab29	75	pam_set_item(__pamh, PAM_CONV, conv);
8c9fe09e	76	}
	77
	78	/* start an authentication run */
	79	int do_pam_authenticate(int flags)
	80	{
e11aab29	81	int retval = pam_authenticate(__pamh, flags);
8c9fe09e	82	was_authenticated = (retval == PAM_SUCCESS);
	83	return retval;
	84	}
ad55cd03	85
	86	/*
	87	* PAM conversation function.
	88	* There are two states this can run in.
	89	*
	90	* INITIAL_LOGIN mode simply feeds the password from the client into
	91	* PAM in response to PAM_PROMPT_ECHO_OFF, and collects output
e11aab29	92	* messages with into __pam_msg. This is used during initial
ad55cd03	93	* authentication to bypass the normal PAM password prompt.
ad55cd03	94	*
9678565b	95	* OTHER mode handles PAM_PROMPT_ECHO_OFF with read_passphrase()
ad55cd03	96	* and outputs messages to stderr. This mode is used if pam_chauthtok()
	97	* is called to update expired passwords.
	98	*/
5c377b3b	99	static int do_pam_conversation(int num_msg, const struct pam_message **msg,
a5c9cd31	100	struct pam_response *resp, void appdata_ptr)
	101	{
	102	struct pam_response *reply;
	103	int count;
ad55cd03	104	char buf[1024];
a5c9cd31	105
a5c9cd31	106	/* PAM will free this later */
b2f295dc	107	reply = xmalloc(num_msg * sizeof(*reply));
a5c9cd31	108
ad55cd03	109	for (count = 0; count < num_msg; count++) {
5c377b3b	110	if (pamstate == INITIAL_LOGIN) {
	111	/*
	112	* We can't use stdio yet, queue messages for
	113	* printing later
	114	*/
	115	switch(PAM_MSG_MEMBER(msg, count, msg_style)) {
ad55cd03	116	case PAM_PROMPT_ECHO_ON:
b2f295dc	117	xfree(reply);
5c377b3b	118	return PAM_CONV_ERR;
5c377b3b	119	case PAM_PROMPT_ECHO_OFF:
e11aab29	120	if (__pampasswd == NULL) {
b2f295dc	121	xfree(reply);
71dfaf1c	122	return PAM_CONV_ERR;
71dfaf1c	123	}
e11aab29	124	reply[count].resp = xstrdup(__pampasswd);
a5c9cd31	125	reply[count].resp_retcode = PAM_SUCCESS;
a5c9cd31	126	break;
ad55cd03	127	case PAM_ERROR_MSG:
a5c9cd31	128	case PAM_TEXT_INFO:
b2f295dc	129	if (PAM_MSG_MEMBER(msg, count, msg) != NULL) {
e11aab29	130	message_cat(&__pam_msg,
5c377b3b	131	PAM_MSG_MEMBER(msg, count, msg));
ad55cd03	132	}
a5c9cd31	133	reply[count].resp = xstrdup("");
ad55cd03	134	reply[count].resp_retcode = PAM_SUCCESS;
a5c9cd31	135	break;
a5c9cd31	136	default:
b2f295dc	137	xfree(reply);
a5c9cd31	138	return PAM_CONV_ERR;
5c377b3b	139	}
	140	} else {
	141	/*
	142	* stdio is connected, so interact directly
	143	*/
	144	switch(PAM_MSG_MEMBER(msg, count, msg_style)) {
	145	case PAM_PROMPT_ECHO_ON:
	146	fputs(PAM_MSG_MEMBER(msg, count, msg), stderr);
	147	fgets(buf, sizeof(buf), stdin);
	148	reply[count].resp = xstrdup(buf);
	149	reply[count].resp_retcode = PAM_SUCCESS;
	150	break;
	151	case PAM_PROMPT_ECHO_OFF:
9678565b	152	reply[count].resp =
840ad55e	153	read_passphrase(PAM_MSG_MEMBER(msg, count,
840ad55e	154	msg), RP_ALLOW_STDIN);
5c377b3b	155	reply[count].resp_retcode = PAM_SUCCESS;
	156	break;
	157	case PAM_ERROR_MSG:
	158	case PAM_TEXT_INFO:
d228d9dd	159	if (PAM_MSG_MEMBER(msg, count, msg) != NULL)
5c377b3b	160	fprintf(stderr, "%s\n",
	161	PAM_MSG_MEMBER(msg, count, msg));
	162	reply[count].resp = xstrdup("");
	163	reply[count].resp_retcode = PAM_SUCCESS;
	164	break;
	165	default:
b2f295dc	166	xfree(reply);
5c377b3b	167	return PAM_CONV_ERR;
5c377b3b	168	}
a5c9cd31	169	}
	170	}
	171
	172	*resp = reply;
	173
	174	return PAM_SUCCESS;
	175	}
	176
	177	/* Called at exit to cleanly shutdown PAM */
e11aab29	178	void do_pam_cleanup_proc(void *context)
a5c9cd31	179	{
37eadb90	180	int pam_retval = PAM_SUCCESS;
a5c9cd31	181
e11aab29	182	if (__pamh && session_opened) {
e11aab29	183	pam_retval = pam_close_session(__pamh, 0);
5c377b3b	184	if (pam_retval != PAM_SUCCESS)
2b87da3b	185	log("Cannot close PAM session[%d]: %.200s",
e11aab29	186	pam_retval, PAM_STRERROR(__pamh, pam_retval));
1c2d0a13	187	}
a5c9cd31	188
e11aab29	189	if (__pamh && creds_set) {
e11aab29	190	pam_retval = pam_setcred(__pamh, PAM_DELETE_CRED);
5c377b3b	191	if (pam_retval != PAM_SUCCESS)
5c377b3b	192	debug("Cannot delete credentials[%d]: %.200s",
e11aab29	193	pam_retval, PAM_STRERROR(__pamh, pam_retval));
1c2d0a13	194	}
a5c9cd31	195
e11aab29	196	if (__pamh) {
e11aab29	197	pam_retval = pam_end(__pamh, pam_retval);
5c377b3b	198	if (pam_retval != PAM_SUCCESS)
2b87da3b	199	log("Cannot release PAM authentication[%d]: %.200s",
e11aab29	200	pam_retval, PAM_STRERROR(__pamh, pam_retval));
a5c9cd31	201	}
	202	}
	203
	204	/* Attempt password authentation using PAM */
fde58bd4	205	int auth_pam_password(Authctxt authctxt, const char password)
a5c9cd31	206	{
	207	extern ServerOptions options;
	208	int pam_retval;
fde58bd4	209	struct passwd *pw = authctxt->pw;
a5c9cd31	210
e11aab29	211	do_pam_set_conv(&conv);
8c9fe09e	212
a5c9cd31	213	/* deny if no user. */
	214	if (pw == NULL)
	215	return 0;
3cc990d7	216	if (pw->pw_uid == 0 && options.permit_root_login == PERMIT_NO_PASSWD)
a5c9cd31	217	return 0;
	218	if (*password == '\0' && options.permit_empty_passwd == 0)
	219	return 0;
	220
e11aab29	221	__pampasswd = password;
2b87da3b	222
ad55cd03	223	pamstate = INITIAL_LOGIN;
78afd1dc	224	pam_retval = do_pam_authenticate(
78afd1dc	225	options.permit_empty_passwd == 0 ? PAM_DISALLOW_NULL_AUTHTOK : 0);
a5c9cd31	226	if (pam_retval == PAM_SUCCESS) {
5c377b3b	227	debug("PAM Password authentication accepted for "
5c377b3b	228	"user \"%.100s\"", pw->pw_name);
a5c9cd31	229	return 1;
a5c9cd31	230	} else {
5c377b3b	231	debug("PAM Password authentication for \"%.100s\" "
5c377b3b	232	"failed[%d]: %s", pw->pw_name, pam_retval,
e11aab29	233	PAM_STRERROR(__pamh, pam_retval));
a5c9cd31	234	return 0;
	235	}
	236	}
	237
	238	/* Do account management using PAM */
	239	int do_pam_account(char username, char remote_user)
	240	{
	241	int pam_retval;
2b87da3b	242
e11aab29	243	do_pam_set_conv(&conv);
5c377b3b	244
5c377b3b	245	if (remote_user) {
a5c9cd31	246	debug("PAM setting ruser to \"%.200s\"", remote_user);
e11aab29	247	pam_retval = pam_set_item(__pamh, PAM_RUSER, remote_user);
5c377b3b	248	if (pam_retval != PAM_SUCCESS)
5c377b3b	249	fatal("PAM set ruser failed[%d]: %.200s", pam_retval,
e11aab29	250	PAM_STRERROR(__pamh, pam_retval));
a5c9cd31	251	}
a5c9cd31	252
e11aab29	253	pam_retval = pam_acct_mgmt(__pamh, 0);
ad200abb	254	debug2("pam_acct_mgmt() = %d", pam_retval);
5daf7064	255	switch (pam_retval) {
	256	case PAM_SUCCESS:
	257	/* This is what we want */
	258	break;
e108cd93	259	#if 0
5daf7064	260	case PAM_NEW_AUTHTOK_REQD:
277f55cf	261	message_cat(&__pam_msg, use_privsep ?
277f55cf	262	NEW_AUTHTOK_MSG_PRIVSEP : NEW_AUTHTOK_MSG);
ad55cd03	263	/* flag that password change is necessary */
ad55cd03	264	password_change_required = 1;
277f55cf	265	/* disallow other functionality for now */
	266	no_port_forwarding_flag \|= 2;
	267	no_agent_forwarding_flag \|= 2;
	268	no_x11_forwarding_flag \|= 2;
5daf7064	269	break;
e108cd93	270	#endif
5daf7064	271	default:
5c377b3b	272	log("PAM rejected by account configuration[%d]: "
e11aab29	273	"%.200s", pam_retval, PAM_STRERROR(__pamh,
5c377b3b	274	pam_retval));
5daf7064	275	return(0);
a5c9cd31	276	}
2b87da3b	277
a5c9cd31	278	return(1);
	279	}
	280
	281	/* Do PAM-specific session initialisation */
fd094f49	282	void do_pam_session(char username, const char ttyname)
a5c9cd31	283	{
	284	int pam_retval;
	285
5f404be3	286	do_pam_set_conv(&conv);
5f404be3	287
a5c9cd31	288	if (ttyname != NULL) {
a5c9cd31	289	debug("PAM setting tty to \"%.200s\"", ttyname);
e11aab29	290	pam_retval = pam_set_item(__pamh, PAM_TTY, ttyname);
5c377b3b	291	if (pam_retval != PAM_SUCCESS)
2b87da3b	292	fatal("PAM set tty failed[%d]: %.200s",
e11aab29	293	pam_retval, PAM_STRERROR(__pamh, pam_retval));
a5c9cd31	294	}
a5c9cd31	295
e11aab29	296	pam_retval = pam_open_session(__pamh, 0);
5c377b3b	297	if (pam_retval != PAM_SUCCESS)
2b87da3b	298	fatal("PAM session setup failed[%d]: %.200s",
e11aab29	299	pam_retval, PAM_STRERROR(__pamh, pam_retval));
40a35ff1	300
1c2d0a13	301	session_opened = 1;
a5c9cd31	302	}
a5c9cd31	303
2b87da3b	304	/* Set PAM credentials */
9afbfcfa	305	void do_pam_setcred(int init)
a5c9cd31	306	{
a5c9cd31	307	int pam_retval;
2b87da3b	308
39ce53de	309	if (__pamh == NULL)
	310	return;
	311
5f404be3	312	do_pam_set_conv(&conv);
5f404be3	313
a5c9cd31	314	debug("PAM establishing creds");
9afbfcfa	315	pam_retval = pam_setcred(__pamh,
9afbfcfa	316	init ? PAM_ESTABLISH_CRED : PAM_REINITIALIZE_CRED);
5daf7064	317	if (pam_retval != PAM_SUCCESS) {
5c377b3b	318	if (was_authenticated)
2b87da3b	319	fatal("PAM setcred failed[%d]: %.200s",
e11aab29	320	pam_retval, PAM_STRERROR(__pamh, pam_retval));
5c377b3b	321	else
2b87da3b	322	debug("PAM setcred failed[%d]: %.200s",
e11aab29	323	pam_retval, PAM_STRERROR(__pamh, pam_retval));
1c2d0a13	324	} else
1c2d0a13	325	creds_set = 1;
ad55cd03	326	}
ad55cd03	327
2919e060	328	/* accessor function for file scope static variable */
e11aab29	329	int is_pam_password_change_required(void)
2919e060	330	{
	331	return password_change_required;
	332	}
	333
2b87da3b	334	/*
ad55cd03	335	* Have user change authentication token if pam_acct_mgmt() indicated
	336	* it was expired. This needs to be called after an interactive
	337	* session is established and the user's pty is connected to
b992432e	338	* stdin/stdout/stderr.
ad55cd03	339	*/
a815d7a3	340	void do_pam_chauthtok(void)
ad55cd03	341	{
	342	int pam_retval;
	343
5f404be3	344	do_pam_set_conv(&conv);
5f404be3	345
ad55cd03	346	if (password_change_required) {
277f55cf	347	if (use_privsep)
	348	fatal("Password changing is currently unsupported"
	349	" with privilege separation");
ad55cd03	350	pamstate = OTHER;
0a3700ee	351	pam_retval = pam_chauthtok(__pamh, PAM_CHANGE_EXPIRED_AUTHTOK);
	352	if (pam_retval != PAM_SUCCESS)
	353	fatal("PAM pam_chauthtok failed[%d]: %.200s",
	354	pam_retval, PAM_STRERROR(__pamh, pam_retval));
277f55cf	355	#if 0
	356	/* XXX: This would need to be done in the parent process,
	357	* but there's currently no way to pass such request. */
	358	no_port_forwarding_flag &= ~2;
	359	no_agent_forwarding_flag &= ~2;
	360	no_x11_forwarding_flag &= ~2;
	361	if (!no_port_forwarding_flag && options.allow_tcp_forwarding)
	362	channel_permit_all_opens();
	363	#endif
5daf7064	364	}
a5c9cd31	365	}
	366
	367	/* Cleanly shutdown PAM */
	368	void finish_pam(void)
	369	{
e11aab29	370	do_pam_cleanup_proc(NULL);
e11aab29	371	fatal_remove_cleanup(&do_pam_cleanup_proc, NULL);
a5c9cd31	372	}
	373
	374	/* Start PAM authentication for specified account */
04fc7a67	375	void start_pam(const char *user)
a5c9cd31	376	{
a5c9cd31	377	int pam_retval;
dbd97a4d	378	extern ServerOptions options;
46c76c63	379	extern u_int utmp_len;
46c76c63	380	const char *rhost;
a5c9cd31	381
04fc7a67	382	debug("Starting up PAM with username \"%.200s\"", user);
a5c9cd31	383
e11aab29	384	pam_retval = pam_start(SSHD_PAM_SERVICE, user, &conv, &__pamh);
a5c9cd31	385
5c377b3b	386	if (pam_retval != PAM_SUCCESS)
2b87da3b	387	fatal("PAM initialisation failed[%d]: %.200s",
e11aab29	388	pam_retval, PAM_STRERROR(__pamh, pam_retval));
e275684f	389
983784a1	390	rhost = get_remote_name_or_ip(utmp_len, options.verify_reverse_mapping);
46c76c63	391	debug("PAM setting rhost to \"%.200s\"", rhost);
	392
	393	pam_retval = pam_set_item(__pamh, PAM_RHOST, rhost);
e275684f	394	if (pam_retval != PAM_SUCCESS)
e275684f	395	fatal("PAM set rhost failed[%d]: %.200s", pam_retval,
e11aab29	396	PAM_STRERROR(__pamh, pam_retval));
a8545c6c	397	#ifdef PAM_TTY_KLUDGE
ae543aaa	398	/*
ae543aaa	399	* Some PAM modules (e.g. pam_time) require a TTY to operate,
2b87da3b	400	* and will fail in various stupid ways if they don't get one.
ae543aaa	401	* sshd doesn't set the tty until too late in the auth process and may
ae543aaa	402	* not even need one (for tty-less connections)
2b87da3b	403	* Kludge: Set a fake PAM_TTY
ae543aaa	404	*/
9f214051	405	pam_retval = pam_set_item(__pamh, PAM_TTY, "NODEVssh");
5c377b3b	406	if (pam_retval != PAM_SUCCESS)
2b87da3b	407	fatal("PAM set tty failed[%d]: %.200s",
e11aab29	408	pam_retval, PAM_STRERROR(__pamh, pam_retval));
a8545c6c	409	#endif /* PAM_TTY_KLUDGE */
cbd7492e	410
e11aab29	411	fatal_add_cleanup(&do_pam_cleanup_proc, NULL);
a5c9cd31	412	}
a5c9cd31	413
1d3f4ae7	414	/* Return list of PAM environment strings */
a5c9cd31	415	char **fetch_pam_environment(void)
a5c9cd31	416	{
2b763e31	417	#ifdef HAVE_PAM_GETENVLIST
e11aab29	418	return(pam_getenvlist(__pamh));
2b763e31	419	#else /* HAVE_PAM_GETENVLIST */
	420	return(NULL);
	421	#endif /* HAVE_PAM_GETENVLIST */
a5c9cd31	422	}
a5c9cd31	423
ee48c949	424	void free_pam_environment(char **env)
	425	{
	426	int i;
	427
	428	if (env != NULL) {
	429	for (i = 0; env[i] != NULL; i++)
	430	xfree(env[i]);
	431	}
	432	}
	433
a5c9cd31	434	/* Print any messages that have been generated during authentication */
	435	/* or account checking to stderr */
	436	void print_pam_messages(void)
	437	{
e11aab29	438	if (__pam_msg != NULL)
e11aab29	439	fputs(__pam_msg, stderr);
5daf7064	440	}
5daf7064	441
5c377b3b	442	/* Append a message to buffer */
5c377b3b	443	void message_cat(char *p, const char a)
5daf7064	444	{
5c377b3b	445	char *cp;
5c377b3b	446	size_t new_len;
2b87da3b	447
5c377b3b	448	new_len = strlen(a);
2b87da3b	449
5c377b3b	450	if (*p) {
	451	size_t len = strlen(*p);
	452
	453	p = xrealloc(p, new_len + len + 2);
	454	cp = *p + len;
	455	} else
	456	*p = cp = xmalloc(new_len + 2);
5daf7064	457
5c377b3b	458	memcpy(cp, a, new_len);
	459	cp[new_len] = '\n';
	460	cp[new_len + 1] = '\0';
a5c9cd31	461	}
	462
	463	#endif /* USE_PAM */