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/>.
26 /* $ModDesc: Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE. */
28 enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE };
29 enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
31 static std::string sasl_target = "*";
33 static void SendSASL(const parameterlist& params)
35 if (!ServerInstance->PI->SendEncapsulatedData(params))
37 SASLFallback(NULL, params);
42 * Tracks SASL authentication state like charybdis does. --nenolod
44 class SaslAuthenticator
54 SaslAuthenticator(User *user_, std::string method, Module *ctor)
55 : user(user_), state(SASL_INIT), state_announced(false)
58 params.push_back(sasl_target);
59 params.push_back("SASL");
60 params.push_back(user->uuid);
61 params.push_back("*");
62 params.push_back("S");
63 params.push_back(method);
68 SaslResult GetSaslResult(const std::string &result_)
79 /* checks for and deals with a state change. */
80 SaslState ProcessInboundMessage(const std::vector<std::string> &msg)
86 this->user->Write("AUTHENTICATE %s", msg[3].c_str());
87 this->state = SASL_COMM;
90 if (msg[0] != this->agent)
94 this->user->Write("AUTHENTICATE %s", msg[3].c_str());
97 this->state = SASL_DONE;
98 this->result = this->GetSaslResult(msg[3]);
105 ServerInstance->Logs->Log("m_sasl", DEFAULT, "WTF: SaslState is not a known state (%d)", this->state);
114 this->state = SASL_DONE;
115 this->result = SASL_ABORT;
118 bool SendClientMessage(const std::vector<std::string>& parameters)
120 if (this->state != SASL_COMM)
123 parameterlist params;
124 params.push_back(sasl_target);
125 params.push_back("SASL");
126 params.push_back(this->user->uuid);
127 params.push_back(this->agent);
128 params.push_back("C");
130 params.insert(params.end(), parameters.begin(), parameters.end());
134 if (parameters[0][0] == '*')
143 void AnnounceState(void)
145 if (this->state_announced)
148 switch (this->result)
151 this->user->WriteNumeric(903, "%s :SASL authentication successful", this->user->nick.c_str());
154 this->user->WriteNumeric(906, "%s :SASL authentication aborted", this->user->nick.c_str());
157 this->user->WriteNumeric(904, "%s :SASL authentication failed", this->user->nick.c_str());
163 this->state_announced = true;
167 class CommandAuthenticate : public Command
170 SimpleExtItem<SaslAuthenticator>& authExt;
172 CommandAuthenticate(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext, GenericCap& Cap)
173 : Command(Creator, "AUTHENTICATE", 1), authExt(ext), cap(Cap)
175 works_before_reg = true;
178 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
180 /* Only allow AUTHENTICATE on unregistered clients */
181 if (user->registered != REG_ALL)
183 if (!cap.ext.get(user))
186 SaslAuthenticator *sasl = authExt.get(user);
188 authExt.set(user, new SaslAuthenticator(user, parameters[0], creator));
189 else if (sasl->SendClientMessage(parameters) == false) // IAL abort extension --nenolod
191 sasl->AnnounceState();
199 class CommandSASL : public Command
202 SimpleExtItem<SaslAuthenticator>& authExt;
203 CommandSASL(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext) : Command(Creator, "SASL", 2), authExt(ext)
205 this->flags_needed = FLAG_SERVERONLY; // should not be called by users
208 CmdResult Handle(const std::vector<std::string>& parameters, User *user)
210 User* target = ServerInstance->FindNick(parameters[1]);
211 if ((!target) || (IS_SERVER(target)))
213 ServerInstance->Logs->Log("m_sasl", DEBUG,"User not found in sasl ENCAP event: %s", parameters[1].c_str());
217 SaslAuthenticator *sasl = authExt.get(target);
221 SaslState state = sasl->ProcessInboundMessage(parameters);
222 if (state == SASL_DONE)
224 sasl->AnnounceState();
225 authExt.unset(target);
230 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
232 return ROUTE_BROADCAST;
236 class ModuleSASL : public Module
238 SimpleExtItem<SaslAuthenticator> authExt;
240 CommandAuthenticate auth;
244 : authExt("sasl_auth", this), cap(this, "sasl"), auth(this, authExt, cap), sasl(this, authExt)
251 Implementation eventlist[] = { I_OnEvent, I_OnUserRegister, I_OnRehash };
252 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
254 ServiceProvider* providelist[] = { &auth, &sasl, &authExt };
255 ServerInstance->Modules->AddServices(providelist, 3);
257 if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so"))
258 ServerInstance->Logs->Log("m_sasl", 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!");
263 sasl_target = ServerInstance->Config->ConfValue("sasl")->getString("target", "*");
266 ModResult OnUserRegister(LocalUser *user)
268 SaslAuthenticator *sasl_ = authExt.get(user);
275 return MOD_RES_PASSTHRU;
280 return Version("Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE.",VF_VENDOR);
283 void OnEvent(Event &ev)
289 MODULE_INIT(ModuleSASL)