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 #include <security/pam_appl.h>
45 #include "monitor_wrap.h"
52 #include "auth-options.h"
54 extern ServerOptions options;
55 extern Buffer loginmsg;
59 #ifdef USE_POSIX_THREADS
62 * Avoid namespace clash when *not* using pthreads for systems *with*
63 * pthreads, which unconditionally define pthread_t via sys/types.h
66 typedef pthread_t sp_pthread_t;
69 * Simulate threads with processes.
71 typedef pid_t sp_pthread_t;
74 pthread_exit(void *value __unused)
80 pthread_create(sp_pthread_t *thread, const void *attr __unused,
81 void *(*thread_start)(void *), void *arg)
85 switch ((pid = fork())) {
87 error("fork(): %s", strerror(errno));
99 pthread_cancel(sp_pthread_t thread)
101 return (kill(thread, SIGTERM));
105 pthread_join(sp_pthread_t thread, void **value __unused)
109 waitpid(thread, &status, 0);
115 static pam_handle_t *sshpam_handle = NULL;
116 static int sshpam_err = 0;
117 static int sshpam_authenticated = 0;
118 static int sshpam_new_authtok_reqd = 0;
119 static int sshpam_session_open = 0;
120 static int sshpam_cred_established = 0;
121 static char **sshpam_env = NULL;
124 sp_pthread_t pam_thread;
130 static void sshpam_free_ctx(void *);
131 static struct pam_ctxt *cleanup_ctxt;
133 /* Some PAM implementations don't implement this */
134 #ifndef HAVE_PAM_GETENVLIST
136 pam_getenvlist(pam_handle_t *pamh)
139 * XXX - If necessary, we can still support envrionment passing
140 * for platforms without pam_getenvlist by searching for known
141 * env vars (e.g. KRB5CCNAME) from the PAM environment.
147 /* Import regular and PAM environment from subprocess */
149 import_environments(Buffer *b)
155 /* Import environment from subprocess */
156 num_env = buffer_get_int(b);
157 sshpam_env = xmalloc((num_env + 1) * sizeof(*sshpam_env));
158 debug3("PAM: num env strings %d", num_env);
159 for(i = 0; i < num_env; i++)
160 sshpam_env[i] = buffer_get_string(b, NULL);
162 sshpam_env[num_env] = NULL;
164 /* Import PAM environment from subprocess */
165 num_env = buffer_get_int(b);
166 debug("PAM: num PAM env strings %d", num_env);
167 for(i = 0; i < num_env; i++) {
168 env = buffer_get_string(b, NULL);
170 /* Errors are not fatal here */
171 if ((err = pam_putenv(sshpam_handle, env)) != PAM_SUCCESS) {
172 error("PAM: pam_putenv: %s",
173 pam_strerror(sshpam_handle, sshpam_err));
179 * Conversation function for authentication thread.
182 sshpam_thread_conv(int n, const struct pam_message **msg,
183 struct pam_response **resp, void *data)
186 struct pam_ctxt *ctxt;
187 struct pam_response *reply;
193 if (n <= 0 || n > PAM_MAX_NUM_MSG)
194 return (PAM_CONV_ERR);
196 if ((reply = malloc(n * sizeof(*reply))) == NULL)
197 return (PAM_CONV_ERR);
198 memset(reply, 0, n * sizeof(*reply));
200 buffer_init(&buffer);
201 for (i = 0; i < n; ++i) {
202 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
203 case PAM_PROMPT_ECHO_OFF:
204 buffer_put_cstring(&buffer,
205 PAM_MSG_MEMBER(msg, i, msg));
206 if (ssh_msg_send(ctxt->pam_csock,
207 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
209 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
211 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
213 reply[i].resp = buffer_get_string(&buffer, NULL);
215 case PAM_PROMPT_ECHO_ON:
216 buffer_put_cstring(&buffer,
217 PAM_MSG_MEMBER(msg, i, msg));
218 if (ssh_msg_send(ctxt->pam_csock,
219 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
221 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
223 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
225 reply[i].resp = buffer_get_string(&buffer, NULL);
228 buffer_put_cstring(&buffer,
229 PAM_MSG_MEMBER(msg, i, msg));
230 if (ssh_msg_send(ctxt->pam_csock,
231 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
235 buffer_put_cstring(&buffer,
236 PAM_MSG_MEMBER(msg, i, msg));
237 if (ssh_msg_send(ctxt->pam_csock,
238 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
244 buffer_clear(&buffer);
246 buffer_free(&buffer);
248 return (PAM_SUCCESS);
251 for(i = 0; i < n; i++) {
252 if (reply[i].resp != NULL)
253 xfree(reply[i].resp);
256 buffer_free(&buffer);
257 return (PAM_CONV_ERR);
261 * Authentication thread.
264 sshpam_thread(void *ctxtp)
266 struct pam_ctxt *ctxt = ctxtp;
268 struct pam_conv sshpam_conv;
269 #ifndef USE_POSIX_THREADS
270 extern char **environ;
273 const char *pam_user;
275 pam_get_item(sshpam_handle, PAM_USER, (const void **)&pam_user);
276 setproctitle("%s [pam]", pam_user);
280 sshpam_conv.conv = sshpam_thread_conv;
281 sshpam_conv.appdata_ptr = ctxt;
283 buffer_init(&buffer);
284 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
285 (const void *)&sshpam_conv);
286 if (sshpam_err != PAM_SUCCESS)
288 sshpam_err = pam_authenticate(sshpam_handle, 0);
289 if (sshpam_err != PAM_SUCCESS)
291 buffer_put_cstring(&buffer, "OK");
293 #ifndef USE_POSIX_THREADS
294 /* Export any environment strings set in child */
295 for(i = 0; environ[i] != NULL; i++)
297 buffer_put_int(&buffer, i);
298 for(i = 0; environ[i] != NULL; i++)
299 buffer_put_cstring(&buffer, environ[i]);
301 /* Export any environment strings set by PAM in child */
302 env_from_pam = pam_getenvlist(sshpam_handle);
303 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
305 buffer_put_int(&buffer, i);
306 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
307 buffer_put_cstring(&buffer, env_from_pam[i]);
308 #endif /* USE_POSIX_THREADS */
310 /* XXX - can't do much about an error here */
311 ssh_msg_send(ctxt->pam_csock, sshpam_err, &buffer);
312 buffer_free(&buffer);
316 buffer_put_cstring(&buffer,
317 pam_strerror(sshpam_handle, sshpam_err));
318 /* XXX - can't do much about an error here */
319 ssh_msg_send(ctxt->pam_csock, PAM_AUTH_ERR, &buffer);
320 buffer_free(&buffer);
323 return (NULL); /* Avoid warning for non-pthread case */
327 sshpam_thread_cleanup(void)
329 struct pam_ctxt *ctxt = cleanup_ctxt;
331 if (ctxt != NULL && ctxt->pam_thread != 0) {
332 pthread_cancel(ctxt->pam_thread);
333 pthread_join(ctxt->pam_thread, NULL);
334 close(ctxt->pam_psock);
335 close(ctxt->pam_csock);
336 memset(ctxt, 0, sizeof(*ctxt));
342 sshpam_null_conv(int n, const struct pam_message **msg,
343 struct pam_response **resp, void *data)
345 return (PAM_CONV_ERR);
348 static struct pam_conv null_conv = { sshpam_null_conv, NULL };
353 debug("PAM: cleanup");
354 if (sshpam_handle == NULL)
356 pam_set_item(sshpam_handle, PAM_CONV, (const void *)&null_conv);
357 if (sshpam_cred_established) {
358 pam_setcred(sshpam_handle, PAM_DELETE_CRED);
359 sshpam_cred_established = 0;
361 if (sshpam_session_open) {
362 pam_close_session(sshpam_handle, PAM_SILENT);
363 sshpam_session_open = 0;
365 sshpam_authenticated = sshpam_new_authtok_reqd = 0;
366 pam_end(sshpam_handle, sshpam_err);
367 sshpam_handle = NULL;
371 sshpam_init(const char *user)
373 extern u_int utmp_len;
374 extern char *__progname;
375 const char *pam_rhost, *pam_user;
377 if (sshpam_handle != NULL) {
378 /* We already have a PAM context; check if the user matches */
379 sshpam_err = pam_get_item(sshpam_handle,
380 PAM_USER, (const void **)&pam_user);
381 if (sshpam_err == PAM_SUCCESS && strcmp(user, pam_user) == 0)
383 pam_end(sshpam_handle, sshpam_err);
384 sshpam_handle = NULL;
386 debug("PAM: initializing for \"%s\"", user);
388 pam_start(SSHD_PAM_SERVICE, user, &null_conv, &sshpam_handle);
389 if (sshpam_err != PAM_SUCCESS) {
390 pam_end(sshpam_handle, sshpam_err);
391 sshpam_handle = NULL;
394 pam_rhost = get_remote_name_or_ip(utmp_len, options.use_dns);
395 debug("PAM: setting PAM_RHOST to \"%s\"", pam_rhost);
396 sshpam_err = pam_set_item(sshpam_handle, PAM_RHOST, pam_rhost);
397 if (sshpam_err != PAM_SUCCESS) {
398 pam_end(sshpam_handle, sshpam_err);
399 sshpam_handle = NULL;
402 #ifdef PAM_TTY_KLUDGE
404 * Some silly PAM modules (e.g. pam_time) require a TTY to operate.
405 * sshd doesn't set the tty until too late in the auth process and
406 * may not even set one (for tty-less connections)
408 debug("PAM: setting PAM_TTY to \"ssh\"");
409 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, "ssh");
410 if (sshpam_err != PAM_SUCCESS) {
411 pam_end(sshpam_handle, sshpam_err);
412 sshpam_handle = NULL;
420 sshpam_init_ctx(Authctxt *authctxt)
422 struct pam_ctxt *ctxt;
425 /* Refuse to start if we don't have PAM enabled */
426 if (!options.use_pam)
430 if (sshpam_init(authctxt->user) == -1) {
431 error("PAM: initialization failed");
435 ctxt = xmalloc(sizeof *ctxt);
436 memset(ctxt, 0, sizeof(*ctxt));
438 /* Start the authentication thread */
439 if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, socks) == -1) {
440 error("PAM: failed create sockets: %s", strerror(errno));
444 ctxt->pam_psock = socks[0];
445 ctxt->pam_csock = socks[1];
446 if (pthread_create(&ctxt->pam_thread, NULL, sshpam_thread, ctxt) == -1) {
447 error("PAM: failed to start authentication thread: %s",
459 sshpam_query(void *ctx, char **name, char **info,
460 u_int *num, char ***prompts, u_int **echo_on)
463 struct pam_ctxt *ctxt = ctx;
469 buffer_init(&buffer);
472 *prompts = xmalloc(sizeof(char *));
475 *echo_on = xmalloc(sizeof(u_int));
476 while (ssh_msg_recv(ctxt->pam_psock, &buffer) == 0) {
477 type = buffer_get_char(&buffer);
478 msg = buffer_get_string(&buffer, NULL);
480 case PAM_PROMPT_ECHO_ON:
481 case PAM_PROMPT_ECHO_OFF:
483 len = plen + strlen(msg) + 1;
484 **prompts = xrealloc(**prompts, len);
485 plen += snprintf(**prompts + plen, len, "%s", msg);
486 **echo_on = (type == PAM_PROMPT_ECHO_ON);
491 /* accumulate messages */
492 len = plen + strlen(msg) + 2;
493 **prompts = xrealloc(**prompts, len);
494 plen += snprintf(**prompts + plen, len, "%s\n", msg);
499 if (**prompts != NULL) {
500 /* drain any accumulated messages */
501 debug("PAM: %s", **prompts);
502 buffer_append(&loginmsg, **prompts,
507 if (type == PAM_SUCCESS) {
508 import_environments(&buffer);
515 error("PAM: %s", msg);
528 /* XXX - see also comment in auth-chall.c:verify_response */
530 sshpam_respond(void *ctx, u_int num, char **resp)
533 struct pam_ctxt *ctxt = ctx;
535 debug2("PAM: %s", __func__);
536 switch (ctxt->pam_done) {
538 sshpam_authenticated = 1;
546 error("PAM: expected one response, got %u", num);
549 buffer_init(&buffer);
550 buffer_put_cstring(&buffer, *resp);
551 if (ssh_msg_send(ctxt->pam_psock, PAM_AUTHTOK, &buffer) == -1) {
552 buffer_free(&buffer);
555 buffer_free(&buffer);
560 sshpam_free_ctx(void *ctxtp)
562 struct pam_ctxt *ctxt = ctxtp;
564 sshpam_thread_cleanup();
567 * We don't call sshpam_cleanup() here because we may need the PAM
568 * handle at a later stage, e.g. when setting up a session. It's
569 * still on the cleanup list, so pam_end() *will* be called before
570 * the server process terminates.
574 KbdintDevice sshpam_device = {
582 KbdintDevice mm_sshpam_device = {
591 * This replaces auth-pam.c
594 start_pam(const char *user)
596 if (!options.use_pam)
597 fatal("PAM: initialisation requested when UsePAM=no");
599 if (sshpam_init(user) == -1)
600 fatal("PAM: initialisation failed");
612 sshpam_err = pam_acct_mgmt(sshpam_handle, 0);
613 debug3("%s: pam_acct_mgmt = %d", __func__, sshpam_err);
615 if (sshpam_err != PAM_SUCCESS && sshpam_err != PAM_NEW_AUTHTOK_REQD)
618 if (sshpam_err == PAM_NEW_AUTHTOK_REQD) {
619 sshpam_new_authtok_reqd = 1;
621 /* Prevent forwardings until password changed */
622 no_port_forwarding_flag |= 2;
623 no_agent_forwarding_flag |= 2;
624 no_x11_forwarding_flag |= 2;
631 do_pam_set_tty(const char *tty)
634 debug("PAM: setting PAM_TTY to \"%s\"", tty);
635 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, tty);
636 if (sshpam_err != PAM_SUCCESS)
637 fatal("PAM: failed to set PAM_TTY: %s",
638 pam_strerror(sshpam_handle, sshpam_err));
643 do_pam_setcred(int init)
645 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
646 (const void *)&null_conv);
647 if (sshpam_err != PAM_SUCCESS)
648 fatal("PAM: failed to set PAM_CONV: %s",
649 pam_strerror(sshpam_handle, sshpam_err));
651 debug("PAM: establishing credentials");
652 sshpam_err = pam_setcred(sshpam_handle, PAM_ESTABLISH_CRED);
654 debug("PAM: reinitializing credentials");
655 sshpam_err = pam_setcred(sshpam_handle, PAM_REINITIALIZE_CRED);
657 if (sshpam_err == PAM_SUCCESS) {
658 sshpam_cred_established = 1;
661 if (sshpam_authenticated)
662 fatal("PAM: pam_setcred(): %s",
663 pam_strerror(sshpam_handle, sshpam_err));
665 debug("PAM: pam_setcred(): %s",
666 pam_strerror(sshpam_handle, sshpam_err));
670 is_pam_password_change_required(void)
672 return (sshpam_new_authtok_reqd);
676 pam_tty_conv(int n, const struct pam_message **msg,
677 struct pam_response **resp, void *data)
679 char input[PAM_MAX_MSG_SIZE];
680 struct pam_response *reply;
685 if (n <= 0 || n > PAM_MAX_NUM_MSG || !isatty(STDIN_FILENO))
686 return (PAM_CONV_ERR);
688 if ((reply = malloc(n * sizeof(*reply))) == NULL)
689 return (PAM_CONV_ERR);
690 memset(reply, 0, n * sizeof(*reply));
692 for (i = 0; i < n; ++i) {
693 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
694 case PAM_PROMPT_ECHO_OFF:
696 read_passphrase(PAM_MSG_MEMBER(msg, i, msg),
698 reply[i].resp_retcode = PAM_SUCCESS;
700 case PAM_PROMPT_ECHO_ON:
701 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
702 fgets(input, sizeof input, stdin);
703 reply[i].resp = xstrdup(input);
704 reply[i].resp_retcode = PAM_SUCCESS;
708 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
709 reply[i].resp_retcode = PAM_SUCCESS;
716 return (PAM_SUCCESS);
719 for(i = 0; i < n; i++) {
720 if (reply[i].resp != NULL)
721 xfree(reply[i].resp);
724 return (PAM_CONV_ERR);
727 static struct pam_conv tty_conv = { pam_tty_conv, NULL };
730 * XXX this should be done in the authentication phase, but ssh1 doesn't
734 do_pam_chauthtok(void)
737 fatal("Password expired (unable to change with privsep)");
738 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
739 (const void *)&tty_conv);
740 if (sshpam_err != PAM_SUCCESS)
741 fatal("PAM: failed to set PAM_CONV: %s",
742 pam_strerror(sshpam_handle, sshpam_err));
743 debug("PAM: changing password");
744 sshpam_err = pam_chauthtok(sshpam_handle, PAM_CHANGE_EXPIRED_AUTHTOK);
745 if (sshpam_err != PAM_SUCCESS)
746 fatal("PAM: pam_chauthtok(): %s",
747 pam_strerror(sshpam_handle, sshpam_err));
753 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
754 (const void *)&tty_conv);
755 if (sshpam_err != PAM_SUCCESS)
756 fatal("PAM: failed to set PAM_CONV: %s",
757 pam_strerror(sshpam_handle, sshpam_err));
758 sshpam_err = pam_open_session(sshpam_handle, 0);
759 if (sshpam_err != PAM_SUCCESS)
760 fatal("PAM: pam_open_session(): %s",
761 pam_strerror(sshpam_handle, sshpam_err));
762 sshpam_session_open = 1;
766 * Set a PAM environment string. We need to do this so that the session
767 * modules can handle things like Kerberos/GSI credentials that appear
768 * during the ssh authentication process.
771 do_pam_putenv(char *name, char *value)
774 #ifdef HAVE_PAM_PUTENV
778 len = strlen(name) + strlen(value) + 2;
779 compound = xmalloc(len);
781 snprintf(compound, len, "%s=%s", name, value);
782 ret = pam_putenv(sshpam_handle, compound);
790 print_pam_messages(void)
796 fetch_pam_child_environment(void)
802 fetch_pam_environment(void)
804 return (pam_getenvlist(sshpam_handle));
808 free_pam_environment(char **env)
815 for (envp = env; *envp; envp++)