2 * Copyright 2001-2010 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /* shibresponder.cpp - Shibboleth FastCGI Responder/Handler
23 #include "config_win32.h"
25 #define _CRT_NONSTDC_NO_DEPRECATE 1
26 #define _CRT_SECURE_NO_DEPRECATE 1
27 #define _SCL_SECURE_NO_WARNINGS 1
29 #include <shibsp/AbstractSPRequest.h>
30 #include <shibsp/SPConfig.h>
31 #include <shibsp/ServiceProvider.h>
32 #include <xmltooling/unicode.h>
33 #include <xmltooling/XMLToolingConfig.h>
34 #include <xmltooling/util/NDC.h>
35 #include <xmltooling/util/XMLConstants.h>
36 #include <xmltooling/util/XMLHelper.h>
37 #include <xercesc/util/XMLUniDefs.hpp>
43 # include <sys/mman.h>
47 using namespace shibsp;
48 using namespace xmltooling;
49 using namespace xercesc;
52 static const XMLCh path[] = UNICODE_LITERAL_4(p,a,t,h);
53 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
61 class ShibTargetFCGI : public AbstractSPRequest
65 multimap<string,string> m_headers;
67 string m_scheme,m_hostname;
70 ShibTargetFCGI(FCGX_Request* req, char* post_data, const char* scheme=nullptr, const char* hostname=nullptr, int port=0)
71 : AbstractSPRequest(SHIBSP_LOGCAT".FastCGI"), m_req(req), m_body(post_data) {
73 const char* server_name_str = hostname;
74 if (!server_name_str || !*server_name_str)
75 server_name_str = FCGX_GetParam("SERVER_NAME", req->envp);
76 m_hostname = server_name_str;
80 char* server_port_str = FCGX_GetParam("SERVER_PORT", req->envp);
81 m_port = strtol(server_port_str, &server_port_str, 10);
82 if (*server_port_str) {
83 cerr << "can't parse SERVER_PORT (" << FCGX_GetParam("SERVER_PORT", req->envp) << ")" << endl;
84 throw runtime_error("Unable to determine server port.");
88 const char* server_scheme_str = scheme;
89 if (!server_scheme_str || !*server_scheme_str)
90 server_scheme_str = (m_port == 443 || m_port == 8443) ? "https" : "http";
91 m_scheme = server_scheme_str;
93 setRequestURI(FCGX_GetParam("REQUEST_URI", m_req->envp));
98 const char* getScheme() const {
99 return m_scheme.c_str();
101 const char* getHostname() const {
102 return m_hostname.c_str();
104 int getPort() const {
107 const char* getMethod() const {
108 return FCGX_GetParam("REQUEST_METHOD", m_req->envp);
110 string getContentType() const {
111 const char* s = FCGX_GetParam("CONTENT_TYPE", m_req->envp);
114 long getContentLength() const {
115 const char* s = FCGX_GetParam("CONTENT_LENGTH", m_req->envp);
116 return s ? atol(s) : 0;
118 string getRemoteUser() const {
119 const char* s = FCGX_GetParam("REMOTE_USER", m_req->envp);
122 string getRemoteAddr() const {
123 string ret = AbstractSPRequest::getRemoteAddr();
126 const char* s = FCGX_GetParam("REMOTE_ADDR", m_req->envp);
129 void log(SPLogLevel level, const string& msg) const {
130 AbstractSPRequest::log(level,msg);
131 if (level >= SPError)
132 cerr << "shib: " << msg;
135 string getHeader(const char* name) const {
137 for (; *name; ++name) {
141 hdr += toupper(*name);
143 char* s = FCGX_GetParam(hdr.c_str(), m_req->envp);
147 void setResponseHeader(const char* name, const char* value) {
148 HTTPResponse::setResponseHeader(name, value);
151 m_headers.insert(make_pair(name,value));
153 m_headers.erase(name);
156 const char* getQueryString() const {
157 return FCGX_GetParam("QUERY_STRING", m_req->envp);
160 const char* getRequestBody() const {
164 long sendResponse(istream& in, long status) {
165 string hdr = string("Connection: close\r\n");
166 for (multimap<string,string>::const_iterator i=m_headers.begin(); i!=m_headers.end(); ++i)
167 hdr += i->first + ": " + i->second + "\r\n";
169 const char* codestr="Status: 200 OK";
171 case XMLTOOLING_HTTP_STATUS_ERROR: codestr="Status: 500 Server Error"; break;
172 case XMLTOOLING_HTTP_STATUS_UNAUTHORIZED: codestr="Status: 401 Authorization Required"; break;
173 case XMLTOOLING_HTTP_STATUS_FORBIDDEN: codestr="Status: 403 Forbidden"; break;
174 case XMLTOOLING_HTTP_STATUS_NOTFOUND: codestr="Status: 404 Not Found"; break;
175 case XMLTOOLING_HTTP_STATUS_NOTMODIFIED: codestr="Status: 304 Not Modified"; break;
177 cout << codestr << "\r\n" << hdr << "\r\n";
181 cout.write(buf, in.gcount());
183 return SHIB_RETURN_DONE;
186 long sendRedirect(const char* url) {
187 HTTPResponse::sendRedirect(url);
188 string hdr=string("Status: 302 Please Wait\r\nLocation: ") + url + "\r\n"
189 "Content-Type: text/html\r\n"
190 "Content-Length: 40\r\n"
191 "Expires: 01-Jan-1997 12:00:00 GMT\r\n"
192 "Cache-Control: private,no-store,no-cache\r\n";
193 for (multimap<string,string>::const_iterator i=m_headers.begin(); i!=m_headers.end(); ++i)
194 hdr += i->first + ": " + i->second + "\r\n";
197 cout << hdr << "<HTML><BODY>Redirecting...</BODY></HTML>";
198 return SHIB_RETURN_DONE;
201 long returnDecline() {
202 return SHIB_RETURN_KO;
205 return SHIB_RETURN_OK;
208 const vector<string>& getClientCertificates() const {
209 static vector<string> g_NoCerts;
213 // Not used in the extension.
215 virtual void clearHeader(const char* rawname, const char* cginame) {
216 throw runtime_error("clearHeader not implemented by FastCGI responder.");
219 virtual void setHeader(const char* name, const char* value) {
220 throw runtime_error("setHeader not implemented by FastCGI responder.");
223 virtual void setRemoteUser(const char* user) {
224 throw runtime_error("setRemoteUser not implemented by FastCGI responder.");
228 // Maximum number of bytes allowed to be read from stdin
229 static const unsigned long STDIN_MAX = 1000000;
231 static long gstdin(FCGX_Request* request, char** content)
233 char* clenstr = FCGX_GetParam("CONTENT_LENGTH", request->envp);
234 unsigned long clen = STDIN_MAX;
237 clen = strtol(clenstr, &clenstr, 10);
239 cerr << "can't parse CONTENT_LENGTH (" << FCGX_GetParam("CONTENT_LENGTH", request->envp) << ")" << endl;
243 // *always* put a cap on the amount of data that will be read
244 if (clen > STDIN_MAX)
247 *content = new char[clen];
249 cin.read(*content, clen);
253 // *never* read stdin when CONTENT_LENGTH is missing or unparsable
258 // Chew up any remaining stdin - this shouldn't be necessary
259 // but is because mod_fastcgi doesn't handle it correctly.
261 // ignore() doesn't set the eof bit in some versions of glibc++
262 // so use gcount() instead of eof()...
263 do cin.ignore(1024); while (cin.gcount() == 1024);
268 static void print_ok() {
269 cout << "Status: 200 OK" << "\r\n\r\n";
272 static void print_error(const char* msg) {
273 cout << "Status: 500 Server Error" << "\r\n\r\n" << msg;
278 SPConfig* g_Config=&SPConfig::getConfig();
279 g_Config->setFeatures(
282 SPConfig::RequestMapping |
283 SPConfig::InProcess |
287 if (!g_Config->init()) {
288 cerr << "failed to initialize Shibboleth libraries" << endl;
293 if (!g_Config->instantiate(nullptr, true))
294 throw runtime_error("unknown error");
296 catch (exception& ex) {
298 cerr << "exception while initializing Shibboleth configuration: " << ex.what() << endl;
302 string g_ServerScheme;
306 // Load "authoritative" URL fields.
307 char* var = getenv("SHIBSP_SERVER_NAME");
310 var = getenv("SHIBSP_SERVER_SCHEME");
312 g_ServerScheme = var;
313 var = getenv("SHIBSP_SERVER_PORT");
315 g_ServerPort = atoi(var);
317 streambuf* cin_streambuf = cin.rdbuf();
318 streambuf* cout_streambuf = cout.rdbuf();
319 streambuf* cerr_streambuf = cerr.rdbuf();
321 FCGX_Request request;
324 FCGX_InitRequest(&request, 0, 0);
326 cout << "Shibboleth initialization complete. Starting request loop." << endl;
327 while (FCGX_Accept_r(&request) == 0) {
328 // Note that the default bufsize (0) will cause the use of iostream
329 // methods that require positioning (such as peek(), seek(),
330 // unget() and putback()) to fail (in favour of more efficient IO).
331 fcgi_streambuf cin_fcgi_streambuf(request.in);
332 fcgi_streambuf cout_fcgi_streambuf(request.out);
333 fcgi_streambuf cerr_fcgi_streambuf(request.err);
335 cin.rdbuf(&cin_fcgi_streambuf);
336 cout.rdbuf(&cout_fcgi_streambuf);
337 cerr.rdbuf(&cerr_fcgi_streambuf);
339 // Although FastCGI supports writing before reading,
340 // many http clients (browsers) don't support it (so
341 // the connection deadlocks until a timeout expires!).
343 gstdin(&request, &content);
346 xmltooling::NDC ndc("FastCGI shibresponder");
347 ShibTargetFCGI stf(&request, content, g_ServerScheme.c_str(), g_ServerName.c_str(), g_ServerPort);
349 pair<bool,long> res = stf.getServiceProvider().doHandler(stf);
351 stf.log(SPRequest::SPDebug, "shib: doHandler handled the request");
358 cerr << "shib: doHandler failed to handle the request" << endl;
359 print_error("<html><body>FastCGI Shibboleth responder should only be used for Shibboleth protocol requests.</body></html>");
362 case SHIB_RETURN_DONE:
363 // response already handled
367 cerr << "shib: doHandler returned an unexpected result: " << res.second << endl;
368 print_error("<html><body>FastCGI Shibboleth responder returned an unexpected result.</body></html>");
373 cerr << "shib: doHandler failed to handle request." << endl;
374 print_error("<html><body>FastCGI Shibboleth responder failed to process request.</body></html>");
378 catch (exception& e) {
379 cerr << "shib: FastCGI responder caught an exception: " << e.what() << endl;
380 print_error("<html><body>FastCGI Shibboleth responder caught an exception, check log for details.</body></html>");
385 // If the output streambufs had non-zero bufsizes and
386 // were constructed outside of the accept loop (i.e.
387 // their destructor won't be called here), they would
388 // have to be flushed here.
391 cout << "Request loop ended." << endl;
393 cin.rdbuf(cin_streambuf);
394 cout.rdbuf(cout_streambuf);
395 cerr.rdbuf(cerr_streambuf);