2 * auth.c User authentication.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * Copyright 2000,2006 The FreeRADIUS server project
21 * Copyright 2000 Miquel van Smoorenburg <miquels@cistron.nl>
22 * Copyright 2000 Jeff Carneal <jeff@apex.net>
25 #include <freeradius-devel/ident.h>
28 #include <freeradius-devel/radiusd.h>
29 #include <freeradius-devel/modules.h>
30 #include <freeradius-devel/rad_assert.h>
35 * Return a short string showing the terminal server, port
36 * and calling station ID.
38 char *auth_name(char *buf, size_t buflen, REQUEST *request, int do_cli)
45 if ((cli = pairfind(request->packet->vps, PW_CALLING_STATION_ID, 0)) == NULL)
47 if ((pair = pairfind(request->packet->vps, PW_NAS_PORT, 0)) != NULL)
48 port = pair->vp_integer;
50 if (request->packet->dst_port == 0) {
51 if (pairfind(request->packet->vps, PW_FREERADIUS_PROXIED_TO, 0)) {
52 tls = " via TLS tunnel";
54 tls = " via proxy to virtual server";
58 snprintf(buf, buflen, "from client %.128s port %u%s%.128s%s",
59 request->client->shortname, port,
60 (do_cli ? " cli " : ""), (do_cli ? (char *)cli->vp_strvalue : ""),
69 * Make sure user/pass are clean
72 static int rad_authlog(const char *msg, REQUEST *request, int goodpass)
75 const char *extra_msg = NULL;
76 char clean_password[1024];
77 char clean_username[1024];
80 VALUE_PAIR *username = NULL;
82 if (!request->root->log_auth) {
87 * Get the correct username based on the configured value
89 if (log_stripped_names == 0) {
90 username = pairfind(request->packet->vps, PW_USER_NAME, 0);
92 username = request->username;
96 * Clean up the username
98 if (username == NULL) {
99 strcpy(clean_username, "<no User-Name attribute>");
101 fr_print_string((char *)username->vp_strvalue,
103 clean_username, sizeof(clean_username));
107 * Clean up the password
109 if (request->root->log_auth_badpass || request->root->log_auth_goodpass) {
110 if (!request->password) {
111 VALUE_PAIR *auth_type;
113 auth_type = pairfind(request->config_items,
115 if (auth_type && (auth_type->vp_strvalue[0] != '\0')) {
116 snprintf(clean_password, sizeof(clean_password),
117 "<via Auth-Type = %s>",
118 auth_type->vp_strvalue);
120 strcpy(clean_password, "<no User-Password attribute>");
122 } else if (pairfind(request->packet->vps, PW_CHAP_PASSWORD, 0)) {
123 strcpy(clean_password, "<CHAP-Password>");
125 fr_print_string((char *)request->password->vp_strvalue,
126 request->password->length,
127 clean_password, sizeof(clean_password));
132 logit = request->root->log_auth_goodpass;
133 extra_msg = request->root->auth_goodpass_msg;
135 logit = request->root->log_auth_badpass;
136 extra_msg = request->root->auth_badpass_msg;
141 radius_xlat(extra + 1, sizeof(extra) - 1, extra_msg, request,
147 radlog_request(L_AUTH, 0, request, "%s: [%s%s%s] (%s)%s",
151 logit ? clean_password : "",
152 auth_name(buf, sizeof(buf), request, 1),
163 * -2 Rejected (Auth-Type = Reject, send Port-Message back)
164 * 1 End check & return, don't reply
166 * NOTE: NOT the same as the RLM_ values !
168 static int rad_check_password(REQUEST *request)
170 VALUE_PAIR *auth_type_pair;
171 VALUE_PAIR *cur_config_item;
172 VALUE_PAIR *password_pair;
173 VALUE_PAIR *auth_item;
174 uint8_t my_chap[MAX_STRING_LEN];
177 int auth_type_count = 0;
181 * Look for matching check items. We skip the whole lot
182 * if the authentication type is PW_AUTHTYPE_ACCEPT or
183 * PW_AUTHTYPE_REJECT.
185 cur_config_item = request->config_items;
186 while(((auth_type_pair = pairfind(cur_config_item, PW_AUTH_TYPE, 0))) != NULL) {
188 auth_type = auth_type_pair->vp_integer;
190 dv = dict_valbyattr(auth_type_pair->attribute,
191 auth_type_pair->vp_integer, 0);
193 RDEBUG2("Found Auth-Type = %s",
194 (dv != NULL) ? dv->name : "?");
195 cur_config_item = auth_type_pair->next;
197 if (auth_type == PW_AUTHTYPE_REJECT) {
198 RDEBUG2("Auth-Type = Reject, rejecting user");
203 if (( auth_type_count > 1) && (debug_flag)) {
204 radlog_request(L_ERR, 0, request, "Warning: Found %d auth-types on request for user '%s'",
205 auth_type_count, request->username->vp_strvalue);
209 * This means we have a proxy reply or an accept
210 * and it wasn't rejected in the above loop. So
211 * that means it is accepted and we do no further
214 if ((auth_type == PW_AUTHTYPE_ACCEPT)
219 RDEBUG2("Auth-Type = Accept, accepting the user");
223 password_pair = pairfind(request->config_items, PW_USER_PASSWORD, 0);
225 pairfind(request->config_items, PW_CLEARTEXT_PASSWORD, 0)) {
226 pairdelete(&request->config_items, PW_USER_PASSWORD, 0);
227 password_pair = NULL;
233 RDEBUG("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
234 RDEBUG("!!! Replacing User-Password in config items with Cleartext-Password. !!!");
235 RDEBUG("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
236 RDEBUG("!!! Please update your configuration so that the \"known good\" !!!");
237 RDEBUG("!!! clear text password is in Cleartext-Password, and not in User-Password. !!!");
238 RDEBUG("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
239 password_pair->attribute = PW_CLEARTEXT_PASSWORD;
240 da = dict_attrbyvalue(PW_CLEARTEXT_PASSWORD, 0);
242 radlog_request(L_ERR, 0, request, "FATAL: You broke the dictionaries. Please use the default dictionaries!");
246 password_pair->name = da->name;
250 * Find the "known good" password.
252 * FIXME: We should get rid of these hacks, and replace
253 * them with a module.
255 if ((password_pair = pairfind(request->config_items, PW_CRYPT_PASSWORD, 0)) != NULL) {
257 * Re-write Auth-Type, but ONLY if it isn't already
260 if (auth_type == -1) auth_type = PW_AUTHTYPE_CRYPT;
262 password_pair = pairfind(request->config_items, PW_CLEARTEXT_PASSWORD, 0);
267 auth_type = PW_AUTHTYPE_LOCAL;
270 * The admin hasn't told us how to
271 * authenticate the user, so we reject them!
275 RDEBUG2("ERROR: No authenticate method (Auth-Type) found for the request: Rejecting the user");
281 case PW_AUTHTYPE_CRYPT:
282 RDEBUG2("WARNING: Please update your configuration, and remove 'Auth-Type = Crypt'");
283 RDEBUG2("WARNING: Use the PAP module instead.");
286 * Find the password sent by the user. It
287 * SHOULD be there, if it's not
288 * authentication fails.
290 auth_item = request->password;
291 if (auth_item == NULL) {
292 RDEBUG2("No User-Password or CHAP-Password attribute in the request");
296 if (password_pair == NULL) {
297 RDEBUG2("No Crypt-Password configured for the user");
298 rad_authlog("Login incorrect "
299 "(No Crypt-Password configured for the user)", request, 0);
303 switch (fr_crypt_check((char *)auth_item->vp_strvalue,
304 (char *)password_pair->vp_strvalue)) {
306 rad_authlog("Login incorrect "
307 "(system failed to supply an encrypted password for comparison)", request, 0);
312 case PW_AUTHTYPE_LOCAL:
313 RDEBUG2("WARNING: Please update your configuration, and remove 'Auth-Type = Local'");
314 RDEBUG2("WARNING: Use the PAP or CHAP modules instead.");
317 * Find the password sent by the user. It
318 * SHOULD be there, if it's not
319 * authentication fails.
321 auth_item = request->password;
323 auth_item = pairfind(request->packet->vps,
324 PW_CHAP_PASSWORD, 0);
326 RDEBUG2("No User-Password or CHAP-Password attribute in the request.");
327 RDEBUG2("Cannot perform authentication.");
332 * Plain text password.
334 if (password_pair == NULL) {
335 RDEBUG2("No \"known good\" password was configured for the user.");
336 RDEBUG2("As a result, we cannot authenticate the user.");
337 rad_authlog("Login incorrect "
338 "(No password configured for the user)", request, 0);
343 * Local password is just plain text.
345 if (auth_item->attribute == PW_USER_PASSWORD) {
346 if (strcmp((char *)password_pair->vp_strvalue,
347 (char *)auth_item->vp_strvalue) != 0) {
348 RDEBUG2("User-Password in the request does NOT match \"known good\" password.");
351 RDEBUG2("User-Password in the request is correct.");
354 } else if (auth_item->attribute != PW_CHAP_PASSWORD) {
355 RDEBUG2("The user did not supply a User-Password or a CHAP-Password attribute");
356 rad_authlog("Login incorrect "
357 "(no User-Password or CHAP-Password attribute)", request, 0);
361 rad_chap_encode(request->packet, my_chap,
362 auth_item->vp_octets[0], password_pair);
367 if (memcmp(my_chap + 1, auth_item->vp_strvalue + 1,
368 CHAP_VALUE_LENGTH) != 0) {
369 RDEBUG2("CHAP-Password is incorrect.");
372 RDEBUG2("CHAP-Password is correct.");
376 * See if there is a module that handles
377 * this type, and turn the RLM_ return
378 * status into the values as defined at
379 * the top of this function.
381 result = module_authenticate(auth_type, request);
384 * An authentication module FAIL
385 * return code, or any return code that
386 * is not expected from authentication,
387 * is the same as an explicit REJECT!
389 case RLM_MODULE_FAIL:
390 case RLM_MODULE_INVALID:
391 case RLM_MODULE_NOOP:
392 case RLM_MODULE_NOTFOUND:
393 case RLM_MODULE_REJECT:
394 case RLM_MODULE_UPDATED:
395 case RLM_MODULE_USERLOCK:
402 case RLM_MODULE_HANDLED:
413 * Post-authentication step processes the response before it is
414 * sent to the NAS. It can receive both Access-Accept and Access-Reject
417 int rad_postauth(REQUEST *request)
420 int postauth_type = 0;
424 * Do post-authentication calls. ignoring the return code.
426 vp = pairfind(request->config_items, PW_POST_AUTH_TYPE, 0);
428 RDEBUG2("Using Post-Auth-Type %s", vp->vp_strvalue);
429 postauth_type = vp->vp_integer;
431 result = module_post_auth(postauth_type, request);
434 * The module failed, or said to reject the user: Do so.
436 case RLM_MODULE_FAIL:
437 case RLM_MODULE_INVALID:
438 case RLM_MODULE_REJECT:
439 case RLM_MODULE_USERLOCK:
441 request->reply->code = PW_AUTHENTICATION_REJECT;
442 result = RLM_MODULE_REJECT;
445 * The module handled the request, cancel the reply.
447 case RLM_MODULE_HANDLED:
451 * The module had a number of OK return codes.
453 case RLM_MODULE_NOOP:
454 case RLM_MODULE_NOTFOUND:
456 case RLM_MODULE_UPDATED:
457 result = RLM_MODULE_OK;
464 * Process and reply to an authentication request
466 * The return value of this function isn't actually used right now, so
467 * it's not entirely clear if it is returning the right things. --Pac.
469 int rad_authenticate(REQUEST *request)
471 VALUE_PAIR *namepair;
472 #ifdef WITH_SESSION_MGMT
473 VALUE_PAIR *check_item;
475 VALUE_PAIR *auth_item = NULL;
476 VALUE_PAIR *module_msg;
477 VALUE_PAIR *tmp = NULL;
479 const char *password;
487 * If this request got proxied to another server, we need
488 * to check whether it authenticated the request or not.
490 if (request->proxy_reply) {
491 switch (request->proxy_reply->code) {
493 * Reply of ACCEPT means accept, thus set Auth-Type
496 case PW_AUTHENTICATION_ACK:
497 tmp = radius_paircreate(request,
498 &request->config_items,
499 PW_AUTH_TYPE, 0, PW_TYPE_INTEGER);
500 if (tmp) tmp->vp_integer = PW_AUTHTYPE_ACCEPT;
504 * Challenges are punted back to the NAS without any
505 * further processing.
507 case PW_ACCESS_CHALLENGE:
508 request->reply->code = PW_ACCESS_CHALLENGE;
509 return RLM_MODULE_OK;
511 * ALL other replies mean reject. (this is fail-safe)
513 * Do NOT do any authorization or authentication. They
514 * are being rejected, so we minimize the amount of work
515 * done by the server, by rejecting them here.
517 case PW_AUTHENTICATION_REJECT:
518 rad_authlog("Login incorrect (Home Server says so)",
520 request->reply->code = PW_AUTHENTICATION_REJECT;
521 return RLM_MODULE_REJECT;
524 rad_authlog("Login incorrect (Home Server failed to respond)",
526 return RLM_MODULE_REJECT;
532 * Get the username from the request.
534 * Note that namepair MAY be NULL, in which case there
535 * is no User-Name attribute in the request.
537 namepair = request->username;
540 * Look for, and cache, passwords.
542 if (!request->password) {
543 request->password = pairfind(request->packet->vps,
544 PW_USER_PASSWORD, 0);
548 * Discover which password we want to use.
550 auth_item = request->password;
552 password = (const char *)auth_item->vp_strvalue;
556 * Maybe there's a CHAP-Password?
558 if ((auth_item = pairfind(request->packet->vps,
559 PW_CHAP_PASSWORD, 0)) != NULL) {
560 password = "<CHAP-PASSWORD>";
564 * No password we recognize.
566 password = "<NO-PASSWORD>";
569 request->password = auth_item;
572 * Get the user's authorization information from the database
575 result = module_authorize(autz_type, request);
577 case RLM_MODULE_NOOP:
578 case RLM_MODULE_NOTFOUND:
580 case RLM_MODULE_UPDATED:
582 case RLM_MODULE_HANDLED:
584 case RLM_MODULE_FAIL:
585 case RLM_MODULE_INVALID:
586 case RLM_MODULE_REJECT:
587 case RLM_MODULE_USERLOCK:
589 if ((module_msg = pairfind(request->packet->vps,
590 PW_MODULE_FAILURE_MESSAGE, 0)) != NULL) {
591 char msg[MAX_STRING_LEN + 16];
592 snprintf(msg, sizeof(msg), "Invalid user (%s)",
593 module_msg->vp_strvalue);
594 rad_authlog(msg,request,0);
596 rad_authlog("Invalid user", request, 0);
598 request->reply->code = PW_AUTHENTICATION_REJECT;
602 tmp = pairfind(request->config_items, PW_AUTZ_TYPE, 0);
604 RDEBUG2("Using Autz-Type %s", tmp->vp_strvalue);
605 autz_type = tmp->vp_integer;
612 * If we haven't already proxied the packet, then check
613 * to see if we should. Maybe one of the authorize
614 * modules has decided that a proxy should be used. If
615 * so, get out of here and send the packet.
619 (request->proxy == NULL) &&
621 ((tmp = pairfind(request->config_items, PW_PROXY_TO_REALM, 0)) != NULL)) {
624 realm = realm_find2(tmp->vp_strvalue);
627 * Don't authenticate, as the request is going to
630 if (realm && realm->auth_pool) {
631 return RLM_MODULE_OK;
635 * Catch users who set Proxy-To-Realm to a LOCAL
636 * realm (sigh). But don't complain if it is
639 if (realm &&(strcmp(realm->name, "LOCAL") != 0)) {
640 RDEBUG2("WARNING: You set Proxy-To-Realm = %s, but it is a LOCAL realm! Cancelling proxy request.", realm->name);
644 RDEBUG2("WARNING: You set Proxy-To-Realm = %s, but the realm does not exist! Cancelling invalid proxy request.", tmp->vp_strvalue);
653 * Perhaps there is a Stripped-User-Name now.
655 namepair = request->username;
661 result = rad_check_password(request);
664 return RLM_MODULE_HANDLED;
669 * Failed to validate the user.
671 * We PRESUME that the code which failed will clean up
672 * request->reply->vps, to be ONLY the reply items it
673 * wants to send back.
676 RDEBUG2("Failed to authenticate the user.");
677 request->reply->code = PW_AUTHENTICATION_REJECT;
679 if ((module_msg = pairfind(request->packet->vps,PW_MODULE_FAILURE_MESSAGE, 0)) != NULL){
680 char msg[MAX_STRING_LEN+19];
682 snprintf(msg, sizeof(msg), "Login incorrect (%s)",
683 module_msg->vp_strvalue);
684 rad_authlog(msg, request, 0);
686 rad_authlog("Login incorrect", request, 0);
689 /* double check: maybe the secret is wrong? */
690 if ((debug_flag > 1) && (auth_item != NULL) &&
691 (auth_item->attribute == PW_USER_PASSWORD)) {
694 p = auth_item->vp_strvalue;
698 size = fr_utf8_char(p);
700 log_debug(" WARNING: Unprintable characters in the password. Double-check the shared secret on the server and the NAS!");
708 #ifdef WITH_SESSION_MGMT
710 (check_item = pairfind(request->config_items, PW_SIMULTANEOUS_USE, 0)) != NULL) {
711 int r, session_type = 0;
713 char umsg[MAX_STRING_LEN + 1];
714 const char *user_msg = NULL;
716 tmp = pairfind(request->config_items, PW_SESSION_TYPE, 0);
718 RDEBUG2("Using Session-Type %s", tmp->vp_strvalue);
719 session_type = tmp->vp_integer;
723 * User authenticated O.K. Now we have to check
724 * for the Simultaneous-Use parameter.
727 (r = module_checksimul(session_type, request, check_item->vp_integer)) != 0) {
731 /* Multilink attempt. Check if port-limit > simultaneous-use */
732 VALUE_PAIR *port_limit;
734 if ((port_limit = pairfind(request->reply->vps, PW_PORT_LIMIT, 0)) != NULL &&
735 port_limit->vp_integer > check_item->vp_integer){
736 RDEBUG2("MPP is OK");
741 if (check_item->vp_integer > 1) {
742 snprintf(umsg, sizeof(umsg),
743 "\r\nYou are already logged in %d times - access denied\r\n\n",
744 (int)check_item->vp_integer);
747 user_msg = "\r\nYou are already logged in - access denied\r\n\n";
750 request->reply->code = PW_AUTHENTICATION_REJECT;
753 * They're trying to log in too many times.
754 * Remove ALL reply attributes.
756 pairfree(&request->reply->vps);
757 radius_pairmake(request, &request->reply->vps,
761 snprintf(logstr, sizeof(logstr), "Multiple logins (max %d) %s",
762 check_item->vp_integer,
763 r == 2 ? "[MPP attempt]" : "");
764 rad_authlog(logstr, request, 1);
773 * Result should be >= 0 here - if not, it means the user
774 * is rejected, so we just process post-auth and return.
777 return RLM_MODULE_REJECT;
781 * Add the port number to the Framed-IP-Address if
782 * vp->addport is set.
784 if (((tmp = pairfind(request->reply->vps,
785 PW_FRAMED_IP_ADDRESS, 0)) != NULL) &&
786 (tmp->flags.addport != 0)) {
787 VALUE_PAIR *vpPortId;
790 * Find the NAS port ID.
792 if ((vpPortId = pairfind(request->packet->vps,
793 PW_NAS_PORT, 0)) != NULL) {
794 unsigned long tvalue = ntohl(tmp->vp_integer);
795 tmp->vp_integer = htonl(tvalue + vpPortId->vp_integer);
796 tmp->flags.addport = 0;
797 ip_ntoa(tmp->vp_strvalue, tmp->vp_integer);
799 RDEBUG2("WARNING: No NAS-Port attribute in request. CANNOT return a Framed-IP-Address + NAS-Port.\n");
800 pairdelete(&request->reply->vps, PW_FRAMED_IP_ADDRESS, 0);
805 * Set the reply to Access-Accept, if it hasn't already
806 * been set to something. (i.e. Access-Challenge)
808 if (request->reply->code == 0)
809 request->reply->code = PW_AUTHENTICATION_ACK;
811 if ((module_msg = pairfind(request->packet->vps,PW_MODULE_SUCCESS_MESSAGE, 0)) != NULL){
812 char msg[MAX_STRING_LEN+12];
814 snprintf(msg, sizeof(msg), "Login OK (%s)",
815 module_msg->vp_strvalue);
816 rad_authlog(msg, request, 1);
818 rad_authlog("Login OK", request, 1);
822 * Run the modules in the 'post-auth' section.
824 result = rad_postauth(request);