2 * Copyright 2001-2009 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/SecurityPolicyRule.h
20 * Policy rules that secure and authenticate bindings.
23 #ifndef __saml_secrule_h__
24 #define __saml_secrule_h__
26 #include <saml/base.h>
28 namespace xmltooling {
29 class XMLTOOL_API GenericRequest;
30 class XMLTOOL_API XMLObject;
34 class SAML_API SecurityPolicy;
37 * A rule that a protocol request and message must meet in order to be valid and secure.
39 * <p>Rules must be stateless and thread-safe across evaluations. Evaluation should not
40 * result in an exception if the request/message properties do not apply to the rule
41 * (e.g. particular security mechanisms that are not present).
43 class SAML_API SecurityPolicyRule
45 MAKE_NONCOPYABLE(SecurityPolicyRule);
47 SecurityPolicyRule() {}
49 virtual ~SecurityPolicyRule() {}
52 * Returns the rule's class/type.
54 * @return the class/type of the object
56 virtual const char* getType() const=0;
59 * Evaluates the rule against the given request and message.
61 * <p>An exception will be raised if the message is fatally invalid according to
64 * <p>The return value is used to indicate whether a message was ignored or
65 * successfully processed. A false value signals that the rule wasn't successful
66 * because the rule was inapplicable to the message, but allows other rules to
67 * return an alternate result.
69 * @param message the incoming message
70 * @param request the protocol request
71 * @param policy SecurityPolicy to provide various components and track message data
72 * @return indicator as to whether a message was understood and processed
74 virtual bool evaluate(
75 const xmltooling::XMLObject& message,
76 const xmltooling::GenericRequest* request,
77 SecurityPolicy& policy
82 * Registers SecurityPolicyRule plugins into the runtime.
84 void SAML_API registerSecurityPolicyRules();
87 * SecurityPolicyRule for evaluation of SAML AudienceRestriction Conditions.
89 #define AUDIENCE_POLICY_RULE "Audience"
92 * SecurityPolicyRule for evaluation of SAML DelegationRestriction Conditions.
94 #define DELEGATION_POLICY_RULE "Delegation"
97 * SecurityPolicyRule for TLS client certificate authentication.
99 * Evaluates client certificates against the issuer's metadata.
101 #define CLIENTCERTAUTH_POLICY_RULE "ClientCertAuth"
104 * SecurityPolicyRule for evaluation of SAML Conditions.
106 #define CONDITIONS_POLICY_RULE "Conditions"
109 * SecurityPolicyRule for ignoring a SAML Condition.
111 #define IGNORE_POLICY_RULE "Ignore"
114 * SecurityPolicyRule for replay detection and freshness checking.
116 * <p>A ReplayCache instance must be available from the runtime, unless
117 * a "checkReplay" XML attribute is set to "0" or "false" when instantiating
120 * <p>Messages must have been issued in the past, but no more than 60 seconds ago,
121 * or up to a number of seconds set by an "expires" XML attribute when
122 * instantiating the policy rule.
124 #define MESSAGEFLOW_POLICY_RULE "MessageFlow"
127 * SecurityPolicyRule for disabling security.
129 * Allows the message issuer to be authenticated regardless of the message or
130 * transport. Used mainly for debugging or in situations that I wouldn't care to
133 #define NULLSECURITY_POLICY_RULE "NullSecurity"
136 * SecurityPolicyRule for protocol message "blob" signing.
138 * Allows the message issuer to be authenticated using a non-XML digital signature
139 * over the message body. The transport layer is not considered.
141 #define SIMPLESIGNING_POLICY_RULE "SimpleSigning"
144 * SecurityPolicyRule for protocol message XML signing.
146 * Allows the message issuer to be authenticated using an XML digital signature
147 * over the message. The transport layer is not considered.
149 #define XMLSIGNING_POLICY_RULE "XMLSigning"
152 * SecurityPolicyRule for SAML 1.x Browser SSO profile validation.
154 * Enforces presence of time conditions and proper subject confirmation.
156 #define SAML1BROWSERSSO_POLICY_RULE "SAML1BrowserSSO"
159 * SecurityPolicyRule for SAML 2.0 bearer SubjectConfirmation.
161 * <p>Optionally enforces message delivery requirements based on SubjectConfirmationData.
163 * <p>The XML attributes "checkValidity", "checkRecipient", and "checkCorrelation" can be set
164 * "false" to disable checks of NotBefore/NotOnOrAfter, Recipient, and InResponseTo confirmation
167 #define BEARER_POLICY_RULE "Bearer"
170 #endif /* __saml_secrule_h__ */