-/*
- * Copyright 2001-2006 Internet2
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
*/
/**
* ClientCertAuthRule.cpp
*
- * XML Signature checking SecurityPolicyRule
+ * TLS client authentication SecurityPolicyRule.
*/
#include "internal.h"
#include "exceptions.h"
-#include "binding/ClientCertAuthRule.h"
+#include "binding/SecurityPolicy.h"
+#include "binding/SecurityPolicyRule.h"
#include "saml2/metadata/Metadata.h"
+#include "saml2/metadata/MetadataCredentialCriteria.h"
#include "saml2/metadata/MetadataProvider.h"
-#include "security/X509TrustEngine.h"
-#include <xmltooling/util/NDC.h>
+#include <xmltooling/logging.h>
+#include <xmltooling/io/GenericRequest.h>
+#include <xmltooling/security/Credential.h>
+#include <xmltooling/security/X509TrustEngine.h>
#include <xmltooling/util/ReplayCache.h>
-#include <log4cpp/Category.hh>
using namespace opensaml::saml2md;
using namespace opensaml;
+using namespace xmltooling::logging;
using namespace xmltooling;
-using namespace log4cpp;
using namespace std;
namespace opensaml {
+ class SAML_DLLLOCAL ClientCertAuthRule : public SecurityPolicyRule
+ {
+ public:
+ ClientCertAuthRule(const DOMElement* e);
+ virtual ~ClientCertAuthRule() {}
+
+ const char* getType() const {
+ return CLIENTCERTAUTH_POLICY_RULE;
+ }
+ bool evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const;
+
+ private:
+ bool m_errorFatal;
+ };
+
SecurityPolicyRule* SAML_DLLLOCAL ClientCertAuthRuleFactory(const DOMElement* const & e)
{
return new ClientCertAuthRule(e);
}
+
+ static const XMLCh errorFatal[] = UNICODE_LITERAL_10(e,r,r,o,r,F,a,t,a,l);
};
-pair<saml2::Issuer*,const RoleDescriptor*> ClientCertAuthRule::evaluate(
- const GenericRequest& request,
- const XMLObject& message,
- const MetadataProvider* metadataProvider,
- const QName* role,
- const opensaml::TrustEngine* trustEngine
- ) const
+ClientCertAuthRule::ClientCertAuthRule(const DOMElement* e) : m_errorFatal(XMLHelper::getAttrBool(e, false, errorFatal))
{
- Category& log=Category::getInstance(SAML_LOGCAT".SecurityPolicyRule.ClientCertAuth");
- log.debug("evaluating client certificate authentication policy");
-
- pair<saml2::Issuer*,const RoleDescriptor*> ret = pair<saml2::Issuer*,const RoleDescriptor*>(NULL,NULL);
+}
+
+bool ClientCertAuthRule::evaluate(const XMLObject& message, const GenericRequest* request, SecurityPolicy& policy) const
+{
+ Category& log=Category::getInstance(SAML_LOGCAT ".SecurityPolicyRule.ClientCertAuth");
- const opensaml::X509TrustEngine* x509trust;
- if (!metadataProvider || !role || !(x509trust=dynamic_cast<const opensaml::X509TrustEngine*>(trustEngine))) {
- log.debug("ignoring message, no metadata or X509TrustEngine supplied");
- return ret;
- }
+ if (!request)
+ return false;
- const std::vector<XSECCryptoX509*>& chain = request.getClientCertificates();
- if (chain.empty()) {
- log.debug("ignoring message, no client certificates in request");
- return ret;
+ if (!policy.getIssuerMetadata()) {
+ log.debug("ignoring message, no issuer metadata supplied");
+ return false;
}
-
- try {
- log.debug("extracting issuer from message");
- pair<saml2::Issuer*,const XMLCh*> issuerInfo = getIssuerAndProtocol(message);
-
- auto_ptr<saml2::Issuer> issuer(issuerInfo.first);
- if (!issuerInfo.first || !issuerInfo.second ||
- (issuer->getFormat() && !XMLString::equals(issuer->getFormat(), saml2::NameIDType::ENTITY))) {
- log.warn("issuer identity not estabished, or was not an entityID");
- return ret;
- }
-
- log.debug("searching metadata for message issuer...");
- const EntityDescriptor* entity = metadataProvider->getEntityDescriptor(issuer->getName());
- if (!entity) {
- auto_ptr_char temp(issuer->getName());
- log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
- return ret;
- }
-
- log.debug("matched message issuer against metadata, searching for applicable role...");
- const RoleDescriptor* roledesc=entity->getRoleDescriptor(*role, issuerInfo.second);
- if (!roledesc) {
- log.warn("unable to find compatible role (%s) in metadata", role->toString().c_str());
- return ret;
- }
- if (!x509trust->validate(chain.front(), chain, *roledesc, true, metadataProvider->getKeyResolver())) {
- log.error("unable to verify certificate chain with supplied trust engine");
- return ret;
- }
-
- if (log.isDebugEnabled()) {
- auto_ptr_char iname(entity->getEntityID());
- log.debug("message from (%s), signature verified", iname.get());
- }
-
- ret.first = issuer.release();
- ret.second = roledesc;
+ const X509TrustEngine* x509trust;
+ if (!(x509trust=dynamic_cast<const X509TrustEngine*>(policy.getTrustEngine()))) {
+ log.debug("ignoring message, no X509TrustEngine supplied");
+ return false;
}
- catch (bad_cast&) {
- // Just trap it.
- log.warn("caught a bad_cast while extracting issuer");
- }
- return ret;
-}
-
-pair<saml2::Issuer*,const XMLCh*> ClientCertAuthRule::getIssuerAndProtocol(const XMLObject& message) const
-{
- // We just let any bad casts throw here.
+
+ const vector<XSECCryptoX509*>& chain = request->getClientCertificates();
+ if (chain.empty())
+ return false;
+
+ // Set up criteria object, including peer name to enforce cert name checking.
+ MetadataCredentialCriteria cc(*(policy.getIssuerMetadata()));
+ auto_ptr_char pn(policy.getIssuer()->getName());
+ cc.setPeerName(pn.get());
+ cc.setUsage(Credential::TLS_CREDENTIAL);
- // Shortcuts some of the casting.
- const XMLCh* ns = message.getElementQName().getNamespaceURI();
- if (ns) {
- if (XMLString::equals(ns, samlconstants::SAML20P_NS)) {
- // 2.0 namespace should be castable to a specialized 2.0 root.
- const saml2::RootObject& root = dynamic_cast<const saml2::RootObject&>(message);
- saml2::Issuer* issuer = root.getIssuer();
- if (issuer && issuer->getName())
- return make_pair(issuer->cloneIssuer(), samlconstants::SAML20P_NS);
- }
+ if (!x509trust->validate(chain.front(), chain, *(policy.getMetadataProvider()), &cc)) {
+ if (m_errorFatal)
+ throw SecurityPolicyException("Client certificate supplied, but could not be verified.");
+ log.error("unable to verify certificate chain with supplied trust engine");
+ return false;
}
- return pair<saml2::Issuer*,const XMLCh*>(NULL,NULL);
+
+ log.debug("client certificate verified against message issuer");
+ policy.setAuthenticated(true);
+ return true;
}