src/modules/m_sasl.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #include "inspircd.h"
  22 #include "m_cap.h"
  23 #include "account.h"
  24 #include "sasl.h"
  25 #include "ssl.h"
  26
  27 /* $ModDesc: Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE. */
  28
  29 enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE };
  30 enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
  31
  32 static std::string sasl_target = "*";
  33
  34 static void SendSASL(const parameterlist& params)
  35 {
  36         if (!ServerInstance->PI->SendEncapsulatedData(params))
  37         {
  38                 SASLFallback(NULL, params);
  39         }
  40 }
  41
  42 /**
  43  * Tracks SASL authentication state like charybdis does. --nenolod
  44  */
  45 class SaslAuthenticator
  46 {
  47  private:
  48         std::string agent;
  49         User *user;
  50         SaslState state;
  51         SaslResult result;
  52         bool state_announced;
  53
  54  public:
  55         SaslAuthenticator(User *user_, std::string method, Module *ctor)
  56                 : user(user_), state(SASL_INIT), state_announced(false)
  57         {
  58                 parameterlist params;
  59                 params.push_back(sasl_target);
  60                 params.push_back("SASL");
  61                 params.push_back(user->uuid);
  62                 params.push_back("*");
  63                 params.push_back("S");
  64                 params.push_back(method);
  65
  66                 if (method == "EXTERNAL" && IS_LOCAL(user_))
  67                 {
  68                         SocketCertificateRequest req(&((LocalUser*)user_)->eh, ServerInstance->Modules->Find("m_sasl.so"));
  69                         std::string fp = req.GetFingerprint();
  70
  71                         if (fp.size())
  72                                 params.push_back(fp);
  73                 }
  74
  75                 SendSASL(params);
  76         }
  77
  78         SaslResult GetSaslResult(const std::string &result_)
  79         {
  80                 if (result_ == "F")
  81                         return SASL_FAIL;
  82
  83                 if (result_ == "A")
  84                         return SASL_ABORT;
  85
  86                 return SASL_OK;
  87         }
  88
  89         /* checks for and deals with a state change. */
  90         SaslState ProcessInboundMessage(const std::vector<std::string> &msg)
  91         {
  92                 switch (this->state)
  93                 {
  94                  case SASL_INIT:
  95                         this->agent = msg[0];
  96                         this->user->Write("AUTHENTICATE %s", msg[3].c_str());
  97                         this->state = SASL_COMM;
  98                         break;
  99                  case SASL_COMM:
 100                         if (msg[0] != this->agent)
 101                                 return this->state;
 102
 103                         if (msg[2] != "D")
 104                                 this->user->Write("AUTHENTICATE %s", msg[3].c_str());
 105                         else
 106                         {
 107                                 this->state = SASL_DONE;
 108                                 this->result = this->GetSaslResult(msg[3]);
 109                         }
 110
 111                         break;
 112                  case SASL_DONE:
 113                         break;
 114                  default:
 115                         ServerInstance->Logs->Log("m_sasl", LOG_DEFAULT, "WTF: SaslState is not a known state (%d)", this->state);
 116                         break;
 117                 }
 118
 119                 return this->state;
 120         }
 121
 122         void Abort(void)
 123         {
 124                 this->state = SASL_DONE;
 125                 this->result = SASL_ABORT;
 126         }
 127
 128         bool SendClientMessage(const std::vector<std::string>& parameters)
 129         {
 130                 if (this->state != SASL_COMM)
 131                         return true;
 132
 133                 parameterlist params;
 134                 params.push_back(sasl_target);
 135                 params.push_back("SASL");
 136                 params.push_back(this->user->uuid);
 137                 params.push_back(this->agent);
 138                 params.push_back("C");
 139
 140                 params.insert(params.end(), parameters.begin(), parameters.end());
 141
 142                 SendSASL(params);
 143
 144                 if (parameters[0][0] == '*')
 145                 {
 146                         this->Abort();
 147                         return false;
 148                 }
 149
 150                 return true;
 151         }
 152
 153         void AnnounceState(void)
 154         {
 155                 if (this->state_announced)
 156                         return;
 157
 158                 switch (this->result)
 159                 {
 160                  case SASL_OK:
 161                         this->user->WriteNumeric(903, "%s :SASL authentication successful", this->user->nick.c_str());
 162                         break;
 163                  case SASL_ABORT:
 164                         this->user->WriteNumeric(906, "%s :SASL authentication aborted", this->user->nick.c_str());
 165                         break;
 166                  case SASL_FAIL:
 167                         this->user->WriteNumeric(904, "%s :SASL authentication failed", this->user->nick.c_str());
 168                         break;
 169                  default:
 170                         break;
 171                 }
 172
 173                 this->state_announced = true;
 174         }
 175 };
 176
 177 class CommandAuthenticate : public Command
 178 {
 179  public:
 180         SimpleExtItem<SaslAuthenticator>& authExt;
 181         GenericCap& cap;
 182         CommandAuthenticate(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext, GenericCap& Cap)
 183                 : Command(Creator, "AUTHENTICATE", 1), authExt(ext), cap(Cap)
 184         {
 185                 works_before_reg = true;
 186         }
 187
 188         CmdResult Handle (const std::vector<std::string>& parameters, User *user)
 189         {
 190                 /* Only allow AUTHENTICATE on unregistered clients */
 191                 if (user->registered != REG_ALL)
 192                 {
 193                         if (!cap.ext.get(user))
 194                                 return CMD_FAILURE;
 195
 196                         SaslAuthenticator *sasl = authExt.get(user);
 197                         if (!sasl)
 198                                 authExt.set(user, new SaslAuthenticator(user, parameters[0], creator));
 199                         else if (sasl->SendClientMessage(parameters) == false)  // IAL abort extension --nenolod
 200                         {
 201                                 sasl->AnnounceState();
 202                                 authExt.unset(user);
 203                         }
 204                 }
 205                 return CMD_FAILURE;
 206         }
 207 };
 208
 209 class CommandSASL : public Command
 210 {
 211  public:
 212         SimpleExtItem<SaslAuthenticator>& authExt;
 213         CommandSASL(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext) : Command(Creator, "SASL", 2), authExt(ext)
 214         {
 215                 this->flags_needed = FLAG_SERVERONLY; // should not be called by users
 216         }
 217
 218         CmdResult Handle(const std::vector<std::string>& parameters, User *user)
 219         {
 220                 User* target = ServerInstance->FindNick(parameters[1]);
 221                 if ((!target) || (IS_SERVER(target)))
 222                 {
 223                         ServerInstance->Logs->Log("m_sasl", LOG_DEBUG,"User not found in sasl ENCAP event: %s", parameters[1].c_str());
 224                         return CMD_FAILURE;
 225                 }
 226
 227                 SaslAuthenticator *sasl = authExt.get(target);
 228                 if (!sasl)
 229                         return CMD_FAILURE;
 230
 231                 SaslState state = sasl->ProcessInboundMessage(parameters);
 232                 if (state == SASL_DONE)
 233                 {
 234                         sasl->AnnounceState();
 235                         authExt.unset(target);
 236                 }
 237                 return CMD_SUCCESS;
 238         }
 239
 240         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 241         {
 242                 return ROUTE_BROADCAST;
 243         }
 244 };
 245
 246 class ModuleSASL : public Module
 247 {
 248         SimpleExtItem<SaslAuthenticator> authExt;
 249         GenericCap cap;
 250         CommandAuthenticate auth;
 251         CommandSASL sasl;
 252
 253  public:
 254         ModuleSASL()
 255                 : authExt("sasl_auth", this), cap(this, "sasl"), auth(this, authExt, cap), sasl(this, authExt)
 256         {
 257         }
 258
 259         void init()
 260         {
 261                 OnRehash(NULL);
 262                 Implementation eventlist[] = { I_OnEvent, I_OnUserRegister, I_OnRehash };
 263                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 264
 265                 ServiceProvider* providelist[] = { &auth, &sasl, &authExt };
 266                 ServerInstance->Modules->AddServices(providelist, 3);
 267
 268                 if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so"))
 269                         ServerInstance->Logs->Log("m_sasl", LOG_DEFAULT, "WARNING: m_services_account.so and m_cap.so are not loaded! m_sasl.so will NOT function correctly until these two modules are loaded!");
 270         }
 271
 272         void OnRehash(User*)
 273         {
 274                 sasl_target = ServerInstance->Config->ConfValue("sasl")->getString("target", "*");
 275         }
 276
 277         ModResult OnUserRegister(LocalUser *user)
 278         {
 279                 SaslAuthenticator *sasl_ = authExt.get(user);
 280                 if (sasl_)
 281                 {
 282                         sasl_->Abort();
 283                         authExt.unset(user);
 284                 }
 285
 286                 return MOD_RES_PASSTHRU;
 287         }
 288
 289         Version GetVersion()
 290         {
 291                 return Version("Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE.",VF_VENDOR);
 292         }
 293
 294         void OnEvent(Event &ev)
 295         {
 296                 cap.HandleEvent(ev);
 297         }
 298 };
 299
 300 MODULE_INIT(ModuleSASL)