2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
24 * TCP-based SocketListener implementation.
28 #include "exceptions.h"
29 #include "remoting/impl/SocketListener.h"
30 #include "util/IPRange.h"
32 #include <xercesc/util/XMLUniDefs.hpp>
33 #include <xmltooling/unicode.h>
34 #include <xmltooling/util/XMLHelper.h>
37 # include <winsock2.h>
38 # include <ws2tcpip.h>
42 # include <sys/socket.h>
46 # include <arpa/inet.h>
47 # include <netinet/in.h>
50 #include <sys/types.h>
51 #include <sys/stat.h> /* for chmod() */
56 using namespace shibsp;
57 using namespace xmltooling;
58 using namespace xercesc;
62 class TCPListener : virtual public SocketListener
65 TCPListener(const DOMElement* e);
68 bool create(ShibSocket& s) const;
69 bool bind(ShibSocket& s, bool force=false) const;
70 bool connect(ShibSocket& s) const;
71 bool close(ShibSocket& s) const;
72 bool accept(ShibSocket& listener, ShibSocket& s) const;
74 int send(ShibSocket& s, const char* buf, int len) const {
75 return ::send(s, buf, len, 0);
78 int recv(ShibSocket& s, char* buf, int buflen) const {
79 return ::recv(s, buf, buflen, 0);
83 bool setup_tcp_sockaddr();
86 unsigned short m_port;
87 vector<IPRange> m_acl;
88 #ifdef HAVE_STRUCT_SOCKADDR_STORAGE
89 struct sockaddr_storage m_sockaddr;
91 struct sockaddr_in m_sockaddr;
95 ListenerService* SHIBSP_DLLLOCAL TCPListenerServiceFactory(const DOMElement* const & e)
97 return new TCPListener(e);
100 static const XMLCh address[] = UNICODE_LITERAL_7(a,d,d,r,e,s,s);
101 static const XMLCh port[] = UNICODE_LITERAL_4(p,o,r,t);
102 static const XMLCh acl[] = UNICODE_LITERAL_3(a,c,l);
105 TCPListener::TCPListener(const DOMElement* e)
107 m_address(XMLHelper::getAttrString(e, getenv("SHIBSP_LISTENER_ADDRESS"), address)),
108 m_port(XMLHelper::getAttrInt(e, 0, port))
110 if (m_address.empty())
111 m_address = "127.0.0.1";
114 const char* p = getenv("SHIBSP_LISTENER_PORT");
122 string aclbuf = XMLHelper::getAttrString(e, "127.0.0.1", acl);
123 for (unsigned int i = 0; i < aclbuf.length(); ++i) {
124 if (aclbuf.at(i) == ' ') {
126 m_acl.push_back(IPRange::parseCIDRBlock(aclbuf.substr(j, i-j).c_str()));
128 catch (exception& ex) {
129 log->error("invalid CIDR block (%s): %s", aclbuf.substr(j, i-j).c_str(), ex.what());
135 m_acl.push_back(IPRange::parseCIDRBlock(aclbuf.substr(j, aclbuf.length()-j).c_str()));
137 catch (exception& ex) {
138 log->error("invalid CIDR block (%s): %s", aclbuf.substr(j, aclbuf.length()-j).c_str(), ex.what());
142 log->warn("invalid CIDR range(s) in acl property, allowing 127.0.0.1 as a fall back");
143 m_acl.push_back(IPRange::parseCIDRBlock("127.0.0.1"));
146 if (!setup_tcp_sockaddr()) {
147 throw ConfigurationException("Unable to use configured socket address property.");
151 bool TCPListener::setup_tcp_sockaddr()
153 struct addrinfo* ret = nullptr;
154 struct addrinfo hints;
156 memset(&hints, 0, sizeof(hints));
157 hints.ai_flags = AI_NUMERICHOST;
158 hints.ai_family = AF_UNSPEC;
160 if (getaddrinfo(m_address.c_str(), nullptr, &hints, &ret) != 0) {
161 log->error("unable to parse server address (%s)", m_address.c_str());
165 if (ret->ai_family == AF_INET) {
166 memcpy(&m_sockaddr, ret->ai_addr, ret->ai_addrlen);
168 ((struct sockaddr_in*)&m_sockaddr)->sin_port=htons(m_port);
171 #if defined(AF_INET6) && defined(HAVE_STRUCT_SOCKADDR_STORAGE)
172 else if (ret->ai_family == AF_INET6) {
173 memcpy(&m_sockaddr, ret->ai_addr, ret->ai_addrlen);
175 ((struct sockaddr_in6*)&m_sockaddr)->sin6_port=htons(m_port);
180 log->error("unknown address type (%d)", ret->ai_family);
185 bool TCPListener::create(ShibSocket& s) const
187 #ifdef HAVE_STRUCT_SOCKADDR_STORAGE
188 s = socket(m_sockaddr.ss_family, SOCK_STREAM, 0);
190 s = socket(m_sockaddr.sin_family, SOCK_STREAM, 0);
193 if(s == INVALID_SOCKET)
197 return log_error("socket");
201 bool TCPListener::bind(ShibSocket& s, bool force) const
203 // XXX: Do we care about the return value from setsockopt?
205 ::setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (const char*)&opt, sizeof(opt));
208 if (SOCKET_ERROR==::bind(s, (const struct sockaddr*)&m_sockaddr, m_sockaddr.ss_len) || SOCKET_ERROR==::listen(s, 3)) {
214 # ifdef HAVE_STRUCT_SOCKADDR_STORAGE
215 if (::bind(s, (const struct sockaddr*)&m_sockaddr, m_sockaddr.ss_len) < 0)
217 if (::bind(s, (const struct sockaddr*)&m_sockaddr, m_sockaddr.sin_len) < 0)
229 bool TCPListener::connect(ShibSocket& s) const
232 if(SOCKET_ERROR==::connect(s, (const struct sockaddr*)&m_sockaddr, m_sockaddr.ss_len))
233 return log_error("connect");
235 # ifdef HAVE_STRUCT_SOCKADDR_STORAGE
236 if (::connect(s, (const struct sockaddr*)&m_sockaddr, m_sockaddr.ss_len) < 0)
238 if (::connect(s, (const struct sockaddr*)&m_sockaddr, m_sockaddr.sin_len) < 0)
240 return log_error("connect");
245 bool TCPListener::close(ShibSocket& s) const
255 bool TCPListener::accept(ShibSocket& listener, ShibSocket& s) const
257 #ifdef HAVE_STRUCT_SOCKADDR_STORAGE
258 struct sockaddr_storage addr;
260 struct sockaddr_in addr;
262 memset(&addr, 0, sizeof(addr));
265 int size=sizeof(addr);
266 s=::accept(listener, (struct sockaddr*)&addr, &size);
267 if(s==INVALID_SOCKET)
269 socklen_t size=sizeof(addr);
270 s=::accept(listener, (struct sockaddr*)&addr, &size);
273 return log_error("accept");
275 for (vector<IPRange>::const_iterator acl = m_acl.begin(); !found && acl != m_acl.end(); ++acl) {
276 found = acl->contains((const struct sockaddr*)&addr);
281 log->error("accept() rejected client with invalid address");