libgck-1-doc 3.2.2-2ubuntu4 / usr / share / gtk-doc / html / gck / gck-PKCS11-URIs.html

This file is indexed.

/usr/share/gtk-doc/html/gck/gck-PKCS11-URIs.html is in libgck-1-doc 3.2.2-2ubuntu4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PKCS11 URIs</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gck Library Reference Manual">
<link rel="up" href="reference.html" title="PKCS#11 GObject Bindings">
<link rel="prev" href="gck-Errors.html" title="Errors">
<link rel="next" href="gck-Miscellaneous-Functions.html" title="Miscellaneous Functions">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gck-Errors.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gck Library Reference Manual</th>
<td><a accesskey="n" href="gck-Miscellaneous-Functions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gck-PKCS11-URIs.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gck-PKCS11-URIs.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gck-PKCS11-URIs"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gck-PKCS11-URIs.top_of_page"></a>PKCS11 URIs</span></h2>
<p>PKCS11 URIs — Parsing and building PKCS#11 URIs.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gck-PKCS11-URIs.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData">GckUriData</a>;
enum                <a class="link" href="gck-PKCS11-URIs.html#GckUriFlags" title="enum GckUriFlags">GckUriFlags</a>;
<a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="returnvalue">GckUriData</span></a> *        <a class="link" href="gck-PKCS11-URIs.html#gck-uri-data-new" title="gck_uri_data_new ()">gck_uri_data_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="returnvalue">GckUriData</span></a> *        <a class="link" href="gck-PKCS11-URIs.html#gck-uri-parse" title="gck_uri_parse ()">gck_uri_parse</a>                       (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriFlags" title="enum GckUriFlags"><span class="type">GckUriFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gck-PKCS11-URIs.html#gck-uri-build" title="gck_uri_build ()">gck_uri_build</a>                       (<em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a> *uri_data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriFlags" title="enum GckUriFlags"><span class="type">GckUriFlags</span></a> flags</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="gck-PKCS11-URIs.html#gck-uri-data-free" title="gck_uri_data_free ()">gck_uri_data_free</a>                   (<em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a> *uri_data</code></em>);
#define             <a class="link" href="gck-PKCS11-URIs.html#GCK-URI-BAD-PREFIX:CAPS" title="GCK_URI_BAD_PREFIX">GCK_URI_BAD_PREFIX</a>
#define             <a class="link" href="gck-PKCS11-URIs.html#GCK-URI-ERROR:CAPS" title="GCK_URI_ERROR">GCK_URI_ERROR</a>
</pre>
</div>
<div class="refsect1">
<a name="gck-PKCS11-URIs.description"></a><h2>Description</h2>
<p>
<a class="ulink" href="" target="_top">PKCS\#11 URIs</a>
are a standard for referring to PKCS#11 modules, tokens, or objects. What the
PKCS#11 URI refers to depends on the context in which it is used.
</p>
<p>
A PKCS#11 URI can always resolve to more than one object, token or module. A
PKCS#11 URI that refers to a token, would (when used in a context that expects
objects) refer to all the token on that module.
</p>
<p>
In most cases the parsing or building of URIs is handled elsewhere in the GCK
library. For example to enumerate objects that match a PKCS#11 URI use the
<a class="link" href="gck-GckModule-lists.html#gck-modules-enumerate-uri" title="gck_modules_enumerate_uri ()"><code class="function">gck_modules_enumerate_uri()</code></a> function.
</p>
<p>
To parse a PKCS#11 URI use the <a class="link" href="gck-PKCS11-URIs.html#gck-uri-parse" title="gck_uri_parse ()"><code class="function">gck_uri_parse()</code></a> function passing in the type of
context in which you're using the URI. To build a URI use the <a class="link" href="gck-PKCS11-URIs.html#gck-uri-build" title="gck_uri_build ()"><code class="function">gck_uri_build()</code></a>
function.
</p>
</div>
<div class="refsect1">
<a name="gck-PKCS11-URIs.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GckUriData"></a><h3>GckUriData</h3>
<pre class="programlisting">typedef struct {
	gboolean any_unrecognized;
	GckModuleInfo *module_info;
	GckTokenInfo *token_info;
	GckAttributes *attributes;
} GckUriData;
</pre>
<p>
Information about the contents of a PKCS#11 URI. Various fields may be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
depending on the context that the URI was parsed for.
</p>
<p>
Since PKCS#11 URIs represent a set which results from the intersections of
all of the URI parts, if <em class="parameter"><code>any_recognized</code></em> is set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then usually the URI
should be treated as not matching anything.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="GckUriData.any-unrecognized"></a>any_unrecognized</code></em>;</span></p></td>
<td>whether any parts of the PKCS#11 URI were unsupported or unrecognized.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gck-GckModule.html#GckModuleInfo" title="GckModuleInfo"><span class="type">GckModuleInfo</span></a> *<em class="structfield"><code><a name="GckUriData.module-info"></a>module_info</code></em>;</span></p></td>
<td>information about the PKCS#11 modules matching the URI.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gck-GckSlot.html#GckTokenInfo" title="GckTokenInfo"><span class="type">GckTokenInfo</span></a> *<em class="structfield"><code><a name="GckUriData.token-info"></a>token_info</code></em>;</span></p></td>
<td>information about the PKCS#11 tokens matching the URI.</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="gck-GckAttributes.html#GckAttributes" title="GckAttributes"><span class="type">GckAttributes</span></a> *<em class="structfield"><code><a name="GckUriData.attributes"></a>attributes</code></em>;</span></p></td>
<td>information about the PKCS#11 objects matching the URI.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GckUriFlags"></a><h3>enum GckUriFlags</h3>
<pre class="programlisting">typedef enum {
	GCK_URI_FOR_OBJECT =  (1 &lt;&lt; 1),
	GCK_URI_FOR_TOKEN =   (1 &lt;&lt; 2),
	GCK_URI_FOR_MODULE =  (1 &lt;&lt; 3),

	GCK_URI_FOR_MODULE_WITH_VERSION =
		(1 &lt;&lt; 4) | GCK_URI_FOR_MODULE,

	GCK_URI_FOR_OBJECT_ON_TOKEN =
		GCK_URI_FOR_OBJECT | GCK_URI_FOR_TOKEN,

	GCK_URI_FOR_OBJECT_ON_TOKEN_AND_MODULE =
		GCK_URI_FOR_OBJECT_ON_TOKEN | GCK_URI_FOR_MODULE,

	GCK_URI_FOR_ANY =     0x0000FFFF,
} GckUriFlags;
</pre>
<p>
Which parts of the PKCS#11 URI will be parsed or formatted. These can be
combined.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GCK-URI-FOR-OBJECT:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_OBJECT</code></span></p></td>
<td>the URI will be used to match objects.
</td>
</tr>
<tr>
<td><p><a name="GCK-URI-FOR-TOKEN:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_TOKEN</code></span></p></td>
<td>the URI will be used to match tokens.
</td>
</tr>
<tr>
<td><p><a name="GCK-URI-FOR-MODULE:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_MODULE</code></span></p></td>
<td>the URI will be used to match modules.
</td>
</tr>
<tr>
<td><p><a name="GCK-URI-FOR-MODULE-WITH-VERSION:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_MODULE_WITH_VERSION</code></span></p></td>
<td>the URI will match specific version of modules.
</td>
</tr>
<tr>
<td><p><a name="GCK-URI-FOR-OBJECT-ON-TOKEN:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_OBJECT_ON_TOKEN</code></span></p></td>
<td>the URI will match objects on a specific token.
</td>
</tr>
<tr>
<td><p><a name="GCK-URI-FOR-OBJECT-ON-TOKEN-AND-MODULE:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_OBJECT_ON_TOKEN_AND_MODULE</code></span></p></td>
<td>the URI will match objects on a specific
     token inserted into a device with a specific module.
</td>
</tr>
<tr>
<td><p><a name="GCK-URI-FOR-ANY:CAPS"></a><span class="term"><code class="literal">GCK_URI_FOR_ANY</code></span></p></td>
<td>parse all recognized components of the URI.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-uri-data-new"></a><h3>gck_uri_data_new ()</h3>
<pre class="programlisting"><a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="returnvalue">GckUriData</span></a> *        gck_uri_data_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gck-uri-parse"></a><h3>gck_uri_parse ()</h3>
<pre class="programlisting"><a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="returnvalue">GckUriData</span></a> *        gck_uri_parse                       (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriFlags" title="enum GckUriFlags"><span class="type">GckUriFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Parse a PKCS#11 URI for use in a given context.
</p>
<p>
The result will contain the fields that are relevant for
the given context. See <a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a>  for more info.
Other fields will be set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>the URI to parse.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>the context in which the URI will be used.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a>, which should be freed with
<a class="link" href="gck-PKCS11-URIs.html#gck-uri-data-free" title="gck_uri_data_free ()"><code class="function">gck_uri_data_free()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-uri-build"></a><h3>gck_uri_build ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gck_uri_build                       (<em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a> *uri_data</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriFlags" title="enum GckUriFlags"><span class="type">GckUriFlags</span></a> flags</code></em>);</pre>
<p>
Build a PKCS#11 URI. The various parts relevant to the flags
specified will be used to build the URI.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri_data</code></em> :</span></p></td>
<td>the info to build the URI from.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>The context that the URI is for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated string containing a PKCS#11 URI.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-uri-data-free"></a><h3>gck_uri_data_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gck_uri_data_free                   (<em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a> *uri_data</code></em>);</pre>
<p>
Free a <a class="link" href="gck-PKCS11-URIs.html#GckUriData" title="GckUriData"><span class="type">GckUriData</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>uri_data</code></em> :</span></p></td>
<td>URI data to free.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GCK-URI-BAD-PREFIX:CAPS"></a><h3>GCK_URI_BAD_PREFIX</h3>
<pre class="programlisting">#define GCK_URI_BAD_PREFIX GCK_URI_BAD_SCHEME
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GCK-URI-ERROR:CAPS"></a><h3>GCK_URI_ERROR</h3>
<pre class="programlisting">#define             GCK_URI_ERROR                           (gck_uri_get_error_quark ())
</pre>
<p>
Error domain for URI errors.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.