saml/binding/impl/SecurityPolicy.cpp

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * SecurityPolicy.cpp
  19  *
  20  * Overall policy used to verify the security of an incoming message.
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "binding/SecurityPolicyRule.h"
  26 #include "saml2/core/Assertions.h"
  27
  28 using namespace opensaml::saml2md;
  29 using namespace opensaml::saml2;
  30 using namespace opensaml;
  31 using namespace xmltooling;
  32 using namespace std;
  33
  34 namespace opensaml {
  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;
  43
  44     namespace saml1 {
  45         SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory BrowserSSORuleFactory;
  46     }
  47
  48     namespace saml2 {
  49         SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory BearerConfirmationRuleFactory;
  50         SAML_DLLLOCAL PluginManager<SecurityPolicyRule,string,const DOMElement*>::Factory DelegationRestrictionRuleFactory;
  51     }
  52 };
  53
  54 void SAML_API opensaml::registerSecurityPolicyRules()
  55 {
  56     SAMLConfig& conf=SAMLConfig::getConfig();
  57     conf.SecurityPolicyRuleManager.registerFactory(AUDIENCE_POLICY_RULE, AudienceRestrictionRuleFactory);
  58     conf.SecurityPolicyRuleManager.registerFactory(CLIENTCERTAUTH_POLICY_RULE, ClientCertAuthRuleFactory);
  59     conf.SecurityPolicyRuleManager.registerFactory(CONDITIONS_POLICY_RULE, ConditionsRuleFactory);
  60     conf.SecurityPolicyRuleManager.registerFactory(IGNORE_POLICY_RULE, IgnoreRuleFactory);
  61     conf.SecurityPolicyRuleManager.registerFactory(MESSAGEFLOW_POLICY_RULE, MessageFlowRuleFactory);
  62     conf.SecurityPolicyRuleManager.registerFactory(NULLSECURITY_POLICY_RULE, NullSecurityRuleFactory);
  63     conf.SecurityPolicyRuleManager.registerFactory(SIMPLESIGNING_POLICY_RULE, SimpleSigningRuleFactory);
  64     conf.SecurityPolicyRuleManager.registerFactory(XMLSIGNING_POLICY_RULE, XMLSigningRuleFactory);
  65     conf.SecurityPolicyRuleManager.registerFactory(SAML1BROWSERSSO_POLICY_RULE, saml1::BrowserSSORuleFactory);
  66     conf.SecurityPolicyRuleManager.registerFactory(BEARER_POLICY_RULE, saml2::BearerConfirmationRuleFactory);
  67     conf.SecurityPolicyRuleManager.registerFactory(DELEGATION_POLICY_RULE, saml2::DelegationRestrictionRuleFactory);
  68 }
  69
  70 SecurityPolicy::IssuerMatchingPolicy SecurityPolicy::m_defaultMatching;
  71
  72 SecurityPolicy::SecurityPolicy(
  73     const saml2md::MetadataProvider* metadataProvider,
  74     const xmltooling::QName* role,
  75     const xmltooling::TrustEngine* trustEngine,
  76     bool validate
  77     ) : m_metadataCriteria(NULL),
  78         m_issueInstant(0),
  79         m_issuer(NULL),
  80         m_issuerRole(NULL),
  81         m_authenticated(false),
  82         m_matchingPolicy(NULL),
  83         m_metadata(metadataProvider),
  84         m_role(NULL),
  85         m_trust(trustEngine),
  86         m_validate(validate),
  87         m_entityOnly(true),
  88         m_ts(0)
  89 {
  90     if (role)
  91         m_role = new xmltooling::QName(*role);
  92 }
  93
  94 SecurityPolicy::~SecurityPolicy()
  95 {
  96     delete m_metadataCriteria;
  97     delete m_issuer;
  98 }
  99
 100 void SecurityPolicy::reset(bool messageOnly)
 101 {
 102     _reset(messageOnly);
 103 }
 104
 105 void SecurityPolicy::_reset(bool messageOnly)
 106 {
 107     m_messageID.erase();
 108     m_issueInstant=0;
 109     if (!messageOnly) {
 110         delete m_issuer;
 111         m_issuer=NULL;
 112         m_issuerRole=NULL;
 113         m_authenticated=false;
 114     }
 115 }
 116
 117 MetadataProvider::Criteria& SecurityPolicy::getMetadataProviderCriteria() const
 118 {
 119     if (!m_metadataCriteria)
 120         m_metadataCriteria=new MetadataProvider::Criteria();
 121     else
 122         m_metadataCriteria->reset();
 123     return *m_metadataCriteria;
 124 }
 125
 126 void SecurityPolicy::setMetadataProviderCriteria(saml2md::MetadataProvider::Criteria* criteria)
 127 {
 128     if (m_metadataCriteria)
 129         delete m_metadataCriteria;
 130     m_metadataCriteria=criteria;
 131 }
 132
 133 void SecurityPolicy::evaluate(const XMLObject& message, const GenericRequest* request)
 134 {
 135     for (vector<const SecurityPolicyRule*>::const_iterator i=m_rules.begin(); i!=m_rules.end(); ++i)
 136         (*i)->evaluate(message,request,*this);
 137 }
 138
 139 void SecurityPolicy::setIssuer(const Issuer* issuer)
 140 {
 141     if (!getIssuerMatchingPolicy().issuerMatches(m_issuer, issuer))
 142         throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
 143
 144     if (!m_issuer) {
 145         if (m_entityOnly && issuer->getFormat() && !XMLString::equals(issuer->getFormat(), NameIDType::ENTITY))
 146             throw SecurityPolicyException("A non-entity Issuer was supplied, violating policy.");
 147         m_issuerRole = NULL;
 148         m_issuer=issuer->cloneIssuer();
 149     }
 150 }
 151
 152 void SecurityPolicy::setIssuer(const XMLCh* issuer)
 153 {
 154     if (!getIssuerMatchingPolicy().issuerMatches(m_issuer, issuer))
 155         throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
 156
 157     if (!m_issuer && issuer && *issuer) {
 158         m_issuerRole = NULL;
 159         m_issuer = IssuerBuilder::buildIssuer();
 160         m_issuer->setName(issuer);
 161     }
 162 }
 163
 164 void SecurityPolicy::setIssuerMetadata(const RoleDescriptor* issuerRole)
 165 {
 166     if (issuerRole && m_issuerRole && issuerRole!=m_issuerRole)
 167         throw SecurityPolicyException("A rule supplied a RoleDescriptor that conflicts with previous results.");
 168     m_issuerRole=issuerRole;
 169 }
 170
 171 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const Issuer* issuer2) const
 172 {
 173     // NULL matches anything for the purposes of this interface.
 174     if (!issuer1 || !issuer2)
 175         return true;
 176
 177     const XMLCh* op1=issuer1->getName();
 178     const XMLCh* op2=issuer2->getName();
 179     if (!op1 || !op2 || !XMLString::equals(op1,op2))
 180         return false;
 181
 182     op1=issuer1->getFormat();
 183     op2=issuer2->getFormat();
 184     if (!XMLString::equals(op1 ? op1 : NameIDType::ENTITY, op2 ? op2 : NameIDType::ENTITY))
 185         return false;
 186
 187     op1=issuer1->getNameQualifier();
 188     op2=issuer2->getNameQualifier();
 189     if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
 190         return false;
 191
 192     op1=issuer1->getSPNameQualifier();
 193     op2=issuer2->getSPNameQualifier();
 194     if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
 195         return false;
 196
 197     return true;
 198 }
 199
 200 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const XMLCh* issuer2) const
 201 {
 202     // NULL matches anything for the purposes of this interface.
 203     if (!issuer1 || !issuer2 || !*issuer2)
 204         return true;
 205
 206     const XMLCh* op1=issuer1->getName();
 207     if (!op1 || !XMLString::equals(op1,issuer2))
 208         return false;
 209
 210     op1=issuer1->getFormat();
 211     if (op1 && *op1 && !XMLString::equals(op1, NameIDType::ENTITY))
 212         return false;
 213
 214     op1=issuer1->getNameQualifier();
 215     if (op1 && *op1)
 216         return false;
 217
 218     op1=issuer1->getSPNameQualifier();
 219     if (op1 && *op1)
 220         return false;
 221
 222     return true;
 223 }