-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2018-2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013, 2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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 <http://www.gnu.org/licenses/>.
*/
-#include "inspircd.h"
-#include "httpd.h"
-#include "protocol.h"
-#include "wildcard.h"
-/* $ModDesc: Provides access control lists (passwording of resources, ip restrictions etc) to m_httpd.so dependent modules */
-/* $ModDep: httpd.h */
+#include "inspircd.h"
+#include "modules/httpd.h"
-class ACL : public Extensible
+class HTTPACL
{
public:
std::string path;
+ std::string username;
std::string password;
std::string whitelist;
std::string blacklist;
- ACL(const std::string &set_path, const std::string &set_password,
+ HTTPACL(const std::string &set_path, const std::string &set_username, const std::string &set_password,
const std::string &set_whitelist, const std::string &set_blacklist)
- : path(set_path), password(set_password), whitelist(set_whitelist),
+ : path(set_path), username(set_username), password(set_password), whitelist(set_whitelist),
blacklist(set_blacklist) { }
-
- ~ACL() { }
};
-class ModuleHTTPAccessList : public Module
+class ModuleHTTPAccessList : public Module, public HTTPACLEventListener
{
-
- std::string stylesheet;
- bool changed;
- std::vector<ACL> acl_list;
+ private:
+ std::vector<HTTPACL> acl_list;
+ HTTPdAPI API;
public:
+ ModuleHTTPAccessList()
+ : HTTPACLEventListener(this)
+ , API(this)
+ {
+ }
- void ReadConfig()
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
{
- acl_list.clear();
- ConfigReader c(ServerInstance);
- int n_items = c.Enumerate("httpacl");
- for (int i = 0; i < n_items; ++i)
+ std::vector<HTTPACL> new_acls;
+ ConfigTagList acls = ServerInstance->Config->ConfTags("httpdacl");
+ for (ConfigIter i = acls.first; i != acls.second; i++)
{
- std::string path = c.ReadValue("httpacl", "path", i);
- std::string types = c.ReadValue("httpacl", "types", i);
+ ConfigTag* c = i->second;
+ std::string path = c->getString("path");
+ std::string types = c->getString("types");
irc::commasepstream sep(types);
std::string type;
+ std::string username;
std::string password;
std::string whitelist;
std::string blacklist;
while (sep.GetToken(type))
{
- if (type == "password")
+ if (stdalgo::string::equalsci(type, "password"))
{
- password = c.ReadValue("httpacl", "password", i);
+ username = c->getString("username");
+ password = c->getString("password");
}
- else if (type == "whitelist")
+ else if (stdalgo::string::equalsci(type, "whitelist"))
{
- whitelist = c.ReadValue("httpacl", "whitelist", i);
+ whitelist = c->getString("whitelist");
}
- else if (type == "blacklist")
+ else if (stdalgo::string::equalsci(type, "blacklist"))
{
- blacklist = c.ReadValue("httpacl", "blacklist", i);
+ blacklist = c->getString("blacklist");
}
else
{
}
}
- acl_list.push_back(ACL(path, password, whitelist, blacklist));
- }
- }
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Read ACL: path=%s pass=%s whitelist=%s blacklist=%s", path.c_str(),
+ password.c_str(), whitelist.c_str(), blacklist.c_str());
- ModuleHTTPAccessList(InspIRCd* Me) : Module(Me)
- {
- ReadConfig();
- this->changed = true;
- Implementation eventlist[] = { I_OnEvent, I_OnRequest };
- ServerInstance->Modules->Attach(eventlist, this, 2);
+ new_acls.push_back(HTTPACL(path, username, password, whitelist, blacklist));
+ }
+ acl_list.swap(new_acls);
}
- void BlockAccess(HTTPRequest* http, Event* event)
+ void BlockAccess(HTTPRequest* http, unsigned int returnval, const std::string &extraheaderkey = "", const std::string &extraheaderval="")
{
- std::stringstream data("Access to this resource is denied by an access control list. Please contact your IRC administrator.");
- HTTPDocument response(http->sock, &data, 403);
- response.headers.SetHeader("X-Powered-By", "m_httpd_acl.so");
- Request req((char*)&response, (Module*)this, event->GetSource());
- req.Send();
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BlockAccess (%u)", returnval);
+
+ std::stringstream data;
+ data << "<html><head></head><body style='font-family: sans-serif; text-align: center'>"
+ << "<h1 style='font-size: 48pt'>Error " << returnval << "</h1>"
+ << "<h2 style='font-size: 24pt'>Access to this resource is denied by an access control list.</h2>"
+ << "<h2 style='font-size: 24pt'>Please contact your IRC administrator.</h2><hr>"
+ << "<small>Powered by <a href='https://www.inspircd.org'>InspIRCd</a></small></body></html>";
+
+ HTTPDocumentResponse response(this, *http, &data, returnval);
+ response.headers.SetHeader("X-Powered-By", MODNAME);
+ if (!extraheaderkey.empty())
+ response.headers.SetHeader(extraheaderkey, extraheaderval);
+ API->SendResponse(response);
}
- void OnEvent(Event* event)
+ bool IsAccessAllowed(HTTPRequest* http)
{
- std::stringstream data("");
-
- if (event->GetEventID() == "httpd_url")
{
- ServerInstance->Logs->Log("m_http_stats", DEBUG,"Handling httpd event");
- HTTPRequest* http = (HTTPRequest*)event->GetData();
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd acl event");
- for (std::vector<ACL>::const_iterator this_acl = acl_list.begin(); this_acl != acl_list.end(); ++this_acl)
+ for (std::vector<HTTPACL>::const_iterator this_acl = acl_list.begin(); this_acl != acl_list.end(); ++this_acl)
{
- if (match(http->GetURI(), this_acl->path))
+ if (InspIRCd::Match(http->GetPath(), this_acl->path, ascii_case_insensitive_map))
{
if (!this_acl->blacklist.empty())
{
while (sep.GetToken(entry))
{
- if (match(http->GetIP(), entry))
+ if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
{
- BlockAccess(http, event);
- return;
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Denying access to blacklisted resource %s (matched by pattern %s) from ip %s (matched by entry %s)",
+ http->GetPath().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), entry.c_str());
+ BlockAccess(http, 403);
+ return false;
}
}
}
while (sep.GetToken(entry))
{
- if (match(http->GetIP(), entry))
+ if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
allow_access = true;
}
if (!allow_access)
{
- BlockAccess(http, event);
- return;
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Denying access to whitelisted resource %s (matched by pattern %s) from ip %s (Not in whitelist)",
+ http->GetPath().c_str(), this_acl->path.c_str(), http->GetIP().c_str());
+ BlockAccess(http, 403);
+ return false;
}
}
- if (!this_acl->password.empty())
+ if (!this_acl->password.empty() && !this_acl->username.empty())
{
/* Password auth, first look to see if we have a basic authentication header */
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Checking HTTP auth password for resource %s (matched by pattern %s) from ip %s, against username %s",
+ http->GetPath().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), this_acl->username.c_str());
+
+ if (http->headers->IsSet("Authorization"))
+ {
+ /* Password has been given, validate it */
+ std::string authorization = http->headers->GetHeader("Authorization");
+ irc::spacesepstream sep(authorization);
+ std::string authtype;
+ std::string base64;
+
+ sep.GetToken(authtype);
+ if (authtype == "Basic")
+ {
+ std::string user;
+ std::string pass;
+
+ sep.GetToken(base64);
+ std::string userpass = Base64ToBin(base64);
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "HTTP authorization: %s (%s)", userpass.c_str(), base64.c_str());
+
+ irc::sepstream userpasspair(userpass, ':');
+ if (userpasspair.GetToken(user))
+ {
+ userpasspair.GetToken(pass);
+
+ /* Access granted if username and password are correct */
+ if (user == this_acl->username && pass == this_acl->password)
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "HTTP authorization: password and username match");
+ return true;
+ }
+ else
+ /* Invalid password */
+ BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
+ }
+ else
+ /* Malformed user:pass pair */
+ BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
+ }
+ else
+ /* Unsupported authentication type */
+ BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
+ }
+ else
+ {
+ /* No password given at all, access denied */
+ BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
+ }
+ return false;
}
+
+ /* A path may only match one ACL (the first it finds in the config file) */
+ break;
}
}
}
+ return true;
}
- const char* OnRequest(Request* request)
- {
- return NULL;
- }
-
- virtual ~ModuleHTTPAccessList()
+ ModResult OnHTTPACLCheck(HTTPRequest& req) CXX11_OVERRIDE
{
+ if (IsAccessAllowed(&req))
+ return MOD_RES_PASSTHRU;
+ return MOD_RES_DENY;
}
- virtual Version GetVersion()
+ Version GetVersion() CXX11_OVERRIDE
{
- return Version(1, 2, 0, 0, VF_VENDOR, API_VERSION);
+ return Version("Allows the server administrator to control who can access resources served over HTTP with the httpd module.", VF_VENDOR);
}
};