diff options
Diffstat (limited to 'src/modules/rlm_example/rlm_example.c')
| -rw-r--r-- | src/modules/rlm_example/rlm_example.c | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/src/modules/rlm_example/rlm_example.c b/src/modules/rlm_example/rlm_example.c new file mode 100644 index 0000000..ed94bba --- /dev/null +++ b/src/modules/rlm_example/rlm_example.c @@ -0,0 +1,216 @@ +/* + * This program is is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/** + * $Id$ + * @file rlm_example.c + * @brief Example module code. + * + * @copyright 2013 The FreeRADIUS server project + * @copyright 2013 your name \<your address\> + */ +RCSID("$Id$") + +#include <freeradius-devel/radiusd.h> +#include <freeradius-devel/modules.h> +#include <freeradius-devel/rad_assert.h> + +/* + * Define a structure for our module configuration. + * + * These variables do not need to be in a structure, but it's + * a lot cleaner to do so, and a pointer to the structure can + * be used as the instance handle. + */ +typedef struct rlm_example_t { + bool boolean; + uint32_t value; + char const *string; + fr_ipaddr_t ipaddr; +} rlm_example_t; + +/* + * A mapping of configuration file names to internal variables. + */ +static const CONF_PARSER module_config[] = { + { "integer", FR_CONF_OFFSET(PW_TYPE_INTEGER, rlm_example_t, value), "1" }, + { "boolean", FR_CONF_OFFSET(PW_TYPE_BOOLEAN, rlm_example_t, boolean), "no" }, + { "string", FR_CONF_OFFSET(PW_TYPE_STRING, rlm_example_t, string), NULL }, + { "ipaddr", FR_CONF_OFFSET(PW_TYPE_IPV4_ADDR, rlm_example_t, ipaddr), "*" }, + CONF_PARSER_TERMINATOR +}; + +static int rlm_example_cmp(UNUSED void *instance, REQUEST *request, UNUSED VALUE_PAIR *thing, VALUE_PAIR *check, + UNUSED VALUE_PAIR *check_pairs, UNUSED VALUE_PAIR **reply_pairs) +{ + rad_assert(check->da->type == PW_TYPE_STRING); + + RINFO("Example-Paircmp called with \"%s\"", check->vp_strvalue); + + if (strcmp(check->vp_strvalue, "yes") == 0) return 0; + return 1; +} + +/* + * Do any per-module initialization that is separate to each + * configured instance of the module. e.g. set up connections + * to external databases, read configuration files, set up + * dictionary entries, etc. + */ +static int mod_instantiate(CONF_SECTION *conf, void *instance) +{ + rlm_example_t *inst = instance; + ATTR_FLAGS flags; + + memset(&flags, 0, sizeof(flags)); + /* + * Do more work here + */ + if (!inst->boolean) { + cf_log_err_cs(conf, "Boolean is false: forcing error!"); + return -1; + } + + if (dict_addattr("Example-Paircmp", -1, 0, PW_TYPE_STRING, flags) < 0) { + ERROR("Failed creating paircmp attribute: %s", fr_strerror()); + + return -1; + } + + paircompare_register(dict_attrbyname("Example-Paircmp"), dict_attrbyvalue(PW_USER_NAME, 0), false, + rlm_example_cmp, inst); + + return 0; +} + +/* + * Find the named user in this modules database. Create the set + * of attribute-value pairs to check and reply with for this user + * from the database. The authentication code only needs to check + * the password, the rest is done here. + */ +static rlm_rcode_t CC_HINT(nonnull) mod_authorize(UNUSED void *instance, REQUEST *request) +{ + VALUE_PAIR *state; + + /* + * Look for the 'state' attribute. + */ + state = fr_pair_find_by_num(request->packet->vps, PW_STATE, 0, TAG_ANY); + if (state != NULL) { + RDEBUG("Found reply to access challenge"); + return RLM_MODULE_OK; + } + + /* + * Create the challenge, and add it to the reply. + */ + pair_make_reply("Reply-Message", "This is a challenge", T_OP_EQ); + pair_make_reply("State", "0", T_OP_EQ); + + /* + * Mark the packet as an Access-Challenge packet. + * + * The server will take care of sending it to the user. + */ + request->reply->code = PW_CODE_ACCESS_CHALLENGE; + RDEBUG("Sending Access-Challenge"); + + return RLM_MODULE_HANDLED; +} + +/* + * Authenticate the user with the given password. + */ +static rlm_rcode_t CC_HINT(nonnull) mod_authenticate(UNUSED void *instance, UNUSED REQUEST *request) +{ + return RLM_MODULE_OK; +} + +#ifdef WITH_ACCOUNTING +/* + * Massage the request before recording it or proxying it + */ +static rlm_rcode_t CC_HINT(nonnull) mod_preacct(UNUSED void *instance, UNUSED REQUEST *request) +{ + return RLM_MODULE_OK; +} + +/* + * Write accounting information to this modules database. + */ +static rlm_rcode_t CC_HINT(nonnull) mod_accounting(UNUSED void *instance, UNUSED REQUEST *request) +{ + return RLM_MODULE_OK; +} + +/* + * See if a user is already logged in. Sets request->simul_count to the + * current session count for this user and sets request->simul_mpp to 2 + * if it looks like a multilink attempt based on the requested IP + * address, otherwise leaves request->simul_mpp alone. + * + * Check twice. If on the first pass the user exceeds his + * max. number of logins, do a second pass and validate all + * logins by querying the terminal server (using eg. SNMP). + */ +static rlm_rcode_t CC_HINT(nonnull) mod_checksimul(UNUSED void *instance, REQUEST *request) +{ + request->simul_count=0; + + return RLM_MODULE_OK; +} +#endif + + +/* + * Only free memory we allocated. The strings allocated via + * cf_section_parse() do not need to be freed. + */ +static int mod_detach(UNUSED void *instance) +{ + /* free things here */ + return 0; +} + +/* + * The module name should be the only globally exported symbol. + * That is, everything else should be 'static'. + * + * If the module needs to temporarily modify it's instantiation + * data, the type should be changed to RLM_TYPE_THREAD_UNSAFE. + * The server will then take care of ensuring that the module + * is single-threaded. + */ +extern module_t rlm_example; +module_t rlm_example = { + .magic = RLM_MODULE_INIT, + .name = "example", + .type = RLM_TYPE_THREAD_SAFE, + .inst_size = sizeof(rlm_example_t), + .config = module_config, + .instantiate = mod_instantiate, + .detach = mod_detach, + .methods = { + [MOD_AUTHENTICATE] = mod_authenticate, + [MOD_AUTHORIZE] = mod_authorize, +#ifdef WITH_ACCOUNTING + [MOD_PREACCT] = mod_preacct, + [MOD_ACCOUNTING] = mod_accounting, + [MOD_SESSION] = mod_checksimul +#endif + }, +}; |