include/socket.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 INSPIRCD_SOCKET_H
  15 #define INSPIRCD_SOCKET_H
  16
  17 #ifndef WIN32
  18
  19 #include <arpa/inet.h>
  20 #include <sys/time.h>
  21 #include <sys/resource.h>
  22 #include <sys/types.h>
  23 #include <sys/socket.h>
  24 #include <sys/stat.h>
  25 #include <netinet/in.h>
  26 #include <unistd.h>
  27 #include <fcntl.h>
  28 #include <netdb.h>
  29
  30 #else
  31
  32 #include "inspircd_win32wrapper.h"
  33
  34 #endif
  35
  36 #include <cerrno>
  37 #include "socketengine.h"
  38
  39 /* Contains irc-specific definitions */
  40 namespace irc
  41 {
  42         /** This namespace contains various protocol-independent helper classes.
  43          * It also contains some types which are often used by the core and modules
  44          * in place of inet_* functions and types.
  45          */
  46         namespace sockets
  47         {
  48
  49                 typedef union {
  50                         struct sockaddr sa;
  51                         struct sockaddr_in in4;
  52                         struct sockaddr_in6 in6;
  53                 } sockaddrs;
  54
  55         /* macros to the relevant system address description structs */
  56 #ifdef IPV6
  57                 /** insp_sockaddr for ipv6
  58                  */
  59                 typedef struct sockaddr_in6 insp_sockaddr;
  60                 /** insp_inaddr for ipv6
  61                  */
  62                 typedef struct in6_addr     insp_inaddr;
  63 #define AF_FAMILY AF_INET6
  64 #define PF_PROTOCOL PF_INET6
  65
  66 #else
  67                 /** insp_sockaddr for ipv4
  68                  */
  69                 typedef struct sockaddr_in  insp_sockaddr;
  70                 /** insp_inaddr for ipv4
  71                  */
  72                 typedef struct in_addr      insp_inaddr;
  73 #define AF_FAMILY AF_INET
  74 #define PF_PROTOCOL PF_INET
  75
  76 #endif
  77                 /** Match raw binary data using CIDR rules.
  78                  *
  79                  * This function will use binary comparison to compare the
  80                  * two bit sequences, address and mask, up to mask_bits
  81                  * bits in size. If they match, it will return true.
  82                  * @param address The whole address, of 4 or 16 bytes in length
  83                  * @param mask The mask, from 1 to 16 bytes in length, anything
  84                  * from 1 to 128 bits of which is significant
  85                  * @param mask_Bits How many bits of the mask parameter are significant
  86                  * for this comparison.
  87                  * @returns True if the first mask_bits of address matches the first
  88                  * mask_bits of mask.
  89                  */
  90                 CoreExport bool MatchCIDRBits(const unsigned char* address, const unsigned char* mask, unsigned int mask_bits);
  91
  92                 /** Match CIDR, without matching username/nickname parts.
  93                  *
  94                  * This function will compare a human-readable address against a human-
  95                  * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This
  96                  * method supports both IPV4 and IPV6 addresses.
  97                  * @param address The human readable address, e.g. 1.2.3.4
  98                  * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16
  99                  * @return True if the mask matches the address
 100                  */
 101                 CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask);
 102
 103                 /** Match CIDR, including an optional username/nickname part.
 104                  *
 105                  * This function will compare a human-readable address (plus
 106                  * optional username and nickname) against a human-readable
 107                  * CIDR mask, for example joe!bloggs\@1.2.3.4 against
 108                  * *!bloggs\@1.2.0.0/16. This method supports both IPV4 and
 109                  * IPV6 addresses.
 110                  * @param address The human readable address, e.g. fred\@1.2.3.4
 111                  * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16
 112                  * @return True if the mask matches the address
 113                  */
 114                 CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask, bool match_with_username);
 115
 116                 /** Convert an insp_inaddr into human readable form.
 117                  *
 118                  * @param n An insp_inaddr (IP address) structure
 119                  * @return A human-readable address. IPV6 addresses
 120                  * will be shortened to remove fields which are 0.
 121                  */
 122                 CoreExport const char* insp_ntoa(insp_inaddr n);
 123
 124                 /** Convert a human-readable address into an insp_inaddr.
 125                  *
 126                  * @param a A human-readable address
 127                  * @param n An insp_inaddr struct which the result
 128                  * will be copied into on success.
 129                  * @return This method will return a negative value if address
 130                  * does not contain a valid address family. 0 if the address is
 131                  * does not contain a valid string representing a valid network
 132                  * address. A positive value is returned if the network address
 133                  * was successfully converted.
 134
 135                  * or any other number upon failure.
 136                  */
 137                 CoreExport int insp_aton(const char* a, insp_inaddr* n);
 138
 139                 /** Create a new valid file descriptor using socket()
 140                  * @return On return this function will return a value >= 0 for success,
 141                  * or a negative value upon failure (negative values are invalid file
 142                  * descriptors)
 143                  */
 144                 CoreExport int OpenTCPSocket(const char* addr, int socktype = SOCK_STREAM);
 145
 146                 /** Return the size of the structure for syscall passing */
 147                 int sa_size(irc::sockets::sockaddrs& sa)
 148                 {
 149                         return sa.sa.sa_family == AF_INET ? sizeof(sa.in4) : sizeof(sa.in6);
 150                 }
 151
 152                 /** Convert an address-port pair into a binary sockaddr
 153                  * @param addr The IP address, IPv4 or IPv6
 154                  * @param port The port, 0 for unspecified
 155                  * @param sa The structure to place the result in. Will be zeroed prior to conversion
 156                  * @return true if the conversion was successful, false if not.
 157                  */
 158                 CoreExport int aptosa(const char* addr, int port, irc::sockets::sockaddrs* sa);
 159                 /** Convert a binary sockaddr to an address-port pair
 160                  * @param sa The structure to convert
 161                  * @param addr the IP address
 162                  * @param port the port
 163                  * @return true if the conversion was successful, false if unknown address family
 164                  */
 165                 CoreExport int satoap(const irc::sockets::sockaddrs* sa, std::string& addr, int &port);
 166         }
 167 }
 168
 169
 170
 171 /** This class handles incoming connections on client ports.
 172  * It will create a new User for every valid connection
 173  * and assign it a file descriptor.
 174  */
 175 class CoreExport ListenSocketBase : public EventHandler
 176 {
 177  protected:
 178         /** The creator/owner of this object
 179          */
 180         InspIRCd* ServerInstance;
 181         /** Socket description (shown in stats p) */
 182         std::string desc;
 183
 184         /** Address socket is bound to */
 185         std::string bind_addr;
 186         /** Port socket is bound to */
 187         int bind_port;
 188
 189         /** The client address if the most recently connected client.
 190          * Should only be used when accepting a new client.
 191          */
 192         static irc::sockets::sockaddrs client;
 193         /** The server address used by the most recently connected client.
 194          * This may differ from the bind address by having a nonzero address,
 195          * if the port is wildcard bound, or being IPv4 on a 6to4 IPv6 port.
 196          * The address family will always match that of "client"
 197          */
 198         static irc::sockets::sockaddrs server;
 199  public:
 200         /** Create a new listening socket
 201          */
 202         ListenSocketBase(InspIRCd* Instance, int port, const std::string &addr);
 203         /** Handle an I/O event
 204          */
 205         void HandleEvent(EventType et, int errornum = 0);
 206         /** Close the socket
 207          */
 208         ~ListenSocketBase();
 209         /** Set descriptive text
 210          */
 211         void SetDescription(const std::string &description)
 212         {
 213                 desc = description;
 214         }
 215         /** Get description for socket
 216          */
 217         const std::string& GetDescription()
 218         {
 219                 return desc;
 220         }
 221         /** Get port number for socket
 222          */
 223         int GetPort() { return bind_port; }
 224
 225         /** Get IP address socket is bound to
 226          */
 227         const std::string &GetIP() { return bind_addr; }
 228
 229         /** Handles sockets internals crap of a connection, convenience wrapper really
 230          */
 231         void AcceptInternal();
 232
 233         /** Called when a new connection has successfully been accepted on this listener.
 234          * @param ipconnectedto The IP address the connection arrived on
 235          * @param fd The file descriptor of the new connection
 236          * @param incomingip The IP from which the connection was made
 237          */
 238         virtual void OnAcceptReady(const std::string &ipconnectedto, int fd, const std::string &incomingip) = 0;
 239 };
 240
 241 class CoreExport ClientListenSocket : public ListenSocketBase
 242 {
 243         virtual void OnAcceptReady(const std::string &ipconnectedto, int fd, const std::string &incomingip);
 244  public:
 245         ClientListenSocket(InspIRCd* Instance, int port, const std::string &addr) : ListenSocketBase(Instance, port, addr) { }
 246 };
 247
 248 #endif
 249