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 #ifndef M_SPANNINGTREE_TREESOCKET_H
  24 #define M_SPANNINGTREE_TREESOCKET_H
  25
  26 #include "socket.h"
  27 #include "inspircd.h"
  28 #include "xline.h"
  29
  30 #include "utils.h"
  31
  32 /*
  33  * The server list in InspIRCd is maintained as two structures
  34  * which hold the data in different ways. Most of the time, we
  35  * want to very quicky obtain three pieces of information:
  36  *
  37  * (1) The information on a server
  38  * (2) The information on the server we must send data through
  39  *     to actually REACH the server we're after
  40  * (3) Potentially, the child/parent objects of this server
  41  *
  42  * The InspIRCd spanning protocol provides easy access to these
  43  * by storing the data firstly in a recursive structure, where
  44  * each item references its parent item, and a dynamic list
  45  * of child items, and another structure which stores the items
  46  * hashed, linearly. This means that if we want to find a server
  47  * by name quickly, we can look it up in the hash, avoiding
  48  * any O(n) lookups. If however, during a split or sync, we want
  49  * to apply an operation to a server, and any of its child objects
  50  * we can resort to recursion to walk the tree structure.
  51  * Any socket can have one of five states at any one time.
  52  *
  53  * CONNECTING:  indicates an outbound socket which is
  54  *                                                      waiting to be writeable.
  55  * WAIT_AUTH_1: indicates the socket is outbound and
  56  *                                                      has successfully connected, but has not
  57  *                                                      yet sent and received SERVER strings.
  58  * WAIT_AUTH_2: indicates that the socket is inbound
  59  *                                                      but has not yet sent and received
  60  *                                                      SERVER strings.
  61  * CONNECTED:   represents a fully authorized, fully
  62  *                                                      connected server.
  63  * DYING:       represents a server that has had an error.
  64  */
  65 enum ServerState { CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED, DYING };
  66
  67 struct CapabData
  68 {
  69         reference<Link> link;                   /* Link block used for this connection */
  70         reference<Autoconnect> ac;              /* Autoconnect used to cause this connection, if any */
  71         std::string ModuleList;                 /* Required module list of other server from CAPAB */
  72         std::string OptModuleList;              /* Optional module list of other server from CAPAB */
  73         std::string ChanModes;
  74         std::string UserModes;
  75         std::map<std::string,std::string> CapKeys;      /* CAPAB keys from other server */
  76         std::string ourchallenge;               /* Challenge sent for challenge/response */
  77         std::string theirchallenge;             /* Challenge recv for challenge/response */
  78         int capab_phase;                        /* Have sent CAPAB already */
  79         bool auth_fingerprint;                  /* Did we auth using SSL fingerprint */
  80         bool auth_challenge;                    /* Did we auth using challenge/response */
  81
  82         // Data saved from incoming SERVER command, for later use when our credentials have been accepted by the other party
  83         std::string description;
  84         std::string sid;
  85         std::string name;
  86         bool hidden;
  87 };
  88
  89 /** Every SERVER connection inbound or outbound is represented by an object of
  90  * type TreeSocket. During setup, the object can be found in Utils->timeoutlist;
  91  * after setup, MyRoot will have been created as a child of Utils->TreeRoot
  92  */
  93 class TreeSocket : public BufferedSocket
  94 {
  95         SpanningTreeUtilities* Utils;           /* Utility class */
  96         std::string linkID;                     /* Description for this link */
  97         ServerState LinkState;                  /* Link state */
  98         CapabData* capab;                       /* Link setup data (held until burst is sent) */
  99         TreeServer* MyRoot;                     /* The server we are talking to */
 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  public:
 108         time_t age;
 109
 110         /** Because most of the I/O gubbins are encapsulated within
 111          * BufferedSocket, we just call the superclass constructor for
 112          * most of the action, and append a few of our own values
 113          * to it.
 114          */
 115         TreeSocket(SpanningTreeUtilities* Util, Link* link, Autoconnect* myac, const std::string& ipaddr);
 116
 117         /** When a listening socket gives us a new file descriptor,
 118          * we must associate it with a socket without creating a new
 119          * connection. This constructor is used for this purpose.
 120          */
 121         TreeSocket(SpanningTreeUtilities* Util, int newfd, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 122
 123         /** Get link state
 124          */
 125         ServerState GetLinkState();
 126
 127         /** Get challenge set in our CAPAB for challenge/response
 128          */
 129         const std::string& GetOurChallenge();
 130
 131         /** Get challenge set in our CAPAB for challenge/response
 132          */
 133         void SetOurChallenge(const std::string &c);
 134
 135         /** Get challenge set in their CAPAB for challenge/response
 136          */
 137         const std::string& GetTheirChallenge();
 138
 139         /** Get challenge set in their CAPAB for challenge/response
 140          */
 141         void SetTheirChallenge(const std::string &c);
 142
 143         /** Compare two passwords based on authentication scheme
 144          */
 145         bool ComparePass(const Link& link, const std::string &theirs);
 146
 147         /** Clean up information used only during server negotiation
 148          */
 149         void CleanNegotiationInfo();
 150
 151         CullResult cull();
 152         /** Destructor
 153          */
 154         ~TreeSocket();
 155
 156         /** Construct a password, optionally hashed with the other side's
 157          * challenge string
 158          */
 159         std::string MakePass(const std::string &password, const std::string &challenge);
 160
 161         /** When an outbound connection finishes connecting, we receive
 162          * this event, and must send our SERVER string to the other
 163          * side. If the other side is happy, as outlined in the server
 164          * to server docs on the inspircd.org site, the other side
 165          * will then send back its own server string.
 166          */
 167         virtual void OnConnected();
 168
 169         /** Handle socket error event
 170          */
 171         virtual void OnError(BufferedSocketError e);
 172
 173         /** Sends an error to the remote server, and displays it locally to show
 174          * that it was sent.
 175          */
 176         void SendError(const std::string &errormessage);
 177
 178         /** Recursively send the server tree with distances as hops.
 179          * This is used during network burst to inform the other server
 180          * (and any of ITS servers too) of what servers we know about.
 181          * If at any point any of these servers already exist on the other
 182          * end, our connection may be terminated. The hopcounts given
 183          * by this function are relative, this doesn't matter so long as
 184          * they are all >1, as all the remote servers re-calculate them
 185          * to be relative too, with themselves as hop 0.
 186          */
 187         void SendServers(TreeServer* Current, TreeServer* s, int hops);
 188
 189         /** Returns module list as a string, filtered by filter
 190          * @param filter a module version bitmask, such as VF_COMMON or VF_OPTCOMMON
 191          */
 192         std::string MyModules(int filter);
 193
 194         /** Send my capabilities to the remote side
 195          */
 196         void SendCapabilities(int phase);
 197
 198         /** Add modules to VF_COMMON list for backwards compatability */
 199         void CompatAddModules(std::vector<std::string>& modlist);
 200
 201         /* Isolate and return the elements that are different between two lists */
 202         void ListDifference(const std::string &one, const std::string &two, char sep,
 203                 std::string& mleft, std::string& mright);
 204
 205         bool Capab(const parameterlist &params);
 206
 207         /** This function forces this server to quit, removing this server
 208          * and any users on it (and servers and users below that, etc etc).
 209          * It's very slow and pretty clunky, but luckily unless your network
 210          * is having a REAL bad hair day, this function shouldnt be called
 211          * too many times a month ;-)
 212          */
 213         void SquitServer(std::string &from, TreeServer* Current, int& num_lost_servers, int& num_lost_users);
 214
 215         /** This is a wrapper function for SquitServer above, which
 216          * does some validation first and passes on the SQUIT to all
 217          * other remaining servers.
 218          */
 219         void Squit(TreeServer* Current, const std::string &reason);
 220
 221         /* Used on nick collision ... XXX ugly function HACK */
 222         int DoCollision(User *u, time_t remotets, const std::string &remoteident, const std::string &remoteip, const std::string &remoteuid);
 223
 224         /** Send one or more FJOINs for a channel of users.
 225          * If the length of a single line is more than 480-NICKMAX
 226          * in length, it is split over multiple lines.
 227          */
 228         void SendFJoins(Channel* c);
 229
 230         /** Send G, Q, Z and E lines */
 231         void SendXLines();
 232
 233         /** Send channel modes and topics */
 234         void SendChannelModes();
 235
 236         /** send all users and their oper state/modes */
 237         void SendUsers();
 238
 239         /** This function is called when we want to send a netburst to a local
 240          * server. There is a set order we must do this, because for example
 241          * users require their servers to exist, and channels require their
 242          * users to exist. You get the idea.
 243          */
 244         void DoBurst(TreeServer* s);
 245
 246         /** This function is called when we receive data from a remote
 247          * server.
 248          */
 249         void OnDataReady();
 250
 251         /** Send one or more complete lines down the socket
 252          */
 253         void WriteLine(std::string line);
 254
 255         /** Handle ERROR command */
 256         void Error(parameterlist &params);
 257
 258         /** Remote AWAY */
 259         bool Away(const std::string &prefix, parameterlist &params);
 260
 261         /** SAVE to resolve nick collisions without killing */
 262         bool ForceNick(const std::string &prefix, parameterlist &params);
 263
 264         /** ENCAP command
 265          */
 266         void Encap(User* who, parameterlist &params);
 267
 268         /** OPERQUIT command
 269          */
 270         bool OperQuit(const std::string &prefix, parameterlist &params);
 271
 272         /** PONG
 273          */
 274         bool LocalPong(const std::string &prefix, parameterlist &params);
 275
 276         /** VERSION
 277          */
 278         bool ServerVersion(const std::string &prefix, parameterlist &params);
 279
 280         /** ADDLINE
 281          */
 282         bool AddLine(const std::string &prefix, parameterlist &params);
 283
 284         /** DELLINE
 285          */
 286         bool DelLine(const std::string &prefix, parameterlist &params);
 287
 288         /** WHOIS
 289          */
 290         bool Whois(const std::string &prefix, parameterlist &params);
 291
 292         /** PUSH
 293          */
 294         bool Push(const std::string &prefix, parameterlist &params);
 295
 296         /** PING
 297          */
 298         bool LocalPing(const std::string &prefix, parameterlist &params);
 299
 300         /** <- (remote) <- SERVER
 301          */
 302         bool RemoteServer(const std::string &prefix, parameterlist &params);
 303
 304         /** (local) -> SERVER
 305          */
 306         bool Outbound_Reply_Server(parameterlist &params);
 307
 308         /** (local) <- SERVER
 309          */
 310         bool Inbound_Server(parameterlist &params);
 311
 312         /** Handle IRC line split
 313          */
 314         void Split(const std::string &line, std::string& prefix, std::string& command, parameterlist &params);
 315
 316         /** Process complete line from buffer
 317          */
 318         void ProcessLine(std::string &line);
 319
 320         void ProcessConnectedLine(std::string& prefix, std::string& command, parameterlist& params);
 321
 322         /** Handle socket timeout from connect()
 323          */
 324         virtual void OnTimeout();
 325         /** Handle server quit on close
 326          */
 327         virtual void Close();
 328
 329         /** Returns true if this server was introduced to the rest of the network
 330          */
 331         bool Introduced();
 332 };
 333
 334 #endif
 335