2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2005-2007 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
8 * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
9 * Copyright (C) 2006 William Pitcock <nenolod@dereferenced.org>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #ifndef INSPIRCD_SOCKET_H
26 #define INSPIRCD_SOCKET_H
30 #include <arpa/inet.h>
32 #include <sys/resource.h>
33 #include <sys/types.h>
34 #include <sys/socket.h>
36 #include <netinet/in.h>
43 #include "inspircd_win32wrapper.h"
49 /* Contains irc-specific definitions */
52 /** This namespace contains various protocol-independent helper classes.
53 * It also contains some types which are often used by the core and modules
54 * in place of inet_* functions and types.
58 union CoreExport sockaddrs
61 struct sockaddr_in in4;
62 struct sockaddr_in6 in6;
63 /** Return the size of the structure for syscall passing */
65 /** Return port number or -1 if invalid */
68 std::string addr() const;
69 /** Return human-readable IP/port pair */
70 std::string str() const;
71 bool operator==(const sockaddrs& other) const;
72 inline bool operator!=(const sockaddrs& other) const { return !(*this == other); }
75 struct CoreExport cidr_mask
77 /** Type, AF_INET or AF_INET6 */
79 /** Length of the mask in bits (0-128) */
81 /** Raw bits. Unused bits must be zero */
82 unsigned char bits[16];
85 /** Construct a CIDR mask from the string. Will normalize (127.0.0.1/8 => 127.0.0.0/8). */
86 cidr_mask(const std::string& mask);
87 /** Construct a CIDR mask of a given length from the given address */
88 cidr_mask(const irc::sockets::sockaddrs& addr, int len);
89 /** Equality of bits, type, and length */
90 bool operator==(const cidr_mask& other) const;
91 /** Ordering defined for maps */
92 bool operator<(const cidr_mask& other) const;
93 /** Match within this CIDR? */
94 bool match(const irc::sockets::sockaddrs& addr) const;
95 /** Human-readable string */
96 std::string str() const;
99 /** Match CIDR, including an optional username/nickname part.
101 * This function will compare a human-readable address (plus
102 * optional username and nickname) against a human-readable
103 * CIDR mask, for example joe!bloggs\@1.2.3.4 against
104 * *!bloggs\@1.2.0.0/16. This method supports both IPV4 and
106 * @param address The human readable address, e.g. fred\@1.2.3.4
107 * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16
108 * @param match_with_username Does the mask include a nickname segment?
109 * @return True if the mask matches the address
111 CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask, bool match_with_username);
113 /** Return the size of the structure for syscall passing */
114 inline int sa_size(const irc::sockets::sockaddrs& sa) { return sa.sa_size(); }
116 /** Convert an address-port pair into a binary sockaddr
117 * @param addr The IP address, IPv4 or IPv6
118 * @param port The port, 0 for unspecified
119 * @param sa The structure to place the result in. Will be zeroed prior to conversion
120 * @return true if the conversion was successful, false if not.
122 CoreExport bool aptosa(const std::string& addr, int port, irc::sockets::sockaddrs& sa);
124 /** Convert a binary sockaddr to an address-port pair
125 * @param sa The structure to convert
126 * @param addr the IP address
127 * @param port the port
128 * @return true if the conversion was successful, false if unknown address family
130 CoreExport bool satoap(const irc::sockets::sockaddrs& sa, std::string& addr, int &port);
132 /** Convert a binary sockaddr to a user-readable string.
133 * This means IPv6 addresses are written as [::1]:6667, and *:6668 is used for 0.0.0.0:6668
134 * @param sa The structure to convert
135 * @return The string; "<unknown>" if not a valid address
137 inline std::string satouser(const irc::sockets::sockaddrs& sa) { return sa.str(); }
141 #include "socketengine.h"
142 /** This class handles incoming connections on client ports.
143 * It will create a new User for every valid connection
144 * and assign it a file descriptor.
146 class CoreExport ListenSocket : public EventHandler
149 reference<ConfigTag> bind_tag;
150 std::string bind_addr;
152 /** Human-readable bind description */
153 std::string bind_desc;
154 /** Create a new listening socket
156 ListenSocket(ConfigTag* tag, const irc::sockets::sockaddrs& bind_to);
157 /** Handle an I/O event
159 void HandleEvent(EventType et, int errornum = 0);
164 /** Handles sockets internals crap of a connection, convenience wrapper really
166 void AcceptInternal();