2 * Copyright 2001-2007 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 saml/binding/SOAPClient.h
20 * Specialized SOAPClient for SAML SOAP bindings.
23 #ifndef __saml_soap11client_h__
24 #define __saml_soap11client_h__
26 #include <saml/binding/SecurityPolicy.h>
27 #include <xmltooling/soap/SOAPClient.h>
32 * Specialized SOAPClient for SAML SOAP bindings.
34 class SAML_API SOAPClient : public soap11::SOAPClient
38 * Creates a SOAP client instance with a particular SecurityPolicy.
40 * @param policy reference to SecurityPolicy to apply
41 * @param validating controls schema validation
43 SOAPClient(SecurityPolicy& policy)
44 : soap11::SOAPClient(policy.getValidating()), m_policy(policy), m_force(true), m_peer(NULL) {}
46 virtual ~SOAPClient() {}
49 * Controls whether to force transport/peer authentication via an X509TrustEngine.
51 * <p>Only makes sense if an X509TrustEngine is supplied by the SecurityPolicy.
53 * @param force true iff the client should refuse to communicate without this protection
55 void forceTransportAuthentication(bool force=true) {
60 * Override prepares the SecurityPolicy by clearing Issuer identity, in case the policy
63 * @param env SOAP envelope to send
64 * @param peer peer to send message to, expressed in TrustEngine terms
65 * @param endpoint URL of endpoint to recieve message
67 void send(const soap11::Envelope& env, const xmltooling::KeyInfoSource& peer, const char* endpoint);
70 * Override applies SecurityPolicy to envelope before returning it.
72 * @return response envelope after SecurityPolicy has been applied
74 soap11::Envelope* receive();
79 * Returns the SecurityPolicy supplied to the client.
81 * @return the associated SecurityPolicy
83 SecurityPolicy& getPolicy() const {
89 * Override prepares transport by assigning an X509TrustEngine to it, if one is
90 * attached to the policy.
92 * @param transport reference to transport layer
94 void prepareTransport(xmltooling::SOAPTransport& transport);
96 /** Reference to security policy to apply. */
97 SecurityPolicy& m_policy;
99 /** Flag controlling whether transport/peer authn is mandatory. */
102 /** Metadata-based peer identity. */
103 const saml2md::RoleDescriptor* m_peer;
108 #endif /* __saml_soap11client_h__ */