2 * rlm_files.c authorization: Find a user in the "users" file.
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 2002,2006 The FreeRADIUS server project
21 * Copyright 2000 Jeff Carneal <jeff@apex.net>
24 #include <freeradius-devel/ident.h>
27 #include <freeradius-devel/radiusd.h>
28 #include <freeradius-devel/modules.h>
34 struct file_instance {
41 lrad_hash_table_t *users;
45 lrad_hash_table_t *acctusers;
48 char *preproxy_usersfile;
49 lrad_hash_table_t *preproxy_users;
53 lrad_hash_table_t *auth_users;
56 char *postproxy_usersfile;
57 lrad_hash_table_t *postproxy_users;
59 /* post-authenticate */
60 char *postauth_usersfile;
61 lrad_hash_table_t *postauth_users;
66 * See if a VALUE_PAIR list contains Fall-Through = Yes
68 static int fallthrough(VALUE_PAIR *vp)
71 tmp = pairfind(vp, PW_FALL_THROUGH);
73 return tmp ? tmp->vp_integer : 0;
76 static const CONF_PARSER module_config[] = {
77 { "usersfile", PW_TYPE_FILENAME,
78 offsetof(struct file_instance,usersfile), NULL, NULL },
79 { "acctusersfile", PW_TYPE_FILENAME,
80 offsetof(struct file_instance,acctusersfile), NULL, NULL },
81 { "preproxy_usersfile", PW_TYPE_FILENAME,
82 offsetof(struct file_instance,preproxy_usersfile), NULL, NULL },
83 { "auth_usersfile", PW_TYPE_FILENAME,
84 offsetof(struct file_instance,auth_usersfile), NULL, NULL },
85 { "postproxy_usersfile", PW_TYPE_FILENAME,
86 offsetof(struct file_instance,postproxy_usersfile), NULL, NULL },
87 { "postauth_usersfile", PW_TYPE_FILENAME,
88 offsetof(struct file_instance,postauth_usersfile), NULL, NULL },
89 { "compat", PW_TYPE_STRING_PTR,
90 offsetof(struct file_instance,compat_mode), NULL, "cistron" },
91 { "key", PW_TYPE_STRING_PTR,
92 offsetof(struct file_instance,key), NULL, NULL },
93 { NULL, -1, 0, NULL, NULL }
97 static uint32_t pairlist_hash(const void *data)
99 return lrad_hash_string(((const PAIR_LIST *)data)->name);
102 static int pairlist_cmp(const void *a, const void *b)
104 return strcmp(((const PAIR_LIST *)a)->name,
105 ((const PAIR_LIST *)b)->name);
108 static void my_pairlist_free(void *data)
110 PAIR_LIST *pl = data;
116 static int getusersfile(const char *filename, lrad_hash_table_t **pht,
117 char *compat_mode_str)
120 PAIR_LIST *users = NULL;
121 PAIR_LIST *entry, *next;
122 lrad_hash_table_t *ht, *tailht;
130 rcode = pairlist_read(filename, &users, 1);
136 * Walk through the 'users' file list, if we're debugging,
137 * or if we're in compat_mode.
140 (strcmp(compat_mode_str, "cistron") == 0)) {
142 int compat_mode = FALSE;
144 if (strcmp(compat_mode_str, "cistron") == 0) {
151 DEBUG("[%s]:%d Cistron compatibility checks for entry %s ...",
152 filename, entry->lineno,
157 * Look for improper use of '=' in the
158 * check items. They should be using
159 * '==' for on-the-wire RADIUS attributes,
160 * and probably ':=' for server
161 * configuration items.
163 for (vp = entry->check; vp != NULL; vp = vp->next) {
165 * Ignore attributes which are set
168 if (vp->operator != T_OP_EQ) {
173 * If it's a vendor attribute,
174 * or it's a wire protocol,
175 * ensure it has '=='.
177 if (((vp->attribute & ~0xffff) != 0) ||
178 (vp->attribute < 0x100)) {
180 DEBUG("[%s]:%d WARNING! Changing '%s =' to '%s =='\n\tfor comparing RADIUS attribute in check item list for user %s",
181 filename, entry->lineno,
185 DEBUG("\tChanging '%s =' to '%s =='",
188 vp->operator = T_OP_CMP_EQ;
193 * Cistron Compatibility mode.
195 * Re-write selected attributes
196 * to be '+=', instead of '='.
198 * All others get set to '=='
202 * Non-wire attributes become +=
204 * On the write attributes
207 if ((vp->attribute >= 0x100) &&
208 (vp->attribute <= 0xffff) &&
209 (vp->attribute != PW_HINT) &&
210 (vp->attribute != PW_HUNTGROUP_NAME)) {
211 DEBUG("\tChanging '%s =' to '%s +='",
213 vp->operator = T_OP_ADD;
215 DEBUG("\tChanging '%s =' to '%s =='",
217 vp->operator = T_OP_CMP_EQ;
221 } /* end of loop over check items */
224 * Look for server configuration items
227 * It's a common enough mistake, that it's
230 for (vp = entry->reply; vp != NULL; vp = vp->next) {
232 * If it's NOT a vendor attribute,
233 * and it's NOT a wire protocol
234 * and we ignore Fall-Through,
235 * then bitch about it, giving a
236 * good warning message.
238 if (!(vp->attribute & ~0xffff) &&
239 (vp->attribute > 0xff) &&
240 (vp->attribute > 1000)) {
241 log_debug("[%s]:%d WARNING! Check item \"%s\"\n"
242 "\tfound in reply item list for user \"%s\".\n"
243 "\tThis attribute MUST go on the first line"
244 " with the other check items",
245 filename, entry->lineno, vp->name,
255 ht = lrad_hash_table_create(pairlist_hash, pairlist_cmp,
258 pairlist_free(&users);
262 tailht = lrad_hash_table_create(pairlist_hash, pairlist_cmp,
265 lrad_hash_table_free(ht);
266 pairlist_free(&users);
271 * Now that we've read it in, put the entries into a hash
274 for (entry = users; entry != NULL; entry = next) {
279 entry->order = order++;
282 * Insert it into the hash table, and remember
283 * the tail of the linked list.
285 tail = lrad_hash_table_finddata(tailht, entry);
288 * Insert it into the head & tail.
290 if (!lrad_hash_table_insert(ht, entry) ||
291 !lrad_hash_table_insert(tailht, entry)) {
292 pairlist_free(&next);
293 lrad_hash_table_free(ht);
294 lrad_hash_table_free(tailht);
299 if (!lrad_hash_table_replace(tailht, entry)) {
300 pairlist_free(&next);
301 lrad_hash_table_free(ht);
302 lrad_hash_table_free(tailht);
308 lrad_hash_table_free(tailht);
317 static int file_detach(void *instance)
319 struct file_instance *inst = instance;
320 lrad_hash_table_free(inst->users);
321 lrad_hash_table_free(inst->acctusers);
322 lrad_hash_table_free(inst->preproxy_users);
323 lrad_hash_table_free(inst->auth_users);
324 lrad_hash_table_free(inst->postproxy_users);
325 lrad_hash_table_free(inst->postauth_users);
333 * (Re-)read the "users" file into memory.
335 static int file_instantiate(CONF_SECTION *conf, void **instance)
337 struct file_instance *inst;
340 inst = rad_malloc(sizeof *inst);
344 memset(inst, 0, sizeof(*inst));
346 if (cf_section_parse(conf, inst, module_config) < 0) {
351 rcode = getusersfile(inst->usersfile, &inst->users, inst->compat_mode);
353 radlog(L_ERR|L_CONS, "Errors reading %s", inst->usersfile);
358 rcode = getusersfile(inst->acctusersfile, &inst->acctusers, inst->compat_mode);
360 radlog(L_ERR|L_CONS, "Errors reading %s", inst->acctusersfile);
366 * Get the pre-proxy stuff
368 rcode = getusersfile(inst->preproxy_usersfile, &inst->preproxy_users, inst->compat_mode);
370 radlog(L_ERR|L_CONS, "Errors reading %s", inst->preproxy_usersfile);
375 rcode = getusersfile(inst->auth_usersfile, &inst->auth_users, inst->compat_mode);
377 radlog(L_ERR|L_CONS, "Errors reading %s", inst->auth_usersfile);
382 rcode = getusersfile(inst->postproxy_usersfile, &inst->postproxy_users, inst->compat_mode);
384 radlog(L_ERR|L_CONS, "Errors reading %s", inst->postproxy_usersfile);
389 rcode = getusersfile(inst->postauth_usersfile, &inst->postauth_users, inst->compat_mode);
391 radlog(L_ERR|L_CONS, "Errors reading %s", inst->postauth_usersfile);
401 * Common code called by everything below.
403 static int file_common(struct file_instance *inst, REQUEST *request,
404 const char *filename, lrad_hash_table_t *ht,
405 VALUE_PAIR *request_pairs, VALUE_PAIR **reply_pairs)
407 const char *name, *match;
408 VALUE_PAIR **config_pairs;
409 VALUE_PAIR *check_tmp;
410 VALUE_PAIR *reply_tmp;
411 const PAIR_LIST *user_pl, *default_pl;
417 VALUE_PAIR *namepair;
419 namepair = request->username;
420 name = namepair ? (char *) namepair->vp_strvalue : "NONE";
424 len = radius_xlat(buffer, sizeof(buffer), inst->key,
426 if (len) name = buffer;
430 config_pairs = &request->config_items;
432 if (!ht) return RLM_MODULE_NOOP;
435 user_pl = lrad_hash_table_finddata(ht, &my_pl);
436 my_pl.name = "DEFAULT";
437 default_pl = lrad_hash_table_finddata(ht, &my_pl);
440 * Find the entry for the user.
442 while (user_pl || default_pl) {
445 if (!default_pl && user_pl) {
448 user_pl = user_pl->next;
450 } else if (!user_pl && default_pl) {
453 default_pl = default_pl->next;
455 } else if (user_pl->order < default_pl->order) {
458 user_pl = user_pl->next;
463 default_pl = default_pl->next;
466 if (paircompare(request, request_pairs, pl->check, reply_pairs) == 0) {
467 DEBUG2(" %s: Matched entry %s at line %d",
468 filename, match, pl->lineno);
470 check_tmp = paircopy(pl->check);
471 reply_tmp = paircopy(pl->reply);
472 pairxlatmove(request, reply_pairs, &reply_tmp);
473 pairmove(config_pairs, &check_tmp);
474 pairfree(&reply_tmp);
475 pairfree(&check_tmp);
480 if (!fallthrough(pl->reply))
486 * Remove server internal parameters.
488 pairdelete(reply_pairs, PW_FALL_THROUGH);
491 * See if we succeeded.
494 return RLM_MODULE_NOOP; /* on to the next module */
496 return RLM_MODULE_OK;
502 * Find the named user in the database. Create the
503 * set of attribute-value pairs to check and reply with
504 * for this user from the database. The main code only
505 * needs to check the password, the rest is done here.
507 static int file_authorize(void *instance, REQUEST *request)
509 struct file_instance *inst = instance;
511 return file_common(inst, request, "users", inst->users,
512 request->packet->vps, &request->reply->vps);
517 * Pre-Accounting - read the acct_users file for check_items and
518 * config_items. Reply items are Not Recommended(TM) in acct_users,
519 * except for Fallthrough, which should work
521 static int file_preacct(void *instance, REQUEST *request)
523 struct file_instance *inst = instance;
525 return file_common(inst, request, "acct_users", inst->acctusers,
526 request->packet->vps, &request->reply->vps);
529 static int file_preproxy(void *instance, REQUEST *request)
531 struct file_instance *inst = instance;
533 return file_common(inst, request, "preproxy_users",
534 inst->preproxy_users,
535 request->packet->vps, &request->proxy->vps);
538 static int file_postproxy(void *instance, REQUEST *request)
540 struct file_instance *inst = instance;
542 return file_common(inst, request, "postproxy_users",
543 inst->postproxy_users,
544 request->proxy_reply->vps, &request->reply->vps);
547 static int file_authenticate(void *instance, REQUEST *request)
549 struct file_instance *inst = instance;
551 return file_common(inst, request, "auth_users",
553 request->packet->vps, &request->reply->vps);
556 static int file_postauth(void *instance, REQUEST *request)
558 struct file_instance *inst = instance;
560 return file_common(inst, request, "postauth_users",
561 inst->postauth_users,
562 request->packet->vps, &request->reply->vps);
566 /* globally exported name */
567 module_t rlm_files = {
570 RLM_TYPE_CHECK_CONFIG_SAFE | RLM_TYPE_HUP_SAFE,
571 file_instantiate, /* instantiation */
572 file_detach, /* detach */
574 file_authenticate, /* authentication */
575 file_authorize, /* authorization */
576 file_preacct, /* preaccounting */
577 NULL, /* accounting */
578 NULL, /* checksimul */
579 file_preproxy, /* pre-proxy */
580 file_postproxy, /* post-proxy */
581 file_postauth /* post-auth */