xmltooling/soap/impl/CURLSOAPTransport.cpp

   1 /*
   2  *  Copyright 2001-2007 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.CURLPool")) {}
  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             else if (sizeof(curl_off_t) == sizeof(long))
 161                 return (curl_easy_setopt(m_handle, opt, strtol(value, NULL, 10)) == CURLE_OK);
 162             return false;
 163 #else
 164             else
 165                 return (curl_easy_setopt(m_handle, opt, value) == CURLE_OK);
 166 #endif
 167         }
 168
 169         void send(istream& in);
 170
 171         istream& receive() {
 172             return m_stream;
 173         }
 174
 175         bool isAuthenticated() const {
 176             return m_authenticated;
 177         }
 178
 179         void setAuthenticated(bool auth) {
 180             m_authenticated = auth;
 181         }
 182
 183         string getContentType() const;
 184
 185         bool setRequestHeader(const char* name, const char* val) {
 186             string temp(name);
 187             temp=temp + ": " + val;
 188             m_headers=curl_slist_append(m_headers,temp.c_str());
 189             return true;
 190         }
 191
 192         const vector<string>& getResponseHeader(const char* val) const;
 193
 194         bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=NULL) {
 195             m_ssl_callback=fn;
 196             m_ssl_userptr=userptr;
 197             return true;
 198         }
 199
 200     private:
 201         // per-call state
 202         string m_sender,m_peerName,m_endpoint,m_simplecreds;
 203         CURL* m_handle;
 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;
 212         bool m_mandatory;
 213 #endif
 214         ssl_ctx_callback_fn m_ssl_callback;
 215         void* m_ssl_userptr;
 216         bool m_chunked;
 217         bool m_authenticated;
 218
 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);
 222     };
 223
 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);
 232 #endif
 233
 234     SOAPTransport* CURLSOAPTransportFactory(const SOAPTransport::Address& addr)
 235     {
 236         return new CURLSOAPTransport(addr);
 237     }
 238 };
 239
 240 void xmltooling::registerSOAPTransports()
 241 {
 242     XMLToolingConfig& conf=XMLToolingConfig::getConfig();
 243     conf.SOAPTransportManager.registerFactory("http", CURLSOAPTransportFactory);
 244     conf.SOAPTransportManager.registerFactory("https", CURLSOAPTransportFactory);
 245 }
 246
 247 void xmltooling::initSOAPTransports()
 248 {
 249     g_CURLPool=new CURLPool();
 250 }
 251
 252 void xmltooling::termSOAPTransports()
 253 {
 254     delete g_CURLPool;
 255     g_CURLPool = NULL;
 256 }
 257
 258 CURLPool::~CURLPool()
 259 {
 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);
 263     }
 264     delete m_lock;
 265 }
 266
 267 CURL* CURLPool::get(const SOAPTransport::Address& addr)
 268 {
 269 #ifdef _DEBUG
 270     xmltooling::NDC("get");
 271 #endif
 272     m_log.debug("getting connection handle to %s", addr.m_endpoint);
 273     string key(addr.m_endpoint);
 274     if (addr.m_from)
 275         key = key + '|' + addr.m_from;
 276     if (addr.m_to)
 277         key = key + '|' + addr.m_to;
 278     m_lock->lock();
 279     poolmap_t::iterator i=m_bindingMap.find(key);
 280
 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));
 285
 286         // If a free connection exists, return it.
 287         if (!(i->second.empty())) {
 288             CURL* handle=i->second.back();
 289             i->second.pop_back();
 290             m_size--;
 291             m_lock->unlock();
 292             m_log.debug("returning existing connection handle from pool");
 293             return handle;
 294         }
 295     }
 296
 297     m_lock->unlock();
 298     m_log.debug("nothing free in pool, returning new connection handle");
 299
 300     // Create a new connection and set non-varying options.
 301     CURL* handle=curl_easy_init();
 302     if (!handle)
 303         return NULL;
 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);
 314
 315     return handle;
 316 }
 317
 318 void CURLPool::put(const char* from, const char* to, const char* endpoint, CURL* handle)
 319 {
 320     string key(endpoint);
 321     if (from)
 322         key = key + '|' + from;
 323     if (to)
 324         key = key + '|' + to;
 325     m_lock->lock();
 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));
 329     else
 330         i->second.push_back(handle);
 331
 332     CURL* killit=NULL;
 333     if (++m_size > 256) {
 334         // Kick a handle out from the back of the bus.
 335         while (true) {
 336             vector<CURL*>* corpse=m_pools.back();
 337             if (!corpse->empty()) {
 338                 killit=corpse->back();
 339                 corpse->pop_back();
 340                 m_size--;
 341                 break;
 342             }
 343
 344             // Move an empty pool up to the front so we don't keep hitting it.
 345             m_pools.pop_back();
 346             m_pools.push_front(corpse);
 347         }
 348     }
 349     m_lock->unlock();
 350     if (killit) {
 351         curl_easy_cleanup(killit);
 352 #ifdef _DEBUG
 353         xmltooling::NDC("put");
 354 #endif
 355         m_log.info("conn_pool_max limit reached, dropping an old connection");
 356     }
 357 }
 358
 359 bool CURLSOAPTransport::setAuth(transport_auth_t authType, const char* username, const char* password)
 360 {
 361     if (authType==transport_auth_none) {
 362         if (curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,0)!=CURLE_OK)
 363             return false;
 364         return (curl_easy_setopt(m_handle,CURLOPT_USERPWD,NULL)==CURLE_OK);
 365     }
 366     long flag=0;
 367     switch (authType) {
 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;
 373     }
 374     if (curl_easy_setopt(m_handle,CURLOPT_HTTPAUTH,flag)!=CURLE_OK)
 375         return false;
 376     m_simplecreds = string(username ? username : "") + ':' + (password ? password : "");
 377     return (curl_easy_setopt(m_handle,CURLOPT_USERPWD,m_simplecreds.c_str())==CURLE_OK);
 378 }
 379
 380 const vector<string>& CURLSOAPTransport::getResponseHeader(const char* name) const
 381 {
 382     static vector<string> emptyVector;
 383
 384     map<string,vector<string> >::const_iterator i=m_response_headers.find(name);
 385     if (i!=m_response_headers.end())
 386         return i->second;
 387
 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))
 391 #else
 392         if (!stricmp(j->first.c_str(), name))
 393 #endif
 394             return j->second;
 395     }
 396
 397     return emptyVector;
 398 }
 399
 400 string CURLSOAPTransport::getContentType() const
 401 {
 402     char* content_type=NULL;
 403     curl_easy_getinfo(m_handle,CURLINFO_CONTENT_TYPE,&content_type);
 404     return content_type ? content_type : "";
 405 }
 406
 407 void CURLSOAPTransport::send(istream& in)
 408 {
 409 #ifdef _DEBUG
 410     xmltooling::NDC ndc("send");
 411 #endif
 412     Category& log=Category::getInstance(XMLTOOLING_LOGCAT".SOAPTransport");
 413     Category& log_curl=Category::getInstance(XMLTOOLING_LOGCAT".libcurl");
 414
 415     string msg;
 416
 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.
 419
 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);
 424     if (m_chunked) {
 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);
 428     }
 429     else {
 430         char buf[1024];
 431         while (in) {
 432             in.read(buf,1024);
 433             msg.append(buf,in.gcount());
 434         }
 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());
 438     }
 439
 440     char curl_errorbuf[CURL_ERROR_SIZE];
 441     curl_errorbuf[0]=0;
 442     curl_easy_setopt(m_handle,CURLOPT_ERRORBUFFER,curl_errorbuf);
 443     if (log_curl.isDebugEnabled())
 444         curl_easy_setopt(m_handle,CURLOPT_VERBOSE,1);
 445
 446     // Set request headers.
 447     curl_easy_setopt(m_handle,CURLOPT_HTTPHEADER,m_headers);
 448
 449 #ifndef XMLTOOLING_NO_XMLSEC
 450     if (m_ssl_callback || m_cred || m_trustEngine) {
 451 #else
 452     if (m_ssl_callback) {
 453 #endif
 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);
 456
 457         // Restore security "state". Necessary because the callback only runs
 458         // when handshakes occur. Even new TCP connections won't execute it.
 459         char* priv=NULL;
 460         curl_easy_getinfo(m_handle,CURLINFO_PRIVATE,&priv);
 461         if (priv)
 462             m_authenticated=true;
 463     }
 464     else {
 465         curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_FUNCTION,NULL);
 466         curl_easy_setopt(m_handle,CURLOPT_SSL_CTX_DATA,NULL);
 467     }
 468
 469     // Make the call.
 470     log.debug("sending SOAP message to %s", m_endpoint.c_str());
 471     if (curl_easy_perform(m_handle) != CURLE_OK) {
 472         throw IOException(
 473             string("CURLSOAPTransport failed while contacting SOAP responder: ") +
 474                 (curl_errorbuf[0] ? curl_errorbuf : "no further information available"));
 475     }
 476 }
 477
 478 // callback to buffer headers from server
 479 size_t xmltooling::curl_header_hook(void* ptr, size_t size, size_t nmemb, void* stream)
 480 {
 481     // only handle single-byte data
 482     if (size!=1)
 483         return 0;
 484     CURLSOAPTransport* ctx = reinterpret_cast<CURLSOAPTransport*>(stream);
 485     char* buf = (char*)malloc(nmemb + 1);
 486     if (buf) {
 487         memset(buf,0,nmemb + 1);
 488         memcpy(buf,ptr,nmemb);
 489         char* sep=(char*)strchr(buf,':');
 490         if (sep) {
 491             *(sep++)=0;
 492             while (*sep==' ')
 493                 *(sep++)=0;
 494             char* white=buf+nmemb-1;
 495             while (isspace(*white))
 496                 *(white--)=0;
 497             ctx->m_response_headers[buf].push_back(sep);
 498         }
 499         free(buf);
 500         return nmemb;
 501     }
 502     return 0;
 503 }
 504
 505 // callback to send data to server
 506 size_t xmltooling::curl_read_hook(void* ptr, size_t size, size_t nmemb, void* stream)
 507 {
 508     // *stream is actually an istream object
 509     istream& buf=*(reinterpret_cast<istream*>(stream));
 510     buf.read(reinterpret_cast<char*>(ptr),size*nmemb);
 511     return buf.gcount();
 512 }
 513
 514 // callback to buffer data from server
 515 size_t xmltooling::curl_write_hook(void* ptr, size_t size, size_t nmemb, void* stream)
 516 {
 517     size_t len = size*nmemb;
 518     reinterpret_cast<stringstream*>(stream)->write(reinterpret_cast<const char*>(ptr),len);
 519     return len;
 520 }
 521
 522 // callback for curl debug data
 523 int xmltooling::curl_debug_hook(CURL* handle, curl_infotype type, char* data, size_t len, void* ptr)
 524 {
 525     // *ptr is actually a logging object
 526     if (!ptr) return 0;
 527     CategoryStream log=reinterpret_cast<Category*>(ptr)->debugStream();
 528     for (unsigned char* ch=(unsigned char*)data; len && (isprint(*ch) || isspace(*ch)); len--)
 529         log << *ch++;
 530     return 0;
 531 }
 532
 533 #ifndef XMLTOOLING_NO_XMLSEC
 534 int xmltooling::verify_callback(X509_STORE_CTX* x509_ctx, void* arg)
 535 {
 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);
 540 #else
 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()))
 548             )
 549         );
 550 #endif
 551
 552     bool success=false;
 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);
 558     }
 559     else {
 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);
 564     }
 565
 566     if (!success) {
 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;
 571     }
 572
 573     // Signal success. Hopefully it doesn't matter what's actually in the structure now.
 574     ctx->setAuthenticated(true);
 575     return 1;
 576 }
 577 #endif
 578
 579 // callback to invoke a caller-defined SSL callback
 580 CURLcode xmltooling::xml_ssl_ctx_callback(CURL* curl, SSL_CTX* ssl_ctx, void* userptr)
 581 {
 582     CURLSOAPTransport* conf = reinterpret_cast<CURLSOAPTransport*>(userptr);
 583
 584 #ifndef XMLTOOLING_NO_XMLSEC
 585     if (conf->m_cred)
 586         conf->m_cred->attach(ssl_ctx);
 587
 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);
 593 #else
 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));
 599 #endif
 600     }
 601 #endif
 602
 603     if (conf->m_ssl_callback && !conf->m_ssl_callback(conf, ssl_ctx, conf->m_ssl_userptr))
 604         return CURLE_SSL_CERTPROBLEM;
 605
 606     return CURLE_OK;
 607 }