2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
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.
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
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/>.
22 #include "modules/cap.h"
23 #include "modules/account.h"
24 #include "modules/sasl.h"
25 #include "modules/ssl.h"
27 enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE };
28 enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
30 static std::string sasl_target = "*";
31 static Events::ModuleEventProvider* saslevprov;
33 static void SendSASL(const parameterlist& params)
35 if (!ServerInstance->PI->SendEncapsulatedData(sasl_target, "SASL", params))
37 FOREACH_MOD_CUSTOM(*saslevprov, SASLEventListener, OnSASLAuth, (params));
42 * Tracks SASL authentication state like charybdis does. --nenolod
44 class SaslAuthenticator
54 SaslAuthenticator(User* user_, const std::string& method)
55 : user(user_), state(SASL_INIT), state_announced(false)
58 params.push_back(user->uuid);
59 params.push_back("*");
60 params.push_back("S");
61 params.push_back(method);
63 LocalUser* localuser = IS_LOCAL(user);
64 if (method == "EXTERNAL" && localuser)
66 std::string fp = SSLClientCert::GetFingerprint(&localuser->eh);
75 SaslResult GetSaslResult(const std::string &result_)
86 /* checks for and deals with a state change. */
87 SaslState ProcessInboundMessage(const std::vector<std::string> &msg)
93 this->state = SASL_COMM;
96 if (msg[0] != this->agent)
100 this->user->Write("AUTHENTICATE %s", msg[3].c_str());
101 else if (msg[2] == "D")
103 this->state = SASL_DONE;
104 this->result = this->GetSaslResult(msg[3]);
106 else if (msg[2] == "M")
107 this->user->WriteNumeric(908, "%s %s :are available SASL mechanisms", this->user->nick.c_str(), msg[3].c_str());
109 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Services sent an unknown SASL message \"%s\" \"%s\"", msg[2].c_str(), msg[3].c_str());
115 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WTF: SaslState is not a known state (%d)", this->state);
124 this->state = SASL_DONE;
125 this->result = SASL_ABORT;
128 bool SendClientMessage(const std::vector<std::string>& parameters)
130 if (this->state != SASL_COMM)
133 parameterlist params;
134 params.push_back(this->user->uuid);
135 params.push_back(this->agent);
136 params.push_back("C");
138 params.insert(params.end(), parameters.begin(), parameters.end());
142 if (parameters[0][0] == '*')
151 void AnnounceState(void)
153 if (this->state_announced)
156 switch (this->result)
159 this->user->WriteNumeric(903, ":SASL authentication successful");
162 this->user->WriteNumeric(906, ":SASL authentication aborted");
165 this->user->WriteNumeric(904, ":SASL authentication failed");
171 this->state_announced = true;
175 class CommandAuthenticate : public Command
178 SimpleExtItem<SaslAuthenticator>& authExt;
180 CommandAuthenticate(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext, GenericCap& Cap)
181 : Command(Creator, "AUTHENTICATE", 1), authExt(ext), cap(Cap)
183 works_before_reg = true;
186 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
188 /* Only allow AUTHENTICATE on unregistered clients */
189 if (user->registered != REG_ALL)
191 if (!cap.ext.get(user))
194 SaslAuthenticator *sasl = authExt.get(user);
196 authExt.set(user, new SaslAuthenticator(user, parameters[0]));
197 else if (sasl->SendClientMessage(parameters) == false) // IAL abort extension --nenolod
199 sasl->AnnounceState();
207 class CommandSASL : public Command
210 SimpleExtItem<SaslAuthenticator>& authExt;
211 CommandSASL(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext) : Command(Creator, "SASL", 2), authExt(ext)
213 this->flags_needed = FLAG_SERVERONLY; // should not be called by users
216 CmdResult Handle(const std::vector<std::string>& parameters, User *user)
218 User* target = ServerInstance->FindNick(parameters[1]);
219 if ((!target) || (IS_SERVER(target)))
221 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "User not found in sasl ENCAP event: %s", parameters[1].c_str());
225 SaslAuthenticator *sasl = authExt.get(target);
229 SaslState state = sasl->ProcessInboundMessage(parameters);
230 if (state == SASL_DONE)
232 sasl->AnnounceState();
233 authExt.unset(target);
238 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
240 return ROUTE_BROADCAST;
244 class ModuleSASL : public Module
246 SimpleExtItem<SaslAuthenticator> authExt;
248 CommandAuthenticate auth;
250 Events::ModuleEventProvider sasleventprov;
254 : authExt("sasl_auth", ExtensionItem::EXT_USER, this)
256 , auth(this, authExt, cap)
257 , sasl(this, authExt)
258 , sasleventprov(this, "event/sasl")
260 saslevprov = &sasleventprov;
263 void init() CXX11_OVERRIDE
265 if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so"))
266 ServerInstance->Logs->Log(MODNAME, 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!");
269 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
271 sasl_target = ServerInstance->Config->ConfValue("sasl")->getString("target", "*");
274 ModResult OnUserRegister(LocalUser *user) CXX11_OVERRIDE
276 SaslAuthenticator *sasl_ = authExt.get(user);
283 return MOD_RES_PASSTHRU;
286 Version GetVersion() CXX11_OVERRIDE
288 return Version("Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE.",VF_VENDOR);
292 MODULE_INIT(ModuleSASL)