src/modules/m_spanningtree/treesocket.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __TREESOCKET_H__
  15 #define __TREESOCKET_H__
  16
  17 #include "configreader.h"
  18 #include "users.h"
  19 #include "channels.h"
  20 #include "modules.h"
  21 #include "commands/cmd_whois.h"
  22 #include "commands/cmd_stats.h"
  23 #include "socket.h"
  24 #include "inspircd.h"
  25 #include "wildcard.h"
  26 #include "xline.h"
  27 #include "transport.h"
  28
  29 #include "m_spanningtree/utils.h"
  30
  31 /*
  32  * The server list in InspIRCd is maintained as two structures
  33  * which hold the data in different ways. Most of the time, we
  34  * want to very quicky obtain three pieces of information:
  35  *
  36  * (1) The information on a server
  37  * (2) The information on the server we must send data through
  38  *     to actually REACH the server we're after
  39  * (3) Potentially, the child/parent objects of this server
  40  *
  41  * The InspIRCd spanning protocol provides easy access to these
  42  * by storing the data firstly in a recursive structure, where
  43  * each item references its parent item, and a dynamic list
  44  * of child items, and another structure which stores the items
  45  * hashed, linearly. This means that if we want to find a server
  46  * by name quickly, we can look it up in the hash, avoiding
  47  * any O(n) lookups. If however, during a split or sync, we want
  48  * to apply an operation to a server, and any of its child objects
  49  * we can resort to recursion to walk the tree structure.
  50  * Any socket can have one of five states at any one time.
  51  * The LISTENER state indicates a socket which is listening
  52  * for connections. It cannot receive data itself, only incoming
  53  * sockets.
  54  * The CONNECTING state indicates an outbound socket which is
  55  * waiting to be writeable.
  56  * The WAIT_AUTH_1 state indicates the socket is outbound and
  57  * has successfully connected, but has not yet sent and received
  58  * SERVER strings.
  59  * The WAIT_AUTH_2 state indicates that the socket is inbound
  60  * (allocated by a LISTENER) but has not yet sent and received
  61  * SERVER strings.
  62  * The CONNECTED state represents a fully authorized, fully
  63  * connected server.
  64  */
  65 enum ServerState { LISTENER, CONNECTING, WAIT_AUTH_1, WAIT_AUTH_2, CONNECTED };
  66
  67 /** Every SERVER connection inbound or outbound is represented by
  68  * an object of type TreeSocket.
  69  * TreeSockets, being inherited from InspSocket, can be tied into
  70  * the core socket engine, and we cn therefore receive activity events
  71  * for them, just like activex objects on speed. (yes really, that
  72  * is a technical term!) Each of these which relates to a locally
  73  * connected server is assocated with it, by hooking it onto a
  74  * TreeSocket class using its constructor. In this way, we can
  75  * maintain a list of servers, some of which are directly connected,
  76  * some of which are not.
  77  */
  78 class TreeSocket : public InspSocket
  79 {
  80         SpanningTreeUtilities* Utils;           /* Utility class */
  81         std::string myhost;                     /* Canonical hostname */
  82         std::string in_buffer;                  /* Input buffer */
  83         ServerState LinkState;                  /* Link state */
  84         std::string InboundServerName;          /* Server name sent to us by other side */
  85         std::string InboundDescription;         /* Server description (GECOS) sent to us by the other side */
  86         int num_lost_users;                     /* Users lost in split */
  87         int num_lost_servers;                   /* Servers lost in split */
  88         time_t NextPing;                        /* Time when we are due to ping this server */
  89         bool LastPingWasGood;                   /* Responded to last ping we sent? */
  90         bool bursting;                          /* True if not finished bursting yet */
  91         unsigned int keylength;                 /* Is this still used? */
  92         std::string ModuleList;                 /* Module list of other server from CAPAB */
  93         std::map<std::string,std::string> CapKeys;      /* CAPAB keys from other server */
  94         Module* Hook;                           /* I/O hooking module that we're attached to for this socket */
  95         std::string ourchallenge;               /* Challenge sent for challenge/response */
  96         std::string theirchallenge;             /* Challenge recv for challenge/response */
  97         std::string OutboundPass;               /* Outbound password */
  98
  99         static std::map<std::string, std::string> warned;       /* Server names that have had protocol violation warnings displayed for them */
 100
 101  public:
 102
 103         /** Because most of the I/O gubbins are encapsulated within
 104          * InspSocket, we just call the superclass constructor for
 105          * most of the action, and append a few of our own values
 106          * to it.
 107          */
 108         TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, Module* HookMod = NULL);
 109
 110         /** Because most of the I/O gubbins are encapsulated within
 111          * InspSocket, 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, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod = NULL);
 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, InspIRCd* SI, int newfd, char* ip, Module* HookMod = NULL);
 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 std::string &ours, const std::string &theirs);
 146
 147         /** Return the module which we are hooking to for I/O encapsulation
 148          */
 149         Module* GetHook();
 150
 151         /** Destructor
 152          */
 153         ~TreeSocket();
 154
 155         /** Generate random string used for challenge-response auth
 156          */
 157         std::string RandString(unsigned int length);
 158
 159         /** Construct a password, optionally hashed with the other side's
 160          * challenge string
 161          */
 162         std::string MakePass(const std::string &password, const std::string &challenge);
 163
 164         /** When an outbound connection finishes connecting, we receive
 165          * this event, and must send our SERVER string to the other
 166          * side. If the other side is happy, as outlined in the server
 167          * to server docs on the inspircd.org site, the other side
 168          * will then send back its own server string.
 169          */
 170         virtual bool OnConnected();
 171
 172         /** Handle socket error event
 173          */
 174         virtual void OnError(InspSocketError e);
 175
 176         /** Sends an error to the remote server, and displays it locally to show
 177          * that it was sent.
 178          */
 179         void SendError(const std::string &errormessage);
 180
 181         /** Handle socket disconnect event
 182          */
 183         virtual int OnDisconnect();
 184
 185         /** Recursively send the server tree with distances as hops.
 186          * This is used during network burst to inform the other server
 187          * (and any of ITS servers too) of what servers we know about.
 188          * If at any point any of these servers already exist on the other
 189          * end, our connection may be terminated. The hopcounts given
 190          * by this function are relative, this doesn't matter so long as
 191          * they are all >1, as all the remote servers re-calculate them
 192          * to be relative too, with themselves as hop 0.
 193          */
 194         void SendServers(TreeServer* Current, TreeServer* s, int hops);
 195
 196         /** Returns my capabilities as a string
 197          */
 198         std::string MyCapabilities();
 199
 200         /** Send my capabilities to the remote side
 201          */
 202         void SendCapabilities();
 203
 204         /* Check a comma seperated list for an item */
 205         bool HasItem(const std::string &list, const std::string &item);
 206
 207         /* Isolate and return the elements that are different between two comma seperated lists */
 208         std::string ListDifference(const std::string &one, const std::string &two);
 209
 210         bool Capab(const std::deque<std::string> &params);
 211
 212         /** This function forces this server to quit, removing this server
 213          * and any users on it (and servers and users below that, etc etc).
 214          * It's very slow and pretty clunky, but luckily unless your network
 215          * is having a REAL bad hair day, this function shouldnt be called
 216          * too many times a month ;-)
 217          */
 218         void SquitServer(std::string &from, TreeServer* Current);
 219
 220         /** This is a wrapper function for SquitServer above, which
 221          * does some validation first and passes on the SQUIT to all
 222          * other remaining servers.
 223          */
 224         void Squit(TreeServer* Current, const std::string &reason);
 225
 226         /** FMODE command - server mode with timestamp checks */
 227         bool ForceMode(const std::string &source, std::deque<std::string> &params);
 228
 229         /** FTOPIC command */
 230         bool ForceTopic(const std::string &source, std::deque<std::string> &params);
 231
 232         /** FJOIN, similar to TS6 SJOIN, but not quite. */
 233         bool ForceJoin(const std::string &source, std::deque<std::string> &params);
 234
 235         /** NICK command */
 236         bool IntroduceClient(const std::string &source, std::deque<std::string> &params);
 237
 238         /** Send one or more FJOINs for a channel of users.
 239          * If the length of a single line is more than 480-NICKMAX
 240          * in length, it is split over multiple lines.
 241          */
 242         void SendFJoins(TreeServer* Current, chanrec* c);
 243
 244         /** Send G, Q, Z and E lines */
 245         void SendXLines(TreeServer* Current);
 246
 247         /** Send channel modes and topics */
 248         void SendChannelModes(TreeServer* Current);
 249
 250         /** send all users and their oper state/modes */
 251         void SendUsers(TreeServer* Current);
 252
 253         /** This function is called when we want to send a netburst to a local
 254          * server. There is a set order we must do this, because for example
 255          * users require their servers to exist, and channels require their
 256          * users to exist. You get the idea.
 257          */
 258         void DoBurst(TreeServer* s);
 259
 260         /** This function is called when we receive data from a remote
 261          * server. We buffer the data in a std::string (it doesnt stay
 262          * there for long), reading using InspSocket::Read() which can
 263          * read up to 16 kilobytes in one operation.
 264          *
 265          * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
 266          * THE SOCKET OBJECT FOR US.
 267          */
 268         virtual bool OnDataReady();
 269
 270         /** Send one or more complete lines down the socket
 271          */
 272         int WriteLine(std::string line);
 273
 274         /** Handle ERROR command */
 275         bool Error(std::deque<std::string> &params);
 276
 277         /** remote MOTD. leet, huh? */
 278         bool Motd(const std::string &prefix, std::deque<std::string> &params);
 279
 280         /** remote ADMIN. leet, huh? */
 281         bool Admin(const std::string &prefix, std::deque<std::string> &params);
 282
 283         /** Remote MODULES */
 284         bool Modules(const std::string &prefix, std::deque<std::string> &params);
 285
 286         bool Stats(const std::string &prefix, std::deque<std::string> &params);
 287
 288         /** Because the core won't let users or even SERVERS set +o,
 289          * we use the OPERTYPE command to do this.
 290          */
 291         bool OperType(const std::string &prefix, std::deque<std::string> &params);
 292
 293         /** Because Andy insists that services-compatible servers must
 294          * implement SVSNICK and SVSJOIN, that's exactly what we do :p
 295          */
 296         bool ForceNick(const std::string &prefix, std::deque<std::string> &params);
 297
 298         bool OperQuit(const std::string &prefix, std::deque<std::string> &params);
 299
 300         /** Remote SQUIT (RSQUIT). Routing works similar to SVSNICK: Route it to the server that the target is connected to locally,
 301          * then let that server do the dirty work (squit it!). Example:
 302          * A -> B -> C -> D: oper on A squits D, A routes to B, B routes to C, C notices D connected locally, kills it. -- w00t
 303          */
 304         bool RemoteSquit(const std::string &prefix, std::deque<std::string> &params);
 305
 306         /** SVSJOIN
 307          */
 308         bool ServiceJoin(const std::string &prefix, std::deque<std::string> &params);
 309
 310         /** REHASH
 311          */
 312         bool RemoteRehash(const std::string &prefix, std::deque<std::string> &params);
 313
 314         /** KILL
 315          */
 316         bool RemoteKill(const std::string &prefix, std::deque<std::string> &params);
 317
 318         /** PONG
 319          */
 320         bool LocalPong(const std::string &prefix, std::deque<std::string> &params);
 321
 322         /** METADATA
 323          */
 324         bool MetaData(const std::string &prefix, std::deque<std::string> &params);
 325
 326         /** VERSION
 327          */
 328         bool ServerVersion(const std::string &prefix, std::deque<std::string> &params);
 329
 330         /** CHGHOST
 331          */
 332         bool ChangeHost(const std::string &prefix, std::deque<std::string> &params);
 333
 334         /** ADDLINE
 335          */
 336         bool AddLine(const std::string &prefix, std::deque<std::string> &params);
 337
 338         /** CHGNAME
 339          */
 340         bool ChangeName(const std::string &prefix, std::deque<std::string> &params);
 341
 342         /** WHOIS
 343          */
 344         bool Whois(const std::string &prefix, std::deque<std::string> &params);
 345
 346         /** PUSH
 347          */
 348         bool Push(const std::string &prefix, std::deque<std::string> &params);
 349
 350         /** SETTIME
 351          */
 352         bool HandleSetTime(const std::string &prefix, std::deque<std::string> &params);
 353
 354         /** TIME
 355          */
 356         bool Time(const std::string &prefix, std::deque<std::string> &params);
 357
 358         /** PING
 359          */
 360         bool LocalPing(const std::string &prefix, std::deque<std::string> &params);
 361
 362         /** Remove all modes from a channel, including statusmodes (+qaovh etc), simplemodes, parameter modes.
 363          * This does not update the timestamp of the target channel, this must be done seperately.
 364          */
 365         bool RemoveStatus(const std::string &prefix, std::deque<std::string> &params);
 366
 367         /** <- (remote) <- SERVER
 368          */
 369         bool RemoteServer(const std::string &prefix, std::deque<std::string> &params);
 370
 371         /** (local) -> SERVER
 372          */
 373         bool Outbound_Reply_Server(std::deque<std::string> &params);
 374
 375         /** (local) <- SERVER
 376          */
 377         bool Inbound_Server(std::deque<std::string> &params);
 378
 379         /** Handle netsplit
 380          */
 381         void Split(const std::string &line, std::deque<std::string> &n);
 382
 383         /** Process complete line from buffer
 384          */
 385         bool ProcessLine(std::string &line);
 386
 387         /** Get this server's name
 388          */
 389         virtual std::string GetName();
 390
 391         /** Handle socket timeout from connect()
 392          */
 393         virtual void OnTimeout();
 394
 395         /** Handle socket close event
 396          */
 397         virtual void OnClose();
 398
 399         /** Handle incoming connection event
 400          */
 401         virtual int OnIncomingConnection(int newsock, char* ip);
 402 };
 403
 404 #endif
 405