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 */
52 #include <sys/types.h>
63 #if defined(HAVE_SECURITY_PAM_APPL_H)
64 #include <security/pam_appl.h>
65 #elif defined (HAVE_PAM_PAM_APPL_H)
66 #include <pam/pam_appl.h>
69 #if !defined(SSHD_PAM_SERVICE)
70 extern char *__progname;
71 # define SSHD_PAM_SERVICE __progname
74 /* OpenGroup RFC86.0 and XSSO specify no "const" on arguments */
75 #ifdef PAM_SUN_CODEBASE
76 # define sshpam_const /* Solaris, HP-UX, SunOS */
78 # define sshpam_const const /* LinuxPAM, OpenPAM, AIX */
81 /* Ambiguity in spec: is it an array of pointers or a pointer to an array? */
82 #ifdef PAM_SUN_CODEBASE
83 # define PAM_MSG_MEMBER(msg, n, member) ((*(msg))[(n)].member)
85 # define PAM_MSG_MEMBER(msg, n, member) ((msg)[(n)]->member)
101 #include "auth-options.h"
105 #include "monitor_wrap.h"
106 #include "blacklist_client.h"
108 extern ServerOptions options;
109 extern struct sshbuf *loginmsg;
110 extern u_int utmp_len;
112 /* so we don't silently change behaviour */
113 #ifdef USE_POSIX_THREADS
114 # error "USE_POSIX_THREADS replaced by UNSUPPORTED_POSIX_THREADS_HACK"
118 * Formerly known as USE_POSIX_THREADS, using this is completely unsupported
119 * and generally a bad idea. Use at own risk and do not expect support if
122 #ifdef UNSUPPORTED_POSIX_THREADS_HACK
125 * Avoid namespace clash when *not* using pthreads for systems *with*
126 * pthreads, which unconditionally define pthread_t via sys/types.h
129 typedef pthread_t sp_pthread_t;
131 typedef pid_t sp_pthread_t;
135 sp_pthread_t pam_thread;
141 static void sshpam_free_ctx(void *);
142 static struct pam_ctxt *cleanup_ctxt;
144 #ifndef UNSUPPORTED_POSIX_THREADS_HACK
146 * Simulate threads with processes.
149 static int sshpam_thread_status = -1;
150 static mysig_t sshpam_oldsig;
153 sshpam_sigchld_handler(int sig)
155 signal(SIGCHLD, SIG_DFL);
156 if (cleanup_ctxt == NULL)
157 return; /* handler called after PAM cleanup, shouldn't happen */
158 if (waitpid(cleanup_ctxt->pam_thread, &sshpam_thread_status, WNOHANG)
160 /* PAM thread has not exitted, privsep slave must have */
161 kill(cleanup_ctxt->pam_thread, SIGTERM);
162 while (waitpid(cleanup_ctxt->pam_thread,
163 &sshpam_thread_status, 0) == -1) {
169 if (WIFSIGNALED(sshpam_thread_status) &&
170 WTERMSIG(sshpam_thread_status) == SIGTERM)
171 return; /* terminated by pthread_cancel */
172 if (!WIFEXITED(sshpam_thread_status))
173 sigdie("PAM: authentication thread exited unexpectedly");
174 if (WEXITSTATUS(sshpam_thread_status) != 0)
175 sigdie("PAM: authentication thread exited uncleanly");
180 pthread_exit(void *value)
187 pthread_create(sp_pthread_t *thread, const void *attr,
188 void *(*thread_start)(void *), void *arg)
191 struct pam_ctxt *ctx = arg;
193 sshpam_thread_status = -1;
194 switch ((pid = fork())) {
196 error("fork(): %s", strerror(errno));
199 close(ctx->pam_psock);
205 close(ctx->pam_csock);
207 sshpam_oldsig = signal(SIGCHLD, sshpam_sigchld_handler);
213 pthread_cancel(sp_pthread_t thread)
215 signal(SIGCHLD, sshpam_oldsig);
216 return (kill(thread, SIGTERM));
221 pthread_join(sp_pthread_t thread, void **value)
225 if (sshpam_thread_status != -1)
226 return (sshpam_thread_status);
227 signal(SIGCHLD, sshpam_oldsig);
228 while (waitpid(thread, &status, 0) == -1) {
231 fatal("%s: waitpid: %s", __func__, strerror(errno));
238 static pam_handle_t *sshpam_handle = NULL;
239 static int sshpam_err = 0;
240 static int sshpam_authenticated = 0;
241 static int sshpam_session_open = 0;
242 static int sshpam_cred_established = 0;
243 static int sshpam_account_status = -1;
244 static int sshpam_maxtries_reached = 0;
245 static char **sshpam_env = NULL;
246 static Authctxt *sshpam_authctxt = NULL;
247 static const char *sshpam_password = NULL;
249 /* Some PAM implementations don't implement this */
250 #ifndef HAVE_PAM_GETENVLIST
252 pam_getenvlist(pam_handle_t *pamh)
255 * XXX - If necessary, we can still support envrionment passing
256 * for platforms without pam_getenvlist by searching for known
257 * env vars (e.g. KRB5CCNAME) from the PAM environment.
264 * Some platforms, notably Solaris, do not enforce password complexity
265 * rules during pam_chauthtok() if the real uid of the calling process
266 * is 0, on the assumption that it's being called by "passwd" run by root.
267 * This wraps pam_chauthtok and sets/restore the real uid so PAM will do
270 #ifdef SSHPAM_CHAUTHTOK_NEEDS_RUID
272 sshpam_chauthtok_ruid(pam_handle_t *pamh, int flags)
276 if (sshpam_authctxt == NULL)
277 fatal("PAM: sshpam_authctxt not initialized");
278 if (setreuid(sshpam_authctxt->pw->pw_uid, -1) == -1)
279 fatal("%s: setreuid failed: %s", __func__, strerror(errno));
280 result = pam_chauthtok(pamh, flags);
281 if (setreuid(0, -1) == -1)
282 fatal("%s: setreuid failed: %s", __func__, strerror(errno));
285 # define pam_chauthtok(a,b) (sshpam_chauthtok_ruid((a), (b)))
289 sshpam_password_change_required(int reqd)
291 extern struct sshauthopt *auth_opts;
292 static int saved_port, saved_agent, saved_x11;
294 debug3("%s %d", __func__, reqd);
295 if (sshpam_authctxt == NULL)
296 fatal("%s: PAM authctxt not initialized", __func__);
297 sshpam_authctxt->force_pwchange = reqd;
299 saved_port = auth_opts->permit_port_forwarding_flag;
300 saved_agent = auth_opts->permit_agent_forwarding_flag;
301 saved_x11 = auth_opts->permit_x11_forwarding_flag;
302 auth_opts->permit_port_forwarding_flag = 0;
303 auth_opts->permit_agent_forwarding_flag = 0;
304 auth_opts->permit_x11_forwarding_flag = 0;
307 auth_opts->permit_port_forwarding_flag = saved_port;
309 auth_opts->permit_agent_forwarding_flag = saved_agent;
311 auth_opts->permit_x11_forwarding_flag = saved_x11;
315 /* Import regular and PAM environment from subprocess */
317 import_environments(struct sshbuf *b)
323 debug3("PAM: %s entering", __func__);
325 #ifndef UNSUPPORTED_POSIX_THREADS_HACK
326 /* Import variables set by do_pam_account */
327 if ((r = sshbuf_get_u32(b, &n)) != 0)
328 fatal("%s: buffer error: %s", __func__, ssh_err(r));
330 fatal("%s: invalid PAM account status %u", __func__, n);
331 sshpam_account_status = (int)n;
332 if ((r = sshbuf_get_u32(b, &n)) != 0)
333 fatal("%s: buffer error: %s", __func__, ssh_err(r));
334 sshpam_password_change_required(n != 0);
336 /* Import environment from subprocess */
337 if ((r = sshbuf_get_u32(b, &num_env)) != 0)
338 fatal("%s: buffer error: %s", __func__, ssh_err(r));
340 fatal("%s: received %u environment variables, expected <= 1024",
342 sshpam_env = xcalloc(num_env + 1, sizeof(*sshpam_env));
343 debug3("PAM: num env strings %d", num_env);
344 for(i = 0; i < num_env; i++) {
345 if ((r = sshbuf_get_cstring(b, &(sshpam_env[i]), NULL)) != 0)
346 fatal("%s: buffer error: %s", __func__, ssh_err(r));
348 sshpam_env[num_env] = NULL;
350 /* Import PAM environment from subprocess */
351 if ((r = sshbuf_get_u32(b, &num_env)) != 0)
352 fatal("%s: buffer error: %s", __func__, ssh_err(r));
353 debug("PAM: num PAM env strings %d", num_env);
354 for (i = 0; i < num_env; i++) {
355 if ((r = sshbuf_get_cstring(b, &env, NULL)) != 0)
356 fatal("%s: buffer error: %s", __func__, ssh_err(r));
357 #ifdef HAVE_PAM_PUTENV
358 /* Errors are not fatal here */
359 if ((r = pam_putenv(sshpam_handle, env)) != PAM_SUCCESS) {
360 error("PAM: pam_putenv: %s",
361 pam_strerror(sshpam_handle, r));
370 * Conversation function for authentication thread.
373 sshpam_thread_conv(int n, sshpam_const struct pam_message **msg,
374 struct pam_response **resp, void *data)
376 struct sshbuf *buffer;
377 struct pam_ctxt *ctxt;
378 struct pam_response *reply;
382 debug3("PAM: %s entering, %d messages", __func__, n);
386 error("PAM: conversation function passed a null context");
387 return (PAM_CONV_ERR);
390 if (n <= 0 || n > PAM_MAX_NUM_MSG)
391 return (PAM_CONV_ERR);
393 if ((reply = calloc(n, sizeof(*reply))) == NULL)
395 if ((buffer = sshbuf_new()) == NULL) {
400 for (i = 0; i < n; ++i) {
401 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
402 case PAM_PROMPT_ECHO_OFF:
403 case PAM_PROMPT_ECHO_ON:
404 if ((r = sshbuf_put_cstring(buffer,
405 PAM_MSG_MEMBER(msg, i, msg))) != 0)
406 fatal("%s: buffer error: %s",
407 __func__, ssh_err(r));
408 if (ssh_msg_send(ctxt->pam_csock,
409 PAM_MSG_MEMBER(msg, i, msg_style), buffer) == -1)
412 if (ssh_msg_recv(ctxt->pam_csock, buffer) == -1)
414 if ((r = sshbuf_get_u8(buffer, &status)) != 0)
415 fatal("%s: buffer error: %s",
416 __func__, ssh_err(r));
417 if (status != PAM_AUTHTOK)
419 if ((r = sshbuf_get_cstring(buffer,
420 &reply[i].resp, NULL)) != 0)
421 fatal("%s: buffer error: %s",
422 __func__, ssh_err(r));
426 if ((r = sshbuf_put_cstring(buffer,
427 PAM_MSG_MEMBER(msg, i, msg))) != 0)
428 fatal("%s: buffer error: %s",
429 __func__, ssh_err(r));
430 if (ssh_msg_send(ctxt->pam_csock,
431 PAM_MSG_MEMBER(msg, i, msg_style), buffer) == -1)
437 sshbuf_reset(buffer);
441 return (PAM_SUCCESS);
444 for(i = 0; i < n; i++) {
449 return (PAM_CONV_ERR);
453 * Authentication thread.
456 sshpam_thread(void *ctxtp)
458 struct pam_ctxt *ctxt = ctxtp;
459 struct sshbuf *buffer = NULL;
460 struct pam_conv sshpam_conv;
461 int r, flags = (options.permit_empty_passwd == 0 ?
462 PAM_DISALLOW_NULL_AUTHTOK : 0);
463 #ifndef UNSUPPORTED_POSIX_THREADS_HACK
464 extern char **environ;
467 const char *pam_user;
468 const char **ptr_pam_user = &pam_user;
469 char *tz = getenv("TZ");
471 sshpam_err = pam_get_item(sshpam_handle, PAM_USER,
472 (sshpam_const void **)ptr_pam_user);
473 if (sshpam_err != PAM_SUCCESS)
478 if (setenv("TZ", tz, 1) == -1)
479 error("PAM: could not set TZ environment: %s",
482 if (sshpam_authctxt != NULL) {
483 setproctitle("%s [pam]",
484 sshpam_authctxt->valid ? pam_user : "unknown");
488 sshpam_conv.conv = sshpam_thread_conv;
489 sshpam_conv.appdata_ptr = ctxt;
491 if (sshpam_authctxt == NULL)
492 fatal("%s: PAM authctxt not initialized", __func__);
494 if ((buffer = sshbuf_new()) == NULL)
495 fatal("%s: sshbuf_new failed", __func__);
497 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
498 (const void *)&sshpam_conv);
499 if (sshpam_err != PAM_SUCCESS)
501 sshpam_err = pam_authenticate(sshpam_handle, flags);
502 if (sshpam_err == PAM_MAXTRIES)
503 sshpam_set_maxtries_reached(1);
504 if (sshpam_err != PAM_SUCCESS)
507 if (!do_pam_account()) {
508 sshpam_err = PAM_ACCT_EXPIRED;
511 if (sshpam_authctxt->force_pwchange) {
512 sshpam_err = pam_chauthtok(sshpam_handle,
513 PAM_CHANGE_EXPIRED_AUTHTOK);
514 if (sshpam_err != PAM_SUCCESS)
516 sshpam_password_change_required(0);
519 if ((r = sshbuf_put_cstring(buffer, "OK")) != 0)
520 fatal("%s: buffer error: %s", __func__, ssh_err(r));
522 #ifndef UNSUPPORTED_POSIX_THREADS_HACK
523 /* Export variables set by do_pam_account */
524 if ((r = sshbuf_put_u32(buffer, sshpam_account_status)) != 0 ||
525 (r = sshbuf_put_u32(buffer, sshpam_authctxt->force_pwchange)) != 0)
526 fatal("%s: buffer error: %s", __func__, ssh_err(r));
528 /* Export any environment strings set in child */
529 for (i = 0; environ[i] != NULL; i++) {
532 fatal("%s: too many enviornment strings", __func__);
534 if ((r = sshbuf_put_u32(buffer, i)) != 0)
535 fatal("%s: buffer error: %s", __func__, ssh_err(r));
536 for (i = 0; environ[i] != NULL; i++) {
537 if ((r = sshbuf_put_cstring(buffer, environ[i])) != 0)
538 fatal("%s: buffer error: %s", __func__, ssh_err(r));
540 /* Export any environment strings set by PAM in child */
541 env_from_pam = pam_getenvlist(sshpam_handle);
542 for (i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++) {
545 fatal("%s: too many PAM enviornment strings", __func__);
547 if ((r = sshbuf_put_u32(buffer, i)) != 0)
548 fatal("%s: buffer error: %s", __func__, ssh_err(r));
549 for (i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++) {
550 if ((r = sshbuf_put_cstring(buffer, env_from_pam[i])) != 0)
551 fatal("%s: buffer error: %s", __func__, ssh_err(r));
553 #endif /* UNSUPPORTED_POSIX_THREADS_HACK */
555 /* XXX - can't do much about an error here */
556 ssh_msg_send(ctxt->pam_csock, sshpam_err, buffer);
561 if ((r = sshbuf_put_cstring(buffer,
562 pam_strerror(sshpam_handle, sshpam_err))) != 0)
563 fatal("%s: buffer error: %s", __func__, ssh_err(r));
564 /* XXX - can't do much about an error here */
565 if (sshpam_err == PAM_ACCT_EXPIRED)
566 ssh_msg_send(ctxt->pam_csock, PAM_ACCT_EXPIRED, buffer);
567 else if (sshpam_maxtries_reached)
568 ssh_msg_send(ctxt->pam_csock, PAM_MAXTRIES, buffer);
570 ssh_msg_send(ctxt->pam_csock, PAM_AUTH_ERR, buffer);
574 return (NULL); /* Avoid warning for non-pthread case */
578 sshpam_thread_cleanup(void)
580 struct pam_ctxt *ctxt = cleanup_ctxt;
582 debug3("PAM: %s entering", __func__);
583 if (ctxt != NULL && ctxt->pam_thread != 0) {
584 pthread_cancel(ctxt->pam_thread);
585 pthread_join(ctxt->pam_thread, NULL);
586 close(ctxt->pam_psock);
587 close(ctxt->pam_csock);
588 memset(ctxt, 0, sizeof(*ctxt));
594 sshpam_null_conv(int n, sshpam_const struct pam_message **msg,
595 struct pam_response **resp, void *data)
597 debug3("PAM: %s entering, %d messages", __func__, n);
598 return (PAM_CONV_ERR);
601 static struct pam_conv null_conv = { sshpam_null_conv, NULL };
604 sshpam_store_conv(int n, sshpam_const struct pam_message **msg,
605 struct pam_response **resp, void *data)
607 struct pam_response *reply;
610 debug3("PAM: %s called with %d messages", __func__, n);
613 if (n <= 0 || n > PAM_MAX_NUM_MSG)
614 return (PAM_CONV_ERR);
616 if ((reply = calloc(n, sizeof(*reply))) == NULL)
617 return (PAM_CONV_ERR);
619 for (i = 0; i < n; ++i) {
620 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
623 if ((r = sshbuf_putf(loginmsg, "%s\n",
624 PAM_MSG_MEMBER(msg, i, msg))) != 0)
625 fatal("%s: buffer error: %s",
626 __func__, ssh_err(r));
627 reply[i].resp_retcode = PAM_SUCCESS;
634 return (PAM_SUCCESS);
637 for(i = 0; i < n; i++) {
641 return (PAM_CONV_ERR);
644 static struct pam_conv store_conv = { sshpam_store_conv, NULL };
649 if (sshpam_handle == NULL || (use_privsep && !mm_is_monitor()))
651 debug("PAM: cleanup");
652 pam_set_item(sshpam_handle, PAM_CONV, (const void *)&null_conv);
653 if (sshpam_session_open) {
654 debug("PAM: closing session");
655 pam_close_session(sshpam_handle, PAM_SILENT);
656 sshpam_session_open = 0;
658 if (sshpam_cred_established) {
659 debug("PAM: deleting credentials");
660 pam_setcred(sshpam_handle, PAM_DELETE_CRED);
661 sshpam_cred_established = 0;
663 sshpam_authenticated = 0;
664 pam_end(sshpam_handle, sshpam_err);
665 sshpam_handle = NULL;
669 sshpam_init(Authctxt *authctxt)
671 const char *pam_rhost, *pam_user, *user = authctxt->user;
672 const char **ptr_pam_user = &pam_user;
673 struct ssh *ssh = active_state; /* XXX */
675 if (sshpam_handle != NULL) {
676 /* We already have a PAM context; check if the user matches */
677 sshpam_err = pam_get_item(sshpam_handle,
678 PAM_USER, (sshpam_const void **)ptr_pam_user);
679 if (sshpam_err == PAM_SUCCESS && strcmp(user, pam_user) == 0)
681 pam_end(sshpam_handle, sshpam_err);
682 sshpam_handle = NULL;
684 debug("PAM: initializing for \"%s\"", user);
686 pam_start(SSHD_PAM_SERVICE, user, &store_conv, &sshpam_handle);
687 sshpam_authctxt = authctxt;
689 if (sshpam_err != PAM_SUCCESS) {
690 pam_end(sshpam_handle, sshpam_err);
691 sshpam_handle = NULL;
694 pam_rhost = auth_get_canonical_hostname(ssh, options.use_dns);
695 debug("PAM: setting PAM_RHOST to \"%s\"", pam_rhost);
696 sshpam_err = pam_set_item(sshpam_handle, PAM_RHOST, pam_rhost);
697 if (sshpam_err != PAM_SUCCESS) {
698 pam_end(sshpam_handle, sshpam_err);
699 sshpam_handle = NULL;
702 #ifdef PAM_TTY_KLUDGE
704 * Some silly PAM modules (e.g. pam_time) require a TTY to operate.
705 * sshd doesn't set the tty until too late in the auth process and
706 * may not even set one (for tty-less connections)
708 debug("PAM: setting PAM_TTY to \"ssh\"");
709 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, "ssh");
710 if (sshpam_err != PAM_SUCCESS) {
711 pam_end(sshpam_handle, sshpam_err);
712 sshpam_handle = NULL;
720 expose_authinfo(const char *caller)
725 * Expose authentication information to PAM.
726 * The environment variable is versioned. Please increment the
727 * version suffix if the format of session_info changes.
729 if (sshpam_authctxt->session_info == NULL)
730 auth_info = xstrdup("");
731 else if ((auth_info = sshbuf_dup_string(
732 sshpam_authctxt->session_info)) == NULL)
733 fatal("%s: sshbuf_dup_string failed", __func__);
735 debug2("%s: auth information in SSH_AUTH_INFO_0", caller);
736 do_pam_putenv("SSH_AUTH_INFO_0", auth_info);
741 sshpam_init_ctx(Authctxt *authctxt)
743 struct pam_ctxt *ctxt;
746 debug3("PAM: %s entering", __func__);
748 * Refuse to start if we don't have PAM enabled or do_pam_account
749 * has previously failed.
751 if (!options.use_pam || sshpam_account_status == 0)
755 if (sshpam_init(authctxt) == -1) {
756 error("PAM: initialization failed");
760 expose_authinfo(__func__);
761 ctxt = xcalloc(1, sizeof *ctxt);
763 /* Start the authentication thread */
764 if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, socks) == -1) {
765 error("PAM: failed create sockets: %s", strerror(errno));
769 ctxt->pam_psock = socks[0];
770 ctxt->pam_csock = socks[1];
771 if (pthread_create(&ctxt->pam_thread, NULL, sshpam_thread, ctxt) == -1) {
772 error("PAM: failed to start authentication thread: %s",
784 sshpam_query(void *ctx, char **name, char **info,
785 u_int *num, char ***prompts, u_int **echo_on)
787 struct ssh *ssh = active_state; /* XXX */
788 struct sshbuf *buffer;
789 struct pam_ctxt *ctxt = ctx;
796 debug3("PAM: %s entering", __func__);
797 if ((buffer = sshbuf_new()) == NULL)
798 fatal("%s: sshbuf_new failed", __func__);
801 *prompts = xmalloc(sizeof(char *));
804 *echo_on = xmalloc(sizeof(u_int));
805 while (ssh_msg_recv(ctxt->pam_psock, buffer) == 0) {
806 if ((r = sshbuf_get_u8(buffer, &type)) != 0 ||
807 (r = sshbuf_get_cstring(buffer, &msg, &mlen)) != 0)
808 fatal("%s: buffer error: %s", __func__, ssh_err(r));
810 case PAM_PROMPT_ECHO_ON:
811 case PAM_PROMPT_ECHO_OFF:
813 len = plen + mlen + 1;
814 **prompts = xreallocarray(**prompts, 1, len);
815 strlcpy(**prompts + plen, msg, len - plen);
817 **echo_on = (type == PAM_PROMPT_ECHO_ON);
822 /* accumulate messages */
823 len = plen + mlen + 2;
824 **prompts = xreallocarray(**prompts, 1, len);
825 strlcpy(**prompts + plen, msg, len - plen);
827 strlcat(**prompts + plen, "\n", len - plen);
831 case PAM_ACCT_EXPIRED:
833 if (type == PAM_ACCT_EXPIRED)
834 sshpam_account_status = 0;
835 if (type == PAM_MAXTRIES)
836 sshpam_set_maxtries_reached(1);
839 debug3("PAM: %s", pam_strerror(sshpam_handle, type));
840 if (**prompts != NULL && strlen(**prompts) != 0) {
851 if (**prompts != NULL) {
852 /* drain any accumulated messages */
853 debug("PAM: %s", **prompts);
854 if ((r = sshbuf_put(loginmsg, **prompts,
855 strlen(**prompts))) != 0)
856 fatal("%s: buffer error: %s",
857 __func__, ssh_err(r));
861 if (type == PAM_SUCCESS) {
862 if (!sshpam_authctxt->valid ||
863 (sshpam_authctxt->pw->pw_uid == 0 &&
864 options.permit_root_login != PERMIT_YES))
865 fatal("Internal error: PAM auth "
866 "succeeded when it should have "
868 import_environments(buffer);
875 BLACKLIST_NOTIFY(BLACKLIST_BAD_USER,
876 sshpam_authctxt->user);
877 error("PAM: %s for %s%.100s from %.100s", msg,
878 sshpam_authctxt->valid ? "" : "illegal user ",
879 sshpam_authctxt->user,
880 auth_get_canonical_hostname(ssh, options.use_dns));
894 * Returns a junk password of identical length to that the user supplied.
895 * Used to mitigate timing attacks against crypt(3)/PAM stacks that
896 * vary processing time in proportion to password length.
899 fake_password(const char *wire_password)
901 const char junk[] = "\b\n\r\177INCORRECT";
903 size_t i, l = wire_password != NULL ? strlen(wire_password) : 0;
906 fatal("%s: password length too long: %zu", __func__, l);
911 for (i = 0; i < l; i++)
912 ret[i] = junk[i % (sizeof(junk) - 1)];
917 /* XXX - see also comment in auth-chall.c:verify_response */
919 sshpam_respond(void *ctx, u_int num, char **resp)
921 struct sshbuf *buffer;
922 struct pam_ctxt *ctxt = ctx;
926 debug2("PAM: %s entering, %u responses", __func__, num);
927 switch (ctxt->pam_done) {
929 sshpam_authenticated = 1;
937 error("PAM: expected one response, got %u", num);
940 if ((buffer = sshbuf_new()) == NULL)
941 fatal("%s: sshbuf_new failed", __func__);
942 if (sshpam_authctxt->valid &&
943 (sshpam_authctxt->pw->pw_uid != 0 ||
944 options.permit_root_login == PERMIT_YES)) {
945 if ((r = sshbuf_put_cstring(buffer, *resp)) != 0)
946 fatal("%s: buffer error: %s", __func__, ssh_err(r));
948 fake = fake_password(*resp);
949 if ((r = sshbuf_put_cstring(buffer, fake)) != 0)
950 fatal("%s: buffer error: %s", __func__, ssh_err(r));
953 if (ssh_msg_send(ctxt->pam_psock, PAM_AUTHTOK, buffer) == -1) {
962 sshpam_free_ctx(void *ctxtp)
964 struct pam_ctxt *ctxt = ctxtp;
966 debug3("PAM: %s entering", __func__);
967 sshpam_thread_cleanup();
970 * We don't call sshpam_cleanup() here because we may need the PAM
971 * handle at a later stage, e.g. when setting up a session. It's
972 * still on the cleanup list, so pam_end() *will* be called before
973 * the server process terminates.
977 KbdintDevice sshpam_device = {
985 KbdintDevice mm_sshpam_device = {
994 * This replaces auth-pam.c
997 start_pam(Authctxt *authctxt)
999 if (!options.use_pam)
1000 fatal("PAM: initialisation requested when UsePAM=no");
1002 if (sshpam_init(authctxt) == -1)
1003 fatal("PAM: initialisation failed");
1014 do_pam_account(void)
1016 debug("%s: called", __func__);
1017 if (sshpam_account_status != -1)
1018 return (sshpam_account_status);
1020 expose_authinfo(__func__);
1022 sshpam_err = pam_acct_mgmt(sshpam_handle, 0);
1023 debug3("PAM: %s pam_acct_mgmt = %d (%s)", __func__, sshpam_err,
1024 pam_strerror(sshpam_handle, sshpam_err));
1026 if (sshpam_err != PAM_SUCCESS && sshpam_err != PAM_NEW_AUTHTOK_REQD) {
1027 sshpam_account_status = 0;
1028 return (sshpam_account_status);
1031 if (sshpam_err == PAM_NEW_AUTHTOK_REQD)
1032 sshpam_password_change_required(1);
1034 sshpam_account_status = 1;
1035 return (sshpam_account_status);
1039 do_pam_setcred(int init)
1041 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
1042 (const void *)&store_conv);
1043 if (sshpam_err != PAM_SUCCESS)
1044 fatal("PAM: failed to set PAM_CONV: %s",
1045 pam_strerror(sshpam_handle, sshpam_err));
1047 debug("PAM: establishing credentials");
1048 sshpam_err = pam_setcred(sshpam_handle, PAM_ESTABLISH_CRED);
1050 debug("PAM: reinitializing credentials");
1051 sshpam_err = pam_setcred(sshpam_handle, PAM_REINITIALIZE_CRED);
1053 if (sshpam_err == PAM_SUCCESS) {
1054 sshpam_cred_established = 1;
1057 if (sshpam_authenticated)
1058 fatal("PAM: pam_setcred(): %s",
1059 pam_strerror(sshpam_handle, sshpam_err));
1061 debug("PAM: pam_setcred(): %s",
1062 pam_strerror(sshpam_handle, sshpam_err));
1066 sshpam_tty_conv(int n, sshpam_const struct pam_message **msg,
1067 struct pam_response **resp, void *data)
1069 char input[PAM_MAX_MSG_SIZE];
1070 struct pam_response *reply;
1073 debug3("PAM: %s called with %d messages", __func__, n);
1077 if (n <= 0 || n > PAM_MAX_NUM_MSG || !isatty(STDIN_FILENO))
1078 return (PAM_CONV_ERR);
1080 if ((reply = calloc(n, sizeof(*reply))) == NULL)
1081 return (PAM_CONV_ERR);
1083 for (i = 0; i < n; ++i) {
1084 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
1085 case PAM_PROMPT_ECHO_OFF:
1087 read_passphrase(PAM_MSG_MEMBER(msg, i, msg),
1089 reply[i].resp_retcode = PAM_SUCCESS;
1091 case PAM_PROMPT_ECHO_ON:
1092 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
1093 if (fgets(input, sizeof input, stdin) == NULL)
1095 if ((reply[i].resp = strdup(input)) == NULL)
1097 reply[i].resp_retcode = PAM_SUCCESS;
1101 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
1102 reply[i].resp_retcode = PAM_SUCCESS;
1109 return (PAM_SUCCESS);
1112 for(i = 0; i < n; i++) {
1113 free(reply[i].resp);
1116 return (PAM_CONV_ERR);
1119 static struct pam_conv tty_conv = { sshpam_tty_conv, NULL };
1122 * XXX this should be done in the authentication phase, but ssh1 doesn't
1126 do_pam_chauthtok(void)
1129 fatal("Password expired (unable to change with privsep)");
1130 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
1131 (const void *)&tty_conv);
1132 if (sshpam_err != PAM_SUCCESS)
1133 fatal("PAM: failed to set PAM_CONV: %s",
1134 pam_strerror(sshpam_handle, sshpam_err));
1135 debug("PAM: changing password");
1136 sshpam_err = pam_chauthtok(sshpam_handle, PAM_CHANGE_EXPIRED_AUTHTOK);
1137 if (sshpam_err != PAM_SUCCESS)
1138 fatal("PAM: pam_chauthtok(): %s",
1139 pam_strerror(sshpam_handle, sshpam_err));
1143 do_pam_session(struct ssh *ssh)
1145 debug3("PAM: opening session");
1147 expose_authinfo(__func__);
1149 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
1150 (const void *)&store_conv);
1151 if (sshpam_err != PAM_SUCCESS)
1152 fatal("PAM: failed to set PAM_CONV: %s",
1153 pam_strerror(sshpam_handle, sshpam_err));
1154 sshpam_err = pam_open_session(sshpam_handle, 0);
1155 if (sshpam_err == PAM_SUCCESS)
1156 sshpam_session_open = 1;
1158 sshpam_session_open = 0;
1159 auth_restrict_session(ssh);
1160 error("PAM: pam_open_session(): %s",
1161 pam_strerror(sshpam_handle, sshpam_err));
1167 is_pam_session_open(void)
1169 return sshpam_session_open;
1173 * Set a PAM environment string. We need to do this so that the session
1174 * modules can handle things like Kerberos/GSI credentials that appear
1175 * during the ssh authentication process.
1178 do_pam_putenv(char *name, char *value)
1181 #ifdef HAVE_PAM_PUTENV
1185 len = strlen(name) + strlen(value) + 2;
1186 compound = xmalloc(len);
1188 snprintf(compound, len, "%s=%s", name, value);
1189 ret = pam_putenv(sshpam_handle, compound);
1197 fetch_pam_child_environment(void)
1203 fetch_pam_environment(void)
1205 return (pam_getenvlist(sshpam_handle));
1209 free_pam_environment(char **env)
1216 for (envp = env; *envp; envp++)
1222 * "Blind" conversation function for password authentication. Assumes that
1223 * echo-off prompts are for the password and stores messages for later
1227 sshpam_passwd_conv(int n, sshpam_const struct pam_message **msg,
1228 struct pam_response **resp, void *data)
1230 struct pam_response *reply;
1234 debug3("PAM: %s called with %d messages", __func__, n);
1238 if (n <= 0 || n > PAM_MAX_NUM_MSG)
1239 return (PAM_CONV_ERR);
1241 if ((reply = calloc(n, sizeof(*reply))) == NULL)
1242 return (PAM_CONV_ERR);
1244 for (i = 0; i < n; ++i) {
1245 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
1246 case PAM_PROMPT_ECHO_OFF:
1247 if (sshpam_password == NULL)
1249 if ((reply[i].resp = strdup(sshpam_password)) == NULL)
1251 reply[i].resp_retcode = PAM_SUCCESS;
1255 len = strlen(PAM_MSG_MEMBER(msg, i, msg));
1257 if ((r = sshbuf_putf(loginmsg, "%s\n",
1258 PAM_MSG_MEMBER(msg, i, msg))) != 0)
1259 fatal("%s: buffer error: %s",
1260 __func__, ssh_err(r));
1262 if ((reply[i].resp = strdup("")) == NULL)
1264 reply[i].resp_retcode = PAM_SUCCESS;
1271 return (PAM_SUCCESS);
1274 for(i = 0; i < n; i++) {
1275 free(reply[i].resp);
1278 return (PAM_CONV_ERR);
1281 static struct pam_conv passwd_conv = { sshpam_passwd_conv, NULL };
1284 * Attempt password authentication via PAM
1287 sshpam_auth_passwd(Authctxt *authctxt, const char *password)
1289 int flags = (options.permit_empty_passwd == 0 ?
1290 PAM_DISALLOW_NULL_AUTHTOK : 0);
1293 if (!options.use_pam || sshpam_handle == NULL)
1294 fatal("PAM: %s called when PAM disabled or failed to "
1295 "initialise.", __func__);
1297 sshpam_password = password;
1298 sshpam_authctxt = authctxt;
1301 * If the user logging in is invalid, or is root but is not permitted
1302 * by PermitRootLogin, use an invalid password to prevent leaking
1303 * information via timing (eg if the PAM config has a delay on fail).
1305 if (!authctxt->valid || (authctxt->pw->pw_uid == 0 &&
1306 options.permit_root_login != PERMIT_YES))
1307 sshpam_password = fake = fake_password(password);
1309 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
1310 (const void *)&passwd_conv);
1311 if (sshpam_err != PAM_SUCCESS)
1312 fatal("PAM: %s: failed to set PAM_CONV: %s", __func__,
1313 pam_strerror(sshpam_handle, sshpam_err));
1315 sshpam_err = pam_authenticate(sshpam_handle, flags);
1316 sshpam_password = NULL;
1318 if (sshpam_err == PAM_MAXTRIES)
1319 sshpam_set_maxtries_reached(1);
1320 if (sshpam_err == PAM_SUCCESS && authctxt->valid) {
1321 debug("PAM: password authentication accepted for %.100s",
1325 debug("PAM: password authentication failed for %.100s: %s",
1326 authctxt->valid ? authctxt->user : "an illegal user",
1327 pam_strerror(sshpam_handle, sshpam_err));
1333 sshpam_get_maxtries_reached(void)
1335 return sshpam_maxtries_reached;
1339 sshpam_set_maxtries_reached(int reached)
1341 if (reached == 0 || sshpam_maxtries_reached)
1343 sshpam_maxtries_reached = 1;
1344 options.password_authentication = 0;
1345 options.kbd_interactive_authentication = 0;
1346 options.challenge_response_authentication = 0;
1348 #endif /* USE_PAM */