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.
20 * Overall policy used to verify the security of an incoming message.
24 #include "exceptions.h"
25 #include "binding/SecurityPolicyRule.h"
26 #include "saml2/core/Assertions.h"
28 using namespace opensaml::saml2md;
29 using namespace opensaml::saml2;
30 using namespace opensaml;
31 using namespace xmltooling;
35 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory AudienceRestrictionRuleFactory;
36 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory ClientCertAuthRuleFactory;
37 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory ConditionsRuleFactory;
38 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory IgnoreRuleFactory;
39 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory MessageFlowRuleFactory;
40 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory NullSecurityRuleFactory;
41 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory SimpleSigningRuleFactory;
42 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory XMLSigningRuleFactory;
45 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory BrowserSSORuleFactory;
49 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory BearerConfirmationRuleFactory;
53 void SAML_API opensaml::registerSecurityPolicyRules()
55 SAMLConfig& conf=SAMLConfig::getConfig();
56 conf.SecurityPolicyRuleManager.registerFactory(AUDIENCE_POLICY_RULE, AudienceRestrictionRuleFactory);
57 conf.SecurityPolicyRuleManager.registerFactory(CLIENTCERTAUTH_POLICY_RULE, ClientCertAuthRuleFactory);
58 conf.SecurityPolicyRuleManager.registerFactory(CONDITIONS_POLICY_RULE, ConditionsRuleFactory);
59 conf.SecurityPolicyRuleManager.registerFactory(IGNORE_POLICY_RULE, IgnoreRuleFactory);
60 conf.SecurityPolicyRuleManager.registerFactory(MESSAGEFLOW_POLICY_RULE, MessageFlowRuleFactory);
61 conf.SecurityPolicyRuleManager.registerFactory(NULLSECURITY_POLICY_RULE, NullSecurityRuleFactory);
62 conf.SecurityPolicyRuleManager.registerFactory(SIMPLESIGNING_POLICY_RULE, SimpleSigningRuleFactory);
63 conf.SecurityPolicyRuleManager.registerFactory(XMLSIGNING_POLICY_RULE, XMLSigningRuleFactory);
64 conf.SecurityPolicyRuleManager.registerFactory(SAML1BROWSERSSO_POLICY_RULE, saml1::BrowserSSORuleFactory);
65 conf.SecurityPolicyRuleManager.registerFactory(BEARER_POLICY_RULE, saml2::BearerConfirmationRuleFactory);
68 SecurityPolicy::IssuerMatchingPolicy SecurityPolicy::m_defaultMatching;
70 SecurityPolicy::SecurityPolicy(
71 const saml2md::MetadataProvider* metadataProvider,
72 const xmltooling::QName* role,
73 const xmltooling::TrustEngine* trustEngine,
75 ) : m_metadataCriteria(NULL),
80 m_authenticated(false),
81 m_matchingPolicy(NULL),
82 m_metadata(metadataProvider),
91 m_role = new xmltooling::QName(*role);
94 SecurityPolicy::~SecurityPolicy()
96 XMLString::release(&m_messageID);
97 delete m_metadataCriteria;
101 void SecurityPolicy::reset(bool messageOnly)
106 void SecurityPolicy::_reset(bool messageOnly)
108 XMLString::release(&m_messageID);
115 m_authenticated=false;
119 MetadataProvider::Criteria& SecurityPolicy::getMetadataProviderCriteria() const
121 if (!m_metadataCriteria)
122 m_metadataCriteria=new MetadataProvider::Criteria();
124 m_metadataCriteria->reset();
125 return *m_metadataCriteria;
128 void SecurityPolicy::setMetadataProviderCriteria(saml2md::MetadataProvider::Criteria* criteria)
130 if (m_metadataCriteria)
131 delete m_metadataCriteria;
132 m_metadataCriteria=criteria;
135 void SecurityPolicy::evaluate(const XMLObject& message, const GenericRequest* request)
137 for (vector<const SecurityPolicyRule*>::const_iterator i=m_rules.begin(); i!=m_rules.end(); ++i)
138 (*i)->evaluate(message,request,*this);
141 void SecurityPolicy::setIssuer(const Issuer* issuer)
143 if (!getIssuerMatchingPolicy().issuerMatches(m_issuer, issuer))
144 throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
147 if (m_entityOnly && issuer->getFormat() && !XMLString::equals(issuer->getFormat(), NameIDType::ENTITY))
148 throw SecurityPolicyException("A non-entity Issuer was supplied, violating policy.");
150 m_issuer=issuer->cloneIssuer();
154 void SecurityPolicy::setIssuer(const XMLCh* issuer)
156 if (!getIssuerMatchingPolicy().issuerMatches(m_issuer, issuer))
157 throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
159 if (!m_issuer && issuer && *issuer) {
161 m_issuer = IssuerBuilder::buildIssuer();
162 m_issuer->setName(issuer);
166 void SecurityPolicy::setIssuerMetadata(const RoleDescriptor* issuerRole)
168 if (issuerRole && m_issuerRole && issuerRole!=m_issuerRole)
169 throw SecurityPolicyException("A rule supplied a RoleDescriptor that conflicts with previous results.");
170 m_issuerRole=issuerRole;
173 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const Issuer* issuer2) const
175 // NULL matches anything for the purposes of this interface.
176 if (!issuer1 || !issuer2)
179 const XMLCh* op1=issuer1->getName();
180 const XMLCh* op2=issuer2->getName();
181 if (!op1 || !op2 || !XMLString::equals(op1,op2))
184 op1=issuer1->getFormat();
185 op2=issuer2->getFormat();
186 if (!XMLString::equals(op1 ? op1 : NameIDType::ENTITY, op2 ? op2 : NameIDType::ENTITY))
189 op1=issuer1->getNameQualifier();
190 op2=issuer2->getNameQualifier();
191 if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
194 op1=issuer1->getSPNameQualifier();
195 op2=issuer2->getSPNameQualifier();
196 if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
202 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const XMLCh* issuer2) const
204 // NULL matches anything for the purposes of this interface.
205 if (!issuer1 || !issuer2 || !*issuer2)
208 const XMLCh* op1=issuer1->getName();
209 if (!op1 || !XMLString::equals(op1,issuer2))
212 op1=issuer1->getFormat();
213 if (op1 && *op1 && !XMLString::equals(op1, NameIDType::ENTITY))
216 op1=issuer1->getNameQualifier();
220 op1=issuer1->getSPNameQualifier();