xmltooling/soap/impl/CURLSOAPTransport.cpp

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * CURLSOAPTransport.cpp
  19  *
  20  * libcurl-based SOAPTransport implementation
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "logging.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"
  31 #include "util/NDC.h"
  32 #include "util/Threads.h"
  33
  34 #include <list>
  35 #include <curl/curl.h>
  36 #include <openssl/x509_vfy.h>
  37
  38 using namespace xmltooling::logging;
  39 using namespace xmltooling;
  40 using namespace std;
  41
  42 namespace xmltooling {
  43
  44     // Manages cache of socket connections via CURL handles.
  45     class XMLTOOL_DLLLOCAL CURLPool
  46     {
  47     public:
  48         CURLPool() : m_size(0), m_lock(Mutex::create()),
  49             m_log(Category::getInstance(XMLTOOLING_LOGCAT".SOAPTransport.CURL")) {}
  50         ~CURLPool();
  51
  52         CURL* get(const SOAPTransport::Address& addr);
  53         void put(const char* from, const char* to, const char* endpoint, CURL* handle);
  54
  55     private:
  56         typedef map<string,vector<CURL*> > poolmap_t;
  57         poolmap_t m_bindingMap;
  58         list< vector<CURL*>* > m_pools;
  59         long m_size;
  60         Mutex* m_lock;
  61         Category& m_log;
  62     };
  63
  64     static XMLTOOL_DLLLOCAL CURLPool* g_CURLPool = NULL;
  65
  66     class XMLTOOL_DLLLOCAL CURLSOAPTransport : public HTTPSOAPTransport, public OpenSSLSOAPTransport
  67     {
  68     public:
  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),
  74 #endif
  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");
  85         }
  86
  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);
  92         }
  93
  94         bool isConfidential() const {
  95             return m_endpoint.find("https")==0;
  96         }
  97
  98         bool setConnectTimeout(long timeout) {
  99             return (curl_easy_setopt(m_handle,CURLOPT_CONNECTTIMEOUT,timeout)==CURLE_OK);
 100         }
 101
 102         bool setTimeout(long timeout) {
 103             return (curl_easy_setopt(m_handle,CURLOPT_TIMEOUT,timeout)==CURLE_OK);
 104         }
 105
 106         bool setAuth(transport_auth_t authType, const char* username=NULL, const char* password=NULL);
 107
 108         bool setVerifyHost(bool verify) {
 109             return (curl_easy_setopt(m_handle,CURLOPT_SSL_VERIFYHOST,verify ? 2 : 0)==CURLE_OK);
 110         }
 111
 112 #ifndef XMLTOOLING_NO_XMLSEC
 113         bool setCredential(const Credential* cred=NULL) {
 114             const OpenSSLCredential* down = dynamic_cast<const OpenSSLCredential*>(cred);
 115             if (!down) {
 116                 m_cred = NULL;
 117                 return (cred==NULL);
 118             }
 119             m_cred = down;
 120             return true;
 121         }
 122
 123         bool setTrustEngine(
 124             const X509TrustEngine* trustEngine=NULL,
 125             const CredentialResolver* peerResolver=NULL,
 126             CredentialCriteria* criteria=NULL,
 127             bool mandatory=true
 128             ) {
 129             const OpenSSLTrustEngine* down = dynamic_cast<const OpenSSLTrustEngine*>(trustEngine);
 130             if (!down) {
 131                 m_trustEngine = NULL;
 132                 m_peerResolver = NULL;
 133                 m_criteria = NULL;
 134                 return (trustEngine==NULL);
 135             }
 136             m_trustEngine = down;
 137             m_peerResolver = peerResolver;
 138             m_criteria = criteria;
 139             m_mandatory = mandatory;
 140             return true;
 141         }
 142
 143 #endif
 144
 145         bool useChunkedEncoding(bool chunked=true) {
 146             m_chunked = chunked;
 147             return true;
 148         }
 149
 150         bool setProviderOption(const char* provider, const char* option, const char* value) {
 151             if (!provider || strcmp(provider, "CURL"))
 152                 return false;
 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                 if (value)
 160                     m_saved_options.push_back(value);
 161                 return (curl_easy_setopt(m_handle, opt, value ? m_saved_options.back().c_str() : NULL) == CURLE_OK);
 162             }
 163 # ifdef HAVE_CURL_OFF_T
 164             else if (sizeof(curl_off_t) == sizeof(long))
 165                 return (curl_easy_setopt(m_handle, opt, strtol(value, NULL, 10)) == CURLE_OK);
 166 # else
 167             else if (sizeof(off_t) == sizeof(long))
 168                 return (curl_easy_setopt(m_handle, opt, strtol(value, NULL, 10)) == CURLE_OK);
 169 # endif
 170             return false;
 171 #else
 172             else {
 173                 if (value)
 174                     m_saved_options.push_back(value);
 175                 return (curl_easy_setopt(m_handle, opt, value ? m_saved_options.back().c_str() : NULL) == CURLE_OK);
 176             }
 177 #endif
 178         }
 179
 180         void send(istream& in) {
 181             send(&in);
 182         }
 183
 184         void send(istream* in=NULL);
 185
 186         istream& receive() {
 187             return m_stream;
 188         }
 189
 190         bool isAuthenticated() const {
 191             return m_authenticated;
 192         }
 193
 194         void setAuthenticated(bool auth) {
 195             m_authenticated = auth;
 196         }
 197
 198         string getContentType() const;
 199
 200         bool setRequestHeader(const char* name, const char* val) {
 201             string temp(name);
 202             temp=temp + ": " + val;
 203             m_headers=curl_slist_append(m_headers,temp.c_str());
 204             return true;
 205         }
 206
 207         const vector<string>& getResponseHeader(const char* val) const;
 208
 209         bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=NULL) {
 210             m_ssl_callback=fn;
 211             m_ssl_userptr=userptr;
 212             return true;
 213         }
 214
 215     private:
 216         // per-call state
 217         string m_sender,m_peerName,m_endpoint,m_simplecreds;
 218         CURL* m_handle;
 219         stringstream m_stream;
 220         struct curl_slist* m_headers;
 221         map<string,vector<string> > m_response_headers;
 222         vector<string> m_saved_options;
 223 #ifndef XMLTOOLING_NO_XMLSEC
 224         const OpenSSLCredential* m_cred;
 225         const OpenSSLTrustEngine* m_trustEngine;
 226         const CredentialResolver* m_peerResolver;
 227         CredentialCriteria* m_criteria;
 228         bool m_mandatory;
 229 #endif
 230         ssl_ctx_callback_fn m_ssl_callback;
 231         void* m_ssl_userptr;
 232         bool m_chunked;
 233         bool m_authenticated;
 234
 235         friend size_t XMLTOOL_DLLLOCAL curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream);
 236         friend CURLcode XMLTOOL_DLLLOCAL xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr);
 237         friend int XMLTOOL_DLLLOCAL verify_callback(X509_STORE_CTX* x509_ctx, void* arg);
 238     };
 239
 240     // libcurl callback functions
 241     size_t XMLTOOL_DLLLOCAL curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream);
 242     size_t XMLTOOL_DLLLOCAL curl_write_hook(void* ptr, size_t size, size_t nmemb, void* stream);
 243     size_t XMLTOOL_DLLLOCAL curl_read_hook( void *ptr, size_t size, size_t nmemb, void *stream);
 244     int XMLTOOL_DLLLOCAL curl_debug_hook(CURL* handle, curl_infotype type, char* data, size_t len, void* ptr);
 245     CURLcode XMLTOOL_DLLLOCAL xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr);
 246 #ifndef XMLTOOLING_NO_XMLSEC
 247     int XMLTOOL_DLLLOCAL verify_callback(X509_STORE_CTX* x509_ctx, void* arg);
 248 #endif
 249
 250     SOAPTransport* CURLSOAPTransportFactory(const SOAPTransport::Address& addr)
 251     {
 252         return new CURLSOAPTransport(addr);
 253     }
 254 };
 255
 256 void xmltooling::registerSOAPTransports()
 257 {
 258     XMLToolingConfig& conf=XMLToolingConfig::getConfig();
 259     conf.SOAPTransportManager.registerFactory("http", CURLSOAPTransportFactory);
 260     conf.SOAPTransportManager.registerFactory("https", CURLSOAPTransportFactory);
 261 }
 262
 263 void xmltooling::initSOAPTransports()
 264 {
 265     g_CURLPool=new CURLPool();
 266 }
 267
 268 void xmltooling::termSOAPTransports()
 269 {
 270     delete g_CURLPool;
 271     g_CURLPool = NULL;
 272 }
 273
 274 SOAPTransport::SOAPTransport()
 275 {
 276 }
 277
 278 SOAPTransport::~SOAPTransport()
 279 {
 280 }
 281
 282 bool SOAPTransport::setProviderOption(const char* provider, const char* option, const char* value)
 283 {
 284     return false;
 285 }
 286
 287 HTTPSOAPTransport::HTTPSOAPTransport()
 288 {
 289 }
 290
 291 HTTPSOAPTransport::~HTTPSOAPTransport()
 292 {
 293 }
 294
 295 OpenSSLSOAPTransport::OpenSSLSOAPTransport()
 296 {
 297 }
 298
 299 OpenSSLSOAPTransport::~OpenSSLSOAPTransport()
 300 {
 301 }
 302
 303 CURLPool::~CURLPool()
 304 {
 305     for (poolmap_t::iterator i=m_bindingMap.begin(); i!=m_bindingMap.end(); i++) {
 306         for (vector<CURL*>::iterator j=i->second.begin(); j!=i->second.end(); j++)
 307             curl_easy_cleanup(*j);
 308     }
 309     delete m_lock;
 310 }
 311
 312 CURL* CURLPool::get(const SOAPTransport::Address& addr)
 313 {
 314 #ifdef _DEBUG
 315     xmltooling::NDC("get");
 316 #endif
 317     m_log.debug("getting connection handle to %s", addr.m_endpoint);
 318     string key(addr.m_endpoint);
 319     if (addr.m_from)
 320         key = key + '|' + addr.m_from;
 321     if (addr.m_to)
 322         key = key + '|' + addr.m_to;
 323     m_lock->lock();
 324     poolmap_t::iterator i=m_bindingMap.find(key);
 325
 326     if (i!=m_bindingMap.end()) {
 327         // Move this pool to the front of the list.
 328         m_pools.remove(&(i->second));
 329         m_pools.push_front(&(i->second));
 330
 331         // If a free connection exists, return it.
 332         if (!(i->second.empty())) {
 333             CURL* handle=i->second.back();
 334             i->second.pop_back();
 335             m_size--;
 336             m_lock->unlock();
 337             m_log.debug("returning existing connection handle from pool");
 338             return handle;
 339         }
 340     }
 341
 342     m_lock->unlock();
 343     m_log.debug("nothing free in pool, returning new connection handle");
 344
 345     // Create a new connection and set non-varying options.
 346     CURL* handle=curl_easy_init();
 347     if (!handle)
 348         return NULL;
 349     curl_easy_setopt(handle,CURLOPT_NOPROGRESS,1);
 350     curl_easy_setopt(handle,CURLOPT_NOSIGNAL,1);
 351     curl_easy_setopt(handle,CURLOPT_FAILONERROR,1);
 352     curl_easy_setopt(handle,CURLOPT_SSL_CIPHER_LIST,"ALL:!aNULL:!LOW:!EXPORT:!SSLv2");
 353     // Verification of the peer is via TrustEngine only.
 354     curl_easy_setopt(handle,CURLOPT_SSL_VERIFYPEER,0);
 355     curl_easy_setopt(handle,CURLOPT_CAINFO,NULL);
 356     curl_easy_setopt(handle,CURLOPT_HEADERFUNCTION,&curl_header_hook);
 357     curl_easy_setopt(handle,CURLOPT_WRITEFUNCTION,&curl_write_hook);
 358     curl_easy_setopt(handle,CURLOPT_DEBUGFUNCTION,&curl_debug_hook);
 359
 360     return handle;
 361 }
 362
 363 void CURLPool::put(const char* from, const char* to, const char* endpoint, CURL* handle)
 364 {
 365     string key(endpoint);
 366     if (from)
 367         key = key + '|' + from;
 368     if (to)
 369         key = key + '|' + to;
 370     m_lock->lock();
 371     poolmap_t::iterator i=m_bindingMap.find(key);
 372     if (i==m_bindingMap.end())
 373         m_pools.push_front(&(m_bindingMap.insert(poolmap_t::value_type(key,vector<CURL*>(1,handle))).first->second));
 374     else
 375         i->second.push_back(handle);
 376
 377     CURL* killit=NULL;
 378     if (++m_size > 256) {
 379         // Kick a handle out from the back of the bus.
 380         while (true) {
 381             vector<CURL*>* corpse=m_pools.back();
 382             if (!corpse->empty()) {
 383                 killit=corpse->back();
 384                 corpse->pop_back();
 385                 m_size--;
 386                 break;
 387             }
 388
 389             // Move an empty pool up to the front so we don't keep hitting it.
 390             m_pools.pop_back();
 391             m_pools.push_front(corpse);
 392         }
 393     }
 394     m_lock->unlock();
 395     if (killit) {
 396         curl_easy_cleanup(killit);
 397 #ifdef _DEBUG
 398         xmltooling::NDC("put");
 399 #endif
 400         m_log.info("conn_pool_max limit reached, dropping an old connection");
 401     }
 402 }
 403
 404 bool CURLSOAPTransport::setAuth(transport_auth_t authType, const char* username, const char* password)
 405 {
 406     if (authType==transport_auth_none) {
 407         if (curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,0)!=CURLE_OK)
 408             return false;
 409         return (curl_easy_setopt(m_handle,CURLOPT_USERPWD,NULL)==CURLE_OK);
 410     }
 411     long flag=0;
 412     switch (authType) {
 413         case transport_auth_basic:    flag = CURLAUTH_BASIC; break;
 414         case transport_auth_digest:   flag = CURLAUTH_DIGEST; break;
 415         case transport_auth_ntlm:     flag = CURLAUTH_NTLM; break;
 416         case transport_auth_gss:      flag = CURLAUTH_GSSNEGOTIATE; break;
 417         default:            return false;
 418     }
 419     if (curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,flag)!=CURLE_OK)
 420         return false;
 421     m_simplecreds = string(username ? username : "") + ':' + (password ? password : "");
 422     return (curl_easy_setopt(m_handle,CURLOPT_USERPWD,m_simplecreds.c_str())==CURLE_OK);
 423 }
 424
 425 const vector<string>& CURLSOAPTransport::getResponseHeader(const char* name) const
 426 {
 427     static vector<string> emptyVector;
 428
 429     map<string,vector<string> >::const_iterator i=m_response_headers.find(name);
 430     if (i!=m_response_headers.end())
 431         return i->second;
 432
 433     for (map<string,vector<string> >::const_iterator j=m_response_headers.begin(); j!=m_response_headers.end(); j++) {
 434 #ifdef HAVE_STRCASECMP
 435         if (!strcasecmp(j->first.c_str(), name))
 436 #else
 437         if (!stricmp(j->first.c_str(), name))
 438 #endif
 439             return j->second;
 440     }
 441
 442     return emptyVector;
 443 }
 444
 445 string CURLSOAPTransport::getContentType() const
 446 {
 447     char* content_type=NULL;
 448     curl_easy_getinfo(m_handle,CURLINFO_CONTENT_TYPE,&content_type);
 449     return content_type ? content_type : "";
 450 }
 451
 452 void CURLSOAPTransport::send(istream* in)
 453 {
 454 #ifdef _DEBUG
 455     xmltooling::NDC ndc("send");
 456 #endif
 457     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".SOAPTransport.CURL");
 458     Category& log_curl=Category::getInstance(XMLTOOLING_LOGCAT".libcurl");
 459
 460     // For this implementation, it's sufficient to check for https as a sign of transport security.
 461     if (m_mandatory && !isConfidential())
 462         throw IOException("Blocking unprotected HTTP request, transport authentication by server required.");
 463
 464     string msg;
 465
 466     // By this time, the handle has been prepared with the URL to use and the
 467     // caller should have executed any set functions to manipulate it.
 468
 469     // Setup standard per-call curl properties.
 470     curl_easy_setopt(m_handle,CURLOPT_DEBUGDATA,&log_curl);
 471     curl_easy_setopt(m_handle,CURLOPT_FILE,&m_stream);
 472     if (m_chunked && in) {
 473         curl_easy_setopt(m_handle,CURLOPT_POST,1);
 474         m_headers=curl_slist_append(m_headers,"Transfer-Encoding: chunked");
 475         curl_easy_setopt(m_handle,CURLOPT_READFUNCTION,&curl_read_hook);
 476         curl_easy_setopt(m_handle,CURLOPT_READDATA,in);
 477     }
 478     else if (in) {
 479         char buf[1024];
 480         while (*in) {
 481             in->read(buf,1024);
 482             msg.append(buf,in->gcount());
 483         }
 484         curl_easy_setopt(m_handle,CURLOPT_POST,1);
 485         curl_easy_setopt(m_handle,CURLOPT_READFUNCTION,NULL);
 486         curl_easy_setopt(m_handle,CURLOPT_POSTFIELDS,msg.c_str());
 487         curl_easy_setopt(m_handle,CURLOPT_POSTFIELDSIZE,msg.length());
 488     }
 489     else {
 490         curl_easy_setopt(m_handle,CURLOPT_HTTPGET,1);
 491     }
 492
 493     char curl_errorbuf[CURL_ERROR_SIZE];
 494     curl_errorbuf[0]=0;
 495     curl_easy_setopt(m_handle,CURLOPT_ERRORBUFFER,curl_errorbuf);
 496     if (log_curl.isDebugEnabled())
 497         curl_easy_setopt(m_handle,CURLOPT_VERBOSE,1);
 498
 499     // Set request headers.
 500     curl_easy_setopt(m_handle,CURLOPT_HTTPHEADER,m_headers);
 501
 502 #ifndef XMLTOOLING_NO_XMLSEC
 503     if (m_ssl_callback || m_cred || m_trustEngine) {
 504 #else
 505     if (m_ssl_callback) {
 506 #endif
 507         curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_FUNCTION,xml_ssl_ctx_callback);
 508         curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_DATA,this);
 509
 510         // Restore security "state". Necessary because the callback only runs
 511         // when handshakes occur. Even new TCP connections won't execute it.
 512         char* priv=NULL;
 513         curl_easy_getinfo(m_handle,CURLINFO_PRIVATE,&priv);
 514         if (priv)
 515             m_authenticated=true;
 516     }
 517     else {
 518         curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_FUNCTION,NULL);
 519         curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_DATA,NULL);
 520     }
 521
 522     // Make the call.
 523     log.debug("sending SOAP message to %s", m_endpoint.c_str());
 524     if (curl_easy_perform(m_handle) != CURLE_OK) {
 525         throw IOException(
 526             string("CURLSOAPTransport failed while contacting SOAP endpoint (") + m_endpoint + "): " +
 527                 (curl_errorbuf[0] ? curl_errorbuf : "no further information available"));
 528     }
 529 }
 530
 531 // callback to buffer headers from server
 532 size_t xmltooling::curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream)
 533 {
 534     // only handle single-byte data
 535     if (size!=1)
 536         return 0;
 537     CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(stream);
 538     char* buf = (char*)malloc(nmemb + 1);
 539     if (buf) {
 540         memset(buf,0,nmemb + 1);
 541         memcpy(buf,ptr,nmemb);
 542         char* sep=(char*)strchr(buf,':');
 543         if (sep) {
 544             *(sep++)=0;
 545             while (*sep==' ')
 546                 *(sep++)=0;
 547             char* white=buf+nmemb-1;
 548             while (isspace(*white))
 549                 *(white--)=0;
 550             ctx->m_response_headers[buf].push_back(sep);
 551         }
 552         free(buf);
 553         return nmemb;
 554     }
 555     return 0;
 556 }
 557
 558 // callback to send data to server
 559 size_t xmltooling::curl_read_hook(void* ptr, size_t size, size_t nmemb, void* stream)
 560 {
 561     // stream is actually an istream pointer
 562     istream* buf=reinterpret_cast<istream*>(stream);
 563     buf->read(reinterpret_cast<char*>(ptr),size*nmemb);
 564     return buf->gcount();
 565 }
 566
 567 // callback to buffer data from server
 568 size_t xmltooling::curl_write_hook(void* ptr, size_t size, size_t nmemb, void* stream)
 569 {
 570     size_t len = size*nmemb;
 571     reinterpret_cast<stringstream*>(stream)->write(reinterpret_cast<const char*>(ptr),len);
 572     return len;
 573 }
 574
 575 // callback for curl debug data
 576 int xmltooling::curl_debug_hook(CURL* handle, curl_infotype type, char* data, size_t len, void* ptr)
 577 {
 578     // *ptr is actually a logging object
 579     if (!ptr) return 0;
 580     CategoryStream log=reinterpret_cast<Category*>(ptr)->debugStream();
 581     for (unsigned char* ch=(unsigned char*)data; len && (isprint(*ch) || isspace(*ch)); len--)
 582         log << *ch++;
 583     return 0;
 584 }
 585
 586 #ifndef XMLTOOLING_NO_XMLSEC
 587 int xmltooling::verify_callback(X509_STORE_CTX* x509_ctx, void* arg)
 588 {
 589     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".SOAPTransport.CURL");
 590     log.debug("invoking custom X.509 verify callback");
 591 #if (OPENSSL_VERSION_NUMBER >= 0x00907000L)
 592     CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(arg);
 593 #else
 594     // Yes, this sucks. I'd use TLS, but there's no really obvious spot to put the thread key
 595     // and global variables suck too. We can't access the X509_STORE_CTX depth directly because
 596     // OpenSSL only copies it into the context if it's >=0, and the unsigned pointer may be
 597     // negative in the SSL structure's int member.
 598     CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(
 599         SSL_get_verify_depth(
 600             reinterpret_cast<SSL*>(X509_STORE_CTX_get_ex_data(x509_ctx,SSL_get_ex_data_X509_STORE_CTX_idx()))
 601             )
 602         );
 603 #endif
 604
 605     bool success=false;
 606     if (ctx->m_criteria) {
 607         ctx->m_criteria->setUsage(Credential::TLS_CREDENTIAL);
 608         // Bypass name check (handled for us by curl).
 609         ctx->m_criteria->setPeerName(NULL);
 610         success = ctx->m_trustEngine->validate(x509_ctx->cert,x509_ctx->untrusted,*(ctx->m_peerResolver),ctx->m_criteria);
 611     }
 612     else {
 613         // Bypass name check (handled for us by curl).
 614         CredentialCriteria cc;
 615         cc.setUsage(Credential::TLS_CREDENTIAL);
 616         success = ctx->m_trustEngine->validate(x509_ctx->cert,x509_ctx->untrusted,*(ctx->m_peerResolver),&cc);
 617     }
 618
 619     if (!success) {
 620         log.error("supplied TrustEngine failed to validate SSL/TLS server certificate");
 621         x509_ctx->error=X509_V_ERR_APPLICATION_VERIFICATION;     // generic error, check log for plugin specifics
 622         ctx->setAuthenticated(false);
 623         return ctx->m_mandatory ? 0 : 1;
 624     }
 625
 626     // Signal success. Hopefully it doesn't matter what's actually in the structure now.
 627     ctx->setAuthenticated(true);
 628     return 1;
 629 }
 630 #endif
 631
 632 // callback to invoke a caller-defined SSL callback
 633 CURLcode xmltooling::xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr)
 634 {
 635     CURLSOAPTransport* conf = reinterpret_cast<CURLSOAPTransport*>(userptr);
 636
 637     // Manually disable SSLv2 so we're not dependent on libcurl to do it.
 638     // Also disable the ticket option where implemented, since this breaks a variety
 639     // of servers. Newer libcurl also does this for us.
 640 #ifdef SSL_OP_NO_TICKET
 641     SSL_CTX_set_options(ssl_ctx, SSL_OP_ALL|SSL_OP_NO_SSLv2|SSL_OP_NO_TICKET);
 642 #else
 643     SSL_CTX_set_options(ssl_ctx, SSL_OP_ALL|SSL_OP_NO_SSLv2);
 644 #endif
 645
 646 #ifndef XMLTOOLING_NO_XMLSEC
 647     if (conf->m_cred)
 648         conf->m_cred->attach(ssl_ctx);
 649
 650     if (conf->m_trustEngine) {
 651         SSL_CTX_set_verify(ssl_ctx,SSL_VERIFY_PEER,NULL);
 652 #if (OPENSSL_VERSION_NUMBER >= 0x00907000L)
 653         // With 0.9.7, we can pass a callback argument directly.
 654         SSL_CTX_set_cert_verify_callback(ssl_ctx,verify_callback,userptr);
 655 #else
 656         // With 0.9.6, there's no argument, so we're going to use a really embarrassing hack and
 657         // stuff the argument in the depth property where it will get copied to the context object
 658         // that's handed to the callback.
 659         SSL_CTX_set_cert_verify_callback(ssl_ctx,reinterpret_cast<int (*)()>(verify_callback),NULL);
 660         SSL_CTX_set_verify_depth(ssl_ctx,reinterpret_cast<int>(userptr));
 661 #endif
 662     }
 663 #endif
 664
 665     if (conf->m_ssl_callback && !conf->m_ssl_callback(conf, ssl_ctx, conf->m_ssl_userptr))
 666         return CURLE_SSL_CERTPROBLEM;
 667
 668     return CURLE_OK;
 669 }