xmltooling/soap/OpenSSLSOAPTransport.h

   1 /*
   2  *  Copyright 2001-2006 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  * @file xmltooling/soap/OpenSSLSOAPTransport.h
  19  *
  20  * Encapsulates OpenSSL-capable SOAP transport layer.
  21  */
  22
  23 #if !defined(__xmltooling_opensslsoaptrans_h__) && !defined(XMLTOOLING_NO_XMLSEC)
  24 #define __xmltooling_opensslsoaptrans_h__
  25
  26 #include <xmltooling/signature/CredentialResolver.h>
  27 #include <xmltooling/soap/SOAPTransport.h>
  28
  29 #include <openssl/ssl.h>
  30
  31 namespace xmltooling {
  32
  33     /**
  34      * Encapsulates OpenSSL-capable SOAP transport layer.
  35      */
  36     class XMLTOOL_API OpenSSLSOAPTransport : public virtual SOAPTransport
  37     {
  38     protected:
  39         OpenSSLSOAPTransport() {}
  40     public:
  41         virtual ~OpenSSLSOAPTransport() {}
  42
  43         /** OpenSSL context callback for manipulating credentials and validation behavior. */
  44         typedef bool (*ssl_ctx_callback_fn)(SSL_CTX* ssl_ctx, void* userptr);
  45
  46         /**
  47          * Sets a callback function to invoke against the SSL_CTX before the handshake.
  48          *
  49          * @param fn        callback function
  50          * @param userptr   a caller-supplied value to pass to the callback function
  51          * @return true iff the callback was set
  52          */
  53         virtual bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=NULL) const=0;
  54     };
  55
  56 };
  57
  58 #endif /* __xmltooling_opensslsoaptrans_h__ */