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/base.h>
30 #include <xmltooling/XMLObject.h>
31 #include <xmltooling/io/GenericRequest.h>
32 #include <xmltooling/security/TrustEngine.h>
34 #if defined (_MSC_VER)
35 #pragma warning( push )
36 #pragma warning( disable : 4250 4251 )
42 class SAML_API Issuer;
45 class SAML_API MetadataProvider;
46 class SAML_API RoleDescriptor;
49 class SAML_API SecurityPolicyRule;
52 * A policy used to verify the security of an incoming message.
54 * <p>Its security mechanisms may be used to examine the transport layer
55 * (e.g client certificates and HTTP basic auth passwords) or to check the
56 * payload of a request to ensure it meets certain criteria (e.g. valid
57 * digital signature, freshness, replay).
59 * <p>Policy objects can be reused, but are not thread-safe.
61 class SAML_API SecurityPolicy
63 MAKE_NONCOPYABLE(SecurityPolicy);
66 * Constructor for policy.
68 * @param metadataProvider locked MetadataProvider instance
69 * @param role identifies the role (generally IdP or SP) of the policy peer
70 * @param trustEngine TrustEngine to authenticate policy peer
71 * @param validate true iff XML parsing should be done with validation
74 const saml2md::MetadataProvider* metadataProvider=NULL,
75 const xmltooling::QName* role=NULL,
76 const xmltooling::TrustEngine* trustEngine=NULL,
78 ) : m_messageQName(NULL), m_messageID(NULL), m_issueInstant(0),
79 m_issuer(NULL), m_issuerRole(NULL), m_secure(false), m_matchingPolicy(NULL),
80 m_metadata(metadataProvider), m_role(NULL), m_trust(trustEngine), m_validate(validate) {
82 m_role = new xmltooling::QName(*role);
86 * Constructor for policy using existing rules. The lifetime of the policy rules
87 * must be at least as long as the policy object.
89 * @param rules reference to array of policy rules to use
90 * @param metadataProvider locked MetadataProvider instance
91 * @param role identifies the role (generally IdP or SP) of the policy peer
92 * @param trustEngine TrustEngine to authenticate policy peer
93 * @param validate true iff XML parsing should be done with validation
96 const std::vector<const SecurityPolicyRule*>& rules,
97 const saml2md::MetadataProvider* metadataProvider=NULL,
98 const xmltooling::QName* role=NULL,
99 const xmltooling::TrustEngine* trustEngine=NULL,
101 ) : m_messageQName(NULL), m_messageID(NULL), m_issueInstant(0),
102 m_issuer(NULL), m_issuerRole(NULL), m_secure(false), m_matchingPolicy(NULL),
103 m_rules(rules), m_metadata(metadataProvider), m_role(NULL), m_trust(trustEngine), m_validate(validate) {
105 m_role = new xmltooling::QName(*role);
108 virtual ~SecurityPolicy();
111 * Returns the locked MetadataProvider supplied to the policy.
113 * @return the supplied MetadataProvider or NULL
115 const saml2md::MetadataProvider* getMetadataProvider() const {
120 * Returns the peer role element/type supplied to the policy.
122 * @return the peer role element/type, or an empty QName
124 const xmltooling::QName* getRole() const {
129 * Returns the TrustEngine supplied to the policy.
131 * @return the supplied TrustEngine or NULL
133 const xmltooling::TrustEngine* getTrustEngine() const {
138 * Returns XML message validation setting.
140 * @return validation flag
142 bool getValidating() const {
147 * Adds a SecurityPolicyRule to the policy. The lifetime of the policy rule
148 * must be at least as long as the policy object.
150 * @param rule SecurityPolicyRule to add
152 void addRule(const SecurityPolicyRule* rule) {
153 m_rules.push_back(rule);
157 * Sets a locked MetadataProvider for the policy.
159 * @param metadata a locked MetadataProvider or NULL
161 void setMetadataProvider(const saml2md::MetadataProvider* metadata) {
162 m_metadata = metadata;
166 * Sets a peer role element/type for to the policy.
168 * @param role the peer role element/type or NULL
170 void setRole(const xmltooling::QName* role) {
172 m_role = role ? new xmltooling::QName(*role) : NULL;
176 * Sets a TrustEngine for the policy.
178 * @param trust a TrustEngine or NULL
180 void setTrustEngine(const xmltooling::TrustEngine* trust) {
185 * Controls schema validation of incoming XML messages.
186 * This is separate from other forms of programmatic validation of objects,
187 * but can detect a much wider range of syntax errors.
189 * @param validate validation setting
191 void setValidating(bool validate=true) {
192 m_validate = validate;
196 * Evaluates the policy against the given request and message,
197 * possibly populating message information in the policy object.
199 * @param message the incoming message
200 * @param request the protocol request
202 * @throws BindingException raised if the message/request is invalid according to the supplied rules
204 void evaluate(const xmltooling::XMLObject& message, const xmltooling::GenericRequest* request=NULL);
207 * Resets the policy object and clears any per-message state.
212 * Returns the message element/type as determined by the registered policies.
214 * @return message element/type as determined by the registered policies
216 const xmltooling::QName* getMessageQName() const {
217 return m_messageQName;
221 * Returns the message identifier as determined by the registered policies.
223 * @return message identifier as determined by the registered policies
225 const XMLCh* getMessageID() const {
230 * Returns the message timestamp as determined by the registered policies.
232 * @return message timestamp as determined by the registered policies
234 time_t getIssueInstant() const {
235 return m_issueInstant;
239 * Gets the issuer of the message as determined by the registered policies.
241 * @return issuer of the message as determined by the registered policies
243 const saml2::Issuer* getIssuer() const {
248 * Gets the metadata for the role the issuer is operating in.
250 * @return metadata for the role the issuer is operating in
252 const saml2md::RoleDescriptor* getIssuerMetadata() const {
257 * Returns the security status as determined by the registered policies.
259 * @return true iff a SecurityPolicyRule has indicated the issuer/message has been authenticated
261 bool isSecure() const {
266 * Sets the message element/type as determined by the registered policies.
268 * @param messageQName message element/type
270 void setMessageQName(const xmltooling::QName* messageQName) {
271 delete m_messageQName;
272 m_messageQName = messageQName ? new xmltooling::QName(*messageQName) : NULL;
276 * Sets the message identifier as determined by the registered policies.
278 * @param id message identifier
280 void setMessageID(const XMLCh* id) {
281 xercesc::XMLString::release(&m_messageID);
282 m_messageID = xercesc::XMLString::replicate(id);
286 * Sets the message timestamp as determined by the registered policies.
288 * @param issueInstant message timestamp
290 void setIssueInstant(time_t issueInstant) {
291 m_issueInstant = issueInstant;
295 * Sets the issuer of the message as determined by the registered policies.
297 * @param issuer issuer of the message
299 void setIssuer(const saml2::Issuer* issuer);
302 * Sets the issuer of the message as determined by the registered policies.
304 * @param issuer issuer of the message
306 void setIssuer(const XMLCh* issuer);
309 * Sets the metadata for the role the issuer is operating in.
311 * @param issuerRole metadata for the role the issuer is operating in
313 void setIssuerMetadata(const saml2md::RoleDescriptor* issuerRole);
316 * Sets the security status as determined by the registered policies.
318 * @param secure indicates whether the issuer/message has been authenticated
320 void setSecure(bool secure) {
324 /** Allows override of rules for comparing saml2:Issuer information. */
325 class SAML_API IssuerMatchingPolicy {
326 MAKE_NONCOPYABLE(IssuerMatchingPolicy);
328 IssuerMatchingPolicy() {}
329 virtual ~IssuerMatchingPolicy() {}
332 * Returns true iff the two operands "match". Applications can override this method to
333 * support non-standard issuer matching for complex policies.
335 * <p>The default implementation does a basic comparison of the XML content, treating
336 * an unsupplied Format as an "entityID".
338 * @param issuer1 the first Issuer to match
339 * @param issuer2 the second Issuer to match
340 * @return true iff the operands match
342 virtual bool issuerMatches(const saml2::Issuer* issuer1, const saml2::Issuer* issuer2) const;
345 * Returns true iff the two operands "match". Applications can override this method to
346 * support non-standard issuer matching for complex policies.
348 * <p>The default implementation does a basic comparison of the XML content, treating
349 * an unsupplied Format as an "entityID".
351 * @param issuer1 the first Issuer to match
352 * @param issuer2 the second Issuer to match
353 * @return true iff the operands match
355 virtual bool issuerMatches(const saml2::Issuer* issuer1, const XMLCh* issuer2) const;
359 * Returns the IssuerMatchingPolicy in effect.
361 * @return the effective IssuerMatchingPolicy
363 const IssuerMatchingPolicy& getIssuerMatchingPolicy() const {
364 return m_matchingPolicy ? *m_matchingPolicy : m_defaultMatching;
368 * Sets the IssuerMatchingPolicy in effect. Setting no policy will
369 * cause the simple, default approach to be used.
371 * <p>The matching object will be freed by the SecurityPolicy.
373 * @param matchingPolicy the IssuerMatchingPolicy to use
375 void setIssuerMatchingPolicy(IssuerMatchingPolicy* matchingPolicy) {
376 delete m_matchingPolicy;
377 m_matchingPolicy = matchingPolicy;
381 /** A shared matching object that just supports the default matching rules. */
382 static IssuerMatchingPolicy m_defaultMatching;
385 // information extracted from message
386 xmltooling::QName* m_messageQName;
388 time_t m_issueInstant;
389 saml2::Issuer* m_issuer;
390 const saml2md::RoleDescriptor* m_issuerRole;
393 // components governing policy rules
394 IssuerMatchingPolicy* m_matchingPolicy;
395 std::vector<const SecurityPolicyRule*> m_rules;
396 const saml2md::MetadataProvider* m_metadata;
397 xmltooling::QName* m_role;
398 const xmltooling::TrustEngine* m_trust;
404 #if defined (_MSC_VER)
405 #pragma warning( pop )
408 #endif /* __saml_secpol_h__ */