Refactor m_sqloper to be a full opers.conf replacement (#983).

m_sqloper now supports dynamic fields, works with m_sslinfo, and works with /stats o.

diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index f46526dfc9d1e6c30db27276fe25159ca5a7330b..84cc8efc7975ac5f0fa2305f157f0d7c1765515e 100644 (file)
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -2012,18 +2012,20 @@
 # https://wiki.inspircd.org/Modules/3.0/sqlauth                       #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# SQL oper module: Allows you to store oper credentials in an SQL table
+# SQL oper module: Allows you to store oper credentials in an SQL
+# table. You can add additional table columns like you would config
+# tags in opers.conf. Opers in opers.conf will override opers from
+# this module.
 #
 #<module name="sqloper">
 #
 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # dbid       - Database ID to use (see SQL modules).                  #
-# hash       - Hashing provider to use for password hashing.          #
 #                                                                     #
 # See also: https://wiki.inspircd.org/Modules/3.0/sqloper             #
 #                                                                     #
-#<sqloper dbid="1" hash="bcrypt">
+#<sqloper dbid="1">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # StartTLS module: Implements STARTTLS, which allows clients          #

diff --git a/extras/m_sqloper.mysql.sql b/extras/m_sqloper.mysql.sql
index f4349580682b2903d2f21156cb3214fb53c39b86..a8a2b7e1db9049dd81f361b5701493db9e23b495 100644 (file)
--- a/extras/m_sqloper.mysql.sql
+++ b/extras/m_sqloper.mysql.sql
@@ -1,9 +1,12 @@
 CREATE TABLE ircd_opers (
   id bigint(20) NOT NULL auto_increment,
-  username text,
-  password text,
-  hostname text,
-  type text,
+  name text NOT NULL,
+  password text NOT NULL,
+  hash text,
+  host text NOT NULL,
+  type text NOT NULL,
+  fingerprint text,
+  autologin tinyint(1) NOT NULL DEFAULT 0,
   active tinyint(1) NOT NULL DEFAULT 1,
   PRIMARY KEY  (id)
 ) ENGINE=MyISAM;

diff --git a/extras/m_sqloper.postgresql.sql b/extras/m_sqloper.postgresql.sql
index 4244abc22ca668dc4cc54f82fcc6ff06a6e6ff0a..0b3cdb8dc051a562dd7fc56885d9a0f27d07c908 100644 (file)
--- a/extras/m_sqloper.postgresql.sql
+++ b/extras/m_sqloper.postgresql.sql
@@ -1,10 +1,13 @@
 CREATE TABLE ircd_opers (
-    id serial NOT NULL,
-    username text,
-    "password" text,
-    hostname text,
-    "type" text,
-    active boolean NOT NULL DEFAULT 1
+    "id" serial NOT NULL,
+    "name" text NOT NULL,
+    "password" text NOT NULL,
+    "hash" text,
+    "host" text NOT NULL,
+    "type" text NOT NULL,
+    "fingerprint" text,
+    "autologin" boolean NOT NULL DEFAULT 0,
+    "active" boolean NOT NULL DEFAULT 1
 );
 ALTER TABLE ONLY ircd_opers
     ADD CONSTRAINT ircd_opers_pkey PRIMARY KEY (id);

diff --git a/extras/m_sqloper.sqlite3.sql b/extras/m_sqloper.sqlite3.sql
index 1c607e664e8afa84ca8d80a60fc6d65af8068e6c..6aec5a1185a6e5192017b15a909d1dc27c6a61c4 100644 (file)
--- a/extras/m_sqloper.sqlite3.sql
+++ b/extras/m_sqloper.sqlite3.sql
@@ -1,7 +1,10 @@
 CREATE TABLE ircd_opers (
 id integer primary key,
-username text,
-password text,
-hostname text,
-type text,
+name text NOT NULL,
+password text NOT NULL,
+hash text,
+host text NOT NULL,
+type text NOT NULL,
+fingerprint text,
+autologin integer NOT NULL DEFAULT 0,
 active integer NOT NULL DEFAULT 1);

diff --git a/src/coremods/core_stats.cpp b/src/coremods/core_stats.cpp
index 878ea2fae70c2e88debe207b7348a541283998cf..d14aef15499952f2e2fa0808325f5b5cd0dc5c4f 100644 (file)
--- a/src/coremods/core_stats.cpp
+++ b/src/coremods/core_stats.cpp
@@ -309,10 +309,10 @@ void CommandStats::DoStats(Stats::Context& stats)
                /* stats o */
                case 'o':
                {
-                       ConfigTagList tags = ServerInstance->Config->ConfTags("oper");
-                       for(ConfigIter i = tags.first; i != tags.second; ++i)
+                       for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.begin(); i != ServerInstance->Config->oper_blocks.end(); ++i)
                        {
-                               ConfigTag* tag = i->second;
+                               OperInfo* ifo = i->second;
+                               ConfigTag* tag = ifo->oper_block;
                                stats.AddRow(243, 'O', tag->getString("host"), '*', tag->getString("name"), tag->getString("type"), '0');
                        }
                }

diff --git a/src/modules/m_sqloper.cpp b/src/modules/m_sqloper.cpp
index d4baae7d224d975205a8176ee787555f12876556..4728170192e8cbc6c47d644643fe3cac36f96904 100644 (file)
--- a/src/modules/m_sqloper.cpp
+++ b/src/modules/m_sqloper.cpp
@@ -1,6 +1,7 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2017 Dylan Frank <b00mx0r@aureus.pw>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
@@ -19,49 +20,110 @@
 
 #include "inspircd.h"
 #include "modules/sql.h"
-#include "modules/hash.h"
 
 class OperQuery : public SQL::Query
 {
  public:
+       // This variable will store all the OPER blocks from the DB
+       std::vector<std::string>& my_blocks;
+       /** We want to store the username and password if this is called during an /OPER, as we're responsible for /OPER post-DB fetch
+        *  Note: uid will be empty if this DB update was not called as a result of a user command (i.e. /REHASH)
+        */
        const std::string uid, username, password;
-       OperQuery(Module* me, const std::string& u, const std::string& un, const std::string& pw)
+       OperQuery(Module* me, std::vector<std::string>& mb, const std::string& u, const std::string& un, const std::string& pw)
                : SQL::Query(me)
+               , my_blocks(mb)
                , uid(u)
                , username(un)
                , password(pw)
        {
        }
+       OperQuery(Module* me, std::vector<std::string>& mb)
+               : SQL::Query(me)
+               , my_blocks(mb)
+       {
+       }
 
        void OnResult(SQL::Result& res) CXX11_OVERRIDE
        {
-               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "result for %s", uid.c_str());
-               User* user = ServerInstance->FindNick(uid);
-               if (!user)
-                       return;
+               ServerConfig::OperIndex& oper_blocks = ServerInstance->Config->oper_blocks;
+
+               // Remove our previous blocks from oper_blocks for a clean update
+               for (std::vector<std::string>::const_iterator i = my_blocks.begin(); i != my_blocks.end(); ++i)
+               {
+                       oper_blocks.erase(*i);
+               }
+               my_blocks.clear();
 
-               // multiple rows may exist
                SQL::Row row;
+               // Iterate through DB results to create oper blocks from sqloper rows
                while (res.GetRow(row))
                {
-                       if (OperUser(user, row[0], row[1]))
-                               return;
+                       std::vector<std::string> cols;
+                       res.GetCols(cols);
+
+                       // Create the oper tag as if we were the conf file.
+                       ConfigItems* items;
+                       reference<ConfigTag> tag = ConfigTag::create("oper", MODNAME, 0, items);
+
+                       /** Iterate through each column in the SQLOpers table. An infinite number of fields can be specified.
+                        *  Column 'x' with cell value 'y' will be the same as x=y in an OPER block in opers.conf.
+                        */
+                       for (unsigned int i=0; i < cols.size(); ++i)
+                       {
+                               if (!row[i].IsNull())
+                                       (*items)[cols[i]] = row[i];
+                       }
+                       const std::string name = tag->getString("name");
+
+                       // Skip both duplicate sqloper blocks and sqloper blocks that attempt to override conf blocks.
+                       if (oper_blocks.find(name) != oper_blocks.end())
+                               continue;
+
+                       const std::string type = tag->getString("type");
+                       ServerConfig::OperIndex::iterator tblk = ServerInstance->Config->OperTypes.find(type);
+                       if (tblk == ServerInstance->Config->OperTypes.end())
+                       {
+                               ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Sqloper block " + name + " has missing type " + type);
+                               ServerInstance->SNO->WriteGlobalSno('a', "m_sqloper: Oper block %s has missing type %s", name.c_str(), type.c_str());
+                               continue;
+                       }
+
+                       OperInfo* ifo = new OperInfo(type);
+
+                       ifo->type_block = tblk->second->type_block;
+                       ifo->oper_block = tag;
+                       ifo->class_blocks.assign(tblk->second->class_blocks.begin(), tblk->second->class_blocks.end());
+                       oper_blocks[name] = ifo;
+                       my_blocks.push_back(name);
+               }
+
+               // If this was done as a result of /OPER and not a config read
+               if (!uid.empty())
+               {
+                       // Now that we've updated the DB, call any other /OPER hooks and then call /OPER
+                       OperExec();
                }
-               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "no matches for %s (checked %d rows)", uid.c_str(), res.Rows());
-               // nobody succeeded... fall back to OPER
-               fallback();
        }
 
        void OnError(SQL::Error& error) CXX11_OVERRIDE
        {
                ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "query failed (%s)", error.ToString());
-               fallback();
+               ServerInstance->SNO->WriteGlobalSno('a', "m_sqloper: failed to update blocks from database");
+               if (!uid.empty())
+               {
+                       // Fallback. We don't want to block a netadmin from /OPER
+                       OperExec();
+               }
        }
 
-       void fallback()
+       // Call /oper after placing all blocks from the SQL table into the config->oper_blocks list.
+       void OperExec()
        {
                User* user = ServerInstance->FindNick(uid);
-               if (!user)
+               LocalUser* localuser = IS_LOCAL(user);
+               // This should never be true
+               if (!localuser)
                        return;
 
                Command* oper_command = ServerInstance->Parser.GetHandler("OPER");
@@ -71,6 +133,16 @@ class OperQuery : public SQL::Query
                        std::vector<std::string> params;
                        params.push_back(username);
                        params.push_back(password);
+
+                       // Begin callback to other modules (i.e. sslinfo) now that we completed the DB fetch
+                       ModResult MOD_RESULT;
+
+                       std::string origin = "OPER";
+                       FIRST_MOD_RESULT(OnPreCommand, MOD_RESULT, (origin, params, localuser, true, origin));
+                       if (MOD_RESULT == MOD_RES_DENY)
+                               return;
+
+                       // Now handle /OPER.
                        oper_command->Handle(params, user);
                }
                else
@@ -78,44 +150,29 @@ class OperQuery : public SQL::Query
                        ServerInstance->Logs->Log(MODNAME, LOG_SPARSE, "BUG: WHAT?! Why do we have no OPER command?!");
                }
        }
-
-       bool OperUser(User* user, const std::string &pattern, const std::string &type)
-       {
-               ServerConfig::OperIndex::const_iterator iter = ServerInstance->Config->OperTypes.find(type);
-               if (iter == ServerInstance->Config->OperTypes.end())
-               {
-                       ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "bad type '%s' in returned row for oper %s", type.c_str(), username.c_str());
-                       return false;
-               }
-               OperInfo* ifo = iter->second;
-
-               std::string hostname(user->ident);
-
-               hostname.append("@").append(user->GetRealHost());
-
-               if (InspIRCd::MatchMask(pattern, hostname, user->GetIPString()))
-               {
-                       /* Opertype and host match, looks like this is it. */
-
-                       user->Oper(ifo);
-                       return true;
-               }
-
-               return false;
-       }
 };
 
 class ModuleSQLOper : public Module
 {
+       // Whether OperQuery is running
+       bool active;
        std::string query;
-       std::string hashtype;
+       // Stores oper blocks from DB
+       std::vector<std::string> my_blocks;
        dynamic_reference<SQL::Provider> SQL;
 
 public:
-       ModuleSQLOper() : SQL(this, "SQL") {}
+       ModuleSQLOper()
+               : active(false)
+               , SQL(this, "SQL")
+       {
+       }
 
        void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
+               // Clear list of our blocks, as ConfigReader just wiped them anyway
+               my_blocks.clear();
+
                ConfigTag* tag = ServerInstance->Config->ConfValue("sqloper");
 
                std::string dbid = tag->getString("dbid");
@@ -124,35 +181,61 @@ public:
                else
                        SQL.SetProvider("SQL/" + dbid);
 
-               hashtype = tag->getString("hash");
-               query = tag->getString("query", "SELECT hostname as host, type FROM ircd_opers WHERE username='$username' AND password='$password' AND active=1;");
+               query = tag->getString("query", "SELECT * FROM ircd_opers WHERE active=1;");
+               // Update sqloper list from the database.
+               GetOperBlocks();
        }
 
-       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
+       ~ModuleSQLOper()
        {
-               if (validated && command == "OPER" && parameters.size() >= 2)
+               // Remove all oper blocks that were from the DB
+               for (std::vector<std::string>::const_iterator i = my_blocks.begin(); i != my_blocks.end(); ++i)
+               {
+                       ServerInstance->Config->oper_blocks.erase(*i);
+               }
+       }
+
+       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser* user, bool validated, const std::string& original_line) CXX11_OVERRIDE
+       {
+               // If we are not in the middle of an existing /OPER and someone is trying to oper-up
+               if (validated && command == "OPER" && parameters.size() >= 2 && !active)
                {
                        if (SQL)
                        {
-                               LookupOper(user, parameters[0], parameters[1]);
-                               /* Query is in progress, it will re-invoke OPER if needed */
+                               GetOperBlocks(user->uuid, parameters[0], parameters[1]);
+                               /** We need to reload oper blocks from the DB before other
+                                *  hooks can run (i.e. sslinfo). We will re-call /OPER later.
+                                */
                                return MOD_RES_DENY;
                        }
                        ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "database not present");
                }
+               else if (active)
+               {
+                       active = false;
+               }
+               // There is either no DB or we successfully reloaded oper blocks
                return MOD_RES_PASSTHRU;
        }
 
-       void LookupOper(User* user, const std::string &username, const std::string &password)
+       // The one w/o params is for non-/OPER DB updates, such as a rehash.
+       void GetOperBlocks()
        {
-               HashProvider* hash = ServerInstance->Modules->FindDataService<HashProvider>("hash/" + hashtype);
-
-               SQL::ParamMap userinfo;
-               SQL::PopulateUserInfo(user, userinfo);
-               userinfo["username"] = username;
-               userinfo["password"] = hash ? hash->Generate(password) : password;
+               SQL->Submit(new OperQuery(this, my_blocks), query);
+       }
+       void GetOperBlocks(const std::string u, const std::string& un, const std::string& pw)
+       {
+               active = true;
+               // Call to SQL query to fetch oper list from SQL table.
+               SQL->Submit(new OperQuery(this, my_blocks, u, un, pw), query);
+       }
 
-               SQL->Submit(new OperQuery(this, user->uuid, username, password), query, userinfo);
+       void Prioritize() CXX11_OVERRIDE
+       {
+               /** Run before other /OPER hooks that expect populated blocks, i.e. sslinfo or a TOTP module.
+                *  We issue a DENY first, and will re-run OnPreCommand later to trigger the other hooks post-DB update.
+                */
+               ServerInstance->Modules.SetPriority(this, I_OnPreCommand, PRIORITY_FIRST);
        }
 
        Version GetVersion() CXX11_OVERRIDE