src/modules/rlm_smb/rlm_smb.c

   1 /*
   2  * rlm_smb.c
   3  *
   4  * Version:     $Id$
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  * Copyright 2002  The FreeRADIUS server project
  21  * Copyright 2002  Alan DeKok <aland@ox.org>
  22  */
  23
  24 #include "autoconf.h"
  25 #include "libradius.h"
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29
  30 #include "radiusd.h"
  31 #include "modules.h"
  32 #include "conffile.h"
  33
  34 #include "valid.h"
  35
  36 static const char rcsid[] = "$Id$";
  37
  38 /*
  39  *      Define a structure for our module configuration.
  40  *
  41  *      These variables do not need to be in a structure, but it's
  42  *      a lot cleaner to do so, and a pointer to the structure can
  43  *      be used as the instance handle.
  44  */
  45 typedef struct rlm_smb_t {
  46         char            *server;
  47         char            *backup;
  48         char            *domain;
  49 } rlm_smb_t;
  50
  51 /*
  52  *      A mapping of configuration file names to internal variables.
  53  *
  54  *      Note that the string is dynamically allocated, so it MUST
  55  *      be freed.  When the configuration file parse re-reads the string,
  56  *      it free's the old one, and strdup's the new one, placing the pointer
  57  *      to the strdup'd string into 'config.string'.  This gets around
  58  *      buffer over-flows.
  59  */
  60 static CONF_PARSER module_config[] = {
  61   { "server",  PW_TYPE_STRING_PTR, offsetof(rlm_smb_t,server), NULL,  NULL},
  62   { "backup",  PW_TYPE_STRING_PTR, offsetof(rlm_smb_t,backup), NULL,  NULL},
  63   { "domain",  PW_TYPE_STRING_PTR, offsetof(rlm_smb_t,domain), NULL,  NULL},
  64
  65   { NULL, -1, 0, NULL, NULL }           /* end the list */
  66 };
  67
  68 /*
  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.
  73  *
  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.
  77  */
  78 static int smb_instantiate(CONF_SECTION *conf, void **instance)
  79 {
  80         rlm_smb_t *data;
  81
  82         /*
  83          *      Set up a storage area for instance data
  84          */
  85         data = rad_malloc(sizeof(*data));
  86
  87         /*
  88          *      If the configuration parameters can't be parsed, then
  89          *      fail.
  90          */
  91         if (cf_section_parse(conf, data, module_config) < 0) {
  92                 free(data);
  93                 return -1;
  94         }
  95
  96         *instance = data;
  97
  98         return 0;
  99 }
 100
 101 /*
 102  *      Authenticate the user with the given password.
 103  */
 104 static int smb_authenticate(void *instance, REQUEST *request)
 105 {
 106         rlm_smb_t *data = (rlm_smb_t *) instance;
 107         int rcode;
 108
 109         /*
 110          *      We can only authenticate user requests which HAVE
 111          *      a User-Name attribute.
 112          */
 113         if (!request->username) {
 114                 radlog(L_AUTH, "rlm_smb: Attribute \"User-Name\" is required for authentication.");
 115                 return RLM_MODULE_INVALID;
 116         }
 117
 118         /*
 119          *      We can only authenticate user requests which HAVE
 120          *      a User-Password attribute.
 121          */
 122         if (!request->password) {
 123                 radlog(L_AUTH, "rlm_smb: Attribute \"User-Password\" is required for authentication.");
 124                 return RLM_MODULE_INVALID;
 125         }
 126
 127         /*
 128          *  Ensure that we're being passed a plain-text password,
 129          *  and not anything else.
 130          */
 131         if (request->password->attribute != PW_PASSWORD) {
 132                 radlog(L_AUTH, "rlm_smb: Attribute \"User-Password\" is required for authentication.  Cannot use \"%s\".", request->password->name);
 133                 return RLM_MODULE_INVALID;
 134         }
 135
 136         /*
 137          *  Call the SMB magic to do the work.
 138          */
 139         rcode = Valid_User(request->username->strvalue,
 140                            request->password->strvalue,
 141                            data->server, data->backup, data->domain);
 142
 143         switch (rcode) {
 144         case 0:                 /* success */
 145           return RLM_MODULE_OK;
 146           break;
 147
 148         case 1:                 /* network failure */
 149         case 2:                 /* protocol failure */
 150           return RLM_MODULE_FAIL;
 151           break;
 152
 153         case 3:                 /* invalid user name or password */
 154           return RLM_MODULE_REJECT;
 155         }
 156
 157         /*
 158          *  Something weird happened.  Give up.
 159          */
 160         return RLM_MODULE_INVALID;
 161 }
 162
 163 static int smb_detach(void *instance)
 164 {
 165         rlm_smb_t *data = (rlm_smb_t *) instance;
 166
 167         if (data->server) free(data->server);
 168         if (data->backup) free(data->backup);
 169         if (data->domain) free(data->domain);
 170
 171         free(instance);
 172         return 0;
 173 }
 174
 175 /*
 176  *      The module name should be the only globally exported symbol.
 177  *      That is, everything else should be 'static'.
 178  *
 179  *      If the module needs to temporarily modify it's instantiation
 180  *      data, the type should be changed to RLM_TYPE_THREAD_UNSAFE.
 181  *      The server will then take care of ensuring that the module
 182  *      is single-threaded.
 183  */
 184 module_t rlm_smb = {
 185         "SMB",
 186         RLM_TYPE_THREAD_UNSAFE,         /* type */
 187         NULL,                           /* initialization */
 188         smb_instantiate,                /* instantiation */
 189         {
 190                 smb_authenticate,       /* authentication */
 191                 NULL,                   /* authorization */
 192                 NULL,                   /* preaccounting */
 193                 NULL,                   /* accounting */
 194                 NULL                    /* checksimul */
 195         },
 196         smb_detach,                     /* detach */
 197         NULL,                           /* destroy */
 198 };