/*
- * Copyright 2001-2006 Internet2
- *
+ * Copyright 2001-2009 Internet2
+ *
* Licensed 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
/**
* @file saml/binding/SecurityPolicyRule.h
- *
+ *
* Policy rules that secure and authenticate bindings.
*/
#ifndef __saml_secrule_h__
#define __saml_secrule_h__
-#include <saml/binding/GenericRequest.h>
-#include <xmltooling/XMLObject.h>
+#include <saml/binding/SecurityPolicy.h>
namespace opensaml {
- class SAML_API TrustEngine;
-
- namespace saml2 {
- class SAML_API Issuer;
- };
- namespace saml2md {
- class SAML_API MetadataProvider;
- class SAML_API RoleDescriptor;
- };
-
+
/**
* A rule that a protocol request and message must meet in order to be valid and secure.
- *
+ *
* <p>Rules must be stateless and thread-safe across evaluations. Evaluation should not
* result in an exception if the request/message properties do not apply to the rule
- * (e.g. particular security mechanisms that are not present).
+ * (e.g. particular security mechanisms that are not present).
*/
class SAML_API SecurityPolicyRule
{
public:
virtual ~SecurityPolicyRule() {}
- /** Allows override of code for extracting saml2:Issuer and protocol information. */
- class SAML_API MessageExtractor {
- MAKE_NONCOPYABLE(MessageExtractor);
- public:
- MessageExtractor() {}
- virtual ~MessageExtractor() {}
-
- /**
- * Examines the message and/or its contents and extracts the issuer's claimed
- * identity along with a protocol identifier. Conventions may be needed
- * to properly encode non-SAML2 issuer information into a compatible form.
- *
- * <p>The caller is responsible for freeing the Issuer object.
- *
- * @param message message to examine
- * @return a pair consisting of a SAML 2.0 Issuer object and a protocol constant.
- * @throws std::bad_cast thrown if the message is not of an expected type
- */
- virtual std::pair<saml2::Issuer*,const XMLCh*> getIssuerAndProtocol(const xmltooling::XMLObject& message) const;
- };
+ /**
+ * Returns the rule's class/type.
+ *
+ * @return the class/type of the object
+ */
+ virtual const char* getType() const=0;
/**
- * Evaluates the rule against the given request and message. If an Issuer is
- * returned, the caller is responsible for freeing the Issuer object.
- *
- * @param request the protocol request
- * @param message the incoming message
- * @param metadataProvider locked MetadataProvider instance to authenticate the message
- * @param role identifies the role (generally IdP or SP) of the peer who issued the message
- * @param trustEngine TrustEngine to authenticate the message
- * @param extractor MessageExtractor to use in examining message
- * @return the identity of the message issuer, in two forms, or NULL
- *
- * @throws BindingException thrown if the request/message do not meet the requirements of this rule
+ * Evaluates the rule against the given request and message.
+ *
+ * <p>An exception will be raised if the message is invalid according to
+ * a policy rule.
+ *
+ * <p>The return value is used to indicate whether a message was ignored or
+ * successfully processed. A false value signals that the rule wasn't successful
+ * but was also not unsuccessful, because the rule was inapplicable to the message.
+ *
+ * @param message the incoming message
+ * @param request the protocol request
+ * @param policy SecurityPolicy to provide various components and track message data
+ * @return indicator as to whether a message was understood and processed
*/
- virtual std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
- const GenericRequest& request,
+ virtual bool evaluate(
const xmltooling::XMLObject& message,
- const saml2md::MetadataProvider* metadataProvider,
- const xmltooling::QName* role,
- const TrustEngine* trustEngine,
- const MessageExtractor& extractor
+ const xmltooling::GenericRequest* request,
+ SecurityPolicy& policy
) const=0;
};
void SAML_API registerSecurityPolicyRules();
/**
+ * SecurityPolicyRule for evaluation of SAML AudienceRestriction Conditions.
+ */
+ #define AUDIENCE_POLICY_RULE "Audience"
+
+ /**
+ * SecurityPolicyRule for TLS client certificate authentication.
+ *
+ * Evaluates client certificates against the issuer's metadata.
+ */
+ #define CLIENTCERTAUTH_POLICY_RULE "ClientCertAuth"
+
+ /**
+ * SecurityPolicyRule for evaluation of SAML Conditions.
+ */
+ #define CONDITIONS_POLICY_RULE "Conditions"
+
+ /**
+ * SecurityPolicyRule for ignoring a SAML Condition.
+ */
+ #define IGNORE_POLICY_RULE "Ignore"
+
+ /**
* SecurityPolicyRule for replay detection and freshness checking.
- *
+ *
* <p>A ReplayCache instance must be available from the runtime, unless
* a "checkReplay" XML attribute is set to "0" or "false" when instantiating
* the policy rule.
- *
+ *
* <p>Messages must have been issued in the past, but no more than 60 seconds ago,
* or up to a number of seconds set by an "expires" XML attribute when
* instantiating the policy rule.
*/
- #define MESSAGEFLOW_POLICY_RULE "org.opensaml.binding.MessageFlowRule"
+ #define MESSAGEFLOW_POLICY_RULE "MessageFlow"
+
+ /**
+ * SecurityPolicyRule for disabling security.
+ *
+ * Allows the message issuer to be authenticated regardless of the message or
+ * transport. Used mainly for debugging or in situations that I wouldn't care to
+ * comment on.
+ */
+ #define NULLSECURITY_POLICY_RULE "NullSecurity"
/**
* SecurityPolicyRule for protocol message "blob" signing.
- *
+ *
* Allows the message issuer to be authenticated using a non-XML digital signature
* over the message body. The transport layer is not considered.
*/
- #define SIMPLESIGNING_POLICY_RULE "org.opensaml.binding.SimpleSigningRule"
+ #define SIMPLESIGNING_POLICY_RULE "SimpleSigning"
/**
* SecurityPolicyRule for protocol message XML signing.
- *
+ *
* Allows the message issuer to be authenticated using an XML digital signature
* over the message. The transport layer is not considered.
*/
- #define XMLSIGNING_POLICY_RULE "org.opensaml.binding.XMLSigningRule"
+ #define XMLSIGNING_POLICY_RULE "XMLSigning"
+
+ /**
+ * SecurityPolicyRule for SAML 1.x Browser SSO profile validation.
+ *
+ * Enforces presence of time conditions and proper subject confirmation.
+ */
+ #define SAML1BROWSERSSO_POLICY_RULE "SAML1BrowserSSO"
+
+ /**
+ * SecurityPolicyRule for SAML 2.0 bearer SubjectConfirmation.
+ *
+ * <p>Optionally enforces message delivery requirements based on SubjectConfirmationData.
+ *
+ * <p>The XML attributes "checkValidity", "checkRecipient", and "checkCorrelation" can be set
+ * "false" to disable checks of NotBefore/NotOnOrAfter, Recipient, and InResponseTo confirmation
+ * data respectively.
+ */
+ #define BEARER_POLICY_RULE "Bearer"
};
#endif /* __saml_secrule_h__ */
projects / shibboleth / cpp-opensaml.git / blobdiff