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 The FreeRADIUS server project
21 * Copyright 2000 your name <your address>
24 #include <freeradius-devel/autoconf.h>
29 #include <freeradius-devel/radiusd.h>
30 #include <freeradius-devel/modules.h>
31 #include <freeradius-devel/conffile.h>
33 static const char rcsid[] = "$Id$";
36 * Define a structure for our module configuration.
38 * These variables do not need to be in a structure, but it's
39 * a lot cleaner to do so, and a pointer to the structure can
40 * be used as the instance handle.
42 typedef struct rlm_example_t {
50 * A mapping of configuration file names to internal variables.
52 * Note that the string is dynamically allocated, so it MUST
53 * be freed. When the configuration file parse re-reads the string,
54 * it free's the old one, and strdup's the new one, placing the pointer
55 * to the strdup'd string into 'config.string'. This gets around
58 static const CONF_PARSER module_config[] = {
59 { "integer", PW_TYPE_INTEGER, offsetof(rlm_example_t,value), NULL, "1" },
60 { "boolean", PW_TYPE_BOOLEAN, offsetof(rlm_example_t,boolean), NULL, "no"},
61 { "string", PW_TYPE_STRING_PTR, offsetof(rlm_example_t,string), NULL, NULL},
62 { "ipaddr", PW_TYPE_IPADDR, offsetof(rlm_example_t,ipaddr), NULL, "*" },
64 { NULL, -1, 0, NULL, NULL } /* end the list */
69 * Do any per-module initialization that is separate to each
70 * configured instance of the module. e.g. set up connections
71 * to external databases, read configuration files, set up
72 * dictionary entries, etc.
74 * If configuration information is given in the config section
75 * that must be referenced in later calls, store a handle to it
76 * in *instance otherwise put a null pointer there.
78 static int example_instantiate(CONF_SECTION *conf, void **instance)
83 * Set up a storage area for instance data
85 data = rad_malloc(sizeof(*data));
89 memset(data, 0, sizeof(*data));
92 * If the configuration parameters can't be parsed, then
95 if (cf_section_parse(conf, data, module_config) < 0) {
106 * Find the named user in this modules database. Create the set
107 * of attribute-value pairs to check and reply with for this user
108 * from the database. The authentication code only needs to check
109 * the password, the rest is done here.
111 static int example_authorize(void *instance, REQUEST *request)
116 /* quiet the compiler */
121 * Look for the 'state' attribute.
123 state = pairfind(request->packet->vps, PW_STATE);
125 DEBUG("rlm_example: Found reply to access challenge");
126 return RLM_MODULE_OK;
130 * Create the challenge, and add it to the reply.
132 reply = pairmake("Reply-Message", "This is a challenge", T_OP_EQ);
133 pairadd(&request->reply->vps, reply);
134 state = pairmake("State", "0", T_OP_EQ);
135 pairadd(&request->reply->vps, state);
138 * Mark the packet as an Access-Challenge packet.
140 * The server will take care of sending it to the user.
142 request->reply->code = PW_ACCESS_CHALLENGE;
143 DEBUG("rlm_example: Sending Access-Challenge.");
145 return RLM_MODULE_HANDLED;
149 * Authenticate the user with the given password.
151 static int example_authenticate(void *instance, REQUEST *request)
153 /* quiet the compiler */
157 return RLM_MODULE_OK;
161 * Massage the request before recording it or proxying it
163 static int example_preacct(void *instance, REQUEST *request)
165 /* quiet the compiler */
169 return RLM_MODULE_OK;
173 * Write accounting information to this modules database.
175 static int example_accounting(void *instance, REQUEST *request)
177 /* quiet the compiler */
181 return RLM_MODULE_OK;
185 * See if a user is already logged in. Sets request->simul_count to the
186 * current session count for this user and sets request->simul_mpp to 2
187 * if it looks like a multilink attempt based on the requested IP
188 * address, otherwise leaves request->simul_mpp alone.
190 * Check twice. If on the first pass the user exceeds his
191 * max. number of logins, do a second pass and validate all
192 * logins by querying the terminal server (using eg. SNMP).
194 static int example_checksimul(void *instance, REQUEST *request)
198 request->simul_count=0;
200 return RLM_MODULE_OK;
203 static int example_detach(void *instance)
205 free(((struct rlm_example_t *)instance)->string);
211 * The module name should be the only globally exported symbol.
212 * That is, everything else should be 'static'.
214 * If the module needs to temporarily modify it's instantiation
215 * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
216 * The server will then take care of ensuring that the module
217 * is single-threaded.
219 module_t rlm_example = {
222 RLM_TYPE_THREAD_SAFE, /* type */
223 example_instantiate, /* instantiation */
224 example_detach, /* detach */
226 example_authenticate, /* authentication */
227 example_authorize, /* authorization */
228 example_preacct, /* preaccounting */
229 example_accounting, /* accounting */
230 example_checksimul, /* checksimul */
231 NULL, /* pre-proxy */
232 NULL, /* post-proxy */