Debian Codegraph @

libpskc/gtk-doc/html/libpskc-enums.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>enums: PSKC Library (libpskc) Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="PSKC Library (libpskc) Manual">
8 <link rel="up" href="pskc-reference.html" title="Part II. API Reference">
9 <link rel="prev" href="libpskc-errors.html" title="errors">
10 <link rel="next" href="libpskc-container.html" title="container">
11 <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts"></td>
17 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
18 <td><a accesskey="u" href="pskc-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
19 <td><a accesskey="p" href="libpskc-errors.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
20 <td><a accesskey="n" href="libpskc-container.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
21 </tr></table>
22 <div class="refentry">
23 <a name="libpskc-enums"></a><div class="titlepage"></div>
24 <div class="refnamediv">
25 <h2><span class="refentrytitle"><a name="libpskc-enums.top_of_page"></a>enums</span></h2>
26 <p>enums — PSKC value enumerations and related functions.</p>
27 </div>
28 <div class="refsect1">
29 <a name="libpskc-enums.functions"></a><h2>Functions</h2>
30 <div class="informaltable"><table class="informaltable" width="100%" border="0">
31 <colgroup>
32 <col width="150px" class="functions_proto_type">
33 <col class="functions_proto_name">
34 </colgroup>
35 <tbody>
36 <tr>
37 <td class="function_type">const <a class="link" href=""><span class="returnvalue">char</span></a> *
38 </td>
39 <td class="function_name">
40 <a class="link" href="libpskc-enums.html#pskc-pinusagemode2str" title="pskc_pinusagemode2str ()">pskc_pinusagemode2str</a> <span class="c_punctuation">()</span>
41 </td>
42 </tr>
43 <tr>
44 <td class="function_type">
45 <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="returnvalue">pskc_pinusagemode</span></a>
46 </td>
47 <td class="function_name">
48 <a class="link" href="libpskc-enums.html#pskc-str2pinusagemode" title="pskc_str2pinusagemode ()">pskc_str2pinusagemode</a> <span class="c_punctuation">()</span>
49 </td>
50 </tr>
51 <tr>
52 <td class="function_type">const <a class="link" href=""><span class="returnvalue">char</span></a> *
53 </td>
54 <td class="function_name">
55 <a class="link" href="libpskc-enums.html#pskc-valueformat2str" title="pskc_valueformat2str ()">pskc_valueformat2str</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="returnvalue">pskc_valueformat</span></a>
61 </td>
62 <td class="function_name">
63 <a class="link" href="libpskc-enums.html#pskc-str2valueformat" title="pskc_str2valueformat ()">pskc_str2valueformat</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">const <a class="link" href=""><span class="returnvalue">char</span></a> *
68 </td>
69 <td class="function_name">
70 <a class="link" href="libpskc-enums.html#pskc-keyusage2str" title="pskc_keyusage2str ()">pskc_keyusage2str</a> <span class="c_punctuation">()</span>
71 </td>
72 </tr>
73 <tr>
74 <td class="function_type">
75 <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="returnvalue">pskc_keyusage</span></a>
76 </td>
77 <td class="function_name">
78 <a class="link" href="libpskc-enums.html#pskc-str2keyusage" title="pskc_str2keyusage ()">pskc_str2keyusage</a> <span class="c_punctuation">()</span>
79 </td>
80 </tr>
81 </tbody>
82 </table></div>
83 </div>
84 <div class="refsect1">
85 <a name="libpskc-enums.other"></a><h2>Types and Values</h2>
86 <div class="informaltable"><table class="informaltable" width="100%" border="0">
87 <colgroup>
88 <col width="150px" class="other_proto_type">
89 <col class="other_proto_name">
90 </colgroup>
91 <tbody>
92 <tr>
93 <td class="datatype_keyword">enum</td>
94 <td class="function_name"><a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode">pskc_pinusagemode</a></td>
95 </tr>
96 <tr>
97 <td class="datatype_keyword">enum</td>
98 <td class="function_name"><a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat">pskc_valueformat</a></td>
99 </tr>
100 <tr>
101 <td class="datatype_keyword">enum</td>
102 <td class="function_name"><a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage">pskc_keyusage</a></td>
103 </tr>
104 </tbody>
105 </table></div>
106 </div>
107 <div class="refsect1">
108 <a name="libpskc-enums.description"></a><h2>Description</h2>
109 <p>The <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a> type describes PIN Policy Usage Modes. You
110 can convert between string representation and integer values using
111 <a class="link" href="libpskc-enums.html#pskc-pinusagemode2str" title="pskc_pinusagemode2str ()"><code class="function">pskc_pinusagemode2str()</code></a> and <a class="link" href="libpskc-enums.html#pskc-str2pinusagemode" title="pskc_str2pinusagemode ()"><code class="function">pskc_str2pinusagemode()</code></a>.</p>
112 <p>The <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a> type describes PSKC data value encodings.
113 You can convert between string representation and integer values
114 using <a class="link" href="libpskc-enums.html#pskc-valueformat2str" title="pskc_valueformat2str ()"><code class="function">pskc_valueformat2str()</code></a> and <a class="link" href="libpskc-enums.html#pskc-str2valueformat" title="pskc_str2valueformat ()"><code class="function">pskc_str2valueformat()</code></a>.</p>
115 <p>The <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> type describes what PSKC keys may be used for.
116 You can convert between string representation and integer values
117 using <a class="link" href="libpskc-enums.html#pskc-keyusage2str" title="pskc_keyusage2str ()"><code class="function">pskc_keyusage2str()</code></a> and <a class="link" href="libpskc-enums.html#pskc-str2keyusage" title="pskc_str2keyusage ()"><code class="function">pskc_str2keyusage()</code></a>. Note that often
118 multiple <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> values are ORed together to form set of
119 values.</p>
120 </div>
121 <div class="refsect1">
122 <a name="libpskc-enums.functions_details"></a><h2>Functions</h2>
123 <div class="refsect2">
124 <a name="pskc-pinusagemode2str"></a><h3>pskc_pinusagemode2str ()</h3>
125 <a class="indexterm" name="id-1.3.7.6.2.2"></a><pre class="programlisting">const <a class="link" href=""><span class="returnvalue">char</span></a> *
126 pskc_pinusagemode2str (<em class="parameter"><code><a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a> pinusagemode</code></em>);</pre>
127 <p>Convert <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a> to a string. For example,
128 pskc_pinusagemode2str(<a class="link" href="libpskc-enums.html#PSKC-PINUSAGEMODE-LOCAL:CAPS"><code class="literal">PSKC_PINUSAGEMODE_LOCAL</code></a>) will return
129 "Local". The returned string must not be deallocated.</p>
130 <div class="refsect3">
131 <a name="pskc-pinusagemode2str.parameters"></a><h4>Parameters</h4>
132 <div class="informaltable"><table class="informaltable" width="100%" border="0">
133 <colgroup>
134 <col width="150px" class="parameters_name">
135 <col class="parameters_description">
136 <col width="200px" class="parameters_annotations">
137 </colgroup>
138 <tbody><tr>
139 <td class="parameter_name"><p>pinusagemode</p></td>
140 <td class="parameter_description"><p>an <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a> enumeration type</p></td>
141 <td class="parameter_annotations"> </td>
142 </tr></tbody>
143 </table></div>
144 </div>
145 <div class="refsect3">
146 <a name="pskc-pinusagemode2str.returns"></a><h4>Returns</h4>
147 <p> String corresponding to <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a>.</p>
148 </div>
149 </div>
150 <div class="refsect2">
151 <a name="pskc-str2pinusagemode"></a><h3>pskc_str2pinusagemode ()</h3>
152 <a class="indexterm" name="id-1.3.7.6.3.2"></a><pre class="programlisting"><a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="returnvalue">pskc_pinusagemode</span></a>
153 pskc_str2pinusagemode (<em class="parameter"><code>const <a class="link" href=""><span class="type">char</span></a> *pinusagemode</code></em>);</pre>
154 <p>Convert a string to a <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a> type. For example,
155 pskc_str2pinusagemode("Local") will return
156 <a class="link" href="libpskc-enums.html#PSKC-PINUSAGEMODE-LOCAL:CAPS"><code class="literal">PSKC_PINUSAGEMODE_LOCAL</code></a>.</p>
157 <div class="refsect3">
158 <a name="pskc-str2pinusagemode.parameters"></a><h4>Parameters</h4>
159 <div class="informaltable"><table class="informaltable" width="100%" border="0">
160 <colgroup>
161 <col width="150px" class="parameters_name">
162 <col class="parameters_description">
163 <col width="200px" class="parameters_annotations">
164 </colgroup>
165 <tbody><tr>
166 <td class="parameter_name"><p>pinusagemode</p></td>
167 <td class="parameter_description"><p>an string describing a key usage.</p></td>
168 <td class="parameter_annotations"> </td>
169 </tr></tbody>
170 </table></div>
171 </div>
172 <div class="refsect3">
173 <a name="pskc-str2pinusagemode.returns"></a><h4>Returns</h4>
174 <p> The corresponding <a class="link" href="libpskc-enums.html#pskc-pinusagemode" title="enum pskc_pinusagemode"><span class="type">pskc_pinusagemode</span></a> value.</p>
175 </div>
176 </div>
177 <div class="refsect2">
178 <a name="pskc-valueformat2str"></a><h3>pskc_valueformat2str ()</h3>
179 <a class="indexterm" name="id-1.3.7.6.4.2"></a><pre class="programlisting">const <a class="link" href=""><span class="returnvalue">char</span></a> *
180 pskc_valueformat2str (<em class="parameter"><code><a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a> valueformat</code></em>);</pre>
181 <p>Convert <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a> to a string. For example,
182 pskc_valueformat2str(<a class="link" href="libpskc-enums.html#PSKC-VALUEFORMAT-DECIMAL:CAPS"><code class="literal">PSKC_VALUEFORMAT_DECIMAL</code></a>) will return
183 "DECIMAL". The returned string must not be deallocated.</p>
184 <div class="refsect3">
185 <a name="pskc-valueformat2str.parameters"></a><h4>Parameters</h4>
186 <div class="informaltable"><table class="informaltable" width="100%" border="0">
187 <colgroup>
188 <col width="150px" class="parameters_name">
189 <col class="parameters_description">
190 <col width="200px" class="parameters_annotations">
191 </colgroup>
192 <tbody><tr>
193 <td class="parameter_name"><p>valueformat</p></td>
194 <td class="parameter_description"><p>an <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a> enumeration type</p></td>
195 <td class="parameter_annotations"> </td>
196 </tr></tbody>
197 </table></div>
198 </div>
199 <div class="refsect3">
200 <a name="pskc-valueformat2str.returns"></a><h4>Returns</h4>
201 <p> String corresponding to <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a>.</p>
202 </div>
203 </div>
204 <div class="refsect2">
205 <a name="pskc-str2valueformat"></a><h3>pskc_str2valueformat ()</h3>
206 <a class="indexterm" name="id-1.3.7.6.5.2"></a><pre class="programlisting"><a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="returnvalue">pskc_valueformat</span></a>
207 pskc_str2valueformat (<em class="parameter"><code>const <a class="link" href=""><span class="type">char</span></a> *valueformat</code></em>);</pre>
208 <p>Convert a string to a <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a> type. For example,
209 pskc_str2valueformat("DECIMAL") will return
210 <a class="link" href="libpskc-enums.html#PSKC-VALUEFORMAT-DECIMAL:CAPS"><code class="literal">PSKC_VALUEFORMAT_DECIMAL</code></a>.</p>
211 <div class="refsect3">
212 <a name="pskc-str2valueformat.parameters"></a><h4>Parameters</h4>
213 <div class="informaltable"><table class="informaltable" width="100%" border="0">
214 <colgroup>
215 <col width="150px" class="parameters_name">
216 <col class="parameters_description">
217 <col width="200px" class="parameters_annotations">
218 </colgroup>
219 <tbody><tr>
220 <td class="parameter_name"><p>valueformat</p></td>
221 <td class="parameter_description"><p>an string describing a key usage.</p></td>
222 <td class="parameter_annotations"> </td>
223 </tr></tbody>
224 </table></div>
225 </div>
226 <div class="refsect3">
227 <a name="pskc-str2valueformat.returns"></a><h4>Returns</h4>
228 <p> The corresponding <a class="link" href="libpskc-enums.html#pskc-valueformat" title="enum pskc_valueformat"><span class="type">pskc_valueformat</span></a> value.</p>
229 </div>
230 </div>
231 <div class="refsect2">
232 <a name="pskc-keyusage2str"></a><h3>pskc_keyusage2str ()</h3>
233 <a class="indexterm" name="id-1.3.7.6.6.2"></a><pre class="programlisting">const <a class="link" href=""><span class="returnvalue">char</span></a> *
234 pskc_keyusage2str (<em class="parameter"><code><a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> keyusage</code></em>);</pre>
235 <p>Convert <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> to a string. For example,
236 pskc_keyusage2str(<a class="link" href="libpskc-enums.html#PSKC-KEYUSAGE-OTP:CAPS"><code class="literal">PSKC_KEYUSAGE_OTP</code></a>) will return "OTP". The
237 returned string must not be deallocated.</p>
238 <div class="refsect3">
239 <a name="pskc-keyusage2str.parameters"></a><h4>Parameters</h4>
240 <div class="informaltable"><table class="informaltable" width="100%" border="0">
241 <colgroup>
242 <col width="150px" class="parameters_name">
243 <col class="parameters_description">
244 <col width="200px" class="parameters_annotations">
245 </colgroup>
246 <tbody><tr>
247 <td class="parameter_name"><p>keyusage</p></td>
248 <td class="parameter_description"><p>an <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> enumeration type</p></td>
249 <td class="parameter_annotations"> </td>
250 </tr></tbody>
251 </table></div>
252 </div>
253 <div class="refsect3">
254 <a name="pskc-keyusage2str.returns"></a><h4>Returns</h4>
255 <p> String corresponding to <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a>.</p>
256 </div>
257 </div>
258 <div class="refsect2">
259 <a name="pskc-str2keyusage"></a><h3>pskc_str2keyusage ()</h3>
260 <a class="indexterm" name="id-1.3.7.6.7.2"></a><pre class="programlisting"><a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="returnvalue">pskc_keyusage</span></a>
261 pskc_str2keyusage (<em class="parameter"><code>const <a class="link" href=""><span class="type">char</span></a> *keyusage</code></em>);</pre>
262 <p>Convert a string to a <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> type. For example,
263 pskc_str2keyusage("KeyWrap") will return <a class="link" href="libpskc-enums.html#PSKC-KEYUSAGE-KEYWRAP:CAPS"><code class="literal">PSKC_KEYUSAGE_KEYWRAP</code></a>.</p>
264 <div class="refsect3">
265 <a name="pskc-str2keyusage.parameters"></a><h4>Parameters</h4>
266 <div class="informaltable"><table class="informaltable" width="100%" border="0">
267 <colgroup>
268 <col width="150px" class="parameters_name">
269 <col class="parameters_description">
270 <col width="200px" class="parameters_annotations">
271 </colgroup>
272 <tbody><tr>
273 <td class="parameter_name"><p>keyusage</p></td>
274 <td class="parameter_description"><p>an string describing a key usage.</p></td>
275 <td class="parameter_annotations"> </td>
276 </tr></tbody>
277 </table></div>
278 </div>
279 <div class="refsect3">
280 <a name="pskc-str2keyusage.returns"></a><h4>Returns</h4>
281 <p> The corresponding <a class="link" href="libpskc-enums.html#pskc-keyusage" title="enum pskc_keyusage"><span class="type">pskc_keyusage</span></a> value.</p>
282 </div>
283 </div>
284 </div>
285 <div class="refsect1">
286 <a name="libpskc-enums.other_details"></a><h2>Types and Values</h2>
287 <div class="refsect2">
288 <a name="pskc-pinusagemode"></a><h3>enum pskc_pinusagemode</h3>
289 <a class="indexterm" name="id-1.3.7.7.2.2"></a><p>Enumeration of PIN Policy Usage Modes. This indicate the way the
290 PIN is used.</p>
291 <div class="refsect3">
292 <a name="pskc-pinusagemode.members"></a><h4>Members</h4>
293 <div class="informaltable"><table class="informaltable" width="100%" border="0">
294 <colgroup>
295 <col width="300px" class="enum_members_name">
296 <col class="enum_members_description">
297 <col width="200px" class="enum_members_annotations">
298 </colgroup>
299 <tbody>
300 <tr>
301 <td class="enum_member_name"><p><a name="PSKC-PINUSAGEMODE-UNKNOWN:CAPS"></a>PSKC_PINUSAGEMODE_UNKNOWN</p></td>
302 <td class="enum_member_description">
303 <p>Unknown mode.</p>
304 </td>
305 <td class="enum_member_annotations"> </td>
306 </tr>
307 <tr>
308 <td class="enum_member_name"><p><a name="PSKC-PINUSAGEMODE-LOCAL:CAPS"></a>PSKC_PINUSAGEMODE_LOCAL</p></td>
309 <td class="enum_member_description">
310 <p>PIN is checked locally on the device.</p>
311 </td>
312 <td class="enum_member_annotations"> </td>
313 </tr>
314 <tr>
315 <td class="enum_member_name"><p><a name="PSKC-PINUSAGEMODE-PREPEND:CAPS"></a>PSKC_PINUSAGEMODE_PREPEND</p></td>
316 <td class="enum_member_description">
317 <p>PIN is prepended to the OTP and checked
318 by OTP validating party.</p>
319 </td>
320 <td class="enum_member_annotations"> </td>
321 </tr>
322 <tr>
323 <td class="enum_member_name"><p><a name="PSKC-PINUSAGEMODE-APPEND:CAPS"></a>PSKC_PINUSAGEMODE_APPEND</p></td>
324 <td class="enum_member_description">
325 <p>PIN is appended to the OTP and checked
326 by OTP validating party.</p>
327 </td>
328 <td class="enum_member_annotations"> </td>
329 </tr>
330 <tr>
331 <td class="enum_member_name"><p><a name="PSKC-PINUSAGEMODE-ALGORITHMIC:CAPS"></a>PSKC_PINUSAGEMODE_ALGORITHMIC</p></td>
332 <td class="enum_member_description">
333 <p>The PIN is used as part of the
334 algorithm computation.</p>
335 </td>
336 <td class="enum_member_annotations"> </td>
337 </tr>
338 <tr>
339 <td class="enum_member_name"><p><a name="PSKC-PINUSAGEMODE-LAST:CAPS"></a>PSKC_PINUSAGEMODE_LAST</p></td>
340 <td class="enum_member_description">
341 <p>Meta-value corresponding to the highest value,
342 for use in iterating over all usage mode values.</p>
343 </td>
344 <td class="enum_member_annotations"> </td>
345 </tr>
346 </tbody>
347 </table></div>
348 </div>
349 </div>
350 <div class="refsect2">
351 <a name="pskc-valueformat"></a><h3>enum pskc_valueformat</h3>
352 <a class="indexterm" name="id-1.3.7.7.3.2"></a><p>Enumeration of PSKC value encoding formats.</p>
353 <div class="refsect3">
354 <a name="pskc-valueformat.members"></a><h4>Members</h4>
355 <div class="informaltable"><table class="informaltable" width="100%" border="0">
356 <colgroup>
357 <col width="300px" class="enum_members_name">
358 <col class="enum_members_description">
359 <col width="200px" class="enum_members_annotations">
360 </colgroup>
361 <tbody>
362 <tr>
363 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-UNKNOWN:CAPS"></a>PSKC_VALUEFORMAT_UNKNOWN</p></td>
364 <td class="enum_member_description">
365 <p>Unknown format.</p>
366 </td>
367 <td class="enum_member_annotations"> </td>
368 </tr>
369 <tr>
370 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-DECIMAL:CAPS"></a>PSKC_VALUEFORMAT_DECIMAL</p></td>
371 <td class="enum_member_description">
372 <p>Only numerical digits.</p>
373 </td>
374 <td class="enum_member_annotations"> </td>
375 </tr>
376 <tr>
377 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-HEXADECIMAL:CAPS"></a>PSKC_VALUEFORMAT_HEXADECIMAL</p></td>
378 <td class="enum_member_description">
379 <p>Hexadecimal response.</p>
380 </td>
381 <td class="enum_member_annotations"> </td>
382 </tr>
383 <tr>
384 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-ALPHANUMERIC:CAPS"></a>PSKC_VALUEFORMAT_ALPHANUMERIC</p></td>
385 <td class="enum_member_description">
386 <p>All letters and numbers (case sensitive).</p>
387 </td>
388 <td class="enum_member_annotations"> </td>
389 </tr>
390 <tr>
391 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-BASE64:CAPS"></a>PSKC_VALUEFORMAT_BASE64</p></td>
392 <td class="enum_member_description">
393 <p>Base-64 encoded.</p>
394 </td>
395 <td class="enum_member_annotations"> </td>
396 </tr>
397 <tr>
398 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-BINARY:CAPS"></a>PSKC_VALUEFORMAT_BINARY</p></td>
399 <td class="enum_member_description">
400 <p>Binary data.</p>
401 </td>
402 <td class="enum_member_annotations"> </td>
403 </tr>
404 <tr>
405 <td class="enum_member_name"><p><a name="PSKC-VALUEFORMAT-LAST:CAPS"></a>PSKC_VALUEFORMAT_LAST</p></td>
406 <td class="enum_member_description">
407 <p>Meta-value corresponding to the highest value,
408 for use in iterating over all encoding format values.</p>
409 </td>
410 <td class="enum_member_annotations"> </td>
411 </tr>
412 </tbody>
413 </table></div>
414 </div>
415 </div>
416 <div class="refsect2">
417 <a name="pskc-keyusage"></a><h3>enum pskc_keyusage</h3>
418 <a class="indexterm" name="id-1.3.7.7.4.2"></a><p>Enumeration of PSKC key usage values. These values puts
419 constraints on the intended usage of the key. The recipient of the
420 PSKC document MUST enforce the key usage. The values are assigned
421 to numbers so that they can be ORed together to form a set of
422 values.</p>
423 <div class="refsect3">
424 <a name="pskc-keyusage.members"></a><h4>Members</h4>
425 <div class="informaltable"><table class="informaltable" width="100%" border="0">
426 <colgroup>
427 <col width="300px" class="enum_members_name">
428 <col class="enum_members_description">
429 <col width="200px" class="enum_members_annotations">
430 </colgroup>
431 <tbody>
432 <tr>
433 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-UNKNOWN:CAPS"></a>PSKC_KEYUSAGE_UNKNOWN</p></td>
434 <td class="enum_member_description">
435 <p>Unknown format.</p>
436 </td>
437 <td class="enum_member_annotations"> </td>
438 </tr>
439 <tr>
440 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-OTP:CAPS"></a>PSKC_KEYUSAGE_OTP</p></td>
441 <td class="enum_member_description">
442 <p>The key MUST only be used for OTP generation.</p>
443 </td>
444 <td class="enum_member_annotations"> </td>
445 </tr>
446 <tr>
447 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-CR:CAPS"></a>PSKC_KEYUSAGE_CR</p></td>
448 <td class="enum_member_description">
449 <p>The key MUST only be used for Challenge/Response purposes.</p>
450 </td>
451 <td class="enum_member_annotations"> </td>
452 </tr>
453 <tr>
454 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-ENCRYPT:CAPS"></a>PSKC_KEYUSAGE_ENCRYPT</p></td>
455 <td class="enum_member_description">
456 <p>The key MUST only be used for data
457 encryption purposes.</p>
458 </td>
459 <td class="enum_member_annotations"> </td>
460 </tr>
461 <tr>
462 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-INTEGRITY:CAPS"></a>PSKC_KEYUSAGE_INTEGRITY</p></td>
463 <td class="enum_member_description">
464 <p>The key MUST only be used to generate a
465 keyed message digest for data integrity or authentication purposes.</p>
466 </td>
467 <td class="enum_member_annotations"> </td>
468 </tr>
469 <tr>
470 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-VERIFY:CAPS"></a>PSKC_KEYUSAGE_VERIFY</p></td>
471 <td class="enum_member_description">
472 <p>The key MUST only be used to verify a keyed
473 message digest for data integrity or authentication purposes (this
474 is the opposite key usage of 'Integrity').</p>
475 </td>
476 <td class="enum_member_annotations"> </td>
477 </tr>
478 <tr>
479 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-UNLOCK:CAPS"></a>PSKC_KEYUSAGE_UNLOCK</p></td>
480 <td class="enum_member_description">
481 <p>The key MUST only be used for an inverse
482 Challenge/ Response in the case where a user has locked the device
483 by entering a wrong PIN too many times (for devices with PIN-input
484 capability).</p>
485 </td>
486 <td class="enum_member_annotations"> </td>
487 </tr>
488 <tr>
489 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-DECRYPT:CAPS"></a>PSKC_KEYUSAGE_DECRYPT</p></td>
490 <td class="enum_member_description">
491 <p>The key MUST only be used for data
492 decryption purposes.</p>
493 </td>
494 <td class="enum_member_annotations"> </td>
495 </tr>
496 <tr>
497 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-KEYWRAP:CAPS"></a>PSKC_KEYUSAGE_KEYWRAP</p></td>
498 <td class="enum_member_description">
499 <p>The key MUST only be used for key wrap purposes.</p>
500 </td>
501 <td class="enum_member_annotations"> </td>
502 </tr>
503 <tr>
504 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-UNWRAP:CAPS"></a>PSKC_KEYUSAGE_UNWRAP</p></td>
505 <td class="enum_member_description">
506 <p>The key MUST only be used for key unwrap purposes.</p>
507 </td>
508 <td class="enum_member_annotations"> </td>
509 </tr>
510 <tr>
511 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-DERIVE:CAPS"></a>PSKC_KEYUSAGE_DERIVE</p></td>
512 <td class="enum_member_description">
513 <p>The key MUST only be used with a key
514 derivation function to derive a new key.</p>
515 </td>
516 <td class="enum_member_annotations"> </td>
517 </tr>
518 <tr>
519 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-GENERATE:CAPS"></a>PSKC_KEYUSAGE_GENERATE</p></td>
520 <td class="enum_member_description">
521 <p>The key MUST only be used to generate a
522 new key based on a random number and the previous value of the key.</p>
523 </td>
524 <td class="enum_member_annotations"> </td>
525 </tr>
526 <tr>
527 <td class="enum_member_name"><p><a name="PSKC-KEYUSAGE-LAST:CAPS"></a>PSKC_KEYUSAGE_LAST</p></td>
528 <td class="enum_member_description">
529 <p>Meta-value corresponding to the highest value,
530 for use in iterating over all key usage values.</p>
531 </td>
532 <td class="enum_member_annotations"> </td>
533 </tr>
534 </tbody>
535 </table></div>
536 </div>
537 </div>
538 </div>
539 </div>
540 <div class="footer">
541 <hr>Generated by GTK-Doc V1.34.0</div>
542 </body>
543 </html>