include/socket.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 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 <errno.h>
  37 #include "inspircd_config.h"
  38 #include "socketengine.h"
  39
  40 /* Accept Define */
  41 #ifdef CONFIG_USE_IOCP
  42 #define _accept(s, addr, addrlen) __accept_socket(s, addr, addrlen, m_acceptEvent)
  43 #define _getsockname(fd, sockptr, socklen) __getsockname(fd, sockptr, socklen, m_acceptEvent)
  44 #define _recvfrom(s, buf, len, flags, from, fromlen) __recvfrom(s, buf, len, flags, from, fromlen, ((IOCPEngine*)ServerInstance->SE)->udp_ov)
  45 #else
  46 #define _recvfrom recvfrom
  47 #define _accept accept
  48 #define _getsockname getsockname
  49 #endif
  50
  51 namespace irc
  52 {
  53         /** This namespace contains various protocol-independent helper classes.
  54          * It also contains some types which are often used by the core and modules
  55          * in place of inet_* functions and types.
  56          */
  57         namespace sockets
  58         {
  59
  60         /* macros to the relevant system address description structs */
  61 #ifdef IPV6
  62                 /** insp_sockaddr for ipv6
  63                  */
  64                 typedef struct sockaddr_in6 insp_sockaddr;
  65                 /** insp_inaddr for ipv6
  66                  */
  67                 typedef struct in6_addr     insp_inaddr;
  68 #define AF_FAMILY AF_INET6
  69 #define PF_PROTOCOL PF_INET6
  70
  71 #else
  72                 /** insp_sockaddr for ipv4
  73                  */
  74                 typedef struct sockaddr_in  insp_sockaddr;
  75                 /** insp_inaddr for ipv4
  76                  */
  77                 typedef struct in_addr      insp_inaddr;
  78 #define AF_FAMILY AF_INET
  79 #define PF_PROTOCOL PF_INET
  80
  81 #endif
  82                 /** Match raw binary data using CIDR rules.
  83                  *
  84                  * This function will use binary comparison to compare the
  85                  * two bit sequences, address and mask, up to mask_bits
  86                  * bits in size. If they match, it will return true.
  87                  * @param address The whole address, of 4 or 16 bytes in length
  88                  * @param mask The mask, from 1 to 16 bytes in length, anything
  89                  * from 1 to 128 bits of which is significant
  90                  * @param mask_Bits How many bits of the mask parameter are significant
  91                  * for this comparison.
  92                  * @returns True if the first mask_bits of address matches the first
  93                  * mask_bits of mask.
  94                  */
  95                 CoreExport bool MatchCIDRBits(unsigned char* address, unsigned char* mask, unsigned int mask_bits);
  96
  97                 /** Match CIDR, without matching username/nickname parts.
  98                  *
  99                  * This function will compare a human-readable address against a human-
 100                  * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This
 101                  * method supports both IPV4 and IPV6 addresses.
 102                  * @param address The human readable address, e.g. 1.2.3.4
 103                  * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16
 104                  * @return True if the mask matches the address
 105                  */
 106                 CoreExport bool MatchCIDR(const char* address, const char* cidr_mask);
 107
 108                 /** Match CIDR, including an optional username/nickname part.
 109                  *
 110                  * This function will compare a human-readable address (plus
 111                  * optional username and nickname) against a human-readable
 112                  * CIDR mask, for example joe!bloggs\@1.2.3.4 against
 113                  * *!bloggs\@1.2.0.0/16. This method supports both IPV4 and
 114                  * IPV6 addresses.
 115                  * @param address The human readable address, e.g. fred\@1.2.3.4
 116                  * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16
 117                  * @return True if the mask matches the address
 118                  */
 119                 CoreExport bool MatchCIDR(const char* address, const char* cidr_mask, bool match_with_username);
 120
 121                 /** Convert an insp_inaddr into human readable form.
 122                  *
 123                  * @param n An insp_inaddr (IP address) structure
 124                  * @return A human-readable address. IPV6 addresses
 125                  * will be shortened to remove fields which are 0.
 126                  */
 127                 CoreExport const char* insp_ntoa(insp_inaddr n);
 128
 129                 /** Convert a human-readable address into an insp_inaddr.
 130                  *
 131                  * @param a A human-readable address
 132                  * @param n An insp_inaddr struct which the result
 133                  * will be copied into on success.
 134                  * @return This method will return a negative value if address
 135                  * does not contain a valid address family. 0 if the address is
 136                  * does not contain a valid string representing a valid network
 137                  * address. A positive value is returned if the network address
 138                  * was successfully converted.
 139
 140                  * or any other number upon failure.
 141                  */
 142                 CoreExport int insp_aton(const char* a, insp_inaddr* n);
 143
 144                 /** Make a socket file descriptor a blocking socket
 145                  * @param s A valid file descriptor
 146                  */
 147                 CoreExport void Blocking(int s);
 148
 149                 /** Make a socket file descriptor into a nonblocking socket
 150                  * @param s A valid file descriptor
 151                  */
 152                 CoreExport void NonBlocking(int s);
 153
 154                 /** Create a new valid file descriptor using socket()
 155                  * @return On return this function will return a value >= 0 for success,
 156                  * or a negative value upon failure (negative values are invalid file
 157                  * descriptors)
 158                  */
 159                 CoreExport int OpenTCPSocket(char* addr, int socktype = SOCK_STREAM);
 160         }
 161 }
 162
 163 /** This class handles incoming connections on client ports.
 164  * It will create a new userrec for every valid connection
 165  * and assign it a file descriptor.
 166  */
 167 class CoreExport ListenSocket : public EventHandler
 168 {
 169  protected:
 170         /** The creator/owner of this object
 171          */
 172         InspIRCd* ServerInstance;
 173         std::string desc;
 174         int family;
 175         std::string bind_addr;
 176         int bind_port;
 177  public:
 178         /** Create a new listening socket
 179          */
 180         ListenSocket(InspIRCd* Instance, int port, char* addr);
 181         /** Handle an I/O event
 182          */
 183         void HandleEvent(EventType et, int errornum = 0);
 184         /** Close the socket
 185          */
 186         ~ListenSocket();
 187         /** Set descriptive text
 188          */
 189         void SetDescription(const std::string &description)
 190         {
 191                 desc = description;
 192         }
 193
 194         const std::string& GetDescription()
 195         {
 196                 return desc;
 197         }
 198
 199         int GetPort()
 200         {
 201                 return bind_port;
 202         }
 203
 204         std::string &GetIP()
 205         {
 206                 return bind_addr;
 207         }
 208 };
 209
 210 #endif