xmltooling/soap/impl/CURLSOAPTransport.cpp

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