src/modules/m_httpd_acl.cpp

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