2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
24 * Overall policy used to verify the security of an incoming message.
28 #include "exceptions.h"
29 #include "binding/SecurityPolicy.h"
30 #include "binding/SecurityPolicyRule.h"
31 #include "saml2/core/Assertions.h"
33 #include <boost/bind.hpp>
34 #include <xercesc/util/XMLUniDefs.hpp>
36 using namespace opensaml::saml2md;
37 using namespace opensaml::saml2;
38 using namespace opensaml;
39 using namespace xmltooling;
40 using namespace boost;
44 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory AudienceRestrictionRuleFactory;
45 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory ClientCertAuthRuleFactory;
46 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory ConditionsRuleFactory;
47 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory IgnoreRuleFactory;
48 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory MessageFlowRuleFactory;
49 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory NullSecurityRuleFactory;
50 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory SimpleSigningRuleFactory;
51 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory XMLSigningRuleFactory;
54 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory BrowserSSORuleFactory;
58 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory BearerConfirmationRuleFactory;
59 SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory DelegationRestrictionRuleFactory;
63 void SAML_API opensaml::registerSecurityPolicyRules()
65 SAMLConfig& conf=SAMLConfig::getConfig();
66 conf.SecurityPolicyRuleManager.registerFactory(AUDIENCE_POLICY_RULE, AudienceRestrictionRuleFactory);
67 conf.SecurityPolicyRuleManager.registerFactory(CLIENTCERTAUTH_POLICY_RULE, ClientCertAuthRuleFactory);
68 conf.SecurityPolicyRuleManager.registerFactory(CONDITIONS_POLICY_RULE, ConditionsRuleFactory);
69 conf.SecurityPolicyRuleManager.registerFactory(IGNORE_POLICY_RULE, IgnoreRuleFactory);
70 conf.SecurityPolicyRuleManager.registerFactory(MESSAGEFLOW_POLICY_RULE, MessageFlowRuleFactory);
71 conf.SecurityPolicyRuleManager.registerFactory(NULLSECURITY_POLICY_RULE, NullSecurityRuleFactory);
72 conf.SecurityPolicyRuleManager.registerFactory(SIMPLESIGNING_POLICY_RULE, SimpleSigningRuleFactory);
73 conf.SecurityPolicyRuleManager.registerFactory(XMLSIGNING_POLICY_RULE, XMLSigningRuleFactory);
74 conf.SecurityPolicyRuleManager.registerFactory(SAML1BROWSERSSO_POLICY_RULE, saml1::BrowserSSORuleFactory);
75 conf.SecurityPolicyRuleManager.registerFactory(BEARER_POLICY_RULE, saml2::BearerConfirmationRuleFactory);
76 conf.SecurityPolicyRuleManager.registerFactory(DELEGATION_POLICY_RULE, saml2::DelegationRestrictionRuleFactory);
79 SecurityPolicyRule::SecurityPolicyRule()
83 SecurityPolicyRule::~SecurityPolicyRule()
87 SecurityPolicy::SecurityPolicy(
88 const saml2md::MetadataProvider* metadataProvider,
89 const xmltooling::QName* role,
90 const xmltooling::TrustEngine* trustEngine,
92 ) : m_metadataCriteria(nullptr),
94 m_issuerRole(nullptr),
95 m_authenticated(false),
96 m_metadata(metadataProvider),
97 m_role(role ? new xmltooling::QName(*role) : nullptr),
105 SecurityPolicy::~SecurityPolicy()
107 delete m_metadataCriteria;
110 const MetadataProvider* SecurityPolicy::getMetadataProvider() const
115 MetadataProvider::Criteria& SecurityPolicy::getMetadataProviderCriteria() const
117 if (!m_metadataCriteria)
118 m_metadataCriteria=new MetadataProvider::Criteria();
120 m_metadataCriteria->reset();
121 return *m_metadataCriteria;
124 const xmltooling::QName* SecurityPolicy::getRole() const
129 const TrustEngine* SecurityPolicy::getTrustEngine() const
134 bool SecurityPolicy::getValidating() const
139 bool SecurityPolicy::requireEntityIssuer() const
144 const vector<xstring>& SecurityPolicy::getAudiences() const
149 vector<xstring>& SecurityPolicy::getAudiences()
154 time_t SecurityPolicy::getTime() const
157 return m_ts = time(nullptr);
161 const XMLCh* SecurityPolicy::getCorrelationID() const
163 return m_correlationID.c_str();
166 vector<const SecurityPolicyRule*>& SecurityPolicy::getRules()
171 void SecurityPolicy::setMetadataProvider(const MetadataProvider* metadata)
173 m_metadata = metadata;
176 void SecurityPolicy::setMetadataProviderCriteria(MetadataProvider::Criteria* criteria)
178 if (m_metadataCriteria)
179 delete m_metadataCriteria;
180 m_metadataCriteria=criteria;
183 void SecurityPolicy::setRole(const xmltooling::QName* role)
185 m_role.reset(role ? new xmltooling::QName(*role) : nullptr);
188 void SecurityPolicy::setTrustEngine(const TrustEngine* trust)
193 void SecurityPolicy::setValidating(bool validate)
195 m_validate = validate;
198 void SecurityPolicy::requireEntityIssuer(bool entityOnly)
200 m_entityOnly = entityOnly;
203 void SecurityPolicy::setTime(time_t ts)
208 void SecurityPolicy::setCorrelationID(const XMLCh* correlationID)
210 m_correlationID.erase();
212 m_correlationID = correlationID;
215 void SecurityPolicy::evaluate(const XMLObject& message, const GenericRequest* request)
218 m_rules.begin(), m_rules.end(),
219 boost::bind(&SecurityPolicyRule::evaluate, _1, boost::ref(message), request, boost::ref(*this))
223 void SecurityPolicy::reset(bool messageOnly)
228 void SecurityPolicy::_reset(bool messageOnly)
234 m_issuerRole=nullptr;
235 m_authenticated=false;
239 const XMLCh* SecurityPolicy::getMessageID() const
241 return m_messageID.c_str();
244 time_t SecurityPolicy::getIssueInstant() const
246 return m_issueInstant;
249 const Issuer* SecurityPolicy::getIssuer() const
251 return m_issuer.get();
254 const RoleDescriptor* SecurityPolicy::getIssuerMetadata() const
259 bool SecurityPolicy::isAuthenticated() const
261 return m_authenticated;
264 void SecurityPolicy::setMessageID(const XMLCh* id)
271 void SecurityPolicy::setIssueInstant(time_t issueInstant)
273 m_issueInstant = issueInstant;
276 void SecurityPolicy::setIssuer(const Issuer* issuer)
278 if (!getIssuerMatchingPolicy().issuerMatches(m_issuer.get(), issuer))
279 throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
281 if (!m_issuer.get()) {
282 if (m_entityOnly && issuer->getFormat() && !XMLString::equals(issuer->getFormat(), NameIDType::ENTITY))
283 throw SecurityPolicyException("A non-entity Issuer was supplied, violating policy.");
284 m_issuerRole = nullptr;
285 m_issuer.reset(issuer->cloneIssuer());
289 void SecurityPolicy::setIssuer(const XMLCh* issuer)
291 if (!getIssuerMatchingPolicy().issuerMatches(m_issuer.get(), issuer))
292 throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
294 if (!m_issuer.get() && issuer && *issuer) {
295 m_issuerRole = nullptr;
296 m_issuer.reset(IssuerBuilder::buildIssuer());
297 m_issuer->setName(issuer);
301 void SecurityPolicy::setIssuerMetadata(const RoleDescriptor* issuerRole)
303 if (issuerRole && m_issuerRole && issuerRole!=m_issuerRole)
304 throw SecurityPolicyException("A rule supplied a RoleDescriptor that conflicts with previous results.");
305 m_issuerRole = issuerRole;
308 void SecurityPolicy::setAuthenticated(bool auth)
310 m_authenticated = auth;
313 SecurityPolicy::IssuerMatchingPolicy::IssuerMatchingPolicy()
317 SecurityPolicy::IssuerMatchingPolicy::~IssuerMatchingPolicy()
321 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const Issuer* issuer2) const
323 // nullptr matches anything for the purposes of this interface.
324 if (!issuer1 || !issuer2)
327 const XMLCh* op1=issuer1->getName();
328 const XMLCh* op2=issuer2->getName();
329 if (!op1 || !op2 || !XMLString::equals(op1,op2))
332 op1=issuer1->getFormat();
333 op2=issuer2->getFormat();
334 if (!XMLString::equals(op1 ? op1 : NameIDType::ENTITY, op2 ? op2 : NameIDType::ENTITY))
337 op1=issuer1->getNameQualifier();
338 op2=issuer2->getNameQualifier();
339 if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
342 op1=issuer1->getSPNameQualifier();
343 op2=issuer2->getSPNameQualifier();
344 if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
350 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const XMLCh* issuer2) const
352 // nullptr matches anything for the purposes of this interface.
353 if (!issuer1 || !issuer2 || !*issuer2)
356 const XMLCh* op1=issuer1->getName();
357 if (!op1 || !XMLString::equals(op1,issuer2))
360 op1=issuer1->getFormat();
361 if (op1 && *op1 && !XMLString::equals(op1, NameIDType::ENTITY))
364 op1=issuer1->getNameQualifier();
368 op1=issuer1->getSPNameQualifier();
375 SecurityPolicy::IssuerMatchingPolicy SecurityPolicy::m_defaultMatching;
377 const SecurityPolicy::IssuerMatchingPolicy& SecurityPolicy::getIssuerMatchingPolicy() const
379 return m_matchingPolicy.get() ? *m_matchingPolicy.get() : m_defaultMatching;
382 void SecurityPolicy::setIssuerMatchingPolicy(IssuerMatchingPolicy* matchingPolicy)
384 m_matchingPolicy.reset(matchingPolicy);