/*
- * Copyright 2001-2006 Internet2
+ * Copyright 2001-2007 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#ifndef __saml_secpol_h__
#define __saml_secpol_h__
-#include <saml/binding/SecurityPolicyRule.h>
+#include <saml/base.h>
+
+#include <ctime>
#include <vector>
+#include <xmltooling/XMLObject.h>
+#include <xmltooling/io/GenericRequest.h>
+#include <xmltooling/security/TrustEngine.h>
#if defined (_MSC_VER)
#pragma warning( push )
namespace opensaml {
+ namespace saml2 {
+ class SAML_API Issuer;
+ };
namespace saml2md {
class SAML_API MetadataProvider;
+ class SAML_API RoleDescriptor;
};
+ class SAML_API SecurityPolicyRule;
+
/**
* A policy used to verify the security of an incoming message.
*
public:
/**
* Constructor for policy.
- *
- * @param metadataProvider locked MetadataProvider instance
- * @param role identifies the role (generally IdP or SP) of the policy peer
- * @param trustEngine TrustEngine to authenticate policy peer
- */
- SecurityPolicy(
- const saml2md::MetadataProvider* metadataProvider=NULL,
- const xmltooling::QName* role=NULL,
- const TrustEngine* trustEngine=NULL
- ) : m_issuer(NULL), m_issuerRole(NULL), m_matchingPolicy(NULL), m_extractor(NULL),
- m_metadata(metadataProvider), m_role(role ? *role : xmltooling::QName()), m_trust(trustEngine) {
- }
-
- /**
- * Constructor for policy using existing rules. The lifetime of the policy rules
- * must be at least as long as the policy object.
- *
- * @param rules reference to array of policy rules to use
+ *
* @param metadataProvider locked MetadataProvider instance
* @param role identifies the role (generally IdP or SP) of the policy peer
* @param trustEngine TrustEngine to authenticate policy peer
+ * @param validate true iff XML parsing should be done with validation
*/
SecurityPolicy(
- const std::vector<const SecurityPolicyRule*>& rules,
const saml2md::MetadataProvider* metadataProvider=NULL,
const xmltooling::QName* role=NULL,
- const TrustEngine* trustEngine=NULL
- ) : m_issuer(NULL), m_issuerRole(NULL), m_matchingPolicy(NULL), m_extractor(NULL), m_rules(rules),
- m_metadata(metadataProvider), m_role(role ? *role : xmltooling::QName()), m_trust(trustEngine) {
+ const xmltooling::TrustEngine* trustEngine=NULL,
+ bool validate=true
+ ) : m_messageID(NULL), m_issueInstant(0), m_issuer(NULL), m_issuerRole(NULL), m_secure(false),
+ m_matchingPolicy(NULL), m_metadata(metadataProvider), m_role(NULL), m_trust(trustEngine), m_validate(validate) {
+ if (role)
+ m_role = new xmltooling::QName(*role);
}
virtual ~SecurityPolicy();
* @return the peer role element/type, or an empty QName
*/
const xmltooling::QName* getRole() const {
- return &m_role;
+ return m_role;
}
/**
*
* @return the supplied TrustEngine or NULL
*/
- const TrustEngine* getTrustEngine() const {
+ const xmltooling::TrustEngine* getTrustEngine() const {
return m_trust;
}
/**
- * Adds a SecurityPolicyRule to the policy. The lifetime of the policy rule
- * must be at least as long as the policy object.
+ * Returns XML message validation setting.
+ *
+ * @return validation flag
+ */
+ bool getValidating() const {
+ return m_validate;
+ }
+
+ /**
+ * Gets a mutable array of installed policy rules.
+ *
+ * <p>If adding rules, their lifetime must be at least as long as the policy object.
*
- * @param rule SecurityPolicyRule to add
+ * @return mutable array of rules
*/
- void addRule(const SecurityPolicyRule* rule) {
- m_rules.push_back(rule);
+ std::vector<const SecurityPolicyRule*>& getRules() {
+ return m_rules;
}
/**
* @param role the peer role element/type or NULL
*/
void setRole(const xmltooling::QName* role) {
- m_role = (role ? *role : xmltooling::QName());
+ delete m_role;
+ m_role = role ? new xmltooling::QName(*role) : NULL;
}
/**
*
* @param trust a TrustEngine or NULL
*/
- void setTrustEngine(const TrustEngine* trust) {
+ void setTrustEngine(const xmltooling::TrustEngine* trust) {
m_trust = trust;
}
/**
- * Evaluates the rule against the given request and message,
- * possibly populating issuer information in the policy object.
+ * Controls schema validation of incoming XML messages.
+ * This is separate from other forms of programmatic validation of objects,
+ * but can detect a much wider range of syntax errors.
+ *
+ * @param validate validation setting
+ */
+ void setValidating(bool validate=true) {
+ m_validate = validate;
+ }
+
+ /**
+ * Evaluates the policy against the given request and message,
+ * possibly populating message information in the policy object.
*
- * @param request the protocol request
* @param message the incoming message
- * @return the identity of the message issuer, in one or more of two forms, or NULL
+ * @param request the protocol request
+ * @param protocol the protocol family in use
+ *
+ * @throws BindingException raised if the message/request is invalid according to the supplied rules
+ */
+ void evaluate(
+ const xmltooling::XMLObject& message, const xmltooling::GenericRequest* request=NULL, const XMLCh* protocol=NULL
+ );
+
+ /**
+ * Resets the policy object and/or clears any per-message state.
+ *
+ * <p>Resets can be complete (the default) or merely clear the previous message ID and timestamp
+ * when evaluating multiple layers of a message.
+ *
+ * @param messageOnly true iff security and issuer state should be left in place
+ */
+ void reset(bool messageOnly=false);
+
+ /**
+ * Returns the message identifier as determined by the registered policies.
*
- * @throws BindingException thrown if the request/message do not meet the requirements of this rule
+ * @return message identifier as determined by the registered policies
*/
- void evaluate(const GenericRequest& request, const xmltooling::XMLObject& message);
+ const XMLCh* getMessageID() const {
+ return m_messageID;
+ }
+
+ /**
+ * Returns the message timestamp as determined by the registered policies.
+ *
+ * @return message timestamp as determined by the registered policies
+ */
+ time_t getIssueInstant() const {
+ return m_issueInstant;
+ }
/**
* Gets the issuer of the message as determined by the registered policies.
}
/**
- * Sets the issuer of the message as determined by external factors.
- * The policy object takes ownership of the Issuer object.
+ * Returns the security status as determined by the registered policies.
+ *
+ * @return true iff a SecurityPolicyRule has indicated the issuer/message has been authenticated
+ */
+ bool isSecure() const {
+ return m_secure;
+ }
+
+ /**
+ * Sets the message identifier as determined by the registered policies.
+ *
+ * @param id message identifier
+ */
+ void setMessageID(const XMLCh* id) {
+ xercesc::XMLString::release(&m_messageID);
+ m_messageID = xercesc::XMLString::replicate(id);
+ }
+
+ /**
+ * Sets the message timestamp as determined by the registered policies.
+ *
+ * @param issueInstant message timestamp
+ */
+ void setIssueInstant(time_t issueInstant) {
+ m_issueInstant = issueInstant;
+ }
+
+ /**
+ * Sets the issuer of the message as determined by the registered policies.
*
* @param issuer issuer of the message
*/
- void setIssuer(saml2::Issuer* issuer);
+ void setIssuer(const saml2::Issuer* issuer);
+
+ /**
+ * Sets the issuer of the message as determined by the registered policies.
+ *
+ * @param issuer issuer of the message
+ */
+ void setIssuer(const XMLCh* issuer);
/**
* Sets the metadata for the role the issuer is operating in.
* @param issuerRole metadata for the role the issuer is operating in
*/
void setIssuerMetadata(const saml2md::RoleDescriptor* issuerRole);
+
+ /**
+ * Sets the security status as determined by the registered policies.
+ *
+ * @param secure indicates whether the issuer/message has been authenticated
+ */
+ void setSecure(bool secure) {
+ m_secure = secure;
+ }
/** Allows override of rules for comparing saml2:Issuer information. */
class SAML_API IssuerMatchingPolicy {
* @return true iff the operands match
*/
virtual bool issuerMatches(const saml2::Issuer* issuer1, const saml2::Issuer* issuer2) const;
+
+ /**
+ * Returns true iff the two operands "match". Applications can override this method to
+ * support non-standard issuer matching for complex policies.
+ *
+ * <p>The default implementation does a basic comparison of the XML content, treating
+ * an unsupplied Format as an "entityID".
+ *
+ * @param issuer1 the first Issuer to match
+ * @param issuer2 the second Issuer to match
+ * @return true iff the operands match
+ */
+ virtual bool issuerMatches(const saml2::Issuer* issuer1, const XMLCh* issuer2) const;
};
/**
m_matchingPolicy = matchingPolicy;
}
- /**
- * Returns the MessageExtractor in effect.
- *
- * @return the effective MessageExtractor
- */
- const SecurityPolicyRule::MessageExtractor& getMessageExtractor() const {
- return m_extractor ? *m_extractor : m_defaultExtractor;
- }
-
- /**
- * Sets the MessageExtractor in effect. Setting no extractor will
- * cause the default extractor to be used.
- *
- * <p>The extractor will be freed by the SecurityPolicy.
- *
- * @param extractor the MessageExtractor to use
- */
- void setMessageExtractor(SecurityPolicyRule::MessageExtractor* extractor) {
- delete m_extractor;
- m_extractor = extractor;
- }
-
protected:
/** A shared matching object that just supports the default matching rules. */
static IssuerMatchingPolicy m_defaultMatching;
- /** A shared extractor object that just supports the default SAML message types. */
- static SecurityPolicyRule::MessageExtractor m_defaultExtractor;
-
private:
+ // information extracted from message
+ XMLCh* m_messageID;
+ time_t m_issueInstant;
saml2::Issuer* m_issuer;
const saml2md::RoleDescriptor* m_issuerRole;
+ bool m_secure;
+ // components governing policy rules
IssuerMatchingPolicy* m_matchingPolicy;
- SecurityPolicyRule::MessageExtractor* m_extractor;
-
std::vector<const SecurityPolicyRule*> m_rules;
const saml2md::MetadataProvider* m_metadata;
- xmltooling::QName m_role;
- const TrustEngine* m_trust;
+ xmltooling::QName* m_role;
+ const xmltooling::TrustEngine* m_trust;
+ bool m_validate;
};
};
projects / shibboleth / opensaml2.git / blobdiff