1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XSECKeyInfoResolver Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>XSECKeyInfoResolver Class Reference<br>
<small>
[<a class="el" href="group__interfaces.html">Classes that interface applications to XML Security C.</a>]</small>
</h1><code>#include <<a class="el" href="XSECKeyInfoResolver_8hpp-source.html">XSECKeyInfoResolver.hpp</a>></code>
<p>
Inheritance diagram for XSECKeyInfoResolver:<p><center><img src="classXSECKeyInfoResolver__inherit__graph.png" border="0" usemap="#XSECKeyInfoResolver__inherit__map" alt="Inheritance graph"></center>
<map name="XSECKeyInfoResolver__inherit__map">
<area href="classXSECKeyInfoResolverDefault.html" shape="rect" coords="8,83,208,107" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECKeyInfoResolver-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface class for providing keys to the library.
<p>
The XSEC library does not perform actual mapping of KeyInfo elements to encryption keys. (In some cases a KeyInfo might not even be provided).<p>
This interface class allows the application to perform this key mapping and provision function. Applications can perform whatever steps are necessary to determine the appropriate key and what trust level it might have.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolver.html#z181_0">XSECKeyInfoResolver</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolver.html#z181_1">~XSECKeyInfoResolver</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader">Mandatory Interface Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolver.html#z182_0">resolveKey</a> (<a class="el" href="classDSIGKeyInfoList.html">DSIGKeyInfoList</a> *lst)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide a key to the library. <a href="#z182_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECKeyInfoResolver.html">XSECKeyInfoResolver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolver.html#z182_1">clone</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone the resolver to be installed in a new object. <a href="#z182_1"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z181_0" doxytag="XSECKeyInfoResolver::XSECKeyInfoResolver"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XSECKeyInfoResolver::XSECKeyInfoResolver </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="z181_1" doxytag="XSECKeyInfoResolver::~XSECKeyInfoResolver"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XSECKeyInfoResolver::~XSECKeyInfoResolver </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z182_1" doxytag="XSECKeyInfoResolver::clone"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classXSECKeyInfoResolver.html">XSECKeyInfoResolver</a>* XSECKeyInfoResolver::clone </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clone the resolver to be installed in a new object.
<p>
When KeyInfoResolvers are passed into signatures and other objects, they are cloned and control of the original object is left with the caller.
<p>
Implemented in <a class="el" href="classXSECKeyInfoResolverDefault.html#z184_1">XSECKeyInfoResolverDefault</a>. </td>
</tr>
</table>
<a class="anchor" name="z182_0" doxytag="XSECKeyInfoResolver::resolveKey"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a>* XSECKeyInfoResolver::resolveKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoList.html">DSIGKeyInfoList</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>lst</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Provide a key to the library.
<p>
The library will pass the KeyInfoList to the resolver which then needs to provide a key back to the library. The key may have absolutely no relationship to the KeyInfoList (which is only supposed to provide a hint).<p>
If no KeyInfo elements were provided in the Signature, NULL will be passed in.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lst</em> </td><td>The list of KeyInfo elements from the signature </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Either the appropriate key or NULL if none can be found </dd></dl>
<p>
Implemented in <a class="el" href="classXSECKeyInfoResolverDefault.html#z184_0">XSECKeyInfoResolverDefault</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECKeyInfoResolver_8hpp-source.html">XSECKeyInfoResolver.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:40 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|