saml/saml1/binding/impl/SAML1MessageRule.cpp

   1 /*
   2  *  Copyright 2001-2007 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  * SAML1MessageRule.cpp
  19  *
  20  * SAML 1.x message extraction rule
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "RootObject.h"
  26 #include "binding/SecurityPolicyRule.h"
  27 #include "saml1/core/Assertions.h"
  28 #include "saml1/core/Protocols.h"
  29 #include "saml2/core/Assertions.h"
  30 #include "saml2/metadata/Metadata.h"
  31 #include "saml2/metadata/MetadataProvider.h"
  32 #include "util/SAMLConstants.h"
  33
  34 #include <log4cpp/Category.hh>
  35
  36 using namespace opensaml::saml2md;
  37 using namespace opensaml::saml1p;
  38 using namespace opensaml;
  39 using namespace xmltooling;
  40 using namespace log4cpp;
  41 using namespace std;
  42
  43 namespace opensaml {
  44
  45     class SAML_DLLLOCAL SAML1MessageRule : public SecurityPolicyRule
  46     {
  47     public:
  48         SAML1MessageRule(const DOMElement* e) {}
  49         virtual ~SAML1MessageRule() {}
  50
  51         void evaluate(const xmltooling::XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
  52     };
  53
  54     SecurityPolicyRule* SAML_DLLLOCAL SAML1MessageRuleFactory(const DOMElement* const & e)
  55     {
  56         return new SAML1MessageRule(e);
  57     }
  58 };
  59
  60 void SAML1MessageRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
  61 {
  62     Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.SAML1Message");
  63
  64     const QName& q = message.getElementQName();
  65     policy.setMessageQName(&q);
  66
  67     if (!XMLString::equals(q.getNamespaceURI(), samlconstants::SAML1P_NS) &&
  68         !XMLString::equals(q.getNamespaceURI(), samlconstants::SAML1_NS)) {
  69         log.debug("not a SAML 1.x protocol message or assertion");
  70         return;
  71     }
  72
  73
  74     try {
  75         const RootObject& samlRoot = dynamic_cast<const RootObject&>(message);
  76         policy.setMessageID(samlRoot.getID());
  77         policy.setIssueInstant(samlRoot.getIssueInstantEpoch());
  78
  79         log.debug("extracting issuer from message");
  80
  81         const XMLCh* protocol = NULL;
  82         const saml1::Assertion* a = NULL;
  83
  84         // Handle assertions directly.
  85         if (XMLString::equals(q.getLocalPart(), saml1::Assertion::LOCAL_NAME))
  86             a = dynamic_cast<const saml1::Assertion*>(&samlRoot);
  87
  88         // Only samlp:Response is known to carry issuer (via payload) in standard SAML 1.x.
  89         if (!a && XMLString::equals(q.getLocalPart(), Response::LOCAL_NAME)) {
  90             // Should be a samlp:Response.
  91             const vector<saml1::Assertion*>& assertions = dynamic_cast<const saml1p::Response&>(samlRoot).getAssertions();
  92             if (!assertions.empty())
  93                 a = assertions.front();
  94         }
  95
  96         if (a && a->getIssuer()) {
  97             if (!policy.getIssuer() || policy.getIssuer()->getFormat() ||
  98                     !XMLString::equals(policy.getIssuer()->getName(), a->getIssuer())) {
  99                 // We either have a conflict, or a first-time set of Issuer.
 100                 auto_ptr<saml2::Issuer> issuer(saml2::IssuerBuilder::buildIssuer());
 101                 issuer->setName(a->getIssuer());
 102                 policy.setIssuer(issuer.get());
 103                 issuer.release();   // owned by policy now
 104             }
 105             pair<bool,int> minor = a->getMinorVersion();
 106             protocol = (minor.first && minor.second==0) ?
 107                 samlconstants::SAML10_PROTOCOL_ENUM : samlconstants::SAML11_PROTOCOL_ENUM;
 108         }
 109
 110         if (!protocol) {
 111             log.warn("issuer identity not extracted");
 112             return;
 113         }
 114
 115         if (log.isDebugEnabled()) {
 116             auto_ptr_char iname(policy.getIssuer()->getName());
 117             log.debug("message from (%s)", iname.get());
 118         }
 119
 120         if (policy.getIssuerMetadata()) {
 121             log.debug("metadata for issuer already set, leaving in place");
 122             return;
 123         }
 124
 125         if (policy.getMetadataProvider() && policy.getRole()) {
 126             log.debug("searching metadata for message issuer...");
 127             const EntityDescriptor* entity = policy.getMetadataProvider()->getEntityDescriptor(policy.getIssuer()->getName());
 128             if (!entity) {
 129                 auto_ptr_char temp(policy.getIssuer()->getName());
 130                 log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
 131                 return;
 132             }
 133
 134             log.debug("matched message issuer against metadata, searching for applicable role...");
 135             const RoleDescriptor* roledesc=entity->getRoleDescriptor(*policy.getRole(), protocol);
 136             if (!roledesc) {
 137                 log.warn("unable to find compatible role (%s) in metadata", policy.getRole()->toString().c_str());
 138                 return;
 139             }
 140             policy.setIssuerMetadata(roledesc);
 141         }
 142     }
 143     catch (bad_cast&) {
 144         // Just trap it.
 145         log.warn("caught a bad_cast while examining message");
 146     }
 147 }