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