2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * KeyInfoAttributeDecoder.cpp
24 * Decodes KeyInfo information into a SimpleAttribute.
28 #include "attribute/AttributeDecoder.h"
29 #include "attribute/SimpleAttribute.h"
31 #include <saml/saml1/core/Assertions.h>
32 #include <saml/saml2/core/Assertions.h>
33 #include <xmltooling/XMLToolingConfig.h>
34 #include <xmltooling/security/Credential.h>
35 #include <xmltooling/security/KeyInfoResolver.h>
36 #include <xmltooling/security/SecurityHelper.h>
37 #include <xmltooling/signature/KeyInfo.h>
39 using namespace shibsp;
40 using namespace opensaml;
41 using namespace xmlsignature;
42 using namespace xmltooling;
46 class SHIBSP_DLLLOCAL KeyInfoAttributeDecoder : virtual public AttributeDecoder
49 KeyInfoAttributeDecoder(const DOMElement* e);
50 ~KeyInfoAttributeDecoder() {
51 delete m_keyInfoResolver;
55 const vector<string>& ids, const XMLObject* xmlObject, const char* assertingParty=nullptr, const char* relyingParty=nullptr
59 void extract(const KeyInfo* k, vector<string>& dest) const {
60 auto_ptr<Credential> cred (getKeyInfoResolver()->resolve(k, Credential::RESOLVE_KEYS));
62 dest.push_back(string());
63 dest.back() = SecurityHelper::getDEREncoding(*cred.get(), m_hash ? m_keyInfoHashAlg.c_str() : nullptr);
64 if (dest.back().empty())
69 const KeyInfoResolver* getKeyInfoResolver() const {
70 return m_keyInfoResolver ? m_keyInfoResolver : XMLToolingConfig::getConfig().getKeyInfoResolver();
74 string m_keyInfoHashAlg;
75 KeyInfoResolver* m_keyInfoResolver;
78 AttributeDecoder* SHIBSP_DLLLOCAL KeyInfoAttributeDecoderFactory(const DOMElement* const & e)
80 return new KeyInfoAttributeDecoder(e);
83 static const XMLCh _KeyInfoResolver[] = UNICODE_LITERAL_15(K,e,y,I,n,f,o,R,e,s,o,l,v,e,r);
84 static const XMLCh _hash[] = UNICODE_LITERAL_4(h,a,s,h);
85 static const XMLCh keyInfoHashAlg[] = UNICODE_LITERAL_14(k,e,y,I,n,f,o,H,a,s,h,A,l,g);
86 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
89 KeyInfoAttributeDecoder::KeyInfoAttributeDecoder(const DOMElement* e)
90 : AttributeDecoder(e),
91 m_hash(XMLHelper::getAttrBool(e, false, _hash)),
92 m_keyInfoHashAlg(XMLHelper::getAttrString(e, "SHA1", keyInfoHashAlg)),
93 m_keyInfoResolver(nullptr) {
94 e = XMLHelper::getFirstChildElement(e,_KeyInfoResolver);
96 string t(XMLHelper::getAttrString(e, nullptr, _type));
98 throw UnknownExtensionException("<KeyInfoResolver> element found with no type attribute");
99 m_keyInfoResolver = XMLToolingConfig::getConfig().KeyInfoResolverManager.newPlugin(t.c_str(), e);
103 Attribute* KeyInfoAttributeDecoder::decode(
104 const vector<string>& ids, const XMLObject* xmlObject, const char* assertingParty, const char* relyingParty
107 Category& log = Category::getInstance(SHIBSP_LOGCAT".AttributeDecoder.KeyInfo");
109 if (!xmlObject || !XMLString::equals(saml1::Attribute::LOCAL_NAME, xmlObject->getElementQName().getLocalPart())) {
110 log.warn("XMLObject type not recognized by KeyInfoAttributeDecoder, no values returned");
114 auto_ptr<SimpleAttribute> attr(new SimpleAttribute(ids));
115 vector<string>& dest = attr->getValues();
116 vector<XMLObject*>::const_iterator v,stop;
118 const saml2::Attribute* saml2attr = dynamic_cast<const saml2::Attribute*>(xmlObject);
120 const vector<XMLObject*>& values = saml2attr->getAttributeValues();
123 if (log.isDebugEnabled()) {
124 auto_ptr_char n(saml2attr->getName());
126 "decoding KeyInfo information (%s) from SAML 2 Attribute (%s) with %lu value(s)",
127 ids.front().c_str(), n.get() ? n.get() : "unnamed", values.size()
132 const saml1::Attribute* saml1attr = dynamic_cast<const saml1::Attribute*>(xmlObject);
134 const vector<XMLObject*>& values = saml1attr->getAttributeValues();
137 if (log.isDebugEnabled()) {
138 auto_ptr_char n(saml1attr->getAttributeName());
140 "decoding KeyInfo information (%s) from SAML 1 Attribute (%s) with %lu value(s)",
141 ids.front().c_str(), n.get() ? n.get() : "unnamed", values.size()
146 log.warn("XMLObject type not recognized by KeyInfoAttributeDecoder, no values returned");
151 for (; v!=stop; ++v) {
152 const KeyInfo* k = dynamic_cast<const KeyInfo*>(*v);
155 else if ((*v)->hasChildren()) {
156 const list<XMLObject*>& children = (*v)->getOrderedChildren();
157 for (list<XMLObject*>::const_iterator vv = children.begin(); vv!=children.end(); ++vv) {
158 if (k=dynamic_cast<const KeyInfo*>(*vv))
161 log.warn("skipping AttributeValue without a recognizable KeyInfo");
166 return dest.empty() ? nullptr : _decode(attr.release());