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 saml/binding/SOAPClient.h
20 * Specialized SOAPClient for SAML SOAP bindings.
23 #ifndef __saml_soap11client_h__
24 #define __saml_soap11client_h__
26 #include <saml/saml2/metadata/MetadataCredentialCriteria.h>
28 #include <xmltooling/soap/SOAPClient.h>
32 class SAML_API SecurityPolicy;
35 * Specialized SOAPClient for SAML SOAP bindings.
37 class SAML_API SOAPClient : public soap11::SOAPClient
41 * Creates a SOAP client instance with a particular SecurityPolicy.
43 * @param policy reference to SecurityPolicy to apply
45 SOAPClient(SecurityPolicy& policy);
47 virtual ~SOAPClient() {}
50 * Controls whether to force transport/peer authentication via an X509TrustEngine.
52 * <p>Only makes sense if an X509TrustEngine is supplied by the SecurityPolicy.
54 * @param force true iff the client should refuse to communicate without this protection
56 void forceTransportAuthentication(bool force=true) {
60 using soap11::SOAPClient::send;
63 * SAML-specific method uses metadata to determine the peer name and prepare the
64 * transport layer with peer credential information. The SecurityPolicy is also reset,
65 * in case the policy is reused.
67 * @param env SOAP envelope to send
68 * @param from identity of sending application
69 * @param to peer to send message to, expressed in metadata criteria terms
70 * @param endpoint URL of endpoint to recieve message
72 virtual void send(const soap11::Envelope& env, const char* from, saml2md::MetadataCredentialCriteria& to, const char* endpoint);
75 * Override applies SecurityPolicy to envelope before returning it.
77 * @return response envelope after SecurityPolicy has been applied
79 soap11::Envelope* receive();
84 * Returns the SecurityPolicy supplied to the client.
86 * @return the associated SecurityPolicy
88 SecurityPolicy& getPolicy() const {
94 * Override prepares transport by assigning an X509TrustEngine to it, if one is
95 * attached to the policy.
97 * @param transport reference to transport layer
99 void prepareTransport(xmltooling::SOAPTransport& transport);
101 /** Reference to security policy to apply. */
102 SecurityPolicy& m_policy;
104 /** Flag controlling whether transport/peer authn is mandatory. */
107 /** Metadata-based peer identity. */
108 const saml2md::RoleDescriptor* m_peer;
110 /** Metadata-based CredentialCriteria for supplying credentials to TrustEngine. */
111 saml2md::MetadataCredentialCriteria* m_criteria;
116 #endif /* __saml_soap11client_h__ */