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;
72 * Simulate threads with processes.
74 typedef pid_t sp_pthread_t;
77 pthread_exit(void *value __unused)
83 pthread_create(sp_pthread_t *thread, const void *attr __unused,
84 void *(*thread_start)(void *), void *arg)
88 switch ((pid = fork())) {
90 error("fork(): %s", strerror(errno));
102 pthread_cancel(sp_pthread_t thread)
104 return (kill(thread, SIGTERM));
108 pthread_join(sp_pthread_t thread, void **value __unused)
112 waitpid(thread, &status, 0);
118 static pam_handle_t *sshpam_handle = NULL;
119 static int sshpam_err = 0;
120 static int sshpam_authenticated = 0;
121 static int sshpam_new_authtok_reqd = 0;
122 static int sshpam_session_open = 0;
123 static int sshpam_cred_established = 0;
124 static int sshpam_account_status = -1;
125 static char **sshpam_env = NULL;
128 sp_pthread_t pam_thread;
134 static void sshpam_free_ctx(void *);
135 static struct pam_ctxt *cleanup_ctxt;
137 /* Some PAM implementations don't implement this */
138 #ifndef HAVE_PAM_GETENVLIST
140 pam_getenvlist(pam_handle_t *pamh)
143 * XXX - If necessary, we can still support envrionment passing
144 * for platforms without pam_getenvlist by searching for known
145 * env vars (e.g. KRB5CCNAME) from the PAM environment.
152 pam_password_change_required(int reqd)
154 sshpam_new_authtok_reqd = reqd;
156 no_port_forwarding_flag |= 2;
157 no_agent_forwarding_flag |= 2;
158 no_x11_forwarding_flag |= 2;
160 no_port_forwarding_flag &= ~2;
161 no_agent_forwarding_flag &= ~2;
162 no_x11_forwarding_flag &= ~2;
166 /* Import regular and PAM environment from subprocess */
168 import_environments(Buffer *b)
174 /* Import variables set by do_pam_account */
175 sshpam_account_status = buffer_get_int(b);
176 pam_password_change_required(buffer_get_int(b));
178 /* Import environment from subprocess */
179 num_env = buffer_get_int(b);
180 sshpam_env = xmalloc((num_env + 1) * sizeof(*sshpam_env));
181 debug3("PAM: num env strings %d", num_env);
182 for(i = 0; i < num_env; i++)
183 sshpam_env[i] = buffer_get_string(b, NULL);
185 sshpam_env[num_env] = NULL;
187 /* Import PAM environment from subprocess */
188 num_env = buffer_get_int(b);
189 debug("PAM: num PAM env strings %d", num_env);
190 for(i = 0; i < num_env; i++) {
191 env = buffer_get_string(b, NULL);
193 #ifdef HAVE_PAM_PUTENV
194 /* Errors are not fatal here */
195 if ((err = pam_putenv(sshpam_handle, env)) != PAM_SUCCESS) {
196 error("PAM: pam_putenv: %s",
197 pam_strerror(sshpam_handle, sshpam_err));
204 * Conversation function for authentication thread.
207 sshpam_thread_conv(int n, const struct pam_message **msg,
208 struct pam_response **resp, void *data)
211 struct pam_ctxt *ctxt;
212 struct pam_response *reply;
218 if (n <= 0 || n > PAM_MAX_NUM_MSG)
219 return (PAM_CONV_ERR);
221 if ((reply = malloc(n * sizeof(*reply))) == NULL)
222 return (PAM_CONV_ERR);
223 memset(reply, 0, n * sizeof(*reply));
225 buffer_init(&buffer);
226 for (i = 0; i < n; ++i) {
227 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
228 case PAM_PROMPT_ECHO_OFF:
229 buffer_put_cstring(&buffer,
230 PAM_MSG_MEMBER(msg, i, msg));
231 if (ssh_msg_send(ctxt->pam_csock,
232 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
234 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
236 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
238 reply[i].resp = buffer_get_string(&buffer, NULL);
240 case PAM_PROMPT_ECHO_ON:
241 buffer_put_cstring(&buffer,
242 PAM_MSG_MEMBER(msg, i, msg));
243 if (ssh_msg_send(ctxt->pam_csock,
244 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
246 if (ssh_msg_recv(ctxt->pam_csock, &buffer) == -1)
248 if (buffer_get_char(&buffer) != PAM_AUTHTOK)
250 reply[i].resp = buffer_get_string(&buffer, NULL);
253 buffer_put_cstring(&buffer,
254 PAM_MSG_MEMBER(msg, i, msg));
255 if (ssh_msg_send(ctxt->pam_csock,
256 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
260 buffer_put_cstring(&buffer,
261 PAM_MSG_MEMBER(msg, i, msg));
262 if (ssh_msg_send(ctxt->pam_csock,
263 PAM_MSG_MEMBER(msg, i, msg_style), &buffer) == -1)
269 buffer_clear(&buffer);
271 buffer_free(&buffer);
273 return (PAM_SUCCESS);
276 for(i = 0; i < n; i++) {
277 if (reply[i].resp != NULL)
278 xfree(reply[i].resp);
281 buffer_free(&buffer);
282 return (PAM_CONV_ERR);
286 * Authentication thread.
289 sshpam_thread(void *ctxtp)
291 struct pam_ctxt *ctxt = ctxtp;
293 struct pam_conv sshpam_conv;
294 #ifndef USE_POSIX_THREADS
295 extern char **environ;
298 const char *pam_user;
300 pam_get_item(sshpam_handle, PAM_USER, (const void **)&pam_user);
301 setproctitle("%s [pam]", pam_user);
305 sshpam_conv.conv = sshpam_thread_conv;
306 sshpam_conv.appdata_ptr = ctxt;
308 buffer_init(&buffer);
309 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
310 (const void *)&sshpam_conv);
311 if (sshpam_err != PAM_SUCCESS)
313 sshpam_err = pam_authenticate(sshpam_handle, 0);
314 if (sshpam_err != PAM_SUCCESS)
318 if (!do_pam_account())
320 if (sshpam_new_authtok_reqd) {
321 sshpam_err = pam_chauthtok(sshpam_handle,
322 PAM_CHANGE_EXPIRED_AUTHTOK);
323 if (sshpam_err != PAM_SUCCESS)
325 pam_password_change_required(0);
329 buffer_put_cstring(&buffer, "OK");
331 #ifndef USE_POSIX_THREADS
332 /* Export variables set by do_pam_account */
333 buffer_put_int(&buffer, sshpam_account_status);
334 buffer_put_int(&buffer, sshpam_new_authtok_reqd);
336 /* Export any environment strings set in child */
337 for(i = 0; environ[i] != NULL; i++)
339 buffer_put_int(&buffer, i);
340 for(i = 0; environ[i] != NULL; i++)
341 buffer_put_cstring(&buffer, environ[i]);
343 /* Export any environment strings set by PAM in child */
344 env_from_pam = pam_getenvlist(sshpam_handle);
345 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
347 buffer_put_int(&buffer, i);
348 for(i = 0; env_from_pam != NULL && env_from_pam[i] != NULL; i++)
349 buffer_put_cstring(&buffer, env_from_pam[i]);
350 #endif /* USE_POSIX_THREADS */
352 /* XXX - can't do much about an error here */
353 ssh_msg_send(ctxt->pam_csock, sshpam_err, &buffer);
354 buffer_free(&buffer);
358 buffer_put_cstring(&buffer,
359 pam_strerror(sshpam_handle, sshpam_err));
360 /* XXX - can't do much about an error here */
361 ssh_msg_send(ctxt->pam_csock, PAM_AUTH_ERR, &buffer);
362 buffer_free(&buffer);
365 return (NULL); /* Avoid warning for non-pthread case */
369 sshpam_thread_cleanup(void)
371 struct pam_ctxt *ctxt = cleanup_ctxt;
373 if (ctxt != NULL && ctxt->pam_thread != 0) {
374 pthread_cancel(ctxt->pam_thread);
375 pthread_join(ctxt->pam_thread, NULL);
376 close(ctxt->pam_psock);
377 close(ctxt->pam_csock);
378 memset(ctxt, 0, sizeof(*ctxt));
384 sshpam_null_conv(int n, const struct pam_message **msg,
385 struct pam_response **resp, void *data)
387 return (PAM_CONV_ERR);
390 static struct pam_conv null_conv = { sshpam_null_conv, NULL };
395 debug("PAM: cleanup");
396 if (sshpam_handle == NULL)
398 pam_set_item(sshpam_handle, PAM_CONV, (const void *)&null_conv);
399 if (sshpam_cred_established) {
400 pam_setcred(sshpam_handle, PAM_DELETE_CRED);
401 sshpam_cred_established = 0;
403 if (sshpam_session_open) {
404 pam_close_session(sshpam_handle, PAM_SILENT);
405 sshpam_session_open = 0;
407 sshpam_authenticated = sshpam_new_authtok_reqd = 0;
408 pam_end(sshpam_handle, sshpam_err);
409 sshpam_handle = NULL;
413 sshpam_init(const char *user)
415 extern u_int utmp_len;
416 extern char *__progname;
417 const char *pam_rhost, *pam_user;
419 if (sshpam_handle != NULL) {
420 /* We already have a PAM context; check if the user matches */
421 sshpam_err = pam_get_item(sshpam_handle,
422 PAM_USER, (const void **)&pam_user);
423 if (sshpam_err == PAM_SUCCESS && strcmp(user, pam_user) == 0)
425 pam_end(sshpam_handle, sshpam_err);
426 sshpam_handle = NULL;
428 debug("PAM: initializing for \"%s\"", user);
430 pam_start(SSHD_PAM_SERVICE, user, &null_conv, &sshpam_handle);
431 if (sshpam_err != PAM_SUCCESS) {
432 pam_end(sshpam_handle, sshpam_err);
433 sshpam_handle = NULL;
436 pam_rhost = get_remote_name_or_ip(utmp_len, options.use_dns);
437 debug("PAM: setting PAM_RHOST to \"%s\"", pam_rhost);
438 sshpam_err = pam_set_item(sshpam_handle, PAM_RHOST, pam_rhost);
439 if (sshpam_err != PAM_SUCCESS) {
440 pam_end(sshpam_handle, sshpam_err);
441 sshpam_handle = NULL;
444 #ifdef PAM_TTY_KLUDGE
446 * Some silly PAM modules (e.g. pam_time) require a TTY to operate.
447 * sshd doesn't set the tty until too late in the auth process and
448 * may not even set one (for tty-less connections)
450 debug("PAM: setting PAM_TTY to \"ssh\"");
451 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, "ssh");
452 if (sshpam_err != PAM_SUCCESS) {
453 pam_end(sshpam_handle, sshpam_err);
454 sshpam_handle = NULL;
462 sshpam_init_ctx(Authctxt *authctxt)
464 struct pam_ctxt *ctxt;
467 /* Refuse to start if we don't have PAM enabled */
468 if (!options.use_pam)
472 if (sshpam_init(authctxt->user) == -1) {
473 error("PAM: initialization failed");
477 ctxt = xmalloc(sizeof *ctxt);
478 memset(ctxt, 0, sizeof(*ctxt));
480 /* Start the authentication thread */
481 if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, socks) == -1) {
482 error("PAM: failed create sockets: %s", strerror(errno));
486 ctxt->pam_psock = socks[0];
487 ctxt->pam_csock = socks[1];
488 if (pthread_create(&ctxt->pam_thread, NULL, sshpam_thread, ctxt) == -1) {
489 error("PAM: failed to start authentication thread: %s",
501 sshpam_query(void *ctx, char **name, char **info,
502 u_int *num, char ***prompts, u_int **echo_on)
505 struct pam_ctxt *ctxt = ctx;
511 buffer_init(&buffer);
514 *prompts = xmalloc(sizeof(char *));
517 *echo_on = xmalloc(sizeof(u_int));
518 while (ssh_msg_recv(ctxt->pam_psock, &buffer) == 0) {
519 type = buffer_get_char(&buffer);
520 msg = buffer_get_string(&buffer, NULL);
522 case PAM_PROMPT_ECHO_ON:
523 case PAM_PROMPT_ECHO_OFF:
525 len = plen + strlen(msg) + 1;
526 **prompts = xrealloc(**prompts, len);
527 plen += snprintf(**prompts + plen, len, "%s", msg);
528 **echo_on = (type == PAM_PROMPT_ECHO_ON);
533 /* accumulate messages */
534 len = plen + strlen(msg) + 2;
535 **prompts = xrealloc(**prompts, len);
536 plen += snprintf(**prompts + plen, len, "%s\n", msg);
541 if (**prompts != NULL) {
542 /* drain any accumulated messages */
543 debug("PAM: %s", **prompts);
544 buffer_append(&loginmsg, **prompts,
549 if (type == PAM_SUCCESS) {
550 import_environments(&buffer);
557 error("PAM: %s", msg);
570 /* XXX - see also comment in auth-chall.c:verify_response */
572 sshpam_respond(void *ctx, u_int num, char **resp)
575 struct pam_ctxt *ctxt = ctx;
577 debug2("PAM: %s", __func__);
578 switch (ctxt->pam_done) {
580 sshpam_authenticated = 1;
588 error("PAM: expected one response, got %u", num);
591 buffer_init(&buffer);
592 buffer_put_cstring(&buffer, *resp);
593 if (ssh_msg_send(ctxt->pam_psock, PAM_AUTHTOK, &buffer) == -1) {
594 buffer_free(&buffer);
597 buffer_free(&buffer);
602 sshpam_free_ctx(void *ctxtp)
604 struct pam_ctxt *ctxt = ctxtp;
606 sshpam_thread_cleanup();
609 * We don't call sshpam_cleanup() here because we may need the PAM
610 * handle at a later stage, e.g. when setting up a session. It's
611 * still on the cleanup list, so pam_end() *will* be called before
612 * the server process terminates.
616 KbdintDevice sshpam_device = {
624 KbdintDevice mm_sshpam_device = {
633 * This replaces auth-pam.c
636 start_pam(const char *user)
638 if (!options.use_pam)
639 fatal("PAM: initialisation requested when UsePAM=no");
641 if (sshpam_init(user) == -1)
642 fatal("PAM: initialisation failed");
654 if (sshpam_account_status != -1)
655 return (sshpam_account_status);
657 sshpam_err = pam_acct_mgmt(sshpam_handle, 0);
658 debug3("%s: pam_acct_mgmt = %d", __func__, sshpam_err);
660 if (sshpam_err != PAM_SUCCESS && sshpam_err != PAM_NEW_AUTHTOK_REQD) {
661 sshpam_account_status = 0;
662 return (sshpam_account_status);
665 if (sshpam_err == PAM_NEW_AUTHTOK_REQD)
666 pam_password_change_required(1);
668 sshpam_account_status = 1;
669 return (sshpam_account_status);
673 do_pam_set_tty(const char *tty)
676 debug("PAM: setting PAM_TTY to \"%s\"", tty);
677 sshpam_err = pam_set_item(sshpam_handle, PAM_TTY, tty);
678 if (sshpam_err != PAM_SUCCESS)
679 fatal("PAM: failed to set PAM_TTY: %s",
680 pam_strerror(sshpam_handle, sshpam_err));
685 do_pam_setcred(int init)
687 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
688 (const void *)&null_conv);
689 if (sshpam_err != PAM_SUCCESS)
690 fatal("PAM: failed to set PAM_CONV: %s",
691 pam_strerror(sshpam_handle, sshpam_err));
693 debug("PAM: establishing credentials");
694 sshpam_err = pam_setcred(sshpam_handle, PAM_ESTABLISH_CRED);
696 debug("PAM: reinitializing credentials");
697 sshpam_err = pam_setcred(sshpam_handle, PAM_REINITIALIZE_CRED);
699 if (sshpam_err == PAM_SUCCESS) {
700 sshpam_cred_established = 1;
703 if (sshpam_authenticated)
704 fatal("PAM: pam_setcred(): %s",
705 pam_strerror(sshpam_handle, sshpam_err));
707 debug("PAM: pam_setcred(): %s",
708 pam_strerror(sshpam_handle, sshpam_err));
712 is_pam_password_change_required(void)
714 return (sshpam_new_authtok_reqd);
718 pam_tty_conv(int n, const struct pam_message **msg,
719 struct pam_response **resp, void *data)
721 char input[PAM_MAX_MSG_SIZE];
722 struct pam_response *reply;
727 if (n <= 0 || n > PAM_MAX_NUM_MSG || !isatty(STDIN_FILENO))
728 return (PAM_CONV_ERR);
730 if ((reply = malloc(n * sizeof(*reply))) == NULL)
731 return (PAM_CONV_ERR);
732 memset(reply, 0, n * sizeof(*reply));
734 for (i = 0; i < n; ++i) {
735 switch (PAM_MSG_MEMBER(msg, i, msg_style)) {
736 case PAM_PROMPT_ECHO_OFF:
738 read_passphrase(PAM_MSG_MEMBER(msg, i, msg),
740 reply[i].resp_retcode = PAM_SUCCESS;
742 case PAM_PROMPT_ECHO_ON:
743 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
744 fgets(input, sizeof input, stdin);
745 reply[i].resp = xstrdup(input);
746 reply[i].resp_retcode = PAM_SUCCESS;
750 fprintf(stderr, "%s\n", PAM_MSG_MEMBER(msg, i, msg));
751 reply[i].resp_retcode = PAM_SUCCESS;
758 return (PAM_SUCCESS);
761 for(i = 0; i < n; i++) {
762 if (reply[i].resp != NULL)
763 xfree(reply[i].resp);
766 return (PAM_CONV_ERR);
769 static struct pam_conv tty_conv = { pam_tty_conv, NULL };
772 * XXX this should be done in the authentication phase, but ssh1 doesn't
776 do_pam_chauthtok(void)
779 fatal("Password expired (unable to change with privsep)");
780 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
781 (const void *)&tty_conv);
782 if (sshpam_err != PAM_SUCCESS)
783 fatal("PAM: failed to set PAM_CONV: %s",
784 pam_strerror(sshpam_handle, sshpam_err));
785 debug("PAM: changing password");
786 sshpam_err = pam_chauthtok(sshpam_handle, PAM_CHANGE_EXPIRED_AUTHTOK);
787 if (sshpam_err != PAM_SUCCESS)
788 fatal("PAM: pam_chauthtok(): %s",
789 pam_strerror(sshpam_handle, sshpam_err));
795 sshpam_err = pam_set_item(sshpam_handle, PAM_CONV,
796 (const void *)&tty_conv);
797 if (sshpam_err != PAM_SUCCESS)
798 fatal("PAM: failed to set PAM_CONV: %s",
799 pam_strerror(sshpam_handle, sshpam_err));
800 sshpam_err = pam_open_session(sshpam_handle, 0);
801 if (sshpam_err != PAM_SUCCESS)
802 fatal("PAM: pam_open_session(): %s",
803 pam_strerror(sshpam_handle, sshpam_err));
804 sshpam_session_open = 1;
808 * Set a PAM environment string. We need to do this so that the session
809 * modules can handle things like Kerberos/GSI credentials that appear
810 * during the ssh authentication process.
813 do_pam_putenv(char *name, char *value)
816 #ifdef HAVE_PAM_PUTENV
820 len = strlen(name) + strlen(value) + 2;
821 compound = xmalloc(len);
823 snprintf(compound, len, "%s=%s", name, value);
824 ret = pam_putenv(sshpam_handle, compound);
832 print_pam_messages(void)
838 fetch_pam_child_environment(void)
844 fetch_pam_environment(void)
846 return (pam_getenvlist(sshpam_handle));
850 free_pam_environment(char **env)
857 for (envp = env; *envp; envp++)