2 * Copyright 2001-2006 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * ClientCertAuthRule.cpp
20 * XML Signature checking SecurityPolicyRule
24 #include "exceptions.h"
25 #include "binding/ClientCertAuthRule.h"
26 #include "saml2/metadata/Metadata.h"
27 #include "saml2/metadata/MetadataProvider.h"
29 #include <xmltooling/security/X509TrustEngine.h>
30 #include <xmltooling/util/NDC.h>
31 #include <xmltooling/util/ReplayCache.h>
32 #include <log4cpp/Category.hh>
34 using namespace opensaml::saml2md;
35 using namespace opensaml;
36 using namespace xmltooling;
37 using namespace log4cpp;
41 SecurityPolicyRule* SAML_DLLLOCAL ClientCertAuthRuleFactory(const DOMElement* const & e)
43 return new ClientCertAuthRule(e);
47 pair<saml2::Issuer*,const RoleDescriptor*> ClientCertAuthRule::evaluate(
48 const GenericRequest& request,
49 const XMLObject& message,
50 const MetadataProvider* metadataProvider,
52 const TrustEngine* trustEngine
55 Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.ClientCertAuth");
56 log.debug("evaluating client certificate authentication policy");
58 pair<saml2::Issuer*,const RoleDescriptor*> ret = pair<saml2::Issuer*,const RoleDescriptor*>(NULL,NULL);
60 const X509TrustEngine* x509trust;
61 if (!metadataProvider || !role || !(x509trust=dynamic_cast<const X509TrustEngine*>(trustEngine))) {
62 log.debug("ignoring message, no metadata or X509TrustEngine supplied");
66 const std::vector<XSECCryptoX509*>& chain = request.getClientCertificates();
68 log.debug("ignoring message, no client certificates in request");
73 log.debug("extracting issuer from message");
74 pair<saml2::Issuer*,const XMLCh*> issuerInfo = getIssuerAndProtocol(message);
76 auto_ptr<saml2::Issuer> issuer(issuerInfo.first);
77 if (!issuerInfo.first || !issuerInfo.second ||
78 (issuer->getFormat() && !XMLString::equals(issuer->getFormat(), saml2::NameIDType::ENTITY))) {
79 log.warn("issuer identity not estabished, or was not an entityID");
83 log.debug("searching metadata for message issuer...");
84 const EntityDescriptor* entity = metadataProvider->getEntityDescriptor(issuer->getName());
86 auto_ptr_char temp(issuer->getName());
87 log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
91 log.debug("matched message issuer against metadata, searching for applicable role...");
92 const RoleDescriptor* roledesc=entity->getRoleDescriptor(*role, issuerInfo.second);
94 log.warn("unable to find compatible role (%s) in metadata", role->toString().c_str());
98 if (!x509trust->validate(chain.front(), chain, *roledesc, true, metadataProvider->getKeyResolver())) {
99 log.error("unable to verify certificate chain with supplied trust engine");
103 if (log.isDebugEnabled()) {
104 auto_ptr_char iname(entity->getEntityID());
105 log.debug("message from (%s), signature verified", iname.get());
108 ret.first = issuer.release();
109 ret.second = roledesc;
113 log.warn("caught a bad_cast while extracting issuer");
118 pair<saml2::Issuer*,const XMLCh*> ClientCertAuthRule::getIssuerAndProtocol(const XMLObject& message) const
120 // We just let any bad casts throw here.
122 // Shortcuts some of the casting.
123 const XMLCh* ns = message.getElementQName().getNamespaceURI();
125 if (XMLString::equals(ns, samlconstants::SAML20P_NS)) {
126 // 2.0 namespace should be castable to a specialized 2.0 root.
127 const saml2::RootObject& root = dynamic_cast<const saml2::RootObject&>(message);
128 saml2::Issuer* issuer = root.getIssuer();
129 if (issuer && issuer->getName())
130 return make_pair(issuer->cloneIssuer(), samlconstants::SAML20P_NS);
133 return pair<saml2::Issuer*,const XMLCh*>(NULL,NULL);