File: classXSECKeyInfoResolverDefault.html

package info (click to toggle)
xml-security-c 1.2.1-3
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 24,464 kB
  • ctags: 6,673
  • sloc: cpp: 36,830; xml: 23,415; sh: 2,365; makefile: 340; perl: 221
file content (183 lines) | stat: -rw-r--r-- 10,027 bytes parent folder | download | duplicates (2)
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
174
175
176
177
178
179
180
181
182
183
<!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: XSECKeyInfoResolverDefault 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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>XSECKeyInfoResolverDefault Class Reference<br>
<small>
[<a class="el" href="group__interfaces.html">Classes that interface applications to XML Security C.</a>]</small>
</h1><code>#include &lt;<a class="el" href="XSECKeyInfoResolverDefault_8hpp-source.html">XSECKeyInfoResolverDefault.hpp</a>&gt;</code>
<p>
Inheritance diagram for XSECKeyInfoResolverDefault:<p><center><img src="classXSECKeyInfoResolverDefault__inherit__graph.png" border="0" usemap="#XSECKeyInfoResolverDefault__inherit__map" alt="Inheritance graph"></center>
<map name="XSECKeyInfoResolverDefault__inherit__map">
<area href="classXSECKeyInfoResolver.html" shape="rect" coords="29,9,186,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XSECKeyInfoResolverDefault:<p><center><img src="classXSECKeyInfoResolverDefault__coll__graph.png" border="0" usemap="#XSECKeyInfoResolverDefault__coll__map" alt="Collaboration graph"></center>
<map name="XSECKeyInfoResolverDefault__coll__map">
<area href="classXSECKeyInfoResolver.html" shape="rect" coords="7,190,165,214" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="189,190,370,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="209,9,291,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="299,100,417,124" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECKeyInfoResolverDefault-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A basic class for mapping KeyInfo elements to Keys. 
<p>
This class is provides a method for applications to extract keys from KeyInfo elements that have a public key embedded.<p>
The class makes use of the makeKey() method available in all keyInfo elements. (Which in turn relies on the clone*Key methods available from the Encryption provider - these may not be available, so this class may not work well in these cases.)<p>
<dl compact><dt><b>Note:</b></dt><dd>This class is <b>very</b> basic. It does not validate the trustworthyness of the key in any way. It simply reads the key from the first KeyInfo element that actually holds it and returns the result (or NULL) if none is found. It is mainly provided to allow for interoperability testing. </dd></dl>

<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolverDefault.html#z183_0">XSECKeyInfoResolverDefault</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolverDefault.html#z183_1">~XSECKeyInfoResolverDefault</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader">Interface Functions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECCryptoKey.html">XSECCryptoKey</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolverDefault.html#z184_0">resolveKey</a> (<a class="el" href="classDSIGKeyInfoList.html">DSIGKeyInfoList</a> *lst)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provide a key to the library.  <a href="#z184_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXSECKeyInfoResolver.html">XSECKeyInfoResolver</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECKeyInfoResolverDefault.html#z184_1">clone</a> (void) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clone the resolver to be installed in a new object.  <a href="#z184_1"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z183_0" doxytag="XSECKeyInfoResolverDefault::XSECKeyInfoResolverDefault"></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">XSECKeyInfoResolverDefault::XSECKeyInfoResolverDefault           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a class="anchor" name="z183_1" doxytag="XSECKeyInfoResolverDefault::~XSECKeyInfoResolverDefault"></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 XSECKeyInfoResolverDefault::~XSECKeyInfoResolverDefault           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z184_1" doxytag="XSECKeyInfoResolverDefault::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>* XSECKeyInfoResolverDefault::clone           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Clone the resolver to be installed in a new object. 
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classXSECKeyInfoResolver.html#z182_1">XSECKeyInfoResolver::clone()</a> </dd></dl>

<p>
Implements <a class="el" href="classXSECKeyInfoResolver.html#z182_1">XSECKeyInfoResolver</a>.    </td>
  </tr>
</table>
<a class="anchor" name="z184_0" doxytag="XSECKeyInfoResolverDefault::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>* XSECKeyInfoResolverDefault::resolveKey           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classDSIGKeyInfoList.html">DSIGKeyInfoList</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>lst</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Provide a key to the library. 
<p>
Reads through the KeyInfo elements until it finds an element with an embedded Key. If none is found, returns NULL.<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>&nbsp;</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>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classXSECKeyInfoResolver.html#z182_0">XSECKeyInfoResolver::resolveKey()</a> </dd></dl>

<p>
Implements <a class="el" href="classXSECKeyInfoResolver.html#z182_0">XSECKeyInfoResolver</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECKeyInfoResolverDefault_8hpp-source.html">XSECKeyInfoResolverDefault.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:44 2005 for XML-Security-C by&nbsp;
<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>