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 /* Based on $FreeBSD: src/crypto/openssh/auth2-pam-freebsd.c,v 1.11 2003/03/31 13:48:18 des Exp $ */
37 #if defined(HAVE_SECURITY_PAM_APPL_H)
38 #include <security/pam_appl.h>
39 #elif defined (HAVE_PAM_PAM_APPL_H)
40 #include <pam/pam_appl.h>
49 #include "monitor_wrap.h"
56 #include "auth-options.h"
58 extern ServerOptions options;
59 extern Buffer loginmsg;
62 #ifdef USE_POSIX_THREADS
65 * Avoid namespace clash when *not* using pthreads for systems *with*
66 * pthreads, which unconditionally define pthread_t via sys/types.h
69 typedef pthread_t sp_pthread_t;
71 typedef pid_t sp_pthread_t;
75 sp_pthread_t pam_thread;
81 static void sshpam_free_ctx(void *);
82 static struct pam_ctxt *cleanup_ctxt;
84 #ifndef USE_POSIX_THREADS
86 * Simulate threads with processes.
89 static int sshpam_thread_status = -1;
90 static mysig_t sshpam_oldsig;
93 sshpam_sigchld_handler(int sig)
95 if (cleanup_ctxt == NULL)
96 return; /* handler called after PAM cleanup, shouldn't happen */
97 if (waitpid(cleanup_ctxt->pam_thread, &sshpam_thread_status, 0) == -1)
98 return; /* couldn't wait for process */
99 if (WIFSIGNALED(sshpam_thread_status) &&
100 WTERMSIG(sshpam_thread_status) == SIGTERM)
101 return; /* terminated by pthread_cancel */
102 if (!WIFEXITED(sshpam_thread_status))
103 fatal("PAM: authentication thread exited unexpectedly");
104 if (WEXITSTATUS(sshpam_thread_status) != 0)
105 fatal("PAM: authentication thread exited uncleanly");
109 pthread_exit(void *value __unused)
115 pthread_create(sp_pthread_t *thread, const void *attr __unused,
116 void *(*thread_start)(void *), void *arg)
120 switch ((pid = fork())) {
122 error("fork(): %s", strerror(errno));
129 sshpam_oldsig = signal(SIGCHLD, sshpam_sigchld_handler);
135 pthread_cancel(sp_pthread_t thread)
137 signal(SIGCHLD, sshpam_oldsig);
138 return (kill(thread, SIGTERM));
142 pthread_join(sp_pthread_t thread, void **value __unused)
146 if (sshpam_thread_status != -1)
147 return (sshpam_thread_status);
148 signal(SIGCHLD, sshpam_oldsig);
149 waitpid(thread, &status, 0);
155 static pam_handle_t *sshpam_handle = NULL;
156 static int sshpam_err = 0;
157 static int sshpam_authenticated = 0;
158 static int sshpam_new_authtok_reqd = 0;
159 static int sshpam_session_open = 0;
160 static int sshpam_cred_established = 0;
161 static int sshpam_account_status = -1;
162 static char **sshpam_env = NULL;
164 /* Some PAM implementations don't implement this */
165 #ifndef HAVE_PAM_GETENVLIST
167 pam_getenvlist(pam_handle_t *pamh)
170 * XXX - If necessary, we can still support envrionment passing
171 * for platforms without pam_getenvlist by searching for known
172 * env vars (e.g. KRB5CCNAME) from the PAM environment.
179 pam_password_change_required(int reqd)
181 sshpam_new_authtok_reqd = reqd;
183 no_port_forwarding_flag |= 2;
184 no_agent_forwarding_flag |= 2;
185 no_x11_forwarding_flag |= 2;
187 no_port_forwarding_flag &= ~2;
188 no_agent_forwarding_flag &= ~2;
189 no_x11_forwarding_flag &= ~2;
193 /* Import regular and PAM environment from subprocess */
195 import_environments(Buffer *b)
201 /* Import variables set by do_pam_account */
202 sshpam_account_status = buffer_get_int(b);
203 pam_password_change_required(buffer_get_int(b));
205 /* Import environment from subprocess */
206 num_env = buffer_get_int(b);
207 sshpam_env = xmalloc((num_env + 1) * sizeof(*sshpam_env));
208 debug3("PAM: num env strings %d", num_env);
209 for(i = 0; i < num_env; i++)
210 sshpam_env[i] = buffer_get_string(b, NULL);
212 sshpam_env[num_env] = NULL;
214 /* Import PAM environment from subprocess */
215 num_env = buffer_get_int(b);
216 debug("PAM: num PAM env strings %d", num_env);
217 for(i = 0; i < num_env; i++) {
218 env = buffer_get_string(b, NULL);
220 #ifdef HAVE_PAM_PUTENV
221 /* Errors are not fatal here */
222 if ((err = pam_putenv(sshpam_handle, env)) != PAM_SUCCESS) {
223 error("PAM: pam_putenv: %s",
224 pam_strerror(sshpam_handle, sshpam_err));
231 * Conversation function for authentication thread.
234 sshpam_thread_conv(int n, const struct pam_message **msg,
235 struct pam_response **resp, void *data)
238 struct pam_ctxt *ctxt;
239 struct pam_response *reply;
245 if (n <= 0 || n > PAM_MAX_NUM_MSG)
246 return (PAM_CONV_ERR);
248 if ((reply = malloc(n * sizeof(*reply))) == NULL)
249 return (PAM_CONV_ERR);
250 memset(reply, 0, n * sizeof(*reply));
252 buffer_init(&buffer);
253 for (i = 0; i < n; ++i) {
254 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
255 case PAM_PROMPT_ECHO_OFF:
256 buffer_put_cstring(&buffer,
257 PAM_MSG_MEMBER(msg, i, msg));
258 if (ssh_msg_send(ctxt->pam_csock,
259 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
261 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
263 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
265 reply[i].resp = buffer_get_string(&buffer, NULL);
267 case PAM_PROMPT_ECHO_ON:
268 buffer_put_cstring(&buffer,
269 PAM_MSG_MEMBER(msg, i, msg));
270 if (ssh_msg_send(ctxt->pam_csock,
271 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
273 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
275 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
277 reply[i].resp = buffer_get_string(&buffer, NULL);
280 buffer_put_cstring(&buffer,
281 PAM_MSG_MEMBER(msg, i, msg));
282 if (ssh_msg_send(ctxt->pam_csock,
283 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
287 buffer_put_cstring(&buffer,
288 PAM_MSG_MEMBER(msg, i, msg));
289 if (ssh_msg_send(ctxt->pam_csock,
290 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
296 buffer_clear(&buffer);
298 buffer_free(&buffer);
300 return (PAM_SUCCESS);
303 for(i = 0; i < n; i++) {
304 if (reply[i].resp != NULL)
305 xfree(reply[i].resp);
308 buffer_free(&buffer);
309 return (PAM_CONV_ERR);
313 * Authentication thread.
316 sshpam_thread(void *ctxtp)
318 struct pam_ctxt *ctxt = ctxtp;
320 struct pam_conv sshpam_conv;
321 #ifndef USE_POSIX_THREADS
322 extern char **environ;
325 const char *pam_user;
327 pam_get_item(sshpam_handle, PAM_USER, (const void **)&pam_user);
328 setproctitle("%s [pam]", pam_user);
332 sshpam_conv.conv = sshpam_thread_conv;
333 sshpam_conv.appdata_ptr = ctxt;
335 buffer_init(&buffer);
336 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
337 (const void *)&sshpam_conv);
338 if (sshpam_err != PAM_SUCCESS)
340 sshpam_err = pam_authenticate(sshpam_handle, 0);
341 if (sshpam_err != PAM_SUCCESS)
345 if (!do_pam_account())
347 if (sshpam_new_authtok_reqd) {
348 sshpam_err = pam_chauthtok(sshpam_handle,
349 PAM_CHANGE_EXPIRED_AUTHTOK);
350 if (sshpam_err != PAM_SUCCESS)
352 pam_password_change_required(0);
356 buffer_put_cstring(&buffer, "OK");
358 #ifndef USE_POSIX_THREADS
359 /* Export variables set by do_pam_account */
360 buffer_put_int(&buffer, sshpam_account_status);
361 buffer_put_int(&buffer, sshpam_new_authtok_reqd);
363 /* Export any environment strings set in child */
364 for(i = 0; environ[i] != NULL; i++)
366 buffer_put_int(&buffer, i);
367 for(i = 0; environ[i] != NULL; i++)
368 buffer_put_cstring(&buffer, environ[i]);
370 /* Export any environment strings set by PAM in child */
371 env_from_pam = pam_getenvlist(sshpam_handle);
372 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
374 buffer_put_int(&buffer, i);
375 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
376 buffer_put_cstring(&buffer, env_from_pam[i]);
377 #endif /* USE_POSIX_THREADS */
379 /* XXX - can't do much about an error here */
380 ssh_msg_send(ctxt->pam_csock, sshpam_err, &buffer);
381 buffer_free(&buffer);
385 buffer_put_cstring(&buffer,
386 pam_strerror(sshpam_handle, sshpam_err));
387 /* XXX - can't do much about an error here */
388 ssh_msg_send(ctxt->pam_csock, PAM_AUTH_ERR, &buffer);
389 buffer_free(&buffer);
392 return (NULL); /* Avoid warning for non-pthread case */
396 sshpam_thread_cleanup(void)
398 struct pam_ctxt *ctxt = cleanup_ctxt;
400 if (ctxt != NULL && ctxt->pam_thread != 0) {
401 pthread_cancel(ctxt->pam_thread);
402 pthread_join(ctxt->pam_thread, NULL);
403 close(ctxt->pam_psock);
404 close(ctxt->pam_csock);
405 memset(ctxt, 0, sizeof(*ctxt));
411 sshpam_null_conv(int n, const struct pam_message **msg,
412 struct pam_response **resp, void *data)
414 return (PAM_CONV_ERR);
417 static struct pam_conv null_conv = { sshpam_null_conv, NULL };
422 debug("PAM: cleanup");
423 if (sshpam_handle == NULL)
425 pam_set_item(sshpam_handle, PAM_CONV, (const void *)&null_conv);
426 if (sshpam_cred_established) {
427 pam_setcred(sshpam_handle, PAM_DELETE_CRED);
428 sshpam_cred_established = 0;
430 if (sshpam_session_open) {
431 pam_close_session(sshpam_handle, PAM_SILENT);
432 sshpam_session_open = 0;
434 sshpam_authenticated = sshpam_new_authtok_reqd = 0;
435 pam_end(sshpam_handle, sshpam_err);
436 sshpam_handle = NULL;
440 sshpam_init(const char *user)
442 extern u_int utmp_len;
443 extern char *__progname;
444 const char *pam_rhost, *pam_user;
446 if (sshpam_handle != NULL) {
447 /* We already have a PAM context; check if the user matches */
448 sshpam_err = pam_get_item(sshpam_handle,
449 PAM_USER, (const void **)&pam_user);
450 if (sshpam_err == PAM_SUCCESS && strcmp(user, pam_user) == 0)
452 pam_end(sshpam_handle, sshpam_err);
453 sshpam_handle = NULL;
455 debug("PAM: initializing for \"%s\"", user);
457 pam_start(SSHD_PAM_SERVICE, user, &null_conv, &sshpam_handle);
458 if (sshpam_err != PAM_SUCCESS) {
459 pam_end(sshpam_handle, sshpam_err);
460 sshpam_handle = NULL;
463 pam_rhost = get_remote_name_or_ip(utmp_len, options.use_dns);
464 debug("PAM: setting PAM_RHOST to \"%s\"", pam_rhost);
465 sshpam_err = pam_set_item(sshpam_handle, PAM_RHOST, pam_rhost);
466 if (sshpam_err != PAM_SUCCESS) {
467 pam_end(sshpam_handle, sshpam_err);
468 sshpam_handle = NULL;
471 #ifdef PAM_TTY_KLUDGE
473 * Some silly PAM modules (e.g. pam_time) require a TTY to operate.
474 * sshd doesn't set the tty until too late in the auth process and
475 * may not even set one (for tty-less connections)
477 debug("PAM: setting PAM_TTY to \"ssh\"");
478 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, "ssh");
479 if (sshpam_err != PAM_SUCCESS) {
480 pam_end(sshpam_handle, sshpam_err);
481 sshpam_handle = NULL;
489 sshpam_init_ctx(Authctxt *authctxt)
491 struct pam_ctxt *ctxt;
494 /* Refuse to start if we don't have PAM enabled */
495 if (!options.use_pam)
499 if (sshpam_init(authctxt->user) == -1) {
500 error("PAM: initialization failed");
504 ctxt = xmalloc(sizeof *ctxt);
505 memset(ctxt, 0, sizeof(*ctxt));
507 /* Start the authentication thread */
508 if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, socks) == -1) {
509 error("PAM: failed create sockets: %s", strerror(errno));
513 ctxt->pam_psock = socks[0];
514 ctxt->pam_csock = socks[1];
515 if (pthread_create(&ctxt->pam_thread, NULL, sshpam_thread, ctxt) == -1) {
516 error("PAM: failed to start authentication thread: %s",
528 sshpam_query(void *ctx, char **name, char **info,
529 u_int *num, char ***prompts, u_int **echo_on)
532 struct pam_ctxt *ctxt = ctx;
538 buffer_init(&buffer);
541 *prompts = xmalloc(sizeof(char *));
544 *echo_on = xmalloc(sizeof(u_int));
545 while (ssh_msg_recv(ctxt->pam_psock, &buffer) == 0) {
546 type = buffer_get_char(&buffer);
547 msg = buffer_get_string(&buffer, NULL);
549 case PAM_PROMPT_ECHO_ON:
550 case PAM_PROMPT_ECHO_OFF:
552 len = plen + strlen(msg) + 1;
553 **prompts = xrealloc(**prompts, len);
554 plen += snprintf(**prompts + plen, len, "%s", msg);
555 **echo_on = (type == PAM_PROMPT_ECHO_ON);
560 /* accumulate messages */
561 len = plen + strlen(msg) + 2;
562 **prompts = xrealloc(**prompts, len);
563 plen += snprintf(**prompts + plen, len, "%s\n", msg);
568 if (**prompts != NULL) {
569 /* drain any accumulated messages */
570 debug("PAM: %s", **prompts);
571 buffer_append(&loginmsg, **prompts,
576 if (type == PAM_SUCCESS) {
577 import_environments(&buffer);
584 error("PAM: %s", msg);
597 /* XXX - see also comment in auth-chall.c:verify_response */
599 sshpam_respond(void *ctx, u_int num, char **resp)
602 struct pam_ctxt *ctxt = ctx;
604 debug2("PAM: %s", __func__);
605 switch (ctxt->pam_done) {
607 sshpam_authenticated = 1;
615 error("PAM: expected one response, got %u", num);
618 buffer_init(&buffer);
619 buffer_put_cstring(&buffer, *resp);
620 if (ssh_msg_send(ctxt->pam_psock, PAM_AUTHTOK, &buffer) == -1) {
621 buffer_free(&buffer);
624 buffer_free(&buffer);
629 sshpam_free_ctx(void *ctxtp)
631 struct pam_ctxt *ctxt = ctxtp;
633 sshpam_thread_cleanup();
636 * We don't call sshpam_cleanup() here because we may need the PAM
637 * handle at a later stage, e.g. when setting up a session. It's
638 * still on the cleanup list, so pam_end() *will* be called before
639 * the server process terminates.
643 KbdintDevice sshpam_device = {
651 KbdintDevice mm_sshpam_device = {
660 * This replaces auth-pam.c
663 start_pam(const char *user)
665 if (!options.use_pam)
666 fatal("PAM: initialisation requested when UsePAM=no");
668 if (sshpam_init(user) == -1)
669 fatal("PAM: initialisation failed");
681 if (sshpam_account_status != -1)
682 return (sshpam_account_status);
684 sshpam_err = pam_acct_mgmt(sshpam_handle, 0);
685 debug3("%s: pam_acct_mgmt = %d", __func__, sshpam_err);
687 if (sshpam_err != PAM_SUCCESS && sshpam_err != PAM_NEW_AUTHTOK_REQD) {
688 sshpam_account_status = 0;
689 return (sshpam_account_status);
692 if (sshpam_err == PAM_NEW_AUTHTOK_REQD)
693 pam_password_change_required(1);
695 sshpam_account_status = 1;
696 return (sshpam_account_status);
700 do_pam_set_tty(const char *tty)
703 debug("PAM: setting PAM_TTY to \"%s\"", tty);
704 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, tty);
705 if (sshpam_err != PAM_SUCCESS)
706 fatal("PAM: failed to set PAM_TTY: %s",
707 pam_strerror(sshpam_handle, sshpam_err));
712 do_pam_setcred(int init)
714 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
715 (const void *)&null_conv);
716 if (sshpam_err != PAM_SUCCESS)
717 fatal("PAM: failed to set PAM_CONV: %s",
718 pam_strerror(sshpam_handle, sshpam_err));
720 debug("PAM: establishing credentials");
721 sshpam_err = pam_setcred(sshpam_handle, PAM_ESTABLISH_CRED);
723 debug("PAM: reinitializing credentials");
724 sshpam_err = pam_setcred(sshpam_handle, PAM_REINITIALIZE_CRED);
726 if (sshpam_err == PAM_SUCCESS) {
727 sshpam_cred_established = 1;
730 if (sshpam_authenticated)
731 fatal("PAM: pam_setcred(): %s",
732 pam_strerror(sshpam_handle, sshpam_err));
734 debug("PAM: pam_setcred(): %s",
735 pam_strerror(sshpam_handle, sshpam_err));
739 is_pam_password_change_required(void)
741 return (sshpam_new_authtok_reqd);
745 pam_tty_conv(int n, const struct pam_message **msg,
746 struct pam_response **resp, void *data)
748 char input[PAM_MAX_MSG_SIZE];
749 struct pam_response *reply;
754 if (n <= 0 || n > PAM_MAX_NUM_MSG || !isatty(STDIN_FILENO))
755 return (PAM_CONV_ERR);
757 if ((reply = malloc(n * sizeof(*reply))) == NULL)
758 return (PAM_CONV_ERR);
759 memset(reply, 0, n * sizeof(*reply));
761 for (i = 0; i < n; ++i) {
762 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
763 case PAM_PROMPT_ECHO_OFF:
765 read_passphrase(PAM_MSG_MEMBER(msg, i, msg),
767 reply[i].resp_retcode = PAM_SUCCESS;
769 case PAM_PROMPT_ECHO_ON:
770 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
771 fgets(input, sizeof input, stdin);
772 reply[i].resp = xstrdup(input);
773 reply[i].resp_retcode = PAM_SUCCESS;
777 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
778 reply[i].resp_retcode = PAM_SUCCESS;
785 return (PAM_SUCCESS);
788 for(i = 0; i < n; i++) {
789 if (reply[i].resp != NULL)
790 xfree(reply[i].resp);
793 return (PAM_CONV_ERR);
796 static struct pam_conv tty_conv = { pam_tty_conv, NULL };
799 * XXX this should be done in the authentication phase, but ssh1 doesn't
803 do_pam_chauthtok(void)
806 fatal("Password expired (unable to change with privsep)");
807 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
808 (const void *)&tty_conv);
809 if (sshpam_err != PAM_SUCCESS)
810 fatal("PAM: failed to set PAM_CONV: %s",
811 pam_strerror(sshpam_handle, sshpam_err));
812 debug("PAM: changing password");
813 sshpam_err = pam_chauthtok(sshpam_handle, PAM_CHANGE_EXPIRED_AUTHTOK);
814 if (sshpam_err != PAM_SUCCESS)
815 fatal("PAM: pam_chauthtok(): %s",
816 pam_strerror(sshpam_handle, sshpam_err));
822 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
823 (const void *)&tty_conv);
824 if (sshpam_err != PAM_SUCCESS)
825 fatal("PAM: failed to set PAM_CONV: %s",
826 pam_strerror(sshpam_handle, sshpam_err));
827 sshpam_err = pam_open_session(sshpam_handle, 0);
828 if (sshpam_err != PAM_SUCCESS)
829 fatal("PAM: pam_open_session(): %s",
830 pam_strerror(sshpam_handle, sshpam_err));
831 sshpam_session_open = 1;
835 * Set a PAM environment string. We need to do this so that the session
836 * modules can handle things like Kerberos/GSI credentials that appear
837 * during the ssh authentication process.
840 do_pam_putenv(char *name, char *value)
843 #ifdef HAVE_PAM_PUTENV
847 len = strlen(name) + strlen(value) + 2;
848 compound = xmalloc(len);
850 snprintf(compound, len, "%s=%s", name, value);
851 ret = pam_putenv(sshpam_handle, compound);
859 print_pam_messages(void)
865 fetch_pam_child_environment(void)
871 fetch_pam_environment(void)
873 return (pam_getenvlist(sshpam_handle));
877 free_pam_environment(char **env)
884 for (envp = env; *envp; envp++)