2 * Copyright (c) 2002 Networks Associates Technology, Inc.
5 * This software was developed for the FreeBSD Project by ThinkSec AS and
6 * NAI Labs, the Security Research Division of Network Associates, Inc.
7 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8 * DARPA CHATS research program.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * Copyright (c) 2003,2004 Damien Miller <djm@mindrot.org>
33 * Copyright (c) 2003,2004 Darren Tucker <dtucker@zip.com.au>
35 * Permission to use, copy, modify, and distribute this software for any
36 * purpose with or without fee is hereby granted, provided that the above
37 * copyright notice and this permission notice appear in all copies.
39 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
40 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
41 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
42 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
43 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
44 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
45 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
48 /* Based on $FreeBSD: src/crypto/openssh/auth2-pam-freebsd.c,v 1.11 2003/03/31 13:48:18 des Exp $ */
53 #if defined(HAVE_SECURITY_PAM_APPL_H)
54 #include <security/pam_appl.h>
55 #elif defined (HAVE_PAM_PAM_APPL_H)
56 #include <pam/pam_appl.h>
65 #include "monitor_wrap.h"
72 #include "auth-options.h"
74 extern ServerOptions options;
75 extern Buffer loginmsg;
77 extern u_int utmp_len;
79 #ifdef USE_POSIX_THREADS
82 * Avoid namespace clash when *not* using pthreads for systems *with*
83 * pthreads, which unconditionally define pthread_t via sys/types.h
86 typedef pthread_t sp_pthread_t;
88 typedef pid_t sp_pthread_t;
92 sp_pthread_t pam_thread;
98 static void sshpam_free_ctx(void *);
99 static struct pam_ctxt *cleanup_ctxt;
101 #ifndef USE_POSIX_THREADS
103 * Simulate threads with processes.
106 static int sshpam_thread_status = -1;
107 static mysig_t sshpam_oldsig;
110 sshpam_sigchld_handler(int sig)
112 signal(SIGCHLD, SIG_DFL);
113 if (cleanup_ctxt == NULL)
114 return; /* handler called after PAM cleanup, shouldn't happen */
115 if (waitpid(cleanup_ctxt->pam_thread, &sshpam_thread_status, WNOHANG)
117 /* PAM thread has not exitted, privsep slave must have */
118 kill(cleanup_ctxt->pam_thread, SIGTERM);
119 if (waitpid(cleanup_ctxt->pam_thread, &sshpam_thread_status, 0)
121 return; /* could not wait */
123 if (WIFSIGNALED(sshpam_thread_status) &&
124 WTERMSIG(sshpam_thread_status) == SIGTERM)
125 return; /* terminated by pthread_cancel */
126 if (!WIFEXITED(sshpam_thread_status))
127 fatal("PAM: authentication thread exited unexpectedly");
128 if (WEXITSTATUS(sshpam_thread_status) != 0)
129 fatal("PAM: authentication thread exited uncleanly");
133 pthread_exit(void *value __unused)
139 pthread_create(sp_pthread_t *thread, const void *attr __unused,
140 void *(*thread_start)(void *), void *arg)
144 sshpam_thread_status = -1;
145 switch ((pid = fork())) {
147 error("fork(): %s", strerror(errno));
154 sshpam_oldsig = signal(SIGCHLD, sshpam_sigchld_handler);
160 pthread_cancel(sp_pthread_t thread)
162 signal(SIGCHLD, sshpam_oldsig);
163 return (kill(thread, SIGTERM));
167 pthread_join(sp_pthread_t thread, void **value __unused)
171 if (sshpam_thread_status != -1)
172 return (sshpam_thread_status);
173 signal(SIGCHLD, sshpam_oldsig);
174 waitpid(thread, &status, 0);
180 static pam_handle_t *sshpam_handle = NULL;
181 static int sshpam_err = 0;
182 static int sshpam_authenticated = 0;
183 static int sshpam_session_open = 0;
184 static int sshpam_cred_established = 0;
185 static int sshpam_account_status = -1;
186 static char **sshpam_env = NULL;
187 static Authctxt *sshpam_authctxt = NULL;
188 static const char *sshpam_password = NULL;
189 static char badpw[] = "\b\n\r\177INCORRECT";
191 /* Some PAM implementations don't implement this */
192 #ifndef HAVE_PAM_GETENVLIST
194 pam_getenvlist(pam_handle_t *pamh)
197 * XXX - If necessary, we can still support envrionment passing
198 * for platforms without pam_getenvlist by searching for known
199 * env vars (e.g. KRB5CCNAME) from the PAM environment.
206 * Some platforms, notably Solaris, do not enforce password complexity
207 * rules during pam_chauthtok() if the real uid of the calling process
208 * is 0, on the assumption that it's being called by "passwd" run by root.
209 * This wraps pam_chauthtok and sets/restore the real uid so PAM will do
212 #ifdef SSHPAM_CHAUTHTOK_NEEDS_RUID
214 sshpam_chauthtok_ruid(pam_handle_t *pamh, int flags)
218 if (sshpam_authctxt == NULL)
219 fatal("PAM: sshpam_authctxt not initialized");
220 if (setreuid(sshpam_authctxt->pw->pw_uid, -1) == -1)
221 fatal("%s: setreuid failed: %s", __func__, strerror(errno));
222 result = pam_chauthtok(pamh, flags);
223 if (setreuid(0, -1) == -1)
224 fatal("%s: setreuid failed: %s", __func__, strerror(errno));
227 # define pam_chauthtok(a,b) (sshpam_chauthtok_ruid((a), (b)))
231 sshpam_password_change_required(int reqd)
233 debug3("%s %d", __func__, reqd);
234 if (sshpam_authctxt == NULL)
235 fatal("%s: PAM authctxt not initialized", __func__);
236 sshpam_authctxt->force_pwchange = reqd;
238 no_port_forwarding_flag |= 2;
239 no_agent_forwarding_flag |= 2;
240 no_x11_forwarding_flag |= 2;
242 no_port_forwarding_flag &= ~2;
243 no_agent_forwarding_flag &= ~2;
244 no_x11_forwarding_flag &= ~2;
248 /* Check ssh internal flags in addition to PAM */
251 sshpam_login_allowed(Authctxt *ctxt)
253 if (ctxt->valid && (ctxt->pw->pw_uid != 0 ||
254 options.permit_root_login == PERMIT_YES))
259 /* Import regular and PAM environment from subprocess */
261 import_environments(Buffer *b)
267 debug3("PAM: %s entering", __func__);
269 #ifndef USE_POSIX_THREADS
270 /* Import variables set by do_pam_account */
271 sshpam_account_status = buffer_get_int(b);
272 sshpam_password_change_required(buffer_get_int(b));
274 /* Import environment from subprocess */
275 num_env = buffer_get_int(b);
276 sshpam_env = xmalloc((num_env + 1) * sizeof(*sshpam_env));
277 debug3("PAM: num env strings %d", num_env);
278 for(i = 0; i < num_env; i++)
279 sshpam_env[i] = buffer_get_string(b, NULL);
281 sshpam_env[num_env] = NULL;
283 /* Import PAM environment from subprocess */
284 num_env = buffer_get_int(b);
285 debug("PAM: num PAM env strings %d", num_env);
286 for(i = 0; i < num_env; i++) {
287 env = buffer_get_string(b, NULL);
289 #ifdef HAVE_PAM_PUTENV
290 /* Errors are not fatal here */
291 if ((err = pam_putenv(sshpam_handle, env)) != PAM_SUCCESS) {
292 error("PAM: pam_putenv: %s",
293 pam_strerror(sshpam_handle, sshpam_err));
301 * Conversation function for authentication thread.
304 sshpam_thread_conv(int n, struct pam_message **msg,
305 struct pam_response **resp, void *data)
308 struct pam_ctxt *ctxt;
309 struct pam_response *reply;
312 debug3("PAM: %s entering, %d messages", __func__, n);
316 error("PAM: conversation function passed a null context");
317 return (PAM_CONV_ERR);
320 if (n <= 0 || n > PAM_MAX_NUM_MSG)
321 return (PAM_CONV_ERR);
323 if ((reply = malloc(n * sizeof(*reply))) == NULL)
324 return (PAM_CONV_ERR);
325 memset(reply, 0, n * sizeof(*reply));
327 buffer_init(&buffer);
328 for (i = 0; i < n; ++i) {
329 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
330 case PAM_PROMPT_ECHO_OFF:
331 buffer_put_cstring(&buffer,
332 PAM_MSG_MEMBER(msg, i, msg));
333 if (ssh_msg_send(ctxt->pam_csock,
334 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
336 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
338 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
340 reply[i].resp = buffer_get_string(&buffer, NULL);
342 case PAM_PROMPT_ECHO_ON:
343 buffer_put_cstring(&buffer,
344 PAM_MSG_MEMBER(msg, i, msg));
345 if (ssh_msg_send(ctxt->pam_csock,
346 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
348 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
350 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
352 reply[i].resp = buffer_get_string(&buffer, NULL);
355 buffer_put_cstring(&buffer,
356 PAM_MSG_MEMBER(msg, i, msg));
357 if (ssh_msg_send(ctxt->pam_csock,
358 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
362 buffer_put_cstring(&buffer,
363 PAM_MSG_MEMBER(msg, i, msg));
364 if (ssh_msg_send(ctxt->pam_csock,
365 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
371 buffer_clear(&buffer);
373 buffer_free(&buffer);
375 return (PAM_SUCCESS);
378 for(i = 0; i < n; i++) {
379 if (reply[i].resp != NULL)
380 xfree(reply[i].resp);
383 buffer_free(&buffer);
384 return (PAM_CONV_ERR);
388 * Authentication thread.
391 sshpam_thread(void *ctxtp)
393 struct pam_ctxt *ctxt = ctxtp;
395 struct pam_conv sshpam_conv;
396 int flags = (options.permit_empty_passwd == 0 ?
397 PAM_DISALLOW_NULL_AUTHTOK : 0);
398 #ifndef USE_POSIX_THREADS
399 extern char **environ;
402 const char *pam_user;
404 pam_get_item(sshpam_handle, PAM_USER, (void **)&pam_user);
407 if (sshpam_authctxt != NULL) {
408 setproctitle("%s [pam]",
409 sshpam_authctxt->valid ? pam_user : "unknown");
413 sshpam_conv.conv = sshpam_thread_conv;
414 sshpam_conv.appdata_ptr = ctxt;
416 if (sshpam_authctxt == NULL)
417 fatal("%s: PAM authctxt not initialized", __func__);
419 buffer_init(&buffer);
420 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
421 (const void *)&sshpam_conv);
422 if (sshpam_err != PAM_SUCCESS)
424 sshpam_err = pam_authenticate(sshpam_handle, flags);
425 if (sshpam_err != PAM_SUCCESS)
429 if (!do_pam_account())
431 if (sshpam_authctxt->force_pwchange) {
432 sshpam_err = pam_chauthtok(sshpam_handle,
433 PAM_CHANGE_EXPIRED_AUTHTOK);
434 if (sshpam_err != PAM_SUCCESS)
436 sshpam_password_change_required(0);
440 buffer_put_cstring(&buffer, "OK");
442 #ifndef USE_POSIX_THREADS
443 /* Export variables set by do_pam_account */
444 buffer_put_int(&buffer, sshpam_account_status);
445 buffer_put_int(&buffer, sshpam_authctxt->force_pwchange);
447 /* Export any environment strings set in child */
448 for(i = 0; environ[i] != NULL; i++)
450 buffer_put_int(&buffer, i);
451 for(i = 0; environ[i] != NULL; i++)
452 buffer_put_cstring(&buffer, environ[i]);
454 /* Export any environment strings set by PAM in child */
455 env_from_pam = pam_getenvlist(sshpam_handle);
456 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
458 buffer_put_int(&buffer, i);
459 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
460 buffer_put_cstring(&buffer, env_from_pam[i]);
461 #endif /* USE_POSIX_THREADS */
463 /* XXX - can't do much about an error here */
464 ssh_msg_send(ctxt->pam_csock, sshpam_err, &buffer);
465 buffer_free(&buffer);
469 buffer_put_cstring(&buffer,
470 pam_strerror(sshpam_handle, sshpam_err));
471 /* XXX - can't do much about an error here */
472 ssh_msg_send(ctxt->pam_csock, PAM_AUTH_ERR, &buffer);
473 buffer_free(&buffer);
476 return (NULL); /* Avoid warning for non-pthread case */
480 sshpam_thread_cleanup(void)
482 struct pam_ctxt *ctxt = cleanup_ctxt;
484 debug3("PAM: %s entering", __func__);
485 if (ctxt != NULL && ctxt->pam_thread != 0) {
486 pthread_cancel(ctxt->pam_thread);
487 pthread_join(ctxt->pam_thread, NULL);
488 close(ctxt->pam_psock);
489 close(ctxt->pam_csock);
490 memset(ctxt, 0, sizeof(*ctxt));
496 sshpam_null_conv(int n, struct pam_message **msg,
497 struct pam_response **resp, void *data)
499 debug3("PAM: %s entering, %d messages", __func__, n);
500 return (PAM_CONV_ERR);
503 static struct pam_conv null_conv = { sshpam_null_conv, NULL };
506 sshpam_store_conv(int n, struct pam_message **msg,
507 struct pam_response **resp, void *data)
509 struct pam_response *reply;
513 debug3("PAM: %s called with %d messages", __func__, n);
516 if (n <= 0 || n > PAM_MAX_NUM_MSG)
517 return (PAM_CONV_ERR);
519 if ((reply = malloc(n * sizeof(*reply))) == NULL)
520 return (PAM_CONV_ERR);
521 memset(reply, 0, n * sizeof(*reply));
523 for (i = 0; i < n; ++i) {
524 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
527 len = strlen(PAM_MSG_MEMBER(msg, i, msg));
528 buffer_append(&loginmsg, PAM_MSG_MEMBER(msg, i, msg), len);
529 buffer_append(&loginmsg, "\n", 1 );
530 reply[i].resp_retcode = PAM_SUCCESS;
537 return (PAM_SUCCESS);
540 for(i = 0; i < n; i++) {
541 if (reply[i].resp != NULL)
542 xfree(reply[i].resp);
545 return (PAM_CONV_ERR);
548 static struct pam_conv store_conv = { sshpam_store_conv, NULL };
553 debug("PAM: cleanup");
554 if (sshpam_handle == NULL)
556 pam_set_item(sshpam_handle, PAM_CONV, (const void *)&null_conv);
557 if (sshpam_cred_established) {
558 pam_setcred(sshpam_handle, PAM_DELETE_CRED);
559 sshpam_cred_established = 0;
561 if (sshpam_session_open) {
562 pam_close_session(sshpam_handle, PAM_SILENT);
563 sshpam_session_open = 0;
565 sshpam_authenticated = 0;
566 pam_end(sshpam_handle, sshpam_err);
567 sshpam_handle = NULL;
571 sshpam_init(Authctxt *authctxt)
573 extern char *__progname;
574 const char *pam_rhost, *pam_user, *user = authctxt->user;
576 if (sshpam_handle != NULL) {
577 /* We already have a PAM context; check if the user matches */
578 sshpam_err = pam_get_item(sshpam_handle,
579 PAM_USER, (void **)&pam_user);
580 if (sshpam_err == PAM_SUCCESS && strcmp(user, pam_user) == 0)
582 pam_end(sshpam_handle, sshpam_err);
583 sshpam_handle = NULL;
585 debug("PAM: initializing for \"%s\"", user);
587 pam_start(SSHD_PAM_SERVICE, user, &store_conv, &sshpam_handle);
588 sshpam_authctxt = authctxt;
590 if (sshpam_err != PAM_SUCCESS) {
591 pam_end(sshpam_handle, sshpam_err);
592 sshpam_handle = NULL;
595 pam_rhost = get_remote_name_or_ip(utmp_len, options.use_dns);
596 debug("PAM: setting PAM_RHOST to \"%s\"", pam_rhost);
597 sshpam_err = pam_set_item(sshpam_handle, PAM_RHOST, pam_rhost);
598 if (sshpam_err != PAM_SUCCESS) {
599 pam_end(sshpam_handle, sshpam_err);
600 sshpam_handle = NULL;
603 #ifdef PAM_TTY_KLUDGE
605 * Some silly PAM modules (e.g. pam_time) require a TTY to operate.
606 * sshd doesn't set the tty until too late in the auth process and
607 * may not even set one (for tty-less connections)
609 debug("PAM: setting PAM_TTY to \"ssh\"");
610 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, "ssh");
611 if (sshpam_err != PAM_SUCCESS) {
612 pam_end(sshpam_handle, sshpam_err);
613 sshpam_handle = NULL;
621 sshpam_init_ctx(Authctxt *authctxt)
623 struct pam_ctxt *ctxt;
626 debug3("PAM: %s entering", __func__);
627 /* Refuse to start if we don't have PAM enabled */
628 if (!options.use_pam)
632 if (sshpam_init(authctxt) == -1) {
633 error("PAM: initialization failed");
637 ctxt = xmalloc(sizeof *ctxt);
638 memset(ctxt, 0, sizeof(*ctxt));
640 /* Start the authentication thread */
641 if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, socks) == -1) {
642 error("PAM: failed create sockets: %s", strerror(errno));
646 ctxt->pam_psock = socks[0];
647 ctxt->pam_csock = socks[1];
648 if (pthread_create(&ctxt->pam_thread, NULL, sshpam_thread, ctxt) == -1) {
649 error("PAM: failed to start authentication thread: %s",
661 sshpam_query(void *ctx, char **name, char **info,
662 u_int *num, char ***prompts, u_int **echo_on)
665 struct pam_ctxt *ctxt = ctx;
671 debug3("PAM: %s entering", __func__);
672 buffer_init(&buffer);
675 *prompts = xmalloc(sizeof(char *));
678 *echo_on = xmalloc(sizeof(u_int));
679 while (ssh_msg_recv(ctxt->pam_psock, &buffer) == 0) {
680 type = buffer_get_char(&buffer);
681 msg = buffer_get_string(&buffer, NULL);
684 case PAM_PROMPT_ECHO_ON:
685 case PAM_PROMPT_ECHO_OFF:
687 len = plen + mlen + 1;
688 **prompts = xrealloc(**prompts, len);
689 strlcpy(**prompts + plen, msg, len - plen);
691 **echo_on = (type == PAM_PROMPT_ECHO_ON);
696 /* accumulate messages */
697 len = plen + mlen + 2;
698 **prompts = xrealloc(**prompts, len);
699 strlcpy(**prompts + plen, msg, len - plen);
701 strlcat(**prompts + plen, "\n", len - plen);
707 if (**prompts != NULL) {
708 /* drain any accumulated messages */
709 debug("PAM: %s", **prompts);
710 buffer_append(&loginmsg, **prompts,
715 if (type == PAM_SUCCESS) {
716 if (!sshpam_login_allowed(sshpam_authctxt))
717 fatal("Internal error: PAM auth "
718 "succeeded when it should have "
720 import_environments(&buffer);
727 error("PAM: %s for %s%.100s from %.100s", msg,
728 sshpam_authctxt->valid ? "" : "illegal user ",
729 sshpam_authctxt->user,
730 get_remote_name_or_ip(utmp_len, options.use_dns));
743 /* XXX - see also comment in auth-chall.c:verify_response */
745 sshpam_respond(void *ctx, u_int num, char **resp)
748 struct pam_ctxt *ctxt = ctx;
750 debug2("PAM: %s entering, %d responses", __func__, num);
751 switch (ctxt->pam_done) {
753 sshpam_authenticated = 1;
761 error("PAM: expected one response, got %u", num);
764 buffer_init(&buffer);
765 if (sshpam_login_allowed(sshpam_authctxt))
766 buffer_put_cstring(&buffer, *resp);
768 buffer_put_cstring(&buffer, badpw);
769 if (ssh_msg_send(ctxt->pam_psock, PAM_AUTHTOK, &buffer) == -1) {
770 buffer_free(&buffer);
773 buffer_free(&buffer);
778 sshpam_free_ctx(void *ctxtp)
780 struct pam_ctxt *ctxt = ctxtp;
782 debug3("PAM: %s entering", __func__);
783 sshpam_thread_cleanup();
786 * We don't call sshpam_cleanup() here because we may need the PAM
787 * handle at a later stage, e.g. when setting up a session. It's
788 * still on the cleanup list, so pam_end() *will* be called before
789 * the server process terminates.
793 KbdintDevice sshpam_device = {
801 KbdintDevice mm_sshpam_device = {
810 * This replaces auth-pam.c
813 start_pam(Authctxt *authctxt)
815 if (!options.use_pam)
816 fatal("PAM: initialisation requested when UsePAM=no");
818 if (sshpam_init(authctxt) == -1)
819 fatal("PAM: initialisation failed");
831 debug("%s: called", __func__);
832 if (sshpam_account_status != -1)
833 return (sshpam_account_status);
835 sshpam_err = pam_acct_mgmt(sshpam_handle, 0);
836 debug3("PAM: %s pam_acct_mgmt = %d (%s)", __func__, sshpam_err,
837 pam_strerror(sshpam_handle, sshpam_err));
839 if (sshpam_err != PAM_SUCCESS && sshpam_err != PAM_NEW_AUTHTOK_REQD) {
840 sshpam_account_status = 0;
841 return (sshpam_account_status);
844 if (sshpam_err == PAM_NEW_AUTHTOK_REQD)
845 sshpam_password_change_required(1);
847 sshpam_account_status = 1;
848 return (sshpam_account_status);
852 do_pam_set_tty(const char *tty)
855 debug("PAM: setting PAM_TTY to \"%s\"", tty);
856 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, tty);
857 if (sshpam_err != PAM_SUCCESS)
858 fatal("PAM: failed to set PAM_TTY: %s",
859 pam_strerror(sshpam_handle, sshpam_err));
864 do_pam_setcred(int init)
866 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
867 (const void *)&store_conv);
868 if (sshpam_err != PAM_SUCCESS)
869 fatal("PAM: failed to set PAM_CONV: %s",
870 pam_strerror(sshpam_handle, sshpam_err));
872 debug("PAM: establishing credentials");
873 sshpam_err = pam_setcred(sshpam_handle, PAM_ESTABLISH_CRED);
875 debug("PAM: reinitializing credentials");
876 sshpam_err = pam_setcred(sshpam_handle, PAM_REINITIALIZE_CRED);
878 if (sshpam_err == PAM_SUCCESS) {
879 sshpam_cred_established = 1;
882 if (sshpam_authenticated)
883 fatal("PAM: pam_setcred(): %s",
884 pam_strerror(sshpam_handle, sshpam_err));
886 debug("PAM: pam_setcred(): %s",
887 pam_strerror(sshpam_handle, sshpam_err));
891 sshpam_tty_conv(int n, struct pam_message **msg,
892 struct pam_response **resp, void *data)
894 char input[PAM_MAX_MSG_SIZE];
895 struct pam_response *reply;
898 debug3("PAM: %s called with %d messages", __func__, n);
902 if (n <= 0 || n > PAM_MAX_NUM_MSG || !isatty(STDIN_FILENO))
903 return (PAM_CONV_ERR);
905 if ((reply = malloc(n * sizeof(*reply))) == NULL)
906 return (PAM_CONV_ERR);
907 memset(reply, 0, n * sizeof(*reply));
909 for (i = 0; i < n; ++i) {
910 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
911 case PAM_PROMPT_ECHO_OFF:
913 read_passphrase(PAM_MSG_MEMBER(msg, i, msg),
915 reply[i].resp_retcode = PAM_SUCCESS;
917 case PAM_PROMPT_ECHO_ON:
918 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
919 fgets(input, sizeof input, stdin);
920 if ((reply[i].resp = strdup(input)) == NULL)
922 reply[i].resp_retcode = PAM_SUCCESS;
926 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
927 reply[i].resp_retcode = PAM_SUCCESS;
934 return (PAM_SUCCESS);
937 for(i = 0; i < n; i++) {
938 if (reply[i].resp != NULL)
939 xfree(reply[i].resp);
942 return (PAM_CONV_ERR);
945 static struct pam_conv tty_conv = { sshpam_tty_conv, NULL };
948 * XXX this should be done in the authentication phase, but ssh1 doesn't
952 do_pam_chauthtok(void)
955 fatal("Password expired (unable to change with privsep)");
956 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
957 (const void *)&tty_conv);
958 if (sshpam_err != PAM_SUCCESS)
959 fatal("PAM: failed to set PAM_CONV: %s",
960 pam_strerror(sshpam_handle, sshpam_err));
961 debug("PAM: changing password");
962 sshpam_err = pam_chauthtok(sshpam_handle, PAM_CHANGE_EXPIRED_AUTHTOK);
963 if (sshpam_err != PAM_SUCCESS)
964 fatal("PAM: pam_chauthtok(): %s",
965 pam_strerror(sshpam_handle, sshpam_err));
971 debug3("PAM: opening session");
972 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
973 (const void *)&store_conv);
974 if (sshpam_err != PAM_SUCCESS)
975 fatal("PAM: failed to set PAM_CONV: %s",
976 pam_strerror(sshpam_handle, sshpam_err));
977 sshpam_err = pam_open_session(sshpam_handle, 0);
978 if (sshpam_err == PAM_SUCCESS)
979 sshpam_session_open = 1;
981 sshpam_session_open = 0;
982 disable_forwarding();
983 error("PAM: pam_open_session(): %s",
984 pam_strerror(sshpam_handle, sshpam_err));
990 is_pam_session_open(void)
992 return sshpam_session_open;
996 * Set a PAM environment string. We need to do this so that the session
997 * modules can handle things like Kerberos/GSI credentials that appear
998 * during the ssh authentication process.
1001 do_pam_putenv(char *name, char *value)
1004 #ifdef HAVE_PAM_PUTENV
1008 len = strlen(name) + strlen(value) + 2;
1009 compound = xmalloc(len);
1011 snprintf(compound, len, "%s=%s", name, value);
1012 ret = pam_putenv(sshpam_handle, compound);
1020 fetch_pam_child_environment(void)
1026 fetch_pam_environment(void)
1028 return (pam_getenvlist(sshpam_handle));
1032 free_pam_environment(char **env)
1039 for (envp = env; *envp; envp++)
1045 * "Blind" conversation function for password authentication. Assumes that
1046 * echo-off prompts are for the password and stores messages for later
1050 sshpam_passwd_conv(int n, struct pam_message **msg,
1051 struct pam_response **resp, void *data)
1053 struct pam_response *reply;
1057 debug3("PAM: %s called with %d messages", __func__, n);
1061 if (n <= 0 || n > PAM_MAX_NUM_MSG)
1062 return (PAM_CONV_ERR);
1064 if ((reply = malloc(n * sizeof(*reply))) == NULL)
1065 return (PAM_CONV_ERR);
1066 memset(reply, 0, n * sizeof(*reply));
1068 for (i = 0; i < n; ++i) {
1069 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
1070 case PAM_PROMPT_ECHO_OFF:
1071 if (sshpam_password == NULL)
1073 if ((reply[i].resp = strdup(sshpam_password)) == NULL)
1075 reply[i].resp_retcode = PAM_SUCCESS;
1079 len = strlen(PAM_MSG_MEMBER(msg, i, msg));
1081 buffer_append(&loginmsg,
1082 PAM_MSG_MEMBER(msg, i, msg), len);
1083 buffer_append(&loginmsg, "\n", 1);
1085 if ((reply[i].resp = strdup("")) == NULL)
1087 reply[i].resp_retcode = PAM_SUCCESS;
1094 return (PAM_SUCCESS);
1097 for(i = 0; i < n; i++) {
1098 if (reply[i].resp != NULL)
1099 xfree(reply[i].resp);
1102 return (PAM_CONV_ERR);
1105 static struct pam_conv passwd_conv = { sshpam_passwd_conv, NULL };
1108 * Attempt password authentication via PAM
1111 sshpam_auth_passwd(Authctxt *authctxt, const char *password)
1113 int flags = (options.permit_empty_passwd == 0 ?
1114 PAM_DISALLOW_NULL_AUTHTOK : 0);
1116 if (!options.use_pam || sshpam_handle == NULL)
1117 fatal("PAM: %s called when PAM disabled or failed to "
1118 "initialise.", __func__);
1120 sshpam_password = password;
1121 sshpam_authctxt = authctxt;
1124 * If the user logging in is invalid, or is root but is not permitted
1125 * by PermitRootLogin, use an invalid password to prevent leaking
1126 * information via timing (eg if the PAM config has a delay on fail).
1128 if (!sshpam_login_allowed(authctxt))
1129 sshpam_password = badpw;
1131 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
1132 (const void *)&passwd_conv);
1133 if (sshpam_err != PAM_SUCCESS)
1134 fatal("PAM: %s: failed to set PAM_CONV: %s", __func__,
1135 pam_strerror(sshpam_handle, sshpam_err));
1137 sshpam_err = pam_authenticate(sshpam_handle, flags);
1138 sshpam_password = NULL;
1139 if (sshpam_err == PAM_SUCCESS && sshpam_login_allowed(authctxt)) {
1140 debug("PAM: password authentication accepted for %.100s",
1144 debug("PAM: password authentication failed for %.100s: %s",
1145 authctxt->valid ? authctxt->user : "an illegal user",
1146 pam_strerror(sshpam_handle, sshpam_err));
1150 #endif /* USE_PAM */