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"
30 std::string whitelist;
31 std::string blacklist;
33 HTTPACL(const std::string &set_path, const std::string &set_username, const std::string &set_password,
34 const std::string &set_whitelist, const std::string &set_blacklist)
35 : path(set_path), username(set_username), password(set_password), whitelist(set_whitelist),
36 blacklist(set_blacklist) { }
39 class ModuleHTTPAccessList : public Module, public HTTPACLEventListener
41 std::string stylesheet;
42 std::vector<HTTPACL> acl_list;
46 ModuleHTTPAccessList()
47 : HTTPACLEventListener(this)
52 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
54 std::vector<HTTPACL> new_acls;
55 ConfigTagList acls = ServerInstance->Config->ConfTags("httpdacl");
56 for (ConfigIter i = acls.first; i != acls.second; i++)
58 ConfigTag* c = i->second;
59 std::string path = c->getString("path");
60 std::string types = c->getString("types");
61 irc::commasepstream sep(types);
65 std::string whitelist;
66 std::string blacklist;
68 while (sep.GetToken(type))
70 if (stdalgo::string::equalsci(type, "password"))
72 username = c->getString("username");
73 password = c->getString("password");
75 else if (stdalgo::string::equalsci(type, "whitelist"))
77 whitelist = c->getString("whitelist");
79 else if (stdalgo::string::equalsci(type, "blacklist"))
81 blacklist = c->getString("blacklist");
85 throw ModuleException("Invalid HTTP ACL type '" + type + "'");
89 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Read ACL: path=%s pass=%s whitelist=%s blacklist=%s", path.c_str(),
90 password.c_str(), whitelist.c_str(), blacklist.c_str());
92 new_acls.push_back(HTTPACL(path, username, password, whitelist, blacklist));
94 acl_list.swap(new_acls);
97 void BlockAccess(HTTPRequest* http, unsigned int returnval, const std::string &extraheaderkey = "", const std::string &extraheaderval="")
99 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BlockAccess (%u)", returnval);
101 std::stringstream data("Access to this resource is denied by an access control list. Please contact your IRC administrator.");
102 HTTPDocumentResponse response(this, *http, &data, returnval);
103 response.headers.SetHeader("X-Powered-By", MODNAME);
104 if (!extraheaderkey.empty())
105 response.headers.SetHeader(extraheaderkey, extraheaderval);
106 API->SendResponse(response);
109 bool IsAccessAllowed(HTTPRequest* http)
112 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd acl event");
114 for (std::vector<HTTPACL>::const_iterator this_acl = acl_list.begin(); this_acl != acl_list.end(); ++this_acl)
116 if (InspIRCd::Match(http->GetPath(), this_acl->path, ascii_case_insensitive_map))
118 if (!this_acl->blacklist.empty())
121 irc::commasepstream sep(this_acl->blacklist);
124 while (sep.GetToken(entry))
126 if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
128 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Denying access to blacklisted resource %s (matched by pattern %s) from ip %s (matched by entry %s)",
129 http->GetPath().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), entry.c_str());
130 BlockAccess(http, 403);
135 if (!this_acl->whitelist.empty())
138 irc::commasepstream sep(this_acl->whitelist);
140 bool allow_access = false;
142 while (sep.GetToken(entry))
144 if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
150 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Denying access to whitelisted resource %s (matched by pattern %s) from ip %s (Not in whitelist)",
151 http->GetPath().c_str(), this_acl->path.c_str(), http->GetIP().c_str());
152 BlockAccess(http, 403);
156 if (!this_acl->password.empty() && !this_acl->username.empty())
158 /* Password auth, first look to see if we have a basic authentication header */
159 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Checking HTTP auth password for resource %s (matched by pattern %s) from ip %s, against username %s",
160 http->GetPath().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), this_acl->username.c_str());
162 if (http->headers->IsSet("Authorization"))
164 /* Password has been given, validate it */
165 std::string authorization = http->headers->GetHeader("Authorization");
166 irc::spacesepstream sep(authorization);
167 std::string authtype;
170 sep.GetToken(authtype);
171 if (authtype == "Basic")
176 sep.GetToken(base64);
177 std::string userpass = Base64ToBin(base64);
178 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "HTTP authorization: %s (%s)", userpass.c_str(), base64.c_str());
180 irc::sepstream userpasspair(userpass, ':');
181 if (userpasspair.GetToken(user))
183 userpasspair.GetToken(pass);
185 /* Access granted if username and password are correct */
186 if (user == this_acl->username && pass == this_acl->password)
188 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "HTTP authorization: password and username match");
192 /* Invalid password */
193 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
196 /* Malformed user:pass pair */
197 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
200 /* Unsupported authentication type */
201 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
205 /* No password given at all, access denied */
206 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
211 /* A path may only match one ACL (the first it finds in the config file) */
219 ModResult OnHTTPACLCheck(HTTPRequest& req) CXX11_OVERRIDE
221 if (IsAccessAllowed(&req))
222 return MOD_RES_PASSTHRU;
226 Version GetVersion() CXX11_OVERRIDE
228 return Version("Provides access control lists (passwording of resources, ip restrictions etc) to m_httpd dependent modules", VF_VENDOR);
232 MODULE_INIT(ModuleHTTPAccessList)