2 * Copyright 2001-2007 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 * @file xmltooling/security/KeyInfoResolver.h
20 * Resolves credentials from KeyInfo information.
23 #if !defined(__xmltooling_keyres_h__) && !defined(XMLTOOLING_NO_XMLSEC)
24 #define __xmltooling_keyres_h__
26 #include <xsec/dsig/DSIGKeyInfoList.hpp>
28 namespace xmlsignature {
29 class XMLTOOL_API KeyInfo;
30 class XMLTOOL_API Signature;
33 namespace xmltooling {
35 class XMLTOOL_API Credential;
36 class XMLTOOL_API CredentialCriteria;
37 class XMLTOOL_API KeyInfoCredentialContext;
40 * Resolves credentials from KeyInfo information.
42 * <p>Credential-specific bitmasks can be provided to control what to resolve.
44 * <p>Implementations should only establish KeyNames on the basis of explicit names
45 * within the KeyInfo object, never by extracting names out of physical credentials
48 class XMLTOOL_API KeyInfoResolver {
49 MAKE_NONCOPYABLE(KeyInfoResolver);
53 virtual ~KeyInfoResolver() {}
56 * Returns a credential based on the supplied KeyInfo information.
57 * The caller must release the credential when done with it.
59 * @param keyInfo the key information
60 * @param types types of credentials to resolve, or 0 for any/all
61 * @return the resolved credential, or NULL
63 virtual Credential* resolve(const xmlsignature::KeyInfo* keyInfo, int types=0) const=0;
66 * Returns a credential based on the supplied KeyInfo information.
67 * The caller must release the credential when done with it.
69 * @param keyInfo the key information
70 * @param types types of credentials to resolve, or 0 for any/all
71 * @return the resolved credential, or NULL
73 virtual Credential* resolve(DSIGKeyInfoList* keyInfo, int types=0) const=0;
76 * Returns a credential based on the KeyInfo information in the supplied
77 * context. The caller must release the credential when done with it.
79 * <p>The context object will be owned by the Credential and freed with it.
81 * @param context context containing the key information
82 * @param types types of credentials to resolve, or 0 for any/all
83 * @return the resolved credential, or NULL
85 virtual Credential* resolve(KeyInfoCredentialContext* context, int types=0) const=0;
88 * Returns a credential based on the supplied KeyInfo information.
89 * The caller must release the credential when done with it.
91 * @param sig signature containing the key information
92 * @param types types of credentials to resolve, or 0 for any/all
93 * @return the resolved credential, or NULL
95 Credential* resolve(const xmlsignature::Signature* sig, int types=0) const;
98 * Returns a credential based on the KeyInfo information in the supplied
99 * criteria. The caller must release the credential when done with it.
101 * @param criteria criteria containing the key information
102 * @param types types of credentials to resolve, or 0 for any/all
103 * @return the resolved credential, or NULL
105 Credential* resolve(const CredentialCriteria& criteria, int types=0) const;
109 * Registers KeyInfoResolver classes into the runtime.
111 void XMLTOOL_API registerKeyInfoResolvers();
113 /** KeyInfoResolver based on extracting by value directly out of a KeyInfo */
114 #define INLINE_KEYINFO_RESOLVER "Inline"
117 #endif /* __xmltooling_keyres_h__ */