]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/socket.h
Remove the Kiwi links from the readme.
[user/henk/code/inspircd.git] / include / socket.h
index 861acc1f10c8fb8e5b9d04c508f65dea5e4af369..1ea1332e277eab80ea2a231fc5d649127e325ec8 100644 (file)
@@ -1,20 +1,34 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2013, 2015-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012-2013, 2017-2019 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2012 Adam <Adam@anope.org>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2008, 2010 Craig Edwards <brain@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef INSPIRCD_SOCKET_H
-#define INSPIRCD_SOCKET_H
 
-#ifndef WIN32
+#pragma once
+
+#ifndef _WIN32
 
 #include <arpa/inet.h>
 #include <sys/time.h>
@@ -22,6 +36,7 @@
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <sys/stat.h>
+#include <sys/un.h>
 #include <netinet/in.h>
 #include <unistd.h>
 #include <fcntl.h>
@@ -33,9 +48,7 @@
 
 #endif
 
-#include <errno.h>
-#include "inspircd_config.h"
-#include "socketengine.h"
+#include <cerrno>
 
 /* Contains irc-specific definitions */
 namespace irc
@@ -46,54 +59,49 @@ namespace irc
         */
        namespace sockets
        {
-
-       /* macros to the relevant system address description structs */
-#ifdef IPV6
-               /** insp_sockaddr for ipv6
-                */
-               typedef struct sockaddr_in6 insp_sockaddr;
-               /** insp_inaddr for ipv6
-                */
-               typedef struct in6_addr     insp_inaddr;
-#define AF_FAMILY AF_INET6
-#define PF_PROTOCOL PF_INET6
-
-#else
-               /** insp_sockaddr for ipv4
-                */
-               typedef struct sockaddr_in  insp_sockaddr;
-               /** insp_inaddr for ipv4
-                */
-               typedef struct in_addr      insp_inaddr;
-#define AF_FAMILY AF_INET
-#define PF_PROTOCOL PF_INET
-
-#endif
-               /** Match raw binary data using CIDR rules.
-                * 
-                * This function will use binary comparison to compare the
-                * two bit sequences, address and mask, up to mask_bits
-                * bits in size. If they match, it will return true.
-                * @param address The whole address, of 4 or 16 bytes in length
-                * @param mask The mask, from 1 to 16 bytes in length, anything
-                * from 1 to 128 bits of which is significant
-                * @param mask_Bits How many bits of the mask parameter are significant
-                * for this comparison.
-                * @returns True if the first mask_bits of address matches the first
-                * mask_bits of mask.
-                */
-               CoreExport bool MatchCIDRBits(unsigned char* address, unsigned char* mask, unsigned int mask_bits);
-
-               /** Match CIDR, without matching username/nickname parts.
-                *
-                * This function will compare a human-readable address against a human-
-                * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This
-                * method supports both IPV4 and IPV6 addresses.
-                * @param address The human readable address, e.g. 1.2.3.4
-                * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16
-                * @return True if the mask matches the address
-                */
-               CoreExport bool MatchCIDR(const char* address, const char* cidr_mask);
+               union CoreExport sockaddrs
+               {
+                       struct sockaddr sa;
+                       struct sockaddr_in in4;
+                       struct sockaddr_in6 in6;
+                       struct sockaddr_un un;
+                       /** Return the family of the socket (e.g. AF_INET). */
+                       int family() const;
+                       /** Return the size of the structure for syscall passing */
+                       socklen_t sa_size() const;
+                       /** Return port number or -1 if invalid */
+                       int port() const;
+                       /** Return IP only */
+                       std::string addr() const;
+                       /** Return human-readable IP/port pair */
+                       std::string str() const;
+                       bool operator==(const sockaddrs& other) const;
+                       inline bool operator!=(const sockaddrs& other) const { return !(*this == other); }
+               };
+
+               struct CoreExport cidr_mask
+               {
+                       /** Type, AF_INET or AF_INET6 */
+                       unsigned char type;
+                       /** Length of the mask in bits (0-128) */
+                       unsigned char length;
+                       /** Raw bits. Unused bits must be zero */
+                       unsigned char bits[16];
+
+                       cidr_mask() {}
+                       /** Construct a CIDR mask from the string. Will normalize (127.0.0.1/8 => 127.0.0.0/8). */
+                       cidr_mask(const std::string& mask);
+                       /** Construct a CIDR mask of a given length from the given address */
+                       cidr_mask(const irc::sockets::sockaddrs& addr, unsigned char len);
+                       /** Equality of bits, type, and length */
+                       bool operator==(const cidr_mask& other) const;
+                       /** Ordering defined for maps */
+                       bool operator<(const cidr_mask& other) const;
+                       /** Match within this CIDR? */
+                       bool match(const irc::sockets::sockaddrs& addr) const;
+                       /** Human-readable string */
+                       std::string str() const;
+               };
 
                /** Match CIDR, including an optional username/nickname part.
                 *
@@ -104,95 +112,98 @@ namespace irc
                 * IPV6 addresses.
                 * @param address The human readable address, e.g. fred\@1.2.3.4
                 * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16
+                * @param match_with_username Does the  mask include a nickname segment?
                 * @return True if the mask matches the address
                 */
-               CoreExport bool MatchCIDR(const char* address, const char* cidr_mask, bool match_with_username);
+               CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask, bool match_with_username);
 
-               /** Convert an insp_inaddr into human readable form.
-                * 
-                * @param n An insp_inaddr (IP address) structure
-                * @return A human-readable address. IPV6 addresses
-                * will be shortened to remove fields which are 0.
+               /** Convert an address-port pair into a binary sockaddr
+                * @param addr The IP address, IPv4 or IPv6
+                * @param port The port, 0 for unspecified
+                * @param sa The structure to place the result in. Will be zeroed prior to conversion
+                * @return true if the conversion was successful, false if not.
                 */
-               CoreExport const char* insp_ntoa(insp_inaddr n);
-
-               /** Convert a human-readable address into an insp_inaddr.
-                * 
-                * @param a A human-readable address
-                * @param n An insp_inaddr struct which the result
-                * will be copied into on success.
-                * @return This method will return a negative value if address
-                * does not contain a valid address family. 0 if the address is
-                * does not contain a valid string representing a valid network
-                * address. A positive value is returned if the network address
-                * was successfully converted.
-
-                * or any other number upon failure.
+               CoreExport bool aptosa(const std::string& addr, int port, irc::sockets::sockaddrs& sa);
+
+               /** Convert a UNIX socket path to a binary sockaddr.
+                * @param path The path to the UNIX socket.
+                * @param sa The structure to place the result in. Will be zeroed prior to conversion.
+                * @return True if the conversion was successful; otherwise, false.
                 */
-               CoreExport int insp_aton(const char* a, insp_inaddr* n);
+               CoreExport bool untosa(const std::string& path, irc::sockets::sockaddrs& sa);
 
-               /** Create a new valid file descriptor using socket()
-                * @return On return this function will return a value >= 0 for success,
-                * or a negative value upon failure (negative values are invalid file
-                * descriptors)
+               /** Determines whether the specified file is a UNIX socket.
+                * @param file The path to the file to check.
+                * @return True if the file is a UNIX socket; otherwise, false.
                 */
-               CoreExport int OpenTCPSocket(char* addr, int socktype = SOCK_STREAM);
+               CoreExport bool isunix(const std::string& file);
        }
 }
 
+/** Represents information about a failed port binding. */
+struct CoreExport FailedPort
+{
+       /** The error which happened during binding. */
+       int error;
+
+       /** The endpoint on which we were attempting to bind. */
+       irc::sockets::sockaddrs sa;
+
+       /** The config tag that the listener was created from. */
+       ConfigTag* tag;
+
+       FailedPort(int err, irc::sockets::sockaddrs& ep, ConfigTag* cfg)
+               : error(err)
+               , sa(ep)
+               , tag(cfg)
+       {
+       }
+};
+
+/** A list of failed port bindings, used for informational purposes on startup */
+typedef std::vector<FailedPort> FailedPortList;
+
+#include "socketengine.h"
+
 /** This class handles incoming connections on client ports.
- * It will create a new userrec for every valid connection
+ * It will create a new User for every valid connection
  * and assign it a file descriptor.
  */
 class CoreExport ListenSocket : public EventHandler
 {
- protected:
-       /** The creator/owner of this object
-        */
-       InspIRCd* ServerInstance;
-       /** Socket description (shown in stats p) */
-       std::string desc;
-       /** Socket address family */
-       int family;
-       /** Address socket is bound to */
-       std::string bind_addr;
-       /** Port socket is bound to */
-       int bind_port;
  public:
-       /** Create a new listening socket
+       reference<ConfigTag> bind_tag;
+       const irc::sockets::sockaddrs bind_sa;
+
+       class IOHookProvRef : public dynamic_reference_nocheck<IOHookProvider>
+       {
+        public:
+               IOHookProvRef()
+                       : dynamic_reference_nocheck<IOHookProvider>(NULL, std::string())
+               {
+               }
+       };
+
+       typedef TR1NS::array<IOHookProvRef, 2> IOHookProvList;
+
+       /** IOHook providers for handling connections on this socket,
+        * may be empty.
         */
-       ListenSocket(InspIRCd* Instance, int port, char* addr);
-       /** Handle an I/O event
+       IOHookProvList iohookprovs;
+
+       /** Create a new listening socket
         */
-       void HandleEvent(EventType et, int errornum = 0);
+       ListenSocket(ConfigTag* tag, const irc::sockets::sockaddrs& bind_to);
        /** Close the socket
         */
        ~ListenSocket();
-       /** Set descriptive text
-        */
-       void SetDescription(const std::string &description)
-       {
-               desc = description;
-       }
-       /** Get description for socket
-        */
-       const std::string& GetDescription()
-       {
-               return desc;
-       }
-       /** Get port number for socket
+
+       /** Handles new connections, called by the socket engine
         */
-       int GetPort()
-       {
-               return bind_port;
-       }
-       /** Get IP address socket is bound to
+       void OnEventHandlerRead() CXX11_OVERRIDE;
+
+       /** Inspects the bind block belonging to this socket to set the name of the IO hook
+        * provider which this socket will use for incoming connections.
         */
-       std::string &GetIP()
-       {
-               return bind_addr;
-       }
+       void ResetIOHookProvider();
 };
-
-#endif
-