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 fingerprint */
  77         bool auth_challenge;                    /* Did we auth using challenge/response */
  78 };
  79
  80 /** Every SERVER connection inbound or outbound is represented by an object of
  81  * type TreeSocket. During setup, the object can be found in Utils->timeoutlist;
  82  * after setup, MyRoot will have been created as a child of Utils->TreeRoot
  83  */
  84 class TreeSocket : public BufferedSocket
  85 {
  86         SpanningTreeUtilities* Utils;           /* Utility class */
  87         std::string linkID;                     /* Description for this link */
  88         ServerState LinkState;                  /* Link state */
  89         CapabData* capab;                       /* Link setup data (held until burst is sent) */
  90         TreeServer* MyRoot;                     /* The server we are talking to */
  91         time_t NextPing;                        /* Time when we are due to ping this server */
  92         bool LastPingWasGood;                   /* Responded to last ping we sent? */
  93         int proto_version;                      /* Remote protocol version */
  94         bool ConnectionFailureShown; /* Set to true if a connection failure message was shown */
  95  public:
  96         time_t age;
  97
  98         /** Because most of the I/O gubbins are encapsulated within
  99          * BufferedSocket, we just call the superclass constructor for
 100          * most of the action, and append a few of our own values
 101          * to it.
 102          */
 103         TreeSocket(SpanningTreeUtilities* Util, Link* link, Autoconnect* myac, const std::string& ipaddr);
 104
 105         /** When a listening socket gives us a new file descriptor,
 106          * we must associate it with a socket without creating a new
 107          * connection. This constructor is used for this purpose.
 108          */
 109         TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 110
 111         /** Get link state
 112          */
 113         ServerState GetLinkState();
 114
 115         /** Get challenge set in our CAPAB for challenge/response
 116          */
 117         const std::string& GetOurChallenge();
 118
 119         /** Get challenge set in our CAPAB for challenge/response
 120          */
 121         void SetOurChallenge(const std::string &c);
 122
 123         /** Get challenge set in their CAPAB for challenge/response
 124          */
 125         const std::string& GetTheirChallenge();
 126
 127         /** Get challenge set in their CAPAB for challenge/response
 128          */
 129         void SetTheirChallenge(const std::string &c);
 130
 131         /** Compare two passwords based on authentication scheme
 132          */
 133         bool ComparePass(const Link& link, const std::string &theirs);
 134
 135         /** Clean up information used only during server negotiation
 136          */
 137         void CleanNegotiationInfo();
 138
 139         CullResult cull();
 140         /** Destructor
 141          */
 142         ~TreeSocket();
 143
 144         /** Construct a password, optionally hashed with the other side's
 145          * challenge string
 146          */
 147         std::string MakePass(const std::string &password, const std::string &challenge);
 148
 149         /** When an outbound connection finishes connecting, we receive
 150          * this event, and must send our SERVER string to the other
 151          * side. If the other side is happy, as outlined in the server
 152          * to server docs on the inspircd.org site, the other side
 153          * will then send back its own server string.
 154          */
 155         virtual void OnConnected();
 156
 157         /** Handle socket error event
 158          */
 159         virtual void OnError(BufferedSocketError e);
 160
 161         /** Sends an error to the remote server, and displays it locally to show
 162          * that it was sent.
 163          */
 164         void SendError(const std::string &errormessage);
 165
 166         /** Recursively send the server tree with distances as hops.
 167          * This is used during network burst to inform the other server
 168          * (and any of ITS servers too) of what servers we know about.
 169          * If at any point any of these servers already exist on the other
 170          * end, our connection may be terminated. The hopcounts given
 171          * by this function are relative, this doesn't matter so long as
 172          * they are all >1, as all the remote servers re-calculate them
 173          * to be relative too, with themselves as hop 0.
 174          */
 175         void SendServers(TreeServer* Current, TreeServer* s, int hops);
 176
 177         /** Returns module list as a string, filtered by filter
 178          * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
 179          */
 180         std::string MyModules(int filter);
 181
 182         /** Send my capabilities to the remote side
 183          */
 184         void SendCapabilities(int phase);
 185
 186         /* Isolate and return the elements that are different between two lists */
 187         void ListDifference(const std::string &one, const std::string &two, char sep,
 188                 std::string& mleft, std::string& mright);
 189
 190         bool Capab(const parameterlist &params);
 191
 192         /** This function forces this server to quit, removing this server
 193          * and any users on it (and servers and users below that, etc etc).
 194          * It's very slow and pretty clunky, but luckily unless your network
 195          * is having a REAL bad hair day, this function shouldnt be called
 196          * too many times a month ;-)
 197          */
 198         void SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users);
 199
 200         /** This is a wrapper function for SquitServer above, which
 201          * does some validation first and passes on the SQUIT to all
 202          * other remaining servers.
 203          */
 204         void Squit(TreeServer* Current, const std::string &reason);
 205
 206         /* Used on nick collision ... XXX ugly function HACK */
 207         int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
 208
 209         /** Send one or more FJOINs for a channel of users.
 210          * If the length of a single line is more than 480-NICKMAX
 211          * in length, it is split over multiple lines.
 212          */
 213         void SendFJoins(Channel* c);
 214
 215         /** Send G, Q, Z and E lines */
 216         void SendXLines();
 217
 218         /** Send all known information about a channel */
 219         void SyncChannel(Channel* chan);
 220
 221         /** send all users and their oper state/modes */
 222         void SendUsers();
 223
 224         /** This function is called when we want to send a netburst to a local
 225          * server. There is a set order we must do this, because for example
 226          * users require their servers to exist, and channels require their
 227          * users to exist. You get the idea.
 228          */
 229         void DoBurst(TreeServer* s);
 230
 231         /** This function is called when we receive data from a remote
 232          * server.
 233          */
 234         void OnDataReady();
 235
 236         /** Send one or more complete lines down the socket
 237          */
 238         void WriteLine(std::string line);
 239
 240         /** Handle ERROR command */
 241         void Error(parameterlist &params);
 242
 243         /** Remote AWAY */
 244         bool Away(const std::string &prefix, parameterlist &params);
 245
 246         /** SAVE to resolve nick collisions without killing */
 247         bool ForceNick(const std::string &prefix, parameterlist &params);
 248
 249         /** ENCAP command
 250          */
 251         void Encap(User* who, parameterlist &params);
 252
 253         /** OPERQUIT command
 254          */
 255         bool OperQuit(const std::string &prefix, parameterlist &params);
 256
 257         /** PONG
 258          */
 259         bool LocalPong(const std::string &prefix, parameterlist &params);
 260
 261         /** VERSION
 262          */
 263         bool ServerVersion(const std::string &prefix, parameterlist &params);
 264
 265         /** ADDLINE
 266          */
 267         bool AddLine(const std::string &prefix, parameterlist &params);
 268
 269         /** DELLINE
 270          */
 271         bool DelLine(const std::string &prefix, parameterlist &params);
 272
 273         /** WHOIS
 274          */
 275         bool Whois(const std::string &prefix, parameterlist &params);
 276
 277         /** PUSH
 278          */
 279         bool Push(const std::string &prefix, parameterlist &params);
 280
 281         /** PING
 282          */
 283         bool LocalPing(const std::string &prefix, parameterlist &params);
 284
 285         /** <- (remote) <- SERVER
 286          */
 287         bool RemoteServer(const std::string &prefix, parameterlist &params);
 288
 289         /** (local) -> SERVER
 290          */
 291         bool Outbound_Reply_Server(parameterlist &params);
 292
 293         /** (local) <- SERVER
 294          */
 295         bool Inbound_Server(parameterlist &params);
 296
 297         /** Handle IRC line split
 298          */
 299         void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist &params);
 300
 301         /** Process complete line from buffer
 302          */
 303         void ProcessLine(std::string &line);
 304
 305         void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
 306
 307         /** Handle socket timeout from connect()
 308          */
 309         virtual void OnTimeout();
 310         /** Handle server quit on close
 311          */
 312         virtual void Close();
 313
 314         /** Returns true if this server was introduced to the rest of the network
 315          */
 316         bool Introduced();
 317 };