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/>.
27 /* $ModDesc: Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE. */
29 enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE };
30 enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
32 static std::string sasl_target = "*";
34 static void SendSASL(const parameterlist& params)
36 if (!ServerInstance->PI->SendEncapsulatedData(params))
38 SASLFallback(NULL, params);
43 * Tracks SASL authentication state like charybdis does. --nenolod
45 class SaslAuthenticator
54 /* taken from m_services_account */
55 static bool ReadCGIIRCExt(const char* extname, User* user, std::string& out)
57 ExtensionItem* wiext = ServerInstance->Extensions.GetItem(extname);
61 if (wiext->creator->ModuleSourceFile != "m_cgiirc.so")
64 StringExtItem* stringext = static_cast<StringExtItem*>(wiext);
65 std::string* addr = stringext->get(user);
78 if (!ReadCGIIRCExt("cgiirc_webirc_hostname", user, host))
82 if (!ReadCGIIRCExt("cgiirc_webirc_ip", user, ip))
84 ip = user->GetIPString();
88 /* IP addresses starting with a : on irc are a Bad Thing (tm) */
89 if (ip.c_str()[0] == ':')
90 ip.insert(ip.begin(),1,'0');
94 params.push_back(sasl_target);
95 params.push_back("SASL");
96 params.push_back(user->uuid);
97 params.push_back("*");
98 params.push_back("H");
99 params.push_back(host);
100 params.push_back(ip);
102 LocalUser* lu = IS_LOCAL(user);
105 // NOTE: SaslAuthenticator instances are only created for local
106 // users so this parameter will always be appended.
107 SocketCertificateRequest req(&lu->eh, ServerInstance->Modules->Find("m_sasl.so"));
108 params.push_back(req.cert ? "S" : "P");
115 SaslAuthenticator(User* user_, const std::string& method)
116 : user(user_), state(SASL_INIT), state_announced(false)
120 parameterlist params;
121 params.push_back(sasl_target);
122 params.push_back("SASL");
123 params.push_back(user->uuid);
124 params.push_back("*");
125 params.push_back("S");
126 params.push_back(method);
128 if (method == "EXTERNAL" && IS_LOCAL(user_))
130 SocketCertificateRequest req(&((LocalUser*)user_)->eh, ServerInstance->Modules->Find("m_sasl.so"));
131 std::string fp = req.GetFingerprint();
134 params.push_back(fp);
140 SaslResult GetSaslResult(const std::string &result_)
151 /* checks for and deals with a state change. */
152 SaslState ProcessInboundMessage(const std::vector<std::string> &msg)
157 this->agent = msg[0];
158 this->state = SASL_COMM;
161 if (msg[0] != this->agent)
168 this->user->Write("AUTHENTICATE %s", msg[3].c_str());
169 else if (msg[2] == "D")
171 this->state = SASL_DONE;
172 this->result = this->GetSaslResult(msg[3]);
174 else if (msg[2] == "M")
175 this->user->WriteNumeric(908, "%s %s :are available SASL mechanisms", this->user->nick.c_str(), msg[3].c_str());
177 ServerInstance->Logs->Log("m_sasl", DEFAULT, "Services sent an unknown SASL message \"%s\" \"%s\"", msg[2].c_str(), msg[3].c_str());
183 ServerInstance->Logs->Log("m_sasl", DEFAULT, "WTF: SaslState is not a known state (%d)", this->state);
192 this->state = SASL_DONE;
193 this->result = SASL_ABORT;
196 bool SendClientMessage(const std::vector<std::string>& parameters)
198 if (this->state != SASL_COMM)
201 parameterlist params;
202 params.push_back(sasl_target);
203 params.push_back("SASL");
204 params.push_back(this->user->uuid);
205 params.push_back(this->agent);
206 params.push_back("C");
208 params.insert(params.end(), parameters.begin(), parameters.end());
212 if (parameters[0].c_str()[0] == '*')
221 void AnnounceState(void)
223 if (this->state_announced)
226 switch (this->result)
229 this->user->WriteNumeric(903, "%s :SASL authentication successful", this->user->nick.c_str());
232 this->user->WriteNumeric(906, "%s :SASL authentication aborted", this->user->nick.c_str());
235 this->user->WriteNumeric(904, "%s :SASL authentication failed", this->user->nick.c_str());
241 this->state_announced = true;
245 class CommandAuthenticate : public Command
248 SimpleExtItem<SaslAuthenticator>& authExt;
250 CommandAuthenticate(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext, GenericCap& Cap)
251 : Command(Creator, "AUTHENTICATE", 1), authExt(ext), cap(Cap)
253 works_before_reg = true;
254 allow_empty_last_param = false;
257 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
259 /* Only allow AUTHENTICATE on unregistered clients */
260 if (user->registered != REG_ALL)
262 if (!cap.ext.get(user))
265 if (parameters[0].find(' ') != std::string::npos || parameters[0][0] == ':')
268 SaslAuthenticator *sasl = authExt.get(user);
270 authExt.set(user, new SaslAuthenticator(user, parameters[0]));
271 else if (sasl->SendClientMessage(parameters) == false) // IAL abort extension --nenolod
273 sasl->AnnounceState();
281 class CommandSASL : public Command
284 SimpleExtItem<SaslAuthenticator>& authExt;
285 CommandSASL(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext) : Command(Creator, "SASL", 2), authExt(ext)
287 this->flags_needed = FLAG_SERVERONLY; // should not be called by users
290 CmdResult Handle(const std::vector<std::string>& parameters, User *user)
292 User* target = ServerInstance->FindNick(parameters[1]);
293 if ((!target) || (IS_SERVER(target)))
295 ServerInstance->Logs->Log("m_sasl", DEBUG,"User not found in sasl ENCAP event: %s", parameters[1].c_str());
299 SaslAuthenticator *sasl = authExt.get(target);
303 SaslState state = sasl->ProcessInboundMessage(parameters);
304 if (state == SASL_DONE)
306 sasl->AnnounceState();
307 authExt.unset(target);
312 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
314 return ROUTE_BROADCAST;
318 class ModuleSASL : public Module
320 SimpleExtItem<SaslAuthenticator> authExt;
322 CommandAuthenticate auth;
326 : authExt("sasl_auth", this), cap(this, "sasl"), auth(this, authExt, cap), sasl(this, authExt)
333 Implementation eventlist[] = { I_OnEvent, I_OnUserConnect, I_OnRehash };
334 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
336 ServiceProvider* providelist[] = { &auth, &sasl, &authExt };
337 ServerInstance->Modules->AddServices(providelist, 3);
339 if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so"))
340 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!");
345 sasl_target = ServerInstance->Config->ConfValue("sasl")->getString("target", "*");
348 void OnUserConnect(LocalUser *user)
350 SaslAuthenticator *sasl_ = authExt.get(user);
360 return Version("Provides support for IRC Authentication Layer (aka: SASL) via AUTHENTICATE.", VF_VENDOR);
363 void OnEvent(Event &ev)
369 MODULE_INIT(ModuleSASL)