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