2 * Copyright 2001-2009 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 * CredentialCriteria.cpp
20 * Class for specifying criteria by which a CredentialResolver should resolve credentials.
25 #include "XMLToolingConfig.h"
26 #include "security/X509Credential.h"
27 #include "security/CredentialCriteria.h"
28 #include "security/KeyInfoResolver.h"
29 #include "security/SecurityHelper.h"
30 #include "signature/Signature.h"
32 #include <openssl/dsa.h>
33 #include <openssl/rsa.h>
34 #include <xsec/dsig/DSIGKeyInfoList.hpp>
35 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyDSA.hpp>
36 #include <xsec/enc/OpenSSL/OpenSSLCryptoKeyRSA.hpp>
38 using xmlsignature::KeyInfo;
39 using xmlsignature::Signature;
40 using namespace xmltooling::logging;
41 using namespace xmltooling;
44 CredentialCriteria::CredentialCriteria()
45 : m_keyUsage(Credential::UNSPECIFIED_CREDENTIAL), m_keySize(0), m_key(NULL),
46 m_keyInfo(NULL), m_nativeKeyInfo(NULL), m_credential(NULL)
50 CredentialCriteria::~CredentialCriteria()
55 unsigned int CredentialCriteria::getUsage() const
60 void CredentialCriteria::setUsage(unsigned int usage)
65 const char* CredentialCriteria::getPeerName() const
67 return m_peerName.c_str();
70 void CredentialCriteria::setPeerName(const char* peerName)
74 m_peerName = peerName;
77 const char* CredentialCriteria::getKeyAlgorithm() const
79 return m_keyAlgorithm.c_str();
82 void CredentialCriteria::setKeyAlgorithm(const char* keyAlgorithm)
84 m_keyAlgorithm.erase();
86 m_keyAlgorithm = keyAlgorithm;
89 unsigned int CredentialCriteria::getKeySize() const
94 void CredentialCriteria::setKeySize(unsigned int keySize)
99 void CredentialCriteria::setXMLAlgorithm(const XMLCh* algorithm)
102 pair<const char*,unsigned int> mapped = XMLToolingConfig::getConfig().mapXMLAlgorithmToKeyAlgorithm(algorithm);
103 setKeyAlgorithm(mapped.first);
104 setKeySize(mapped.second);
107 setKeyAlgorithm(NULL);
112 const set<string>& CredentialCriteria::getKeyNames() const
117 set<string>& CredentialCriteria::getKeyNames()
122 XSECCryptoKey* CredentialCriteria::getPublicKey() const
127 void CredentialCriteria::setPublicKey(XSECCryptoKey* key)
132 const KeyInfo* CredentialCriteria::getKeyInfo() const
137 void CredentialCriteria::setKeyInfo(const KeyInfo* keyInfo, int extraction)
142 if (!keyInfo || !extraction)
145 int types = (extraction & KEYINFO_EXTRACTION_KEY) ? Credential::RESOLVE_KEYS : 0;
146 types |= (extraction & KEYINFO_EXTRACTION_KEYNAMES) ? X509Credential::RESOLVE_CERTS : 0;
147 m_credential = XMLToolingConfig::getConfig().getKeyInfoResolver()->resolve(keyInfo,types);
149 // Ensure any key names have been sucked out for later if desired.
150 if (extraction & KEYINFO_EXTRACTION_KEYNAMES) {
151 X509Credential* xcred = dynamic_cast<X509Credential*>(m_credential);
157 DSIGKeyInfoList* CredentialCriteria::getNativeKeyInfo() const
159 return m_nativeKeyInfo;
162 void CredentialCriteria::setNativeKeyInfo(DSIGKeyInfoList* keyInfo, int extraction)
166 m_nativeKeyInfo = keyInfo;
167 if (!keyInfo || !extraction)
170 int types = (extraction & KEYINFO_EXTRACTION_KEY) ? Credential::RESOLVE_KEYS : 0;
171 types |= (extraction & KEYINFO_EXTRACTION_KEYNAMES) ? X509Credential::RESOLVE_CERTS : 0;
172 m_credential = XMLToolingConfig::getConfig().getKeyInfoResolver()->resolve(keyInfo,types);
174 // Ensure any key names have been sucked out for later if desired.
175 if (extraction & KEYINFO_EXTRACTION_KEYNAMES) {
176 X509Credential* xcred = dynamic_cast<X509Credential*>(m_credential);
182 void CredentialCriteria::setSignature(const Signature& sig, int extraction)
184 setXMLAlgorithm(sig.getSignatureAlgorithm());
185 KeyInfo* k = sig.getKeyInfo();
187 return setKeyInfo(k, extraction);
188 DSIGSignature* dsig = sig.getXMLSignature();
190 setNativeKeyInfo(dsig->getKeyInfoList(), extraction);
193 bool CredentialCriteria::matches(const Credential& credential) const
195 Category& log = Category::getInstance(XMLTOOLING_LOGCAT".CredentialCriteria");
197 // Usage check, if specified and we have one, compare masks.
198 if (getUsage() != Credential::UNSPECIFIED_CREDENTIAL) {
199 if (credential.getUsage() != Credential::UNSPECIFIED_CREDENTIAL)
200 if ((getUsage() & credential.getUsage()) == 0) {
201 if (log.isDebugEnabled())
202 log.debug("usage didn't match (%u != %u)", getUsage(), credential.getUsage());
207 // Algorithm check, if specified and we have one.
208 const char* alg = getKeyAlgorithm();
210 const char* alg2 = credential.getAlgorithm();
212 if (strcmp(alg,alg2)) {
213 if (log.isDebugEnabled())
214 log.debug("key algorithm didn't match ('%s' != '%s')", getKeyAlgorithm(), credential.getAlgorithm());
220 // KeySize check, if specified and we have one.
221 if (credential.getKeySize()>0 && getKeySize()>0 && credential.getKeySize() != getKeySize()) {
222 if (log.isDebugEnabled())
223 log.debug("key size didn't match (%u != %u)", getKeySize(), credential.getKeySize());
227 // See if we can test key names.
228 set<string> critnames = getKeyNames();
230 critnames.insert(m_credential->getKeyNames().begin(), m_credential->getKeyNames().end());
231 const set<string>& crednames = credential.getKeyNames();
232 if (!critnames.empty() && !crednames.empty()) {
234 for (set<string>::const_iterator n = critnames.begin(); n!=critnames.end(); ++n) {
235 if (crednames.count(*n)>0) {
241 log.debug("credential name(s) didn't overlap");
246 // See if we have to match a specific key.
247 const XSECCryptoKey* key1 = getPublicKey();
248 if (!key1 && m_credential)
249 key1 = m_credential->getPublicKey();
251 return true; // no key to compare against, so we're done
253 const XSECCryptoKey* key2 = credential.getPublicKey();
255 return true; // no key here, so we can't test it
257 if (SecurityHelper::matches(*key1, *key2))
260 log.debug("keys didn't match");