2 * Copyright (c) 1999-2005, 2007-2010 Todd C. Miller <Todd.Miller@courtesan.com>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 * Sponsored in part by the Defense Advanced Research Projects
17 * Agency (DARPA) and Air Force Research Laboratory, Air Force
18 * Materiel Command, USAF, under agreement number F39502-99-1-0512.
23 #include <sys/types.h>
24 #include <sys/param.h>
33 #endif /* STDC_HEADERS */
36 #endif /* HAVE_STRING_H */
39 #endif /* HAVE_STRINGS_H */
42 #endif /* HAVE_UNISTD_H */
46 #ifdef HAVE_PAM_PAM_APPL_H
47 # include <pam/pam_appl.h>
49 # include <security/pam_appl.h>
54 # if defined(__LINUX_PAM__)
55 # define PAM_TEXT_DOMAIN "Linux-PAM"
56 # elif defined(__sun__)
57 # define PAM_TEXT_DOMAIN "SUNW_OST_SYSOSPAM"
62 #include "sudo_auth.h"
64 /* Only OpenPAM and Linux PAM use const qualifiers. */
65 #if defined(_OPENPAM) || defined(OPENPAM_VERSION) || \
66 defined(__LIBPAM_VERSION) || defined(__LINUX_PAM__)
67 # define PAM_CONST const
72 static int sudo_conv __P((int, PAM_CONST struct pam_message **,
73 struct pam_response **, void *));
74 static char *def_prompt = "Password:";
77 #ifndef PAM_DATA_SILENT
78 #define PAM_DATA_SILENT 0
81 static pam_handle_t *pamh; /* global due to pam_prep_user() */
84 pam_init(pw, promptp, auth)
89 static struct pam_conv pam_conv;
90 static int pam_status;
92 /* Initial PAM setup */
94 auth->data = (void *) &pam_status;
95 pam_conv.conv = sudo_conv;
97 if (ISSET(sudo_mode, MODE_LOGIN_SHELL))
98 pam_status = pam_start("sudo-i", pw->pw_name, &pam_conv, &pamh);
101 pam_status = pam_start("sudo", pw->pw_name, &pam_conv, &pamh);
103 if (pam_status != PAM_SUCCESS) {
104 log_error(USE_ERRNO|NO_EXIT|NO_MAIL, "unable to initialize PAM");
109 * Set PAM_RUSER to the invoking user (the "from" user).
110 * We set PAM_RHOST to avoid a bug in Solaris 7 and below.
112 (void) pam_set_item(pamh, PAM_RUSER, user_name);
114 (void) pam_set_item(pamh, PAM_RHOST, user_host);
118 * Some versions of pam_lastlog have a bug that
119 * will cause a crash if PAM_TTY is not set so if
120 * there is no tty, set PAM_TTY to the empty string.
122 if (user_ttypath == NULL)
123 (void) pam_set_item(pamh, PAM_TTY, "");
125 (void) pam_set_item(pamh, PAM_TTY, user_ttypath);
131 pam_verify(pw, prompt, auth)
137 int *pam_status = (int *) auth->data;
139 def_prompt = prompt; /* for sudo_conv */
141 /* PAM_SILENT prevents the authentication service from generating output. */
142 *pam_status = pam_authenticate(pamh, PAM_SILENT);
143 switch (*pam_status) {
145 *pam_status = pam_acct_mgmt(pamh, PAM_SILENT);
146 switch (*pam_status) {
150 log_error(NO_EXIT|NO_MAIL,
151 "account validation failure, is your account locked?");
153 case PAM_NEW_AUTHTOK_REQD:
154 log_error(NO_EXIT|NO_MAIL, "%s, %s",
155 "Account or password is expired",
156 "reset your password and try again");
157 *pam_status = pam_chauthtok(pamh,
158 PAM_CHANGE_EXPIRED_AUTHTOK);
159 if (*pam_status == PAM_SUCCESS)
161 if ((s = pam_strerror(pamh, *pam_status)))
162 log_error(NO_EXIT|NO_MAIL, "pam_chauthtok: %s", s);
164 case PAM_AUTHTOK_EXPIRED:
165 log_error(NO_EXIT|NO_MAIL,
166 "Password expired, contact your system administrator");
168 case PAM_ACCT_EXPIRED:
169 log_error(NO_EXIT|NO_MAIL, "%s %s",
170 "Account expired or PAM config lacks an \"account\"",
171 "section for sudo, contact your system administrator");
177 /* error or ^C from tgetpass() */
181 case PAM_PERM_DENIED:
184 if ((s = pam_strerror(pamh, *pam_status)))
185 log_error(NO_EXIT|NO_MAIL, "pam_authenticate: %s", s);
191 pam_cleanup(pw, auth)
195 int *pam_status = (int *) auth->data;
197 /* If successful, we can't close the session until pam_prep_user() */
198 if (auth->status == AUTH_SUCCESS)
201 *pam_status = pam_end(pamh, *pam_status | PAM_DATA_SILENT);
202 return *pam_status == PAM_SUCCESS ? AUTH_SUCCESS : AUTH_FAILURE;
206 pam_begin_session(pw)
209 int status = PAM_SUCCESS;
211 /* If the user did not have to authenticate there is no pam handle yet. */
213 pam_init(pw, NULL, NULL);
216 * Update PAM_USER to reference the user we are running the command
217 * as, as opposed to the user we authenticated as.
219 (void) pam_set_item(pamh, PAM_USER, pw->pw_name);
222 * Set credentials (may include resource limits, device ownership, etc).
223 * We don't check the return value here because in Linux-PAM 0.75
224 * it returns the last saved return code, not the return code
225 * for the setcred module. Because we haven't called pam_authenticate(),
226 * this is not set and so pam_setcred() returns PAM_PERM_DENIED.
227 * We can't call pam_acct_mgmt() with Linux-PAM for a similar reason.
229 (void) pam_setcred(pamh, PAM_ESTABLISH_CRED);
231 #ifndef NO_PAM_SESSION
232 status = pam_open_session(pamh, 0);
233 if (status != PAM_SUCCESS) {
234 (void) pam_end(pamh, status | PAM_DATA_SILENT);
238 return status == PAM_SUCCESS ? AUTH_SUCCESS : AUTH_FAILURE;
244 int status = PAM_SUCCESS;
247 #ifndef NO_PAM_SESSION
248 (void) pam_close_session(pamh, 0);
250 status = pam_end(pamh, PAM_SUCCESS | PAM_DATA_SILENT);
252 return status == PAM_SUCCESS ? AUTH_SUCCESS : AUTH_FAILURE;
256 * ``Conversation function'' for PAM.
257 * XXX - does not handle PAM_BINARY_PROMPT
260 sudo_conv(num_msg, msg, response, appdata_ptr)
262 PAM_CONST struct pam_message **msg;
263 struct pam_response **response;
266 struct pam_response *pr;
267 PAM_CONST struct pam_message *pm;
270 int n, flags, std_prompt;
272 if ((*response = malloc(num_msg * sizeof(struct pam_response))) == NULL)
273 return PAM_SYSTEM_ERR;
274 zero_bytes(*response, num_msg * sizeof(struct pam_response));
276 for (pr = *response, pm = *msg, n = num_msg; n--; pr++, pm++) {
277 flags = tgetpass_flags;
278 switch (pm->msg_style) {
279 case PAM_PROMPT_ECHO_ON:
280 SET(flags, TGP_ECHO);
281 case PAM_PROMPT_ECHO_OFF:
284 /* Error out if the last password read was interrupted. */
288 /* Is the sudo prompt standard? (If so, we'l just use PAM's) */
289 std_prompt = strncmp(def_prompt, "Password:", 9) == 0 &&
290 (def_prompt[9] == '\0' ||
291 (def_prompt[9] == ' ' && def_prompt[10] == '\0'));
293 /* Only override PAM prompt if it matches /^Password: ?/ */
294 #if defined(PAM_TEXT_DOMAIN) && defined(HAVE_DGETTEXT)
295 if (!def_passprompt_override && (std_prompt ||
296 (strcmp(pm->msg, dgettext(PAM_TEXT_DOMAIN, "Password: ")) &&
297 strcmp(pm->msg, dgettext(PAM_TEXT_DOMAIN, "Password:")))))
300 if (!def_passprompt_override && (std_prompt ||
301 strncmp(pm->msg, "Password:", 9) || (pm->msg[9] != '\0'
302 && (pm->msg[9] != ' ' || pm->msg[10] != '\0'))))
305 /* Read the password unless interrupted. */
306 pass = tgetpass(prompt, def_passwd_timeout * 60, flags);
308 /* We got ^C instead of a password; abort quickly. */
311 #if defined(__darwin__) || defined(__APPLE__)
317 pr->resp = estrdup(pass);
318 zero_bytes(pass, strlen(pass));
322 (void) puts(pm->msg);
326 (void) fputs(pm->msg, stderr);
327 (void) fputc('\n', stderr);
338 /* Zero and free allocated memory and return an error. */
339 for (pr = *response, n = num_msg; n--; pr++) {
340 if (pr->resp != NULL) {
341 zero_bytes(pr->resp, strlen(pr->resp));
346 zero_bytes(*response, num_msg * sizeof(struct pam_response));
349 return gotintr ? PAM_AUTH_ERR : PAM_CONV_ERR;