projects/rlm_stg/rlm_stg.cpp

   1 /*
   2  *    This program is free software; you can redistribute it and/or modify
   3  *    it under the terms of the GNU General Public License as published by
   4  *    the Free Software Foundation; either version 2 of the License, or
   5  *    (at your option) any later version.
   6  *
   7  *    This program is distributed in the hope that it will be useful,
   8  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  *    GNU General Public License for more details.
  11  *
  12  *    You should have received a copy of the GNU General Public License
  13  *    along with this program; if not, write to the Free Software
  14  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  15  */
  16
  17 /*
  18  *    Author : Maxim Mamontov <faust@stargazer.dp.ua>
  19  */
  20
  21 /*
  22  *  FreeRADIUS module for data access via Stargazer
  23  *
  24  *  $Revision: 1.8 $
  25  *  $Date: 2010/08/14 04:15:08 $
  26  *
  27  */
  28
  29 #include <cstdio>
  30 #include <cstdlib>
  31 #include <cstring>
  32
  33 #include <exception>
  34
  35 extern "C" {
  36 #include "radius.h"
  37 #include "modules.h"
  38 }
  39
  40 #include "stg_client.h"
  41 #include "common.h"
  42
  43 STG_CLIENT * cli;
  44 volatile time_t stgTime;
  45
  46 /*
  47  *    Define a structure for our module configuration.
  48  *
  49  *    These variables do not need to be in a structure, but it's
  50  *    a lot cleaner to do so, and a pointer to the structure can
  51  *    be used as the instance handle.
  52  */
  53 typedef struct rlm_stg_t {
  54     char * server;
  55     char * password;
  56     uint32_t port;
  57     uint32_t localPort;
  58 } rlm_stg_t;
  59
  60 /*
  61  *    A mapping of configuration file names to internal variables.
  62  *
  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
  67  *    buffer over-flows.
  68  */
  69 static CONF_PARSER module_config[] = {
  70   { "password",  PW_TYPE_STRING_PTR, offsetof(rlm_stg_t,password), NULL,  NULL},
  71   { "server",  PW_TYPE_STRING_PTR, offsetof(rlm_stg_t,server), NULL,  NULL},
  72   { "port",  PW_TYPE_INTEGER,     offsetof(rlm_stg_t,port), NULL,  "5555" },
  73   { "local_port", PW_TYPE_INTEGER,    offsetof(rlm_stg_t,localPort), NULL,   "0" },
  74
  75   { NULL, -1, 0, NULL, NULL }        /* end the list */
  76 };
  77
  78 /*
  79  *    Do any per-module initialization that is separate to each
  80  *    configured instance of the module.  e.g. set up connections
  81  *    to external databases, read configuration files, set up
  82  *    dictionary entries, etc.
  83  *
  84  *    If configuration information is given in the config section
  85  *    that must be referenced in later calls, store a handle to it
  86  *    in *instance otherwise put a null pointer there.
  87  */
  88 static int stg_instantiate(CONF_SECTION *conf, void **instance)
  89 {
  90     rlm_stg_t *data;
  91
  92     /*
  93      *    Set up a storage area for instance data
  94      */
  95     DEBUG("rlm_stg: stg_instantiate()");
  96     data = (rlm_stg_t *)rad_malloc(sizeof(rlm_stg_t));
  97     if (!data) {
  98         return -1;
  99     }
 100     memset(data, 0, sizeof(rlm_stg_t));
 101
 102     /*
 103      *    If the configuration parameters can't be parsed, then
 104      *    fail.
 105      */
 106     if (cf_section_parse(conf, data, module_config) < 0) {
 107         free(data);
 108         return -1;
 109     }
 110
 111     try {
 112         cli = new STG_CLIENT(data->server, data->port, data->localPort, data->password);
 113     }
 114     catch (std::exception & ex) {
 115         DEBUG("rlm_stg: stg_instantiate() error: '%s'", ex.what());
 116         return -1;
 117     }
 118
 119     *instance = data;
 120
 121     return 0;
 122 }
 123
 124 /*
 125  *    Find the named user in this modules database.  Create the set
 126  *    of attribute-value pairs to check and reply with for this user
 127  *    from the database. The authentication code only needs to check
 128  *    the password, the rest is done here.
 129  */
 130 static int stg_authorize(void *, REQUEST *request)
 131 {
 132     VALUE_PAIR *uname;
 133     VALUE_PAIR *pwd;
 134     VALUE_PAIR *svc;
 135     DEBUG("rlm_stg: stg_authorize()");
 136
 137     uname = pairfind(request->packet->vps, PW_USER_NAME);
 138     if (uname) {
 139         DEBUG("rlm_stg: stg_authorize() user name defined as '%s'", uname->vp_strvalue);
 140     } else {
 141         DEBUG("rlm_stg: stg_authorize() user name undefined");
 142         return RLM_MODULE_FAIL;
 143     }
 144     if (request->username) {
 145         DEBUG("rlm_stg: stg_authorize() request username field: '%s'", request->username->vp_strvalue);
 146     }
 147     if (request->password) {
 148         DEBUG("rlm_stg: stg_authorize() request password field: '%s'", request->password->vp_strvalue);
 149     }
 150     // Here we need to define Framed-Protocol
 151     svc = pairfind(request->packet->vps, PW_SERVICE_TYPE);
 152     if (svc) {
 153         DEBUG("rlm_stg: stg_authorize() Service-Type defined as '%s'", svc->vp_strvalue);
 154         if (cli->Authorize((const char *)request->username->vp_strvalue, (const char *)svc->vp_strvalue)) {
 155             DEBUG("rlm_stg: stg_authorize() stg status: '%s'", cli->GetError().c_str());
 156             return RLM_MODULE_REJECT;
 157         }
 158     } else {
 159         DEBUG("rlm_stg: stg_authorize() Service-Type undefined");
 160         if (cli->Authorize((const char *)request->username->vp_strvalue, "")) {
 161             DEBUG("rlm_stg: stg_authorize() stg status: '%s'", cli->GetError().c_str());
 162             return RLM_MODULE_REJECT;
 163         }
 164     }
 165     pwd = pairmake("Cleartext-Password", cli->GetUserPassword().c_str(), T_OP_SET);
 166     pairadd(&request->config_items, pwd);
 167     //pairadd(&request->reply->vps, uname);
 168
 169     return RLM_MODULE_UPDATED;
 170 }
 171
 172 /*
 173  *    Authenticate the user with the given password.
 174  */
 175 static int stg_authenticate(void *, REQUEST *request)
 176 {
 177     /* quiet the compiler */
 178     VALUE_PAIR *svc;
 179
 180     DEBUG("rlm_stg: stg_authenticate()");
 181
 182     svc = pairfind(request->packet->vps, PW_SERVICE_TYPE);
 183     if (svc) {
 184         DEBUG("rlm_stg: stg_authenticate() Service-Type defined as '%s'", svc->vp_strvalue);
 185         if (cli->Authenticate((char *)request->username->vp_strvalue, (const char *)svc->vp_strvalue)) {
 186             DEBUG("rlm_stg: stg_authenticate() stg status: '%s'", cli->GetError().c_str());
 187             return RLM_MODULE_REJECT;
 188         }
 189     } else {
 190         DEBUG("rlm_stg: stg_authenticate() Service-Type undefined");
 191         if (cli->Authenticate((char *)request->username->vp_strvalue, "")) {
 192             DEBUG("rlm_stg: stg_authenticate() stg status: '%s'", cli->GetError().c_str());
 193             return RLM_MODULE_REJECT;
 194         }
 195     }
 196
 197     return RLM_MODULE_NOOP;
 198 }
 199
 200 /*
 201  *    Massage the request before recording it or proxying it
 202  */
 203 static int stg_preacct(void *, REQUEST *)
 204 {
 205     DEBUG("rlm_stg: stg_preacct()");
 206
 207     return RLM_MODULE_OK;
 208 }
 209
 210 /*
 211  *    Write accounting information to this modules database.
 212  */
 213 static int stg_accounting(void *, REQUEST * request)
 214 {
 215     /* quiet the compiler */
 216     VALUE_PAIR * sttype;
 217     VALUE_PAIR * svc;
 218     VALUE_PAIR * sessid;
 219     svc = pairfind(request->packet->vps, PW_SERVICE_TYPE);
 220
 221     DEBUG("rlm_stg: stg_accounting()");
 222
 223     sessid = pairfind(request->packet->vps, PW_ACCT_SESSION_ID);
 224     if (!sessid) {
 225         DEBUG("rlm_stg: stg_accounting() Acct-Session-ID undefined");
 226         return RLM_MODULE_FAIL;
 227     }
 228     sttype = pairfind(request->packet->vps, PW_ACCT_STATUS_TYPE);
 229     if (sttype) {
 230         DEBUG("Acct-Status-Type := %s", sttype->vp_strvalue);
 231         if (svc) {
 232             DEBUG("rlm_stg: stg_accounting() Service-Type defined as '%s'", svc->vp_strvalue);
 233             if (cli->Account((const char *)sttype->vp_strvalue, (const char *)request->username->vp_strvalue, (const char *)svc->vp_strvalue, (const char *)sessid->vp_strvalue)) {
 234                 DEBUG("rlm_stg: stg_accounting error: '%s'", cli->GetError().c_str());
 235                 return RLM_MODULE_FAIL;
 236             }
 237         } else {
 238             DEBUG("rlm_stg: stg_accounting() Service-Type undefined");
 239             if (cli->Account((const char *)sttype->vp_strvalue, (const char *)request->username->vp_strvalue, "", (const char *)sessid->vp_strvalue)) {
 240                 DEBUG("rlm_stg: stg_accounting error: '%s'", cli->GetError().c_str());
 241                 return RLM_MODULE_FAIL;
 242             }
 243         }
 244     } else {
 245         DEBUG("Acct-Status-Type := NULL");
 246     }
 247
 248     return RLM_MODULE_OK;
 249 }
 250
 251 /*
 252  *    See if a user is already logged in. Sets request->simul_count to the
 253  *    current session count for this user and sets request->simul_mpp to 2
 254  *    if it looks like a multilink attempt based on the requested IP
 255  *    address, otherwise leaves request->simul_mpp alone.
 256  *
 257  *    Check twice. If on the first pass the user exceeds his
 258  *    max. number of logins, do a second pass and validate all
 259  *    logins by querying the terminal server (using eg. SNMP).
 260  */
 261 static int stg_checksimul(void *, REQUEST *request)
 262 {
 263     DEBUG("rlm_stg: stg_checksimul()");
 264
 265     request->simul_count=0;
 266
 267     return RLM_MODULE_OK;
 268 }
 269
 270 static int stg_postauth(void *, REQUEST *request)
 271 {
 272     VALUE_PAIR *fia;
 273     VALUE_PAIR *svc;
 274     struct in_addr fip;
 275     DEBUG("rlm_stg: stg_postauth()");
 276     svc = pairfind(request->packet->vps, PW_SERVICE_TYPE);
 277     if (svc) {
 278         DEBUG("rlm_stg: stg_postauth() Service-Type defined as '%s'", svc->vp_strvalue);
 279         if (cli->PostAuthenticate((const char *)request->username->vp_strvalue, (const char *)svc->vp_strvalue)) {
 280             DEBUG("rlm_stg: stg_postauth() error: '%s'", cli->GetError().c_str());
 281             return RLM_MODULE_FAIL;
 282         }
 283     } else {
 284         DEBUG("rlm_stg: stg_postauth() Service-Type undefined");
 285         if (cli->PostAuthenticate((const char *)request->username->vp_strvalue, "")) {
 286             DEBUG("rlm_stg: stg_postauth() error: '%s'", cli->GetError().c_str());
 287             return RLM_MODULE_FAIL;
 288         }
 289     }
 290     if (strncmp((const char *)svc->vp_strvalue, "Framed-User", 11) == 0) {
 291         fip.s_addr = cli->GetFramedIP();
 292         DEBUG("rlm_stg: stg_postauth() ip = '%s'", inet_ntostring(fip.s_addr).c_str());
 293         fia = pairmake("Framed-IP-Address", inet_ntostring(fip.s_addr).c_str(), T_OP_SET);
 294         pairadd(&request->reply->vps, fia);
 295     }
 296
 297     return RLM_MODULE_UPDATED;
 298 }
 299
 300 static int stg_detach(void *instance)
 301 {
 302     DEBUG("rlm_stg: stg_detach()");
 303     delete cli;
 304     free(((struct rlm_stg_t *)instance)->server);
 305     free(((struct rlm_stg_t *)instance)->password);
 306     free(instance);
 307     return 0;
 308 }
 309
 310 /*
 311  *    The module name should be the only globally exported symbol.
 312  *    That is, everything else should be 'static'.
 313  *
 314  *    If the module needs to temporarily modify it's instantiation
 315  *    data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
 316  *    The server will then take care of ensuring that the module
 317  *    is single-threaded.
 318  */
 319 module_t rlm_stg = {
 320     RLM_MODULE_INIT,
 321     "stg",
 322     RLM_TYPE_THREAD_SAFE,        /* type */
 323     stg_instantiate,        /* instantiation */
 324     stg_detach,            /* detach */
 325     {
 326         stg_authenticate,    /* authentication */
 327         stg_authorize,    /* authorization */
 328         stg_preacct,    /* preaccounting */
 329         stg_accounting,    /* accounting */
 330         stg_checksimul,    /* checksimul */
 331         NULL,            /* pre-proxy */
 332         NULL,            /* post-proxy */
 333         stg_postauth            /* post-auth */
 334     },
 335 };