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/SecurityPolicy.h
20 * Overall policy used to verify the security of an incoming message.
23 #ifndef __saml_secpol_h__
24 #define __saml_secpol_h__
26 #include <saml/binding/GenericRequest.h>
30 #include <xmltooling/XMLObject.h>
31 #include <xmltooling/security/TrustEngine.h>
33 #if defined (_MSC_VER)
34 #pragma warning( push )
35 #pragma warning( disable : 4250 4251 )
41 class SAML_API Issuer;
44 class SAML_API MetadataProvider;
45 class SAML_API RoleDescriptor;
48 class SAML_API SecurityPolicyRule;
51 * A policy used to verify the security of an incoming message.
53 * <p>Its security mechanisms may be used to examine the transport layer
54 * (e.g client certificates and HTTP basic auth passwords) or to check the
55 * payload of a request to ensure it meets certain criteria (e.g. valid
56 * digital signature, freshness, replay).
58 * <p>Policy objects can be reused, but are not thread-safe.
60 class SAML_API SecurityPolicy
62 MAKE_NONCOPYABLE(SecurityPolicy);
65 * Constructor for policy.
67 * @param metadataProvider locked MetadataProvider instance
68 * @param role identifies the role (generally IdP or SP) of the policy peer
69 * @param trustEngine TrustEngine to authenticate policy peer
72 const saml2md::MetadataProvider* metadataProvider=NULL,
73 const xmltooling::QName* role=NULL,
74 const xmltooling::TrustEngine* trustEngine=NULL
75 ) : m_messageQName(NULL), m_messageID(NULL), m_issueInstant(0), m_issuer(NULL), m_issuerRole(NULL), m_secure(false),
76 m_matchingPolicy(NULL), m_metadata(metadataProvider), m_role(NULL), m_trust(trustEngine) {
78 m_role = new xmltooling::QName(*role);
82 * Constructor for policy using existing rules. The lifetime of the policy rules
83 * must be at least as long as the policy object.
85 * @param rules reference to array of policy rules to use
86 * @param metadataProvider locked MetadataProvider instance
87 * @param role identifies the role (generally IdP or SP) of the policy peer
88 * @param trustEngine TrustEngine to authenticate policy peer
91 const std::vector<const SecurityPolicyRule*>& rules,
92 const saml2md::MetadataProvider* metadataProvider=NULL,
93 const xmltooling::QName* role=NULL,
94 const xmltooling::TrustEngine* trustEngine=NULL
95 ) : m_messageQName(NULL), m_messageID(NULL), m_issueInstant(0), m_issuer(NULL), m_issuerRole(NULL), m_secure(false),
96 m_matchingPolicy(NULL), m_rules(rules), m_metadata(metadataProvider), m_role(NULL), m_trust(trustEngine) {
98 m_role = new xmltooling::QName(*role);
101 virtual ~SecurityPolicy();
104 * Returns the locked MetadataProvider supplied to the policy.
106 * @return the supplied MetadataProvider or NULL
108 const saml2md::MetadataProvider* getMetadataProvider() const {
113 * Returns the peer role element/type supplied to the policy.
115 * @return the peer role element/type, or an empty QName
117 const xmltooling::QName* getRole() const {
122 * Returns the TrustEngine supplied to the policy.
124 * @return the supplied TrustEngine or NULL
126 const xmltooling::TrustEngine* getTrustEngine() const {
131 * Adds a SecurityPolicyRule to the policy. The lifetime of the policy rule
132 * must be at least as long as the policy object.
134 * @param rule SecurityPolicyRule to add
136 void addRule(const SecurityPolicyRule* rule) {
137 m_rules.push_back(rule);
141 * Sets a locked MetadataProvider for the policy.
143 * @param metadata a locked MetadataProvider or NULL
145 void setMetadataProvider(const saml2md::MetadataProvider* metadata) {
146 m_metadata = metadata;
150 * Sets a peer role element/type for to the policy.
152 * @param role the peer role element/type or NULL
154 void setRole(const xmltooling::QName* role) {
156 m_role = role ? new xmltooling::QName(*role) : NULL;
160 * Sets a TrustEngine for the policy.
162 * @param trust a TrustEngine or NULL
164 void setTrustEngine(const xmltooling::TrustEngine* trust) {
169 * Evaluates the policy against the given request and message,
170 * possibly populating message information in the policy object.
172 * @param message the incoming message
173 * @param request the protocol request
175 * @throws BindingException raised if the message/request is invalid according to the supplied rules
177 void evaluate(const xmltooling::XMLObject& message, const GenericRequest* request=NULL);
180 * Resets the policy object and clears any per-message state.
185 * Returns the message element/type as determined by the registered policies.
187 * @return message element/type as determined by the registered policies
189 const xmltooling::QName* getMessageQName() const {
190 return m_messageQName;
194 * Returns the message identifier as determined by the registered policies.
196 * @return message identifier as determined by the registered policies
198 const XMLCh* getMessageID() const {
203 * Returns the message timestamp as determined by the registered policies.
205 * @return message timestamp as determined by the registered policies
207 time_t getIssueInstant() const {
208 return m_issueInstant;
212 * Gets the issuer of the message as determined by the registered policies.
214 * @return issuer of the message as determined by the registered policies
216 const saml2::Issuer* getIssuer() const {
221 * Gets the metadata for the role the issuer is operating in.
223 * @return metadata for the role the issuer is operating in
225 const saml2md::RoleDescriptor* getIssuerMetadata() const {
230 * Returns the security status as determined by the registered policies.
232 * @return true iff a SecurityPolicyRule has indicated the issuer/message has been authenticated
234 bool isSecure() const {
239 * Sets the message element/type as determined by the registered policies.
241 * @param messageQName message element/type
243 void setMessageQName(const xmltooling::QName* messageQName) {
244 delete m_messageQName;
245 m_messageQName = messageQName ? new xmltooling::QName(*messageQName) : NULL;
249 * Sets the message identifier as determined by the registered policies.
251 * @param id message identifier
253 void setMessageID(const XMLCh* id) {
254 XMLString::release(&m_messageID);
255 m_messageID = XMLString::replicate(id);
259 * Sets the message timestamp as determined by the registered policies.
261 * @param issueInstant message timestamp
263 void setIssueInstant(time_t issueInstant) {
264 m_issueInstant = issueInstant;
268 * Sets the issuer of the message as determined by the registered policies.
269 * The policy object takes ownership of the Issuer object.
271 * @param issuer issuer of the message
273 void setIssuer(saml2::Issuer* issuer);
276 * Sets the metadata for the role the issuer is operating in.
278 * @param issuerRole metadata for the role the issuer is operating in
280 void setIssuerMetadata(const saml2md::RoleDescriptor* issuerRole);
283 * Sets the security status as determined by the registered policies.
285 * @param secure indicates whether the issuer/message has been authenticated
287 void setSecure(bool secure) {
291 /** Allows override of rules for comparing saml2:Issuer information. */
292 class SAML_API IssuerMatchingPolicy {
293 MAKE_NONCOPYABLE(IssuerMatchingPolicy);
295 IssuerMatchingPolicy() {}
296 virtual ~IssuerMatchingPolicy() {}
299 * Returns true iff the two operands "match". Applications can override this method to
300 * support non-standard issuer matching for complex policies.
302 * <p>The default implementation does a basic comparison of the XML content, treating
303 * an unsupplied Format as an "entityID".
305 * @param issuer1 the first Issuer to match
306 * @param issuer2 the second Issuer to match
307 * @return true iff the operands match
309 virtual bool issuerMatches(const saml2::Issuer* issuer1, const saml2::Issuer* issuer2) const;
313 * Returns the IssuerMatchingPolicy in effect.
315 * @return the effective IssuerMatchingPolicy
317 const IssuerMatchingPolicy& getIssuerMatchingPolicy() const {
318 return m_matchingPolicy ? *m_matchingPolicy : m_defaultMatching;
322 * Sets the IssuerMatchingPolicy in effect. Setting no policy will
323 * cause the simple, default approach to be used.
325 * <p>The matching object will be freed by the SecurityPolicy.
327 * @param matchingPolicy the IssuerMatchingPolicy to use
329 void setIssuerMatchingPolicy(IssuerMatchingPolicy* matchingPolicy) {
330 delete m_matchingPolicy;
331 m_matchingPolicy = matchingPolicy;
335 /** A shared matching object that just supports the default matching rules. */
336 static IssuerMatchingPolicy m_defaultMatching;
339 // information extracted from message
340 xmltooling::QName* m_messageQName;
342 time_t m_issueInstant;
343 saml2::Issuer* m_issuer;
344 const saml2md::RoleDescriptor* m_issuerRole;
347 // components governing policy rules
348 IssuerMatchingPolicy* m_matchingPolicy;
349 std::vector<const SecurityPolicyRule*> m_rules;
350 const saml2md::MetadataProvider* m_metadata;
351 xmltooling::QName* m_role;
352 const xmltooling::TrustEngine* m_trust;
357 #if defined (_MSC_VER)
358 #pragma warning( pop )
361 #endif /* __saml_secpol_h__ */