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 * @file xmltooling/soap/OpenSSLSOAPTransport.h 23 * 24 * Encapsulates OpenSSL-capable SOAP transport layer. 25 */ 26 27 #if !defined(__xmltooling_opensslsoaptrans_h__) && !defined(XMLTOOLING_NO_XMLSEC) 28 #define __xmltooling_opensslsoaptrans_h__ 29 30 #include <xmltooling/soap/SOAPTransport.h> 31 32 #include <openssl/ssl.h> 33 34 namespace xmltooling { 35 36 /** 37 * Encapsulates OpenSSL-capable SOAP transport layer. 38 */ 39 class XMLTOOL_API OpenSSLSOAPTransport : public virtual SOAPTransport 40 { 41 protected: 42 OpenSSLSOAPTransport(); 43 public: 44 virtual ~OpenSSLSOAPTransport(); 45 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); 48 49 /** 50 * Set a callback function to invoke against the SSL_CTX before the handshake. 51 * 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 55 */ 56 virtual bool setSSLCallback(ssl_ctx_callback_fn fn, void* userptr=nullptr)=0; 57 58 /** 59 * Set an expression identifying the cipher suites to enable using OpenSSL syntax. 60 * 61 * <p>Note this does not include TLS 1.3 ciphers.</p> 62 * 63 * @param cipherlist cipher suite expression/list 64 * @return true iff the ciphers were set 65 */ 66 virtual bool setCipherSuites(const char* cipherlist)=0; 67 68 /** 69 * Set indicator that the transport peer has been authenticated. 70 * 71 * @param auth flag to set 72 */ 73 virtual void setAuthenticated(bool auth)=0; 74 }; 75 76 }; 77 78 #endif /* __xmltooling_opensslsoaptrans_h__ */ 79