src/modules/m_httpd_acl.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *
   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.
  10  *
  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
  14  * details.
  15  *
  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/>.
  18  */
  19
  20
  21 #include "inspircd.h"
  22 #include "modules/httpd.h"
  23
  24 class HTTPACL
  25 {
  26  public:
  27         std::string path;
  28         std::string username;
  29         std::string password;
  30         std::string whitelist;
  31         std::string blacklist;
  32
  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) { }
  37 };
  38
  39 class ModuleHTTPAccessList : public Module, public HTTPACLEventListener
  40 {
  41         std::string stylesheet;
  42         std::vector<HTTPACL> acl_list;
  43         HTTPdAPI API;
  44
  45  public:
  46         ModuleHTTPAccessList()
  47                 : HTTPACLEventListener(this)
  48                 , API(this)
  49         {
  50         }
  51
  52         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
  53         {
  54                 acl_list.clear();
  55                 ConfigTagList acls = ServerInstance->Config->ConfTags("httpdacl");
  56                 for (ConfigIter i = acls.first; i != acls.second; i++)
  57                 {
  58                         ConfigTag* c = i->second;
  59                         std::string path = c->getString("path");
  60                         std::string types = c->getString("types");
  61                         irc::commasepstream sep(types);
  62                         std::string type;
  63                         std::string username;
  64                         std::string password;
  65                         std::string whitelist;
  66                         std::string blacklist;
  67
  68                         while (sep.GetToken(type))
  69                         {
  70                                 if (type == "password")
  71                                 {
  72                                         username = c->getString("username");
  73                                         password = c->getString("password");
  74                                 }
  75                                 else if (type == "whitelist")
  76                                 {
  77                                         whitelist = c->getString("whitelist");
  78                                 }
  79                                 else if (type == "blacklist")
  80                                 {
  81                                         blacklist = c->getString("blacklist");
  82                                 }
  83                                 else
  84                                 {
  85                                         throw ModuleException("Invalid HTTP ACL type '" + type + "'");
  86                                 }
  87                         }
  88
  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());
  91
  92                         acl_list.push_back(HTTPACL(path, username, password, whitelist, blacklist));
  93                 }
  94         }
  95
  96         void BlockAccess(HTTPRequest* http, int returnval, const std::string &extraheaderkey = "", const std::string &extraheaderval="")
  97         {
  98                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "BlockAccess (%d)", returnval);
  99
 100                 std::stringstream data("Access to this resource is denied by an access control list. Please contact your IRC administrator.");
 101                 HTTPDocumentResponse response(this, *http, &data, returnval);
 102                 response.headers.SetHeader("X-Powered-By", MODNAME);
 103                 if (!extraheaderkey.empty())
 104                         response.headers.SetHeader(extraheaderkey, extraheaderval);
 105                 API->SendResponse(response);
 106         }
 107
 108         bool IsAccessAllowed(HTTPRequest* http)
 109         {
 110                 {
 111                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Handling httpd acl event");
 112
 113                         for (std::vector<HTTPACL>::const_iterator this_acl = acl_list.begin(); this_acl != acl_list.end(); ++this_acl)
 114                         {
 115                                 if (InspIRCd::Match(http->GetURI(), this_acl->path, ascii_case_insensitive_map))
 116                                 {
 117                                         if (!this_acl->blacklist.empty())
 118                                         {
 119                                                 /* Blacklist */
 120                                                 irc::commasepstream sep(this_acl->blacklist);
 121                                                 std::string entry;
 122
 123                                                 while (sep.GetToken(entry))
 124                                                 {
 125                                                         if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
 126                                                         {
 127                                                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Denying access to blacklisted resource %s (matched by pattern %s) from ip %s (matched by entry %s)",
 128                                                                                 http->GetURI().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), entry.c_str());
 129                                                                 BlockAccess(http, 403);
 130                                                                 return false;
 131                                                         }
 132                                                 }
 133                                         }
 134                                         if (!this_acl->whitelist.empty())
 135                                         {
 136                                                 /* Whitelist */
 137                                                 irc::commasepstream sep(this_acl->whitelist);
 138                                                 std::string entry;
 139                                                 bool allow_access = false;
 140
 141                                                 while (sep.GetToken(entry))
 142                                                 {
 143                                                         if (InspIRCd::Match(http->GetIP(), entry, ascii_case_insensitive_map))
 144                                                                 allow_access = true;
 145                                                 }
 146
 147                                                 if (!allow_access)
 148                                                 {
 149                                                         ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Denying access to whitelisted resource %s (matched by pattern %s) from ip %s (Not in whitelist)",
 150                                                                         http->GetURI().c_str(), this_acl->path.c_str(), http->GetIP().c_str());
 151                                                         BlockAccess(http, 403);
 152                                                         return false;
 153                                                 }
 154                                         }
 155                                         if (!this_acl->password.empty() && !this_acl->username.empty())
 156                                         {
 157                                                 /* Password auth, first look to see if we have a basic authentication header */
 158                                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Checking HTTP auth password for resource %s (matched by pattern %s) from ip %s, against username %s",
 159                                                                 http->GetURI().c_str(), this_acl->path.c_str(), http->GetIP().c_str(), this_acl->username.c_str());
 160
 161                                                 if (http->headers->IsSet("Authorization"))
 162                                                 {
 163                                                         /* Password has been given, validate it */
 164                                                         std::string authorization = http->headers->GetHeader("Authorization");
 165                                                         irc::spacesepstream sep(authorization);
 166                                                         std::string authtype;
 167                                                         std::string base64;
 168
 169                                                         sep.GetToken(authtype);
 170                                                         if (authtype == "Basic")
 171                                                         {
 172                                                                 std::string user;
 173                                                                 std::string pass;
 174
 175                                                                 sep.GetToken(base64);
 176                                                                 std::string userpass = Base64ToBin(base64);
 177                                                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "HTTP authorization: %s (%s)", userpass.c_str(), base64.c_str());
 178
 179                                                                 irc::sepstream userpasspair(userpass, ':');
 180                                                                 if (userpasspair.GetToken(user))
 181                                                                 {
 182                                                                         userpasspair.GetToken(pass);
 183
 184                                                                         /* Access granted if username and password are correct */
 185                                                                         if (user == this_acl->username && pass == this_acl->password)
 186                                                                         {
 187                                                                                 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "HTTP authorization: password and username match");
 188                                                                                 return true;
 189                                                                         }
 190                                                                         else
 191                                                                                 /* Invalid password */
 192                                                                                 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
 193                                                                 }
 194                                                                 else
 195                                                                         /* Malformed user:pass pair */
 196                                                                         BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
 197                                                         }
 198                                                         else
 199                                                                 /* Unsupported authentication type */
 200                                                                 BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
 201                                                 }
 202                                                 else
 203                                                 {
 204                                                         /* No password given at all, access denied */
 205                                                         BlockAccess(http, 401, "WWW-Authenticate", "Basic realm=\"Restricted Object\"");
 206                                                 }
 207                                                 return false;
 208                                         }
 209
 210                                         /* A path may only match one ACL (the first it finds in the config file) */
 211                                         break;
 212                                 }
 213                         }
 214                 }
 215                 return true;
 216         }
 217
 218         ModResult OnHTTPACLCheck(HTTPRequest& req) CXX11_OVERRIDE
 219         {
 220                 if (IsAccessAllowed(&req))
 221                         return MOD_RES_PASSTHRU;
 222                 return MOD_RES_DENY;
 223         }
 224
 225         Version GetVersion() CXX11_OVERRIDE
 226         {
 227                 return Version("Provides access control lists (passwording of resources, ip restrictions etc) to m_httpd dependent modules", VF_VENDOR);
 228         }
 229 };
 230
 231 MODULE_INIT(ModuleHTTPAccessList)