2 * Copyright 2001-2007 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.
18 * CURLSOAPTransport.cpp
20 * libcurl-based SOAPTransport implementation
24 #include "exceptions.h"
26 #include "security/CredentialCriteria.h"
27 #include "security/OpenSSLTrustEngine.h"
28 #include "security/OpenSSLCredential.h"
29 #include "soap/HTTPSOAPTransport.h"
30 #include "soap/OpenSSLSOAPTransport.h"
32 #include "util/Threads.h"
35 #include <curl/curl.h>
36 #include <openssl/x509_vfy.h>
38 using namespace xmltooling::logging;
39 using namespace xmltooling;
42 namespace xmltooling {
44 // Manages cache of socket connections via CURL handles.
45 class XMLTOOL_DLLLOCAL CURLPool
48 CURLPool() : m_size(0), m_lock(Mutex::create()),
49 m_log(Category::getInstance(XMLTOOLING_LOGCAT".SOAPTransport.CURLPool")) {}
52 CURL* get(const SOAPTransport::Address& addr);
53 void put(const char* from, const char* to, const char* endpoint, CURL* handle);
56 typedef map<string,vector<CURL*> > poolmap_t;
57 poolmap_t m_bindingMap;
58 list< vector<CURL*>* > m_pools;
64 static XMLTOOL_DLLLOCAL CURLPool* g_CURLPool = NULL;
66 class XMLTOOL_DLLLOCAL CURLSOAPTransport : public HTTPSOAPTransport, public OpenSSLSOAPTransport
69 CURLSOAPTransport(const Address& addr)
70 : m_sender(addr.m_from ? addr.m_from : ""), m_peerName(addr.m_to ? addr.m_to : ""), m_endpoint(addr.m_endpoint),
71 m_handle(NULL), m_headers(NULL),
72 #ifndef XMLTOOLING_NO_XMLSEC
73 m_cred(NULL), m_trustEngine(NULL), m_peerResolver(NULL), m_mandatory(false),
75 m_ssl_callback(NULL), m_ssl_userptr(NULL), m_chunked(true), m_authenticated(false) {
76 m_handle = g_CURLPool->get(addr);
77 curl_easy_setopt(m_handle,CURLOPT_URL,addr.m_endpoint);
78 curl_easy_setopt(m_handle,CURLOPT_CONNECTTIMEOUT,15);
79 curl_easy_setopt(m_handle,CURLOPT_TIMEOUT,30);
80 curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,0);
81 curl_easy_setopt(m_handle,CURLOPT_USERPWD,NULL);
82 curl_easy_setopt(m_handle,CURLOPT_SSL_VERIFYHOST,2);
83 curl_easy_setopt(m_handle,CURLOPT_HEADERDATA,this);
84 m_headers=curl_slist_append(m_headers,"Content-Type: text/xml");
87 virtual ~CURLSOAPTransport() {
88 curl_slist_free_all(m_headers);
89 curl_easy_setopt(m_handle,CURLOPT_ERRORBUFFER,NULL);
90 curl_easy_setopt(m_handle,CURLOPT_PRIVATE,m_authenticated ? "secure" : NULL); // Save off security "state".
91 g_CURLPool->put(m_sender.c_str(), m_peerName.c_str(), m_endpoint.c_str(), m_handle);
94 bool isConfidential() const {
95 return m_endpoint.find("https")==0;
98 bool setConnectTimeout(long timeout) {
99 return (curl_easy_setopt(m_handle,CURLOPT_CONNECTTIMEOUT,timeout)==CURLE_OK);
102 bool setTimeout(long timeout) {
103 return (curl_easy_setopt(m_handle,CURLOPT_TIMEOUT,timeout)==CURLE_OK);
106 bool setAuth(transport_auth_t authType, const char* username=NULL, const char* password=NULL);
108 bool setVerifyHost(bool verify) {
109 return (curl_easy_setopt(m_handle,CURLOPT_SSL_VERIFYHOST,verify ? 2 : 0)==CURLE_OK);
112 #ifndef XMLTOOLING_NO_XMLSEC
113 bool setCredential(const Credential* cred=NULL) {
114 const OpenSSLCredential* down = dynamic_cast<const OpenSSLCredential*>(cred);
124 const X509TrustEngine* trustEngine=NULL,
125 const CredentialResolver* peerResolver=NULL,
126 CredentialCriteria* criteria=NULL,
129 const OpenSSLTrustEngine* down = dynamic_cast<const OpenSSLTrustEngine*>(trustEngine);
131 m_trustEngine = NULL;
132 m_peerResolver = NULL;
134 return (trustEngine==NULL);
136 m_trustEngine = down;
137 m_peerResolver = peerResolver;
138 m_criteria = criteria;
139 m_mandatory = mandatory;
145 bool useChunkedEncoding(bool chunked=true) {
150 bool setProviderOption(const char* provider, const char* option, const char* value) {
151 if (!provider || strcmp(provider, "CURL"))
153 // For libcurl, the option is an enum and the value type depends on the option.
154 CURLoption opt = static_cast<CURLoption>(strtol(option, NULL, 10));
155 if (opt < CURLOPTTYPE_OBJECTPOINT)
156 return (curl_easy_setopt(m_handle, opt, strtol(value, NULL, 10)) == CURLE_OK);
157 #ifdef CURLOPTTYPE_OFF_T
158 else if (opt < CURLOPTTYPE_OFF_T)
159 return (curl_easy_setopt(m_handle, opt, value) == CURLE_OK);
160 else if (sizeof(curl_off_t) == sizeof(long))
161 return (curl_easy_setopt(m_handle, opt, strtol(value, NULL, 10)) == CURLE_OK);
165 return (curl_easy_setopt(m_handle, opt, value) == CURLE_OK);
169 void send(istream& in);
175 bool isAuthenticated() const {
176 return m_authenticated;
179 void setAuthenticated(bool auth) {
180 m_authenticated = auth;
183 string getContentType() const;
185 bool setRequestHeader(const char* name, const char* val) {
187 temp=temp + ": " + val;
188 m_headers=curl_slist_append(m_headers,temp.c_str());
192 const vector<string>& getResponseHeader(const char* val) const;
194 bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=NULL) {
196 m_ssl_userptr=userptr;
202 string m_sender,m_peerName,m_endpoint,m_simplecreds;
204 stringstream m_stream;
205 struct curl_slist* m_headers;
206 map<string,vector<string> > m_response_headers;
207 #ifndef XMLTOOLING_NO_XMLSEC
208 const OpenSSLCredential* m_cred;
209 const OpenSSLTrustEngine* m_trustEngine;
210 const CredentialResolver* m_peerResolver;
211 CredentialCriteria* m_criteria;
214 ssl_ctx_callback_fn m_ssl_callback;
217 bool m_authenticated;
219 friend size_t XMLTOOL_DLLLOCAL curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream);
220 friend CURLcode XMLTOOL_DLLLOCAL xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr);
221 friend int XMLTOOL_DLLLOCAL verify_callback(X509_STORE_CTX* x509_ctx, void* arg);
224 // libcurl callback functions
225 size_t XMLTOOL_DLLLOCAL curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream);
226 size_t XMLTOOL_DLLLOCAL curl_write_hook(void* ptr, size_t size, size_t nmemb, void* stream);
227 size_t XMLTOOL_DLLLOCAL curl_read_hook( void *ptr, size_t size, size_t nmemb, void *stream);
228 int XMLTOOL_DLLLOCAL curl_debug_hook(CURL* handle, curl_infotype type, char* data, size_t len, void* ptr);
229 CURLcode XMLTOOL_DLLLOCAL xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr);
230 #ifndef XMLTOOLING_NO_XMLSEC
231 int XMLTOOL_DLLLOCAL verify_callback(X509_STORE_CTX* x509_ctx, void* arg);
234 SOAPTransport* CURLSOAPTransportFactory(const SOAPTransport::Address& addr)
236 return new CURLSOAPTransport(addr);
240 void xmltooling::registerSOAPTransports()
242 XMLToolingConfig& conf=XMLToolingConfig::getConfig();
243 conf.SOAPTransportManager.registerFactory("http", CURLSOAPTransportFactory);
244 conf.SOAPTransportManager.registerFactory("https", CURLSOAPTransportFactory);
247 void xmltooling::initSOAPTransports()
249 g_CURLPool=new CURLPool();
252 void xmltooling::termSOAPTransports()
258 CURLPool::~CURLPool()
260 for (poolmap_t::iterator i=m_bindingMap.begin(); i!=m_bindingMap.end(); i++) {
261 for (vector<CURL*>::iterator j=i->second.begin(); j!=i->second.end(); j++)
262 curl_easy_cleanup(*j);
267 CURL* CURLPool::get(const SOAPTransport::Address& addr)
270 xmltooling::NDC("get");
272 m_log.debug("getting connection handle to %s", addr.m_endpoint);
273 string key(addr.m_endpoint);
275 key = key + '|' + addr.m_from;
277 key = key + '|' + addr.m_to;
279 poolmap_t::iterator i=m_bindingMap.find(key);
281 if (i!=m_bindingMap.end()) {
282 // Move this pool to the front of the list.
283 m_pools.remove(&(i->second));
284 m_pools.push_front(&(i->second));
286 // If a free connection exists, return it.
287 if (!(i->second.empty())) {
288 CURL* handle=i->second.back();
289 i->second.pop_back();
292 m_log.debug("returning existing connection handle from pool");
298 m_log.debug("nothing free in pool, returning new connection handle");
300 // Create a new connection and set non-varying options.
301 CURL* handle=curl_easy_init();
304 curl_easy_setopt(handle,CURLOPT_NOPROGRESS,1);
305 curl_easy_setopt(handle,CURLOPT_NOSIGNAL,1);
306 curl_easy_setopt(handle,CURLOPT_FAILONERROR,1);
307 curl_easy_setopt(handle,CURLOPT_SSLVERSION,CURL_SSLVERSION_SSLv3);
308 curl_easy_setopt(handle,CURLOPT_SSL_CIPHER_LIST,"ALL:!aNULL:!LOW:!EXPORT:!SSLv2");
309 // Verification of the peer is via TrustEngine only.
310 curl_easy_setopt(handle,CURLOPT_SSL_VERIFYPEER,0);
311 curl_easy_setopt(handle,CURLOPT_HEADERFUNCTION,&curl_header_hook);
312 curl_easy_setopt(handle,CURLOPT_WRITEFUNCTION,&curl_write_hook);
313 curl_easy_setopt(handle,CURLOPT_DEBUGFUNCTION,&curl_debug_hook);
318 void CURLPool::put(const char* from, const char* to, const char* endpoint, CURL* handle)
320 string key(endpoint);
322 key = key + '|' + from;
324 key = key + '|' + to;
326 poolmap_t::iterator i=m_bindingMap.find(key);
327 if (i==m_bindingMap.end())
328 m_pools.push_front(&(m_bindingMap.insert(poolmap_t::value_type(key,vector<CURL*>(1,handle))).first->second));
330 i->second.push_back(handle);
333 if (++m_size > 256) {
334 // Kick a handle out from the back of the bus.
336 vector<CURL*>* corpse=m_pools.back();
337 if (!corpse->empty()) {
338 killit=corpse->back();
344 // Move an empty pool up to the front so we don't keep hitting it.
346 m_pools.push_front(corpse);
351 curl_easy_cleanup(killit);
353 xmltooling::NDC("put");
355 m_log.info("conn_pool_max limit reached, dropping an old connection");
359 bool CURLSOAPTransport::setAuth(transport_auth_t authType, const char* username, const char* password)
361 if (authType==transport_auth_none) {
362 if (curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,0)!=CURLE_OK)
364 return (curl_easy_setopt(m_handle,CURLOPT_USERPWD,NULL)==CURLE_OK);
368 case transport_auth_basic: flag = CURLAUTH_BASIC; break;
369 case transport_auth_digest: flag = CURLAUTH_DIGEST; break;
370 case transport_auth_ntlm: flag = CURLAUTH_NTLM; break;
371 case transport_auth_gss: flag = CURLAUTH_GSSNEGOTIATE; break;
372 default: return false;
374 if (curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,flag)!=CURLE_OK)
376 m_simplecreds = string(username ? username : "") + ':' + (password ? password : "");
377 return (curl_easy_setopt(m_handle,CURLOPT_USERPWD,m_simplecreds.c_str())==CURLE_OK);
380 const vector<string>& CURLSOAPTransport::getResponseHeader(const char* name) const
382 static vector<string> emptyVector;
384 map<string,vector<string> >::const_iterator i=m_response_headers.find(name);
385 if (i!=m_response_headers.end())
388 for (map<string,vector<string> >::const_iterator j=m_response_headers.begin(); j!=m_response_headers.end(); j++) {
389 #ifdef HAVE_STRCASECMP
390 if (!strcasecmp(j->first.c_str(), name))
392 if (!stricmp(j->first.c_str(), name))
400 string CURLSOAPTransport::getContentType() const
402 char* content_type=NULL;
403 curl_easy_getinfo(m_handle,CURLINFO_CONTENT_TYPE,&content_type);
404 return content_type ? content_type : "";
407 void CURLSOAPTransport::send(istream& in)
410 xmltooling::NDC ndc("send");
412 Category& log=Category::getInstance(XMLTOOLING_LOGCAT".SOAPTransport");
413 Category& log_curl=Category::getInstance(XMLTOOLING_LOGCAT".libcurl");
417 // By this time, the handle has been prepared with the URL to use and the
418 // caller should have executed any set functions to manipulate it.
420 // Setup standard per-call curl properties.
421 curl_easy_setopt(m_handle,CURLOPT_DEBUGDATA,&log_curl);
422 curl_easy_setopt(m_handle,CURLOPT_FILE,&m_stream);
423 curl_easy_setopt(m_handle,CURLOPT_POST,1);
425 m_headers=curl_slist_append(m_headers,"Transfer-Encoding: chunked");
426 curl_easy_setopt(m_handle,CURLOPT_READFUNCTION,&curl_read_hook);
427 curl_easy_setopt(m_handle,CURLOPT_READDATA,&in);
433 msg.append(buf,in.gcount());
435 curl_easy_setopt(m_handle,CURLOPT_READFUNCTION,NULL);
436 curl_easy_setopt(m_handle,CURLOPT_POSTFIELDS,msg.c_str());
437 curl_easy_setopt(m_handle,CURLOPT_POSTFIELDSIZE,msg.length());
440 char curl_errorbuf[CURL_ERROR_SIZE];
442 curl_easy_setopt(m_handle,CURLOPT_ERRORBUFFER,curl_errorbuf);
443 if (log_curl.isDebugEnabled())
444 curl_easy_setopt(m_handle,CURLOPT_VERBOSE,1);
446 // Set request headers.
447 curl_easy_setopt(m_handle,CURLOPT_HTTPHEADER,m_headers);
449 #ifndef XMLTOOLING_NO_XMLSEC
450 if (m_ssl_callback || m_cred || m_trustEngine) {
452 if (m_ssl_callback) {
454 curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_FUNCTION,xml_ssl_ctx_callback);
455 curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_DATA,this);
457 // Restore security "state". Necessary because the callback only runs
458 // when handshakes occur. Even new TCP connections won't execute it.
460 curl_easy_getinfo(m_handle,CURLINFO_PRIVATE,&priv);
462 m_authenticated=true;
465 curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_FUNCTION,NULL);
466 curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_DATA,NULL);
470 log.debug("sending SOAP message to %s", m_endpoint.c_str());
471 if (curl_easy_perform(m_handle) != CURLE_OK) {
473 string("CURLSOAPTransport failed while contacting SOAP responder: ") +
474 (curl_errorbuf[0] ? curl_errorbuf : "no further information available"));
478 // callback to buffer headers from server
479 size_t xmltooling::curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream)
481 // only handle single-byte data
484 CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(stream);
485 char* buf = (char*)malloc(nmemb + 1);
487 memset(buf,0,nmemb + 1);
488 memcpy(buf,ptr,nmemb);
489 char* sep=(char*)strchr(buf,':');
494 char* white=buf+nmemb-1;
495 while (isspace(*white))
497 ctx->m_response_headers[buf].push_back(sep);
505 // callback to send data to server
506 size_t xmltooling::curl_read_hook(void* ptr, size_t size, size_t nmemb, void* stream)
508 // *stream is actually an istream object
509 istream& buf=*(reinterpret_cast<istream*>(stream));
510 buf.read(reinterpret_cast<char*>(ptr),size*nmemb);
514 // callback to buffer data from server
515 size_t xmltooling::curl_write_hook(void* ptr, size_t size, size_t nmemb, void* stream)
517 size_t len = size*nmemb;
518 reinterpret_cast<stringstream*>(stream)->write(reinterpret_cast<const char*>(ptr),len);
522 // callback for curl debug data
523 int xmltooling::curl_debug_hook(CURL* handle, curl_infotype type, char* data, size_t len, void* ptr)
525 // *ptr is actually a logging object
527 CategoryStream log=reinterpret_cast<Category*>(ptr)->debugStream();
528 for (unsigned char* ch=(unsigned char*)data; len && (isprint(*ch) || isspace(*ch)); len--)
533 #ifndef XMLTOOLING_NO_XMLSEC
534 int xmltooling::verify_callback(X509_STORE_CTX* x509_ctx, void* arg)
536 Category& log = Category::getInstance("OpenSSL");
537 log.debug("invoking X509 verify callback");
538 #if (OPENSSL_VERSION_NUMBER >= 0x00907000L)
539 CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(arg);
541 // Yes, this sucks. I'd use TLS, but there's no really obvious spot to put the thread key
542 // and global variables suck too. We can't access the X509_STORE_CTX depth directly because
543 // OpenSSL only copies it into the context if it's >=0, and the unsigned pointer may be
544 // negative in the SSL structure's int member.
545 CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(
546 SSL_get_verify_depth(
547 reinterpret_cast<SSL*>(X509_STORE_CTX_get_ex_data(x509_ctx,SSL_get_ex_data_X509_STORE_CTX_idx()))
553 if (ctx->m_criteria) {
554 ctx->m_criteria->setUsage(Credential::TLS_CREDENTIAL);
555 // Bypass name check (handled for us by curl).
556 ctx->m_criteria->setPeerName(NULL);
557 success = ctx->m_trustEngine->validate(x509_ctx->cert,x509_ctx->untrusted,*(ctx->m_peerResolver),ctx->m_criteria);
560 // Bypass name check (handled for us by curl).
561 CredentialCriteria cc;
562 cc.setUsage(Credential::TLS_CREDENTIAL);
563 success = ctx->m_trustEngine->validate(x509_ctx->cert,x509_ctx->untrusted,*(ctx->m_peerResolver),&cc);
567 log.error("supplied TrustEngine failed to validate SSL/TLS server certificate");
568 x509_ctx->error=X509_V_ERR_APPLICATION_VERIFICATION; // generic error, check log for plugin specifics
569 ctx->setAuthenticated(false);
570 return ctx->m_mandatory ? 0 : 1;
573 // Signal success. Hopefully it doesn't matter what's actually in the structure now.
574 ctx->setAuthenticated(true);
579 // callback to invoke a caller-defined SSL callback
580 CURLcode xmltooling::xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr)
582 CURLSOAPTransport* conf = reinterpret_cast<CURLSOAPTransport*>(userptr);
584 #ifndef XMLTOOLING_NO_XMLSEC
586 conf->m_cred->attach(ssl_ctx);
588 if (conf->m_trustEngine) {
589 SSL_CTX_set_verify(ssl_ctx,SSL_VERIFY_PEER,NULL);
590 #if (OPENSSL_VERSION_NUMBER >= 0x00907000L)
591 // With 0.9.7, we can pass a callback argument directly.
592 SSL_CTX_set_cert_verify_callback(ssl_ctx,verify_callback,userptr);
594 // With 0.9.6, there's no argument, so we're going to use a really embarrassing hack and
595 // stuff the argument in the depth property where it will get copied to the context object
596 // that's handed to the callback.
597 SSL_CTX_set_cert_verify_callback(ssl_ctx,reinterpret_cast<int (*)()>(verify_callback),NULL);
598 SSL_CTX_set_verify_depth(ssl_ctx,reinterpret_cast<int>(userptr));
603 if (conf->m_ssl_callback && !conf->m_ssl_callback(conf, ssl_ctx, conf->m_ssl_userptr))
604 return CURLE_SSL_CERTPROBLEM;