1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* @file saml/binding/SOAPClient.h
*
* Specialized SOAPClient for SAML SOAP bindings.
*/
#ifndef __saml_soap11client_h__
#define __saml_soap11client_h__
#include <saml/base.h>
#include <xmltooling/soap/SOAPClient.h>
namespace opensaml {
class SAML_API SecurityPolicy;
namespace saml2md {
class SAML_API MetadataCredentialCriteria;
};
/**
* Specialized SOAPClient for SAML SOAP bindings.
*/
class SAML_API SOAPClient : public soap11::SOAPClient
{
public:
/**
* Creates a SOAP client instance with a particular SecurityPolicy.
*
* @param policy reference to SecurityPolicy to apply
*/
SOAPClient(SecurityPolicy& policy);
virtual ~SOAPClient();
/**
* Controls whether to force transport/peer authentication via an X509TrustEngine.
*
* <p>Only makes sense if an X509TrustEngine is supplied by the SecurityPolicy.
*
* @param force true iff the client should refuse to communicate without this protection
*/
void forceTransportAuthentication(bool force=true);
using soap11::SOAPClient::send;
/**
* SAML-specific method uses metadata to determine the peer name and prepare the
* transport layer with peer credential information. The SecurityPolicy is also reset,
* in case the policy is reused.
*
* @param env SOAP envelope to send
* @param from identity of sending application
* @param to peer to send message to, expressed in metadata criteria terms
* @param endpoint URL of endpoint to recieve message
*/
virtual void send(const soap11::Envelope& env, const char* from, saml2md::MetadataCredentialCriteria& to, const char* endpoint);
/**
* Override applies SecurityPolicy to envelope before returning it.
*
* @return response envelope after SecurityPolicy has been applied
*/
soap11::Envelope* receive();
void reset();
/**
* Returns the SecurityPolicy supplied to the client.
*
* @return the associated SecurityPolicy
*/
SecurityPolicy& getPolicy() const;
protected:
/**
* Override prepares transport by assigning an X509TrustEngine to it, if one is
* attached to the policy.
*
* @param transport reference to transport layer
*/
void prepareTransport(xmltooling::SOAPTransport& transport);
/** Reference to security policy to apply. */
SecurityPolicy& m_policy;
/** Flag controlling whether transport/peer authn is mandatory. */
bool m_force;
/** Metadata-based peer identity. */
const saml2md::RoleDescriptor* m_peer;
/** Metadata-based CredentialCriteria for supplying credentials to TrustEngine. */
saml2md::MetadataCredentialCriteria* m_criteria;
};
};
#endif /* __saml_soap11client_h__ */
|
