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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file xmltooling/soap/OpenSSLSOAPTransport.h
24 * Encapsulates OpenSSL-capable SOAP transport layer.
27 #if !defined(__xmltooling_opensslsoaptrans_h__) && !defined(XMLTOOLING_NO_XMLSEC)
28 #define __xmltooling_opensslsoaptrans_h__
30 #include <xmltooling/soap/SOAPTransport.h>
32 #include <openssl/ssl.h>
34 namespace xmltooling {
37 * Encapsulates OpenSSL-capable SOAP transport layer.
39 class XMLTOOL_API OpenSSLSOAPTransport : public virtual SOAPTransport
42 OpenSSLSOAPTransport();
44 virtual ~OpenSSLSOAPTransport();
46 /** OpenSSL context callback for manipulating credentials and validation behavior. */
47 typedef bool (*ssl_ctx_callback_fn)(OpenSSLSOAPTransport* transport, SSL_CTX* ssl_ctx, void* userptr);
50 * Sets a callback function to invoke against the SSL_CTX before the handshake.
52 * @param fn callback function
53 * @param userptr a caller-supplied value to pass to the callback function
54 * @return true iff the callback was set
56 virtual bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=nullptr)=0;
59 * Sets indicator that the transport peer has been authenticated.
61 * @param auth flag to set
63 virtual void setAuthenticated(bool auth)=0;
68 #endif /* __xmltooling_opensslsoaptrans_h__ */