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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Copyright 2003 The FreeRADIUS server project
21 * Copyright 2003 Kostas Kalevras <kkalev@noc.ntua.gr>
24 #include <freeradius-devel/autoconf.h>
30 #include <freeradius-devel/radiusd.h>
31 #include <freeradius-devel/modules.h>
32 #include <freeradius-devel/conffile.h>
37 #define REG_EXTENDED (0)
44 * Define a structure for our module configuration.
46 * These variables do not need to be in a structure, but it's
47 * a lot cleaner to do so, and a pointer to the structure can
48 * be used as the instance handle.
50 typedef struct rlm_checkval_t {
51 char *item_name; /* The attribute inside Access-Request ie Calling-Station-Id */
52 char *check_name; /* The attribute to check it with ie Allowed-Calling-Station-Id */
53 char *data_type; /* string,integer,ipaddr,date,abinary,octets */
57 int notfound_reject; /* If we don't find the item_name in the request send back a reject */
61 * A mapping of configuration file names to internal variables.
63 * Note that the string is dynamically allocated, so it MUST
64 * be freed. When the configuration file parse re-reads the string,
65 * it free's the old one, and strdup's the new one, placing the pointer
66 * to the strdup'd string into 'config.string'. This gets around
69 static const CONF_PARSER module_config[] = {
70 { "item-name", PW_TYPE_STRING_PTR, offsetof(rlm_checkval_t,item_name), NULL, NULL},
71 { "check-name", PW_TYPE_STRING_PTR, offsetof(rlm_checkval_t,check_name), NULL, NULL},
72 { "data-type", PW_TYPE_STRING_PTR, offsetof(rlm_checkval_t,data_type),NULL, "integer"},
73 { "notfound-reject", PW_TYPE_BOOLEAN, offsetof(rlm_checkval_t,notfound_reject),NULL, "no"},
74 { NULL, -1, 0, NULL, NULL } /* end the list */
78 static int checkval_detach(void *instance)
80 rlm_checkval_t *data = (rlm_checkval_t *) instance;
83 free((char *)data->item_name);
85 free((char *)data->check_name);
87 free((char *)data->data_type);
94 * Do any per-module initialization that is separate to each
95 * configured instance of the module. e.g. set up connections
96 * to external databases, read configuration files, set up
97 * dictionary entries, etc.
99 * If configuration information is given in the config section
100 * that must be referenced in later calls, store a handle to it
101 * in *instance otherwise put a null pointer there.
103 static int checkval_instantiate(CONF_SECTION *conf, void **instance)
105 rlm_checkval_t *data;
109 static const LRAD_NAME_NUMBER names[] = {
110 { "string", PW_TYPE_STRING },
111 { "integer", PW_TYPE_INTEGER },
112 { "ipaddr", PW_TYPE_IPADDR },
113 { "date", PW_TYPE_DATE },
114 { "abinary", PW_TYPE_OCTETS },
115 { "octets", PW_TYPE_OCTETS },
116 { "binary", PW_TYPE_OCTETS },
121 * Set up a storage area for instance data
123 data = rad_malloc(sizeof(*data));
127 memset(data, 0, sizeof(*data));
130 * If the configuration parameters can't be parsed, then
133 if (cf_section_parse(conf, data, module_config) < 0) {
134 checkval_detach(data);
139 * Check if data_type exists
141 if (!data->data_type || !strlen(data->data_type)){
142 radlog(L_ERR, "rlm_checkval: Data type not defined");
143 checkval_detach(data);
146 if (!data->item_name || !strlen(data->item_name)){
147 radlog(L_ERR, "rlm_checkval: Item name not defined");
148 checkval_detach(data);
151 if (!data->check_name || !strlen(data->check_name)){
152 radlog(L_ERR, "rlm_checkval: Check item name not defined");
153 checkval_detach(data);
158 * Discover the attribute number of the item name
160 dattr = dict_attrbyname(data->item_name);
162 radlog(L_ERR, "rlm_checkval: No such attribute %s",
164 checkval_detach(data);
167 data->item_attr = dattr->attr;
170 * Add the check attribute name to the dictionary
171 * if it does not already exists. dict_addattr() handles that
174 memset(&flags, 0, sizeof(flags));
175 dict_addattr(data->check_name, 0, PW_TYPE_STRING, -1,flags);
176 dattr = dict_attrbyname(data->check_name);
178 radlog(L_ERR, "rlm_checkval: No such attribute %s",
180 checkval_detach(data);
183 data->chk_attr = dattr->attr;
184 DEBUG2("rlm_checkval: Registered name %s for attribute %d",
185 dattr->name,dattr->attr);
188 * Convert the string type to an integer type,
189 * so we don't have to do string comparisons on each
192 data->dat_type = lrad_str2int(names, data->data_type, -1);
193 if (data->dat_type < 0) {
194 radlog(L_ERR, "rlm_checkval: Data type %s in not known",data->data_type);
195 checkval_detach(data);
204 static int do_checkval(void *instance, REQUEST *request)
206 rlm_checkval_t *data = (rlm_checkval_t *) instance;
207 int ret=RLM_MODULE_NOOP;
208 VALUE_PAIR *chk_vp, *item_vp;
212 /* quiet the compiler */
218 * Look for the check item
221 if (!(item_vp = pairfind(request->packet->vps, data->item_attr))){
222 DEBUG2("rlm_checkval: Could not find item named %s in request", data->item_name);
223 if (data->notfound_reject)
224 ret = RLM_MODULE_REJECT;
226 ret = RLM_MODULE_NOTFOUND;
229 DEBUG2("rlm_checkval: Item Name: %s, Value: %s",data->item_name, item_vp->vp_strvalue);
230 tmp = request->config_items;
232 if (!(chk_vp = pairfind(tmp, data->chk_attr))){
234 DEBUG2("rlm_checkval: Could not find attribute named %s in check pairs",data->check_name);
235 ret = RLM_MODULE_NOTFOUND;
241 DEBUG2("rlm_checkval: Value Name: %s, Value: %s",data->check_name, chk_vp->vp_strvalue);
244 * Check if item != check
247 if (data->dat_type == PW_TYPE_STRING ||
248 data->dat_type == PW_TYPE_OCTETS) {
249 if (item_vp->length != chk_vp->length)
250 ret = RLM_MODULE_REJECT;
252 if (!memcmp(item_vp->vp_strvalue,
254 (size_t) chk_vp->length))
257 ret = RLM_MODULE_REJECT;
260 else{ /* Integer or Date */
262 if (item_vp->lvalue == chk_vp->lvalue)
265 ret = RLM_MODULE_REJECT;
268 if (ret == RLM_MODULE_REJECT &&
269 chk_vp->operator == T_OP_REG_EQ) {
272 char err_msg[MAX_STRING_LEN];
274 DEBUG("rlm_checkval: Doing regex");
275 err = regcomp(®, (char *)chk_vp->vp_strvalue, REG_EXTENDED|REG_NOSUB);
277 regerror(err, ®,err_msg, MAX_STRING_LEN);
278 DEBUG("rlm_checkval: regcomp() returned error: %s", err_msg);
279 return RLM_MODULE_FAIL;
281 if (regexec(®, (char *)item_vp->vp_strvalue,0, NULL, 0) == 0)
284 ret = RLM_MODULE_REJECT;
288 } while (ret == RLM_MODULE_REJECT &&
291 if (ret == RLM_MODULE_REJECT) {
292 if (!item_vp && data->notfound_reject){
293 char module_fmsg[MAX_STRING_LEN];
294 VALUE_PAIR *module_fmsg_vp;
296 snprintf(module_fmsg,sizeof(module_fmsg),
297 "rlm_checkval: Could not find item named %s in request", data->item_name);
298 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
299 pairadd(&request->packet->vps, module_fmsg_vp);
302 char module_fmsg[MAX_STRING_LEN];
303 VALUE_PAIR *module_fmsg_vp;
305 snprintf(module_fmsg,sizeof(module_fmsg),
306 "rlm_checkval: This %s is not allowed for the user", data->item_name);
307 module_fmsg_vp = pairmake("Module-Failure-Message", module_fmsg, T_OP_EQ);
308 pairadd(&request->packet->vps, module_fmsg_vp);
318 static int checkval_authorize(void *instance, REQUEST *request)
320 return do_checkval(instance,request);
323 static int checkval_accounting(void *instance, REQUEST *request)
325 return do_checkval(instance,request);
329 * The module name should be the only globally exported symbol.
330 * That is, everything else should be 'static'.
332 * If the module needs to temporarily modify it's instantiation
333 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
334 * The server will then take care of ensuring that the module
335 * is single-threaded.
337 module_t rlm_checkval = {
341 checkval_instantiate, /* instantiation */
342 checkval_detach, /* detach */
344 NULL, /* authentication */
345 checkval_authorize, /* authorization */
346 NULL, /* preaccounting */
347 checkval_accounting, /* accounting */
348 NULL, /* checksimul */
349 NULL, /* pre-proxy */
350 NULL, /* post-proxy */