2 * Copyright (c) 2002 Jacques A. Vidrine <nectar@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/lib/libpam/modules/pam_ksu/pam_ksu.c,v 1.5 2004/02/10 10:13:21 des Exp $
29 #include <sys/param.h>
40 #include <security/pam_appl.h>
41 #include <security/pam_modules.h>
42 #include <security/pam_mod_misc.h>
44 static const char superuser[] = "root";
46 static long get_su_principal(krb5_context, const char *, const char *,
47 char **, krb5_principal *);
48 static int auth_krb5(pam_handle_t *, krb5_context, const char *,
52 pam_sm_authenticate(pam_handle_t *pamh, int flags __unused,
53 int argc __unused, const char *argv[] __unused)
56 krb5_principal su_principal;
59 char *su_principal_name;
63 pamret = pam_get_user(pamh, &user, NULL);
64 if (pamret != PAM_SUCCESS)
66 PAM_LOG("Got user: %s", user);
67 pamret = pam_get_item(pamh, PAM_RUSER, &ruser);
68 if (pamret != PAM_SUCCESS)
70 PAM_LOG("Got ruser: %s", (const char *)ruser);
71 rv = krb5_init_context(&context);
73 PAM_LOG("krb5_init_context failed: %s",
74 krb5_get_err_text(context, rv));
75 return (PAM_SERVICE_ERR);
77 rv = get_su_principal(context, user, ruser, &su_principal_name, &su_principal);
79 return (PAM_AUTH_ERR);
80 PAM_LOG("kuserok: %s -> %s", su_principal_name, user);
81 rv = krb5_kuserok(context, su_principal, user);
82 pamret = rv ? auth_krb5(pamh, context, su_principal_name, su_principal) : PAM_AUTH_ERR;
83 free(su_principal_name);
84 krb5_free_principal(context, su_principal);
85 krb5_free_context(context);
90 pam_sm_setcred(pam_handle_t *pamh __unused, int flags __unused,
91 int ac __unused, const char *av[] __unused)
97 /* Authenticate using Kerberos 5.
98 * pamh -- The PAM handle.
99 * context -- An initialized krb5_context.
100 * su_principal_name -- The target principal name, used only for password prompts.
101 * If NULL, the password prompts will not include a principal
103 * su_principal -- The target krb5_principal.
104 * Note that a valid keytab in the default location with a host entry
105 * must be available, and that the PAM application must have sufficient
106 * privileges to access it.
107 * Returns PAM_SUCCESS if authentication was successful, or an appropriate
108 * PAM error code if it was not.
111 auth_krb5(pam_handle_t *pamh, krb5_context context, const char *su_principal_name,
112 krb5_principal su_principal)
115 krb5_get_init_creds_opt gic_opt;
116 krb5_verify_init_creds_opt vic_opt;
123 krb5_get_init_creds_opt_init(&gic_opt);
124 krb5_verify_init_creds_opt_init(&vic_opt);
125 if (su_principal_name != NULL)
126 asprintf(&prompt, "Password for %s:", su_principal_name);
128 asprintf(&prompt, "Password:");
130 return (PAM_BUF_ERR);
132 pamret = pam_get_authtok(pamh, PAM_AUTHTOK, &pass, prompt);
134 if (pamret != PAM_SUCCESS)
136 rv = krb5_get_init_creds_password(context, &creds, su_principal,
137 pass, NULL, NULL, 0, NULL, &gic_opt);
139 PAM_LOG("krb5_get_init_creds_password: %s",
140 krb5_get_err_text(context, rv));
141 return (PAM_AUTH_ERR);
143 krb5_verify_init_creds_opt_set_ap_req_nofail(&vic_opt, 1);
144 rv = krb5_verify_init_creds(context, &creds, NULL, NULL, NULL,
146 krb5_free_cred_contents(context, &creds);
148 PAM_LOG("krb5_verify_init_creds: %s",
149 krb5_get_err_text(context, rv));
150 return (PAM_AUTH_ERR);
152 return (PAM_SUCCESS);
155 /* Determine the target principal given the current user and the target user.
156 * context -- An initialized krb5_context.
157 * target_user -- The target username.
158 * current_user -- The current username.
159 * su_principal_name -- (out) The target principal name.
160 * su_principal -- (out) The target krb5_principal.
161 * When the target user is `root', the target principal will be a `root
162 * instance', e.g. `luser/root@REA.LM'. Otherwise, the target principal
163 * will simply be the current user's default principal name. Note that
164 * in any case, if KRB5CCNAME is set and a credentials cache exists, the
165 * principal name found there will be the `starting point', rather than
166 * the ruser parameter.
168 * Returns 0 for success, or a com_err error code on failure.
171 get_su_principal(krb5_context context, const char *target_user,
172 const char *current_user, char **su_principal_name,
173 krb5_principal *su_principal)
175 krb5_principal default_principal;
177 char *principal_name, *ccname, *p;
181 *su_principal = NULL;
182 default_principal = NULL;
183 /* Unless KRB5CCNAME was explicitly set, we won't really be able
184 * to look at the credentials cache since krb5_cc_default will
192 p = getenv("KRB5CCNAME");
196 asprintf(&ccname, "%s%lu", KRB5_DEFAULT_CCROOT, (unsigned long)ruid);
199 rv = krb5_cc_resolve(context, ccname, &ccache);
202 rv = krb5_cc_get_principal(context, ccache, &default_principal);
203 krb5_cc_close(context, ccache);
205 default_principal = NULL; /* just to be safe */
210 if (default_principal == NULL) {
211 rv = krb5_make_principal(context, &default_principal, NULL, current_user, NULL);
213 PAM_LOG("Could not determine default principal name.");
217 /* Now that we have some principal, if the target account is
218 * `root', then transform it into a `root' instance, e.g.
219 * `user@REA.LM' -> `user/root@REA.LM'.
221 rv = krb5_unparse_name(context, default_principal, &principal_name);
222 krb5_free_principal(context, default_principal);
224 PAM_LOG("krb5_unparse_name: %s",
225 krb5_get_err_text(context, rv));
228 PAM_LOG("Default principal name: %s", principal_name);
229 if (strcmp(target_user, superuser) == 0) {
230 p = strrchr(principal_name, '@');
232 PAM_LOG("malformed principal name `%s'", principal_name);
233 free(principal_name);
237 *su_principal_name = NULL;
238 asprintf(su_principal_name, "%s/%s@%s", principal_name, superuser, p);
239 free(principal_name);
241 *su_principal_name = principal_name;
243 if (*su_principal_name == NULL)
245 rv = krb5_parse_name(context, *su_principal_name, &default_principal);
247 PAM_LOG("krb5_parse_name `%s': %s", *su_principal_name,
248 krb5_get_err_text(context, rv));
249 free(*su_principal_name);
252 PAM_LOG("Target principal name: %s", *su_principal_name);
253 *su_principal = default_principal;
257 PAM_MODULE_ENTRY("pam_ksu");