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/httpd.h"
25 /* $ModDesc: Provides access control lists (passwording of resources, ip restrictions etc) to m_httpd.so dependent modules */
33 std::string whitelist;
34 std::string blacklist;
36 HTTPACL(const std::string &set_path, const std::string &set_username, const std::string &set_password,
37 const std::string &set_whitelist, const std::string &set_blacklist)
38 : path(set_path), username(set_username), password(set_password), whitelist(set_whitelist),
39 blacklist(set_blacklist) { }
42 class ModuleHTTPAccessList : public Module
44 std::string stylesheet;
45 std::vector<HTTPACL> acl_list;
49 ModuleHTTPAccessList()
54 void OnRehash(User* user)
57 ConfigTagList acls = ServerInstance->Config->ConfTags("httpdacl");
58 for (ConfigIter i = acls.first; i != acls.second; i++)
60 ConfigTag* c = i->second;
61 std::string path = c->getString("path");
62 std::string types = c->getString("types");
63 irc::commasepstream sep(types);
67 std::string whitelist;
68 std::string blacklist;
70 while (sep.GetToken(type))
72 if (type == "password")
74 username = c->getString("username");
75 password = c->getString("password");
77 else if (type == "whitelist")
79 whitelist = c->getString("whitelist");
81 else if (type == "blacklist")
83 blacklist = c->getString("blacklist");
87 throw ModuleException("Invalid HTTP ACL type '" + type + "'");
91 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "Read ACL: path=%s pass=%s whitelist=%s blacklist=%s", path.c_str(),
92 password.c_str(), whitelist.c_str(), blacklist.c_str());
94 acl_list.push_back(HTTPACL(path, username, password, whitelist, blacklist));
98 void init() CXX11_OVERRIDE
101 Implementation eventlist[] = { I_OnEvent, I_OnRehash };
102 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
105 void BlockAccess(HTTPRequest* http, int returnval, const std::string &extraheaderkey = "", const std::string &extraheaderval="")
107 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "BlockAccess (%d)", returnval);
109 std::stringstream data("Access to this resource is denied by an access control list. Please contact your IRC administrator.");
110 HTTPDocumentResponse response(this, *http, &data, returnval);
111 response.headers.SetHeader("X-Powered-By", "m_httpd_acl.so");
112 if (!extraheaderkey.empty())
113 response.headers.SetHeader(extraheaderkey, extraheaderval);
114 API->SendResponse(response);
117 void OnEvent(Event& event) CXX11_OVERRIDE
119 if (event.id == "httpd_acl")
121 ServerInstance->Logs->Log("m_http_stats", LOG_DEBUG, "Handling httpd acl event");
122 HTTPRequest* http = (HTTPRequest*)&event;
124 for (std::vector<HTTPACL>::const_iterator this_acl = acl_list.begin(); this_acl != acl_list.end(); ++this_acl)
126 if (InspIRCd::Match(http->GetURI(), this_acl->path, ascii_case_insensitive_map))
128 if (!this_acl->blacklist.empty())
131 irc::commasepstream sep(this_acl->blacklist);
134 while (sep.GetToken(entry))
136 if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
138 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "Denying access to blacklisted resource %s (matched by pattern %s) from ip %s (matched by entry %s)",
139 http->GetURI().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), entry.c_str());
140 BlockAccess(http, 403);
145 if (!this_acl->whitelist.empty())
148 irc::commasepstream sep(this_acl->whitelist);
150 bool allow_access = false;
152 while (sep.GetToken(entry))
154 if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
160 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "Denying access to whitelisted resource %s (matched by pattern %s) from ip %s (Not in whitelist)",
161 http->GetURI().c_str(), this_acl->path.c_str(), http->GetIP().c_str());
162 BlockAccess(http, 403);
166 if (!this_acl->password.empty() && !this_acl->username.empty())
168 /* Password auth, first look to see if we have a basic authentication header */
169 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "Checking HTTP auth password for resource %s (matched by pattern %s) from ip %s, against username %s",
170 http->GetURI().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), this_acl->username.c_str());
172 if (http->headers->IsSet("Authorization"))
174 /* Password has been given, validate it */
175 std::string authorization = http->headers->GetHeader("Authorization");
176 irc::spacesepstream sep(authorization);
177 std::string authtype;
180 sep.GetToken(authtype);
181 if (authtype == "Basic")
186 sep.GetToken(base64);
187 std::string userpass = Base64ToBin(base64);
188 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "HTTP authorization: %s (%s)", userpass.c_str(), base64.c_str());
190 irc::sepstream userpasspair(userpass, ':');
191 if (userpasspair.GetToken(user))
193 userpasspair.GetToken(pass);
195 /* Access granted if username and password are correct */
196 if (user == this_acl->username && pass == this_acl->password)
198 ServerInstance->Logs->Log("m_httpd_acl", LOG_DEBUG, "HTTP authorization: password and username match");
202 /* Invalid password */
203 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
206 /* Malformed user:pass pair */
207 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
210 /* Unsupported authentication type */
211 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
215 /* No password given at all, access denied */
216 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
220 /* A path may only match one ACL (the first it finds in the config file) */
227 Version GetVersion() CXX11_OVERRIDE
229 return Version("Provides access control lists (passwording of resources, ip restrictions etc) to m_httpd.so dependent modules", VF_VENDOR);
233 MODULE_INIT(ModuleHTTPAccessList)