xmltooling/soap/OpenSSLSOAPTransport.h

   1 /*
   2  *  Copyright 2001-2010 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/soap/SOAPTransport.h>
  27
  28 #include <openssl/ssl.h>
  29
  30 namespace xmltooling {
  31
  32     /**
  33      * Encapsulates OpenSSL-capable SOAP transport layer.
  34      */
  35     class XMLTOOL_API OpenSSLSOAPTransport : public virtual SOAPTransport
  36     {
  37     protected:
  38         OpenSSLSOAPTransport();
  39     public:
  40         virtual ~OpenSSLSOAPTransport();
  41
  42         /** OpenSSL context callback for manipulating credentials and validation behavior. */
  43         typedef bool (*ssl_ctx_callback_fn)(OpenSSLSOAPTransport* transport, SSL_CTX* ssl_ctx, void* userptr);
  44
  45         /**
  46          * Sets a callback function to invoke against the SSL_CTX before the handshake.
  47          *
  48          * @param fn        callback function
  49          * @param userptr   a caller-supplied value to pass to the callback function
  50          * @return true iff the callback was set
  51          */
  52         virtual bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=nullptr)=0;
  53
  54         /**
  55          * Sets indicator that the transport peer has been authenticated.
  56          *
  57          * @param auth    flag to set
  58          */
  59         virtual void setAuthenticated(bool auth)=0;
  60     };
  61
  62 };
  63
  64 #endif /* __xmltooling_opensslsoaptrans_h__ */