src/modules/m_spanningtree/treesocket.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #pragma once
  24
  25 #include "inspircd.h"
  26
  27 #include "utils.h"
  28
  29 /*
  30  * The server list in InspIRCd is maintained as two structures
  31  * which hold the data in different ways. Most of the time, we
  32  * want to very quicky obtain three pieces of information:
  33  *
  34  * (1) The information on a server
  35  * (2) The information on the server we must send data through
  36  *     to actually REACH the server we're after
  37  * (3) Potentially, the child/parent objects of this server
  38  *
  39  * The InspIRCd spanning protocol provides easy access to these
  40  * by storing the data firstly in a recursive structure, where
  41  * each item references its parent item, and a dynamic list
  42  * of child items, and another structure which stores the items
  43  * hashed, linearly. This means that if we want to find a server
  44  * by name quickly, we can look it up in the hash, avoiding
  45  * any O(n) lookups. If however, during a split or sync, we want
  46  * to apply an operation to a server, and any of its child objects
  47  * we can resort to recursion to walk the tree structure.
  48  * Any socket can have one of five states at any one time.
  49  *
  50  * CONNECTING:  indicates an outbound socket which is
  51  *                                                      waiting to be writeable.
  52  * WAIT_AUTH_1: indicates the socket is outbound and
  53  *                                                      has successfully connected, but has not
  54  *                                                      yet sent and received SERVER strings.
  55  * WAIT_AUTH_2: indicates that the socket is inbound
  56  *                                                      but has not yet sent and received
  57  *                                                      SERVER strings.
  58  * CONNECTED:   represents a fully authorized, fully
  59  *                                                      connected server.
  60  * DYING:       represents a server that has had an error.
  61  */
  62 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
  63
  64 struct CapabData
  65 {
  66         reference<Link> link;                   /* Link block used for this connection */
  67         reference<Autoconnect> ac;              /* Autoconnect used to cause this connection, if any */
  68         std::string ModuleList;                 /* Required module list of other server from CAPAB */
  69         std::string OptModuleList;              /* Optional module list of other server from CAPAB */
  70         std::string ChanModes;
  71         std::string UserModes;
  72         std::map<std::string,std::string> CapKeys;      /* CAPAB keys from other server */
  73         std::string ourchallenge;               /* Challenge sent for challenge/response */
  74         std::string theirchallenge;             /* Challenge recv for challenge/response */
  75         int capab_phase;                        /* Have sent CAPAB already */
  76         bool auth_fingerprint;                  /* Did we auth using SSL certificate fingerprint */
  77         bool auth_challenge;                    /* Did we auth using challenge/response */
  78
  79         // Data saved from incoming SERVER command, for later use when our credentials have been accepted by the other party
  80         std::string description;
  81         std::string sid;
  82         std::string name;
  83         bool hidden;
  84 };
  85
  86 /** Every SERVER connection inbound or outbound is represented by an object of
  87  * type TreeSocket. During setup, the object can be found in Utils->timeoutlist;
  88  * after setup, MyRoot will have been created as a child of Utils->TreeRoot
  89  */
  90 class TreeSocket : public BufferedSocket
  91 {
  92         struct BurstState;
  93
  94         std::string linkID;                     /* Description for this link */
  95         ServerState LinkState;                  /* Link state */
  96         CapabData* capab;                       /* Link setup data (held until burst is sent) */
  97         TreeServer* MyRoot;                     /* The server we are talking to */
  98         time_t NextPing;                        /* Time when we are due to ping this server */
  99         bool LastPingWasGood;                   /* Responded to last ping we sent? */
 100         int proto_version;                      /* Remote protocol version */
 101         bool ConnectionFailureShown; /* Set to true if a connection failure message was shown */
 102
 103         /** Checks if the given servername and sid are both free
 104          */
 105         bool CheckDuplicate(const std::string& servername, const std::string& sid);
 106
 107         /** Send all ListModeBase modes set on the channel
 108          */
 109         void SendListModes(Channel* chan);
 110
 111         /** Send all known information about a channel */
 112         void SyncChannel(Channel* chan, BurstState& bs);
 113
 114         /** Send all users and their oper state, away state and metadata */
 115         void SendUsers(BurstState& bs);
 116
 117         /** Send all additional info about the given server to this server */
 118         void SendServerInfo(TreeServer* from);
 119
 120         /** Find the User source of a command given a prefix and a command string.
 121          * This connection must be fully up when calling this function.
 122          * @param prefix Prefix string to find the source User object for. Can be a sid, a uuid or a server name.
 123          * @param command The command whose source to find. This is required because certain commands (like mode
 124          * changes and kills) must be processed even if their claimed source doesn't exist. If the given command is
 125          * such a command and the source does not exist, the function returns a valid FakeUser that can be used to
 126          * to process the command with.
 127          * @return The command source to use when processing the command or NULL if the source wasn't found.
 128          * Note that the direction of the returned source is not verified.
 129          */
 130         User* FindSource(const std::string& prefix, const std::string& command);
 131
 132         /** Finish the authentication phase of this connection.
 133          * Change the state of the connection to CONNECTED, create a TreeServer object for the server on the
 134          * other end of the connection using the details provided in the parameters, and finally send a burst.
 135          * @param remotename Name of the remote server
 136          * @param remotesid SID of the remote server
 137          * @param remotedesc Description of the remote server
 138          * @param hidden True if the remote server is hidden according to the configuration
 139          */
 140         void FinishAuth(const std::string& remotename, const std::string& remotesid, const std::string& remotedesc, bool hidden);
 141
 142         /** Authenticate the remote server.
 143          * Validate the parameters and find the link block that matches the remote server. In case of an error,
 144          * an appropriate snotice is generated, an ERROR message is sent and the connection is closed.
 145          * Failing to find a matching link block counts as an error.
 146          * @param params Parameters they sent in the SERVER command
 147          * @return Link block for the remote server, or NULL if an error occurred
 148          */
 149         Link* AuthRemote(const parameterlist& params);
 150
 151         /** Write a line on this socket with a new line character appended, skipping all translation for old protocols
 152          * @param line Line to write without a new line character at the end
 153          */
 154         void WriteLineNoCompat(const std::string& line);
 155
 156  public:
 157         const time_t age;
 158
 159         /** Because most of the I/O gubbins are encapsulated within
 160          * BufferedSocket, we just call the superclass constructor for
 161          * most of the action, and append a few of our own values
 162          * to it.
 163          */
 164         TreeSocket(Link* link, Autoconnect* myac, const std::string& ipaddr);
 165
 166         /** When a listening socket gives us a new file descriptor,
 167          * we must associate it with a socket without creating a new
 168          * connection. This constructor is used for this purpose.
 169          */
 170         TreeSocket(int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 171
 172         /** Get link state
 173          */
 174         ServerState GetLinkState();
 175
 176         /** Get challenge set in our CAPAB for challenge/response
 177          */
 178         const std::string& GetOurChallenge();
 179
 180         /** Get challenge set in our CAPAB for challenge/response
 181          */
 182         void SetOurChallenge(const std::string &c);
 183
 184         /** Get challenge set in their CAPAB for challenge/response
 185          */
 186         const std::string& GetTheirChallenge();
 187
 188         /** Get challenge set in their CAPAB for challenge/response
 189          */
 190         void SetTheirChallenge(const std::string &c);
 191
 192         /** Compare two passwords based on authentication scheme
 193          */
 194         bool ComparePass(const Link& link, const std::string &theirs);
 195
 196         /** Clean up information used only during server negotiation
 197          */
 198         void CleanNegotiationInfo();
 199
 200         CullResult cull();
 201         /** Destructor
 202          */
 203         ~TreeSocket();
 204
 205         /** Construct a password, optionally hashed with the other side's
 206          * challenge string
 207          */
 208         std::string MakePass(const std::string &password, const std::string &challenge);
 209
 210         /** When an outbound connection finishes connecting, we receive
 211          * this event, and must send our SERVER string to the other
 212          * side. If the other side is happy, as outlined in the server
 213          * to server docs on the inspircd.org site, the other side
 214          * will then send back its own server string.
 215          */
 216         void OnConnected();
 217
 218         /** Handle socket error event
 219          */
 220         void OnError(BufferedSocketError e) CXX11_OVERRIDE;
 221
 222         /** Sends an error to the remote server, and displays it locally to show
 223          * that it was sent.
 224          */
 225         void SendError(const std::string &errormessage);
 226
 227         /** Recursively send the server tree with distances as hops.
 228          * This is used during network burst to inform the other server
 229          * (and any of ITS servers too) of what servers we know about.
 230          */
 231         void SendServers(TreeServer* Current, TreeServer* s);
 232
 233         /** Returns module list as a string, filtered by filter
 234          * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
 235          */
 236         std::string MyModules(int filter);
 237
 238         /** Send my capabilities to the remote side
 239          */
 240         void SendCapabilities(int phase);
 241
 242         /* Isolate and return the elements that are different between two lists */
 243         void ListDifference(const std::string &one, const std::string &two, char sep,
 244                 std::string& mleft, std::string& mright);
 245
 246         bool Capab(const parameterlist &params);
 247
 248         /** This function forces this server to quit, removing this server
 249          * and any users on it (and servers and users below that, etc etc).
 250          * It's very slow and pretty clunky, but luckily unless your network
 251          * is having a REAL bad hair day, this function shouldnt be called
 252          * too many times a month ;-)
 253          */
 254         void SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users);
 255
 256         /** This is a wrapper function for SquitServer above, which
 257          * does some validation first and passes on the SQUIT to all
 258          * other remaining servers.
 259          */
 260         void Squit(TreeServer* Current, const std::string &reason);
 261
 262         /** Send one or more FJOINs for a channel of users.
 263          * If the length of a single line is more than 480-NICKMAX
 264          * in length, it is split over multiple lines.
 265          */
 266         void SendFJoins(Channel* c);
 267
 268         /** Send G, Q, Z and E lines */
 269         void SendXLines();
 270
 271         /** Send all known information about a channel */
 272         void SyncChannel(Channel* chan);
 273
 274         /** This function is called when we want to send a netburst to a local
 275          * server. There is a set order we must do this, because for example
 276          * users require their servers to exist, and channels require their
 277          * users to exist. You get the idea.
 278          */
 279         void DoBurst(TreeServer* s);
 280
 281         /** This function is called when we receive data from a remote
 282          * server.
 283          */
 284         void OnDataReady();
 285
 286         /** Send one or more complete lines down the socket
 287          */
 288         void WriteLine(const std::string& line);
 289
 290         /** Handle ERROR command */
 291         void Error(parameterlist &params);
 292
 293         /** (local) -> SERVER
 294          */
 295         bool Outbound_Reply_Server(parameterlist &params);
 296
 297         /** (local) <- SERVER
 298          */
 299         bool Inbound_Server(parameterlist &params);
 300
 301         /** Handle IRC line split
 302          */
 303         void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist &params);
 304
 305         /** Process complete line from buffer
 306          */
 307         void ProcessLine(std::string &line);
 308
 309         void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
 310
 311         /** Handle socket timeout from connect()
 312          */
 313         void OnTimeout();
 314         /** Handle server quit on close
 315          */
 316         void Close();
 317
 318         /** Returns true if this server was introduced to the rest of the network
 319          */
 320         bool Introduced();
 321
 322         /** Fixes messages coming from old servers so the new command handlers understand them
 323          */
 324         bool PreProcessOldProtocolMessage(User*& who, std::string& cmd, std::vector<std::string>& params);
 325 };