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     }
  51 };
  52
  53 void SAML_API opensaml::registerSecurityPolicyRules()
  54 {
  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);
  66 }
  67
  68 SecurityPolicy::IssuerMatchingPolicy SecurityPolicy::m_defaultMatching;
  69
  70 SecurityPolicy::SecurityPolicy(
  71     const saml2md::MetadataProvider* metadataProvider,
  72     const xmltooling::QName* role,
  73     const xmltooling::TrustEngine* trustEngine,
  74     bool validate
  75     ) : m_metadataCriteria(NULL),
  76         m_issueInstant(0),
  77         m_issuer(NULL),
  78         m_issuerRole(NULL),
  79         m_authenticated(false),
  80         m_matchingPolicy(NULL),
  81         m_metadata(metadataProvider),
  82         m_role(NULL),
  83         m_trust(trustEngine),
  84         m_validate(validate),
  85         m_entityOnly(true),
  86         m_ts(0)
  87 {
  88     if (role)
  89         m_role = new xmltooling::QName(*role);
  90 }
  91
  92 SecurityPolicy::~SecurityPolicy()
  93 {
  94     delete m_metadataCriteria;
  95     delete m_issuer;
  96 }
  97
  98 void SecurityPolicy::reset(bool messageOnly)
  99 {
 100     _reset(messageOnly);
 101 }
 102
 103 void SecurityPolicy::_reset(bool messageOnly)
 104 {
 105     m_messageID.erase();
 106     m_issueInstant=0;
 107     if (!messageOnly) {
 108         delete m_issuer;
 109         m_issuer=NULL;
 110         m_issuerRole=NULL;
 111         m_authenticated=false;
 112     }
 113 }
 114
 115 MetadataProvider::Criteria& SecurityPolicy::getMetadataProviderCriteria() const
 116 {
 117     if (!m_metadataCriteria)
 118         m_metadataCriteria=new MetadataProvider::Criteria();
 119     else
 120         m_metadataCriteria->reset();
 121     return *m_metadataCriteria;
 122 }
 123
 124 void SecurityPolicy::setMetadataProviderCriteria(saml2md::MetadataProvider::Criteria* criteria)
 125 {
 126     if (m_metadataCriteria)
 127         delete m_metadataCriteria;
 128     m_metadataCriteria=criteria;
 129 }
 130
 131 void SecurityPolicy::evaluate(const XMLObject& message, const GenericRequest* request)
 132 {
 133     for (vector<const SecurityPolicyRule*>::const_iterator i=m_rules.begin(); i!=m_rules.end(); ++i)
 134         (*i)->evaluate(message,request,*this);
 135 }
 136
 137 void SecurityPolicy::setIssuer(const Issuer* issuer)
 138 {
 139     if (!getIssuerMatchingPolicy().issuerMatches(m_issuer, issuer))
 140         throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
 141
 142     if (!m_issuer) {
 143         if (m_entityOnly && issuer->getFormat() && !XMLString::equals(issuer->getFormat(), NameIDType::ENTITY))
 144             throw SecurityPolicyException("A non-entity Issuer was supplied, violating policy.");
 145         m_issuerRole = NULL;
 146         m_issuer=issuer->cloneIssuer();
 147     }
 148 }
 149
 150 void SecurityPolicy::setIssuer(const XMLCh* issuer)
 151 {
 152     if (!getIssuerMatchingPolicy().issuerMatches(m_issuer, issuer))
 153         throw SecurityPolicyException("An Issuer was supplied that conflicts with previous results.");
 154
 155     if (!m_issuer && issuer && *issuer) {
 156         m_issuerRole = NULL;
 157         m_issuer = IssuerBuilder::buildIssuer();
 158         m_issuer->setName(issuer);
 159     }
 160 }
 161
 162 void SecurityPolicy::setIssuerMetadata(const RoleDescriptor* issuerRole)
 163 {
 164     if (issuerRole && m_issuerRole && issuerRole!=m_issuerRole)
 165         throw SecurityPolicyException("A rule supplied a RoleDescriptor that conflicts with previous results.");
 166     m_issuerRole=issuerRole;
 167 }
 168
 169 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const Issuer* issuer2) const
 170 {
 171     // NULL matches anything for the purposes of this interface.
 172     if (!issuer1 || !issuer2)
 173         return true;
 174
 175     const XMLCh* op1=issuer1->getName();
 176     const XMLCh* op2=issuer2->getName();
 177     if (!op1 || !op2 || !XMLString::equals(op1,op2))
 178         return false;
 179
 180     op1=issuer1->getFormat();
 181     op2=issuer2->getFormat();
 182     if (!XMLString::equals(op1 ? op1 : NameIDType::ENTITY, op2 ? op2 : NameIDType::ENTITY))
 183         return false;
 184
 185     op1=issuer1->getNameQualifier();
 186     op2=issuer2->getNameQualifier();
 187     if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
 188         return false;
 189
 190     op1=issuer1->getSPNameQualifier();
 191     op2=issuer2->getSPNameQualifier();
 192     if (!XMLString::equals(op1 ? op1 : &chNull, op2 ? op2 : &chNull))
 193         return false;
 194
 195     return true;
 196 }
 197
 198 bool SecurityPolicy::IssuerMatchingPolicy::issuerMatches(const Issuer* issuer1, const XMLCh* issuer2) const
 199 {
 200     // NULL matches anything for the purposes of this interface.
 201     if (!issuer1 || !issuer2 || !*issuer2)
 202         return true;
 203
 204     const XMLCh* op1=issuer1->getName();
 205     if (!op1 || !XMLString::equals(op1,issuer2))
 206         return false;
 207
 208     op1=issuer1->getFormat();
 209     if (op1 && *op1 && !XMLString::equals(op1, NameIDType::ENTITY))
 210         return false;
 211
 212     op1=issuer1->getNameQualifier();
 213     if (op1 && *op1)
 214         return false;
 215
 216     op1=issuer1->getSPNameQualifier();
 217     if (op1 && *op1)
 218         return false;
 219
 220     return true;
 221 }