2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright 1998 Juniper Networks, Inc.
6 * Copyright (c) 2001-2003 Networks Associates Technology, Inc.
9 * Portions of this software were developed for the FreeBSD Project by
10 * ThinkSec AS and NAI Labs, the Security Research Division of Network
11 * Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
12 * ("CBOSS"), as part of the DARPA CHATS research program.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. The name of the author may not be used to endorse or promote
23 * products derived from this software without specific prior written
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
42 #include <sys/param.h>
43 #include <sys/socket.h>
54 #include <security/pam_appl.h>
55 #include <security/pam_modules.h>
56 #include <security/pam_mod_misc.h>
58 #define PAM_OPT_CONF "conf"
59 #define PAM_OPT_TEMPLATE_USER "template_user"
60 #define PAM_OPT_NAS_ID "nas_id"
61 #define PAM_OPT_NAS_IPADDR "nas_ipaddr"
63 #define MAX_CHALLENGE_MSGS 10
64 #define PASSWORD_PROMPT "RADIUS Password:"
66 static int build_access_request(struct rad_handle *, const char *,
67 const char *, const char *, const char *, const char *,
68 const void *, size_t);
69 static int do_accept(pam_handle_t *, struct rad_handle *);
70 static int do_challenge(pam_handle_t *, struct rad_handle *,
71 const char *, const char *, const char *, const char *);
74 * Construct an access request, but don't send it. Returns 0 on success,
78 build_access_request(struct rad_handle *radh, const char *user,
79 const char *pass, const char *nas_id, const char *nas_ipaddr,
80 const char *rhost, const void *state, size_t state_len)
83 char host[MAXHOSTNAMELEN];
84 struct sockaddr_in *haddr;
85 struct addrinfo hints;
88 if (rad_create_request(radh, RAD_ACCESS_REQUEST) == -1) {
89 syslog(LOG_CRIT, "rad_create_request: %s", rad_strerror(radh));
93 (nas_ipaddr != NULL && strlen(nas_ipaddr) == 0)) {
94 if (gethostname(host, sizeof host) != -1) {
97 if (nas_ipaddr != NULL && strlen(nas_ipaddr) == 0)
102 rad_put_string(radh, RAD_USER_NAME, user) == -1) ||
104 rad_put_string(radh, RAD_USER_PASSWORD, pass) == -1) ||
106 rad_put_string(radh, RAD_NAS_IDENTIFIER, nas_id) == -1)) {
107 syslog(LOG_CRIT, "rad_put_string: %s", rad_strerror(radh));
110 if (nas_ipaddr != NULL) {
111 memset(&hints, 0, sizeof(hints));
112 hints.ai_family = AF_INET;
113 if (getaddrinfo(nas_ipaddr, NULL, &hints, &res) == 0 &&
114 res != NULL && res->ai_family == AF_INET) {
115 haddr = (struct sockaddr_in *)res->ai_addr;
116 error = rad_put_addr(radh, RAD_NAS_IP_ADDRESS,
120 syslog(LOG_CRIT, "rad_put_addr: %s",
127 rad_put_string(radh, RAD_CALLING_STATION_ID, rhost) == -1) {
128 syslog(LOG_CRIT, "rad_put_string: %s", rad_strerror(radh));
132 rad_put_attr(radh, RAD_STATE, state, state_len) == -1) {
133 syslog(LOG_CRIT, "rad_put_attr: %s", rad_strerror(radh));
136 if (rad_put_int(radh, RAD_SERVICE_TYPE, RAD_AUTHENTICATE_ONLY) == -1) {
137 syslog(LOG_CRIT, "rad_put_int: %s", rad_strerror(radh));
144 do_accept(pam_handle_t *pamh, struct rad_handle *radh)
151 while ((attrtype = rad_get_attr(radh, &attrval, &attrlen)) > 0) {
152 if (attrtype == RAD_USER_NAME) {
153 s = rad_cvt_string(attrval, attrlen);
156 "rad_cvt_string: out of memory");
159 pam_set_item(pamh, PAM_USER, s);
163 if (attrtype == -1) {
164 syslog(LOG_CRIT, "rad_get_attr: %s", rad_strerror(radh));
171 do_challenge(pam_handle_t *pamh, struct rad_handle *radh, const char *user,
172 const char *nas_id, const char *nas_ipaddr, const char *rhost)
180 struct pam_message msgs[MAX_CHALLENGE_MSGS];
181 const struct pam_message *msg_ptrs[MAX_CHALLENGE_MSGS];
182 struct pam_response *resp;
185 const struct pam_conv *conv;
190 while ((attrtype = rad_get_attr(radh, &attrval, &attrlen)) > 0) {
198 case RAD_REPLY_MESSAGE:
199 if (num_msgs >= MAX_CHALLENGE_MSGS) {
201 "Too many RADIUS challenge messages");
202 return (PAM_SERVICE_ERR);
204 msgs[num_msgs].msg = rad_cvt_string(attrval, attrlen);
205 if (msgs[num_msgs].msg == NULL) {
207 "rad_cvt_string: out of memory");
208 return (PAM_SERVICE_ERR);
210 msgs[num_msgs].msg_style = PAM_TEXT_INFO;
211 msg_ptrs[num_msgs] = &msgs[num_msgs];
216 if (attrtype == -1) {
217 syslog(LOG_CRIT, "rad_get_attr: %s", rad_strerror(radh));
218 return (PAM_SERVICE_ERR);
221 msgs[num_msgs].msg = strdup("(null RADIUS challenge): ");
222 if (msgs[num_msgs].msg == NULL) {
223 syslog(LOG_CRIT, "Out of memory");
224 return (PAM_SERVICE_ERR);
226 msgs[num_msgs].msg_style = PAM_TEXT_INFO;
227 msg_ptrs[num_msgs] = &msgs[num_msgs];
230 msgs[num_msgs-1].msg_style = PAM_PROMPT_ECHO_ON;
231 if ((retval = pam_get_item(pamh, PAM_CONV, &item)) != PAM_SUCCESS) {
232 syslog(LOG_CRIT, "do_challenge: cannot get PAM_CONV");
235 conv = (const struct pam_conv *)item;
236 if ((retval = conv->conv(num_msgs, msg_ptrs, &resp,
237 conv->appdata_ptr)) != PAM_SUCCESS)
239 if (build_access_request(radh, user, resp[num_msgs-1].resp, nas_id,
240 nas_ipaddr, rhost, state, statelen) == -1)
241 return (PAM_SERVICE_ERR);
242 memset(resp[num_msgs-1].resp, 0, strlen(resp[num_msgs-1].resp));
243 free(resp[num_msgs-1].resp);
246 free(msgs[--num_msgs].msg);
247 return (PAM_SUCCESS);
251 pam_sm_authenticate(pam_handle_t *pamh, int flags __unused,
252 int argc __unused, const char *argv[] __unused)
254 struct rad_handle *radh;
255 const char *user, *pass;
256 const void *rhost, *tmpuser;
257 const char *conf_file, *template_user, *nas_id, *nas_ipaddr;
261 conf_file = openpam_get_option(pamh, PAM_OPT_CONF);
262 template_user = openpam_get_option(pamh, PAM_OPT_TEMPLATE_USER);
263 nas_id = openpam_get_option(pamh, PAM_OPT_NAS_ID);
264 nas_ipaddr = openpam_get_option(pamh, PAM_OPT_NAS_IPADDR);
265 pam_get_item(pamh, PAM_RHOST, &rhost);
267 retval = pam_get_user(pamh, &user, NULL);
268 if (retval != PAM_SUCCESS)
271 PAM_LOG("Got user: %s", user);
273 retval = pam_get_authtok(pamh, PAM_AUTHTOK, &pass, PASSWORD_PROMPT);
274 if (retval != PAM_SUCCESS)
277 PAM_LOG("Got password");
281 syslog(LOG_CRIT, "rad_open failed");
282 return (PAM_SERVICE_ERR);
285 PAM_LOG("Radius opened");
287 if (rad_config(radh, conf_file) == -1) {
288 syslog(LOG_ALERT, "rad_config: %s", rad_strerror(radh));
290 return (PAM_SERVICE_ERR);
293 PAM_LOG("Radius config file read");
295 if (build_access_request(radh, user, pass, nas_id, nas_ipaddr, rhost,
298 return (PAM_SERVICE_ERR);
301 PAM_LOG("Radius build access done");
304 switch (rad_send_request(radh)) {
306 case RAD_ACCESS_ACCEPT:
307 e = do_accept(pamh, radh);
310 return (PAM_SERVICE_ERR);
311 if (template_user != NULL) {
313 PAM_LOG("Trying template user: %s",
317 * If the given user name doesn't exist in
318 * the local password database, change it
319 * to the value given in the "template_user"
322 retval = pam_get_item(pamh, PAM_USER, &tmpuser);
323 if (retval != PAM_SUCCESS)
325 if (getpwnam(tmpuser) == NULL) {
326 pam_set_item(pamh, PAM_USER,
328 PAM_LOG("Using template user");
332 return (PAM_SUCCESS);
334 case RAD_ACCESS_REJECT:
336 PAM_VERBOSE_ERROR("Radius rejection");
337 return (PAM_AUTH_ERR);
339 case RAD_ACCESS_CHALLENGE:
340 retval = do_challenge(pamh, radh, user, nas_id,
342 if (retval != PAM_SUCCESS) {
349 syslog(LOG_CRIT, "rad_send_request: %s",
352 PAM_VERBOSE_ERROR("Radius failure");
353 return (PAM_AUTHINFO_UNAVAIL);
357 "rad_send_request: unexpected return value");
359 PAM_VERBOSE_ERROR("Radius error");
360 return (PAM_SERVICE_ERR);
366 pam_sm_setcred(pam_handle_t *pamh __unused, int flags __unused,
367 int argc __unused, const char *argv[] __unused)
370 return (PAM_SUCCESS);
373 PAM_MODULE_ENTRY("pam_radius");