src/modules/m_spanningtree/treesocket.h

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