https://issues.shibboleth.net/jira/browse/SSPCPP-132
[shibboleth/cpp-opensaml.git] / saml / saml2 / binding / impl / SAML2MessageDecoder.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  * SAML2MessageDecoder.cpp
19  *
20  * Base class for SAML 2.0 MessageDecoders.
21  */
22
23 #include "internal.h"
24 #include "exceptions.h"
25 #include "saml2/binding/SAML2MessageDecoder.h"
26 #include "saml2/core/Protocols.h"
27 #include "saml2/metadata/Metadata.h"
28 #include "saml2/metadata/MetadataProvider.h"
29 #include "util/SAMLConstants.h"
30
31 #include <xmltooling/logging.h>
32
33 using namespace opensaml::saml2md;
34 using namespace opensaml::saml2p;
35 using namespace opensaml::saml2;
36 using namespace opensaml;
37 using namespace xmltooling::logging;
38 using namespace xmltooling;
39 using namespace std;
40
41 void SAML2MessageDecoder::extractMessageDetails(
42     const XMLObject& message, const GenericRequest& request, const XMLCh* protocol, SecurityPolicy& policy
43     ) const
44 {
45     // Only handle SAML 2.0 messages.
46     const QName& q = message.getElementQName();
47     if (!XMLString::equals(q.getNamespaceURI(), samlconstants::SAML20P_NS))
48         return;
49
50     Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML2");
51
52     try {
53         const saml2::RootObject& samlRoot = dynamic_cast<const saml2::RootObject&>(message);
54         policy.setMessageID(samlRoot.getID());
55         policy.setIssueInstant(samlRoot.getIssueInstantEpoch());
56
57         log.debug("extracting issuer from SAML 2.0 protocol message");
58         const Issuer* issuer = samlRoot.getIssuer();
59         if (issuer) {
60             policy.setIssuer(issuer);
61         }
62         else if (XMLString::equals(q.getLocalPart(), Response::LOCAL_NAME)) {
63             // No issuer in the message, so we have to try the Response approach.
64             const vector<saml2::Assertion*>& assertions = dynamic_cast<const Response&>(samlRoot).getAssertions();
65             if (!assertions.empty()) {
66                 issuer = assertions.front()->getIssuer();
67                 if (issuer)
68                     policy.setIssuer(issuer);
69             }
70         }
71
72         if (!issuer) {
73             log.warn("issuer identity not extracted");
74             return;
75         }
76
77         if (log.isDebugEnabled()) {
78             auto_ptr_char iname(issuer->getName());
79             log.debug("message from (%s)", iname.get());
80         }
81
82         if (policy.getIssuerMetadata()) {
83             log.debug("metadata for issuer already set, leaving in place");
84             return;
85         }
86
87         if (policy.getMetadataProvider() && policy.getRole()) {
88             if (issuer->getFormat() && !XMLString::equals(issuer->getFormat(), NameIDType::ENTITY)) {
89                 log.warn("non-system entity issuer, skipping metadata lookup");
90                 return;
91             }
92
93             log.debug("searching metadata for message issuer...");
94             MetadataProvider::Criteria& mc = policy.getMetadataProviderCriteria();
95             mc.entityID_unicode = issuer->getName();
96             mc.role = policy.getRole();
97             mc.protocol = protocol;
98             pair<const EntityDescriptor*,const RoleDescriptor*> entity = policy.getMetadataProvider()->getEntityDescriptor(mc);
99             if (!entity.first) {
100                 auto_ptr_char temp(issuer->getName());
101                 log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
102                 return;
103             }
104             else if (!entity.second) {
105                 log.warn("unable to find compatible role (%s) in metadata", policy.getRole()->toString().c_str());
106                 return;
107             }
108             policy.setIssuerMetadata(entity.second);
109         }
110     }
111     catch (bad_cast&) {
112         // Just trap it.
113         log.warn("caught a bad_cast while extracting message details");
114     }
115 }