/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2008 Craig Edwards * * This file is part of InspIRCd. InspIRCd is free software: you can * redistribute it and/or modify it under the terms of the GNU General Public * License as published by the Free Software Foundation, version 2. * * This program is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more * details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include "inspircd.h" #include "m_cap.h" #include "account.h" #include "sasl.h" #include "ssl.h" /* $ModDesc: Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE. */ enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE }; enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT }; static std::string sasl_target = "*"; static void SendSASL(const parameterlist& params) { if (!ServerInstance->PI->SendEncapsulatedData(params)) { SASLFallback(NULL, params); } } /** * Tracks SASL authentication state like charybdis does. --nenolod */ class SaslAuthenticator { private: std::string agent; User *user; SaslState state; SaslResult result; bool state_announced; /* taken from m_services_account */ static bool ReadCGIIRCExt(const char* extname, User* user, std::string& out) { ExtensionItem* wiext = ServerInstance->Extensions.GetItem(extname); if (!wiext) return false; if (wiext->creator->ModuleSourceFile != "m_cgiirc.so") return false; StringExtItem* stringext = static_cast(wiext); std::string* addr = stringext->get(user); if (!addr) return false; out = *addr; return true; } void SendHostIP() { std::string host, ip; if (!ReadCGIIRCExt("cgiirc_webirc_hostname", user, host)) { host = user->host; } if (!ReadCGIIRCExt("cgiirc_webirc_ip", user, ip)) { ip = user->GetIPString(); } else { /* IP addresses starting with a : on irc are a Bad Thing (tm) */ if (ip.c_str()[0] == ':') ip.insert(ip.begin(),1,'0'); } parameterlist params; params.push_back(sasl_target); params.push_back("SASL"); params.push_back(user->uuid); params.push_back("*"); params.push_back("H"); params.push_back(host); params.push_back(ip); LocalUser* lu = IS_LOCAL(user); if (lu) { // NOTE: SaslAuthenticator instances are only created for local // users so this parameter will always be appended. SocketCertificateRequest req(&lu->eh, ServerInstance->Modules->Find("m_sasl.so")); params.push_back(req.cert ? "S" : "P"); } SendSASL(params); } public: SaslAuthenticator(User* user_, const std::string& method) : user(user_), state(SASL_INIT), state_announced(false) { SendHostIP(); parameterlist params; params.push_back(sasl_target); params.push_back("SASL"); params.push_back(user->uuid); params.push_back("*"); params.push_back("S"); params.push_back(method); if (method == "EXTERNAL" && IS_LOCAL(user_)) { SocketCertificateRequest req(&((LocalUser*)user_)->eh, ServerInstance->Modules->Find("m_sasl.so")); std::string fp = req.GetFingerprint(); if (fp.size()) params.push_back(fp); } SendSASL(params); } SaslResult GetSaslResult(const std::string &result_) { if (result_ == "F") return SASL_FAIL; if (result_ == "A") return SASL_ABORT; return SASL_OK; } /* checks for and deals with a state change. */ SaslState ProcessInboundMessage(const std::vector &msg) { switch (this->state) { case SASL_INIT: this->agent = msg[0]; this->state = SASL_COMM; /* fall through */ case SASL_COMM: if (msg[0] != this->agent) return this->state; if (msg.size() < 4) return this->state; if (msg[2] == "C") this->user->Write("AUTHENTICATE %s", msg[3].c_str()); else if (msg[2] == "D") { this->state = SASL_DONE; this->result = this->GetSaslResult(msg[3]); } else if (msg[2] == "M") this->user->WriteNumeric(908, "%s %s :are available SASL mechanisms", this->user->nick.c_str(), msg[3].c_str()); else ServerInstance->Logs->Log("m_sasl", DEFAULT, "Services sent an unknown SASL message \"%s\" \"%s\"", msg[2].c_str(), msg[3].c_str()); break; case SASL_DONE: break; default: ServerInstance->Logs->Log("m_sasl", DEFAULT, "WTF: SaslState is not a known state (%d)", this->state); break; } return this->state; } void Abort(void) { this->state = SASL_DONE; this->result = SASL_ABORT; } bool SendClientMessage(const std::vector& parameters) { if (this->state != SASL_COMM) return true; parameterlist params; params.push_back(sasl_target); params.push_back("SASL"); params.push_back(this->user->uuid); params.push_back(this->agent); params.push_back("C"); params.insert(params.end(), parameters.begin(), parameters.end()); SendSASL(params); if (parameters[0].c_str()[0] == '*') { this->Abort(); return false; } return true; } void AnnounceState(void) { if (this->state_announced) return; switch (this->result) { case SASL_OK: this->user->WriteNumeric(903, "%s :SASL authentication successful", this->user->nick.c_str()); break; case SASL_ABORT: this->user->WriteNumeric(906, "%s :SASL authentication aborted", this->user->nick.c_str()); break; case SASL_FAIL: this->user->WriteNumeric(904, "%s :SASL authentication failed", this->user->nick.c_str()); break; default: break; } this->state_announced = true; } }; class CommandAuthenticate : public Command { public: SimpleExtItem& authExt; GenericCap& cap; CommandAuthenticate(Module* Creator, SimpleExtItem& ext, GenericCap& Cap) : Command(Creator, "AUTHENTICATE", 1), authExt(ext), cap(Cap) { works_before_reg = true; allow_empty_last_param = false; } CmdResult Handle (const std::vector& parameters, User *user) { /* Only allow AUTHENTICATE on unregistered clients */ if (user->registered != REG_ALL) { if (!cap.ext.get(user)) return CMD_FAILURE; if (parameters[0].find(' ') != std::string::npos || parameters[0][0] == ':') return CMD_FAILURE; SaslAuthenticator *sasl = authExt.get(user); if (!sasl) authExt.set(user, new SaslAuthenticator(user, parameters[0])); else if (sasl->SendClientMessage(parameters) == false) // IAL abort extension --nenolod { sasl->AnnounceState(); authExt.unset(user); } } return CMD_FAILURE; } }; class CommandSASL : public Command { public: SimpleExtItem& authExt; CommandSASL(Module* Creator, SimpleExtItem& ext) : Command(Creator, "SASL", 2), authExt(ext) { this->flags_needed = FLAG_SERVERONLY; // should not be called by users } CmdResult Handle(const std::vector& parameters, User *user) { User* target = ServerInstance->FindNick(parameters[1]); if ((!target) || (IS_SERVER(target))) { ServerInstance->Logs->Log("m_sasl", DEBUG,"User not found in sasl ENCAP event: %s", parameters[1].c_str()); return CMD_FAILURE; } SaslAuthenticator *sasl = authExt.get(target); if (!sasl) return CMD_FAILURE; SaslState state = sasl->ProcessInboundMessage(parameters); if (state == SASL_DONE) { sasl->AnnounceState(); authExt.unset(target); } return CMD_SUCCESS; } RouteDescriptor GetRouting(User* user, const std::vector& parameters) { return ROUTE_BROADCAST; } }; class ModuleSASL : public Module { SimpleExtItem authExt; GenericCap cap; CommandAuthenticate auth; CommandSASL sasl; public: ModuleSASL() : authExt("sasl_auth", this), cap(this, "sasl"), auth(this, authExt, cap), sasl(this, authExt) { } void init() { OnRehash(NULL); Implementation eventlist[] = { I_OnEvent, I_OnUserConnect, I_OnRehash }; ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation)); ServiceProvider* providelist[] = { &auth, &sasl, &authExt }; ServerInstance->Modules->AddServices(providelist, 3); if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so")) 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!"); } void OnRehash(User*) { sasl_target = ServerInstance->Config->ConfValue("sasl")->getString("target", "*"); } void OnUserConnect(LocalUser *user) { SaslAuthenticator *sasl_ = authExt.get(user); if (sasl_) { sasl_->Abort(); authExt.unset(user); } } Version GetVersion() { return Version("Provides support for IRC Authentication Layer (aka: SASL) via AUTHENTICATE.", VF_VENDOR); } void OnEvent(Event &ev) { cap.HandleEvent(ev); } }; MODULE_INIT(ModuleSASL)