2 * Copyright 2001-2009 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file xmltooling/soap/OpenSSLSOAPTransport.h
20 * Encapsulates OpenSSL-capable SOAP transport layer.
23 #if !defined(__xmltooling_opensslsoaptrans_h__) && !defined(XMLTOOLING_NO_XMLSEC)
24 #define __xmltooling_opensslsoaptrans_h__
26 #include <xmltooling/soap/SOAPTransport.h>
28 #include <openssl/ssl.h>
30 namespace xmltooling {
33 * Encapsulates OpenSSL-capable SOAP transport layer.
35 class XMLTOOL_API OpenSSLSOAPTransport : public virtual SOAPTransport
38 OpenSSLSOAPTransport();
40 virtual ~OpenSSLSOAPTransport();
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);
46 * Sets a callback function to invoke against the SSL_CTX before the handshake.
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
52 virtual bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=NULL)=0;
55 * Sets indicator that the transport peer has been authenticated.
57 * @param auth flag to set
59 virtual void setAuthenticated(bool auth)=0;
64 #endif /* __xmltooling_opensslsoaptrans_h__ */