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