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