libgck-1-doc 3.10.1-1 / usr / share / gtk-doc / html / gck / GckModule.html

This file is indexed.

/usr/share/gtk-doc/html/gck/GckModule.html is in libgck-1-doc 3.10.1-1.

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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GckModule</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="reference.html" title="PKCS#11 GObject Bindings">
<link rel="next" href="GckSlot.html" title="GckSlot">
<meta name="generator" content="GTK-Doc V1.19 (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="reference.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="GckSlot.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GckModule.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GckModule.description" class="shortcut">Description</a>
                   | 
                  <a href="#GckModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GckModule.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GckModule.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GckModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GckModule.top_of_page"></a>GckModule</span></h2>
<p>GckModule — A loaded and initialized PKCS#11 module.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GckModule.synopsis"></a><h2>Synopsis</h2>
<a name="GckModuleInfo"></a><pre class="synopsis">struct              <a class="link" href="GckModule.html#GckModule-struct" title="struct GckModule">GckModule</a>;
<a class="link" href="GckModule.html" title="GckModule"><span class="returnvalue">GckModule</span></a> *         <a class="link" href="GckModule.html#gck-module-initialize" title="gck_module_initialize ()">gck_module_initialize</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> *path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>);
<span class="returnvalue">void</span>                <a class="link" href="GckModule.html#gck-module-initialize-async" title="gck_module_initialize_async ()">gck_module_initialize_async</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> *path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a class="link" href="GckModule.html" title="GckModule"><span class="returnvalue">GckModule</span></a> *         <a class="link" href="GckModule.html#gck-module-initialize-finish" title="gck_module_initialize_finish ()">gck_module_initialize_finish</a>        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</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 class="link" href="GckModule.html" title="GckModule"><span class="returnvalue">GckModule</span></a> *         <a class="link" href="GckModule.html#gck-module-new" title="gck_module_new ()">gck_module_new</a>                      (<em class="parameter"><code><a class="link" href="pkcs11-links.html#CK-FUNCTION-LIST-PTR:CAPS"><span class="type">CK_FUNCTION_LIST_PTR</span></a> funcs</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GckModule.html#gck-module-equal" title="gck_module_equal ()">gck_module_equal</a>                    (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> module1</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> module2</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GckModule.html#gck-module-hash" title="gck_module_hash ()">gck_module_hash</a>                     (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> module</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GckModule.html#gck-module-match" title="gck_module_match ()">gck_module_match</a>                    (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriData"><span class="type">GckUriData</span></a> *uri</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="GckModule.html#gck-module-get-path" title="gck_module_get_path ()">gck_module_get_path</a>                 (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>);
<a class="link" href="pkcs11-links.html#CK-FUNCTION-LIST-PTR:CAPS"><span class="returnvalue">CK_FUNCTION_LIST_PTR</span></a> <a class="link" href="GckModule.html#gck-module-get-functions" title="gck_module_get_functions ()">gck_module_get_functions</a>           (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>);
<a class="link" href="GckModule.html#GckModuleInfo"><span class="returnvalue">GckModuleInfo</span></a> *     <a class="link" href="GckModule.html#gck-module-get-info" title="gck_module_get_info ()">gck_module_get_info</a>                 (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GckModule.html#gck-module-get-slots" title="gck_module_get_slots ()">gck_module_get_slots</a>                (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> token_present</code></em>);
struct              <a class="link" href="GckModule.html#GckModuleInfo-struct" title="struct GckModuleInfo">GckModuleInfo</a>;
<a class="link" href="GckModule.html#GckModuleInfo"><span class="returnvalue">GckModuleInfo</span></a> *     <a class="link" href="GckModule.html#gck-module-info-copy" title="gck_module_info_copy ()">gck_module_info_copy</a>                (<em class="parameter"><code><a class="link" href="GckModule.html#GckModuleInfo"><span class="type">GckModuleInfo</span></a> *module_info</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GckModule.html#gck-module-info-free" title="gck_module_info_free ()">gck_module_info_free</a>                (<em class="parameter"><code><a class="link" href="GckModule.html#GckModuleInfo"><span class="type">GckModuleInfo</span></a> *module_info</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GckModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----GckModule
</pre>
<pre class="synopsis">
  GBoxed
   +----GckModuleInfo
</pre>
</div>
<div class="refsect1">
<a name="GckModule.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GckModule.html#GckModule--functions" title='The "functions" property'>functions</a>"                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write / Construct Only
  "<a class="link" href="GckModule.html#GckModule--path" title='The "path" property'>path</a>"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GckModule.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GckModule.html#GckModule-authenticate-object" title='The "authenticate-object" signal'>authenticate-object</a>"                            : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GckModule.html#GckModule-authenticate-slot" title='The "authenticate-slot" signal'>authenticate-slot</a>"                              : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GckModule.description"></a><h2>Description</h2>
<p>
A GckModule object holds a loaded PKCS#11 module. A PKCS#11 module is a shared library.
</p>
<p>
You can load and initialize a PKCS#11 module with the <a class="link" href="GckModule.html#gck-module-initialize" title="gck_module_initialize ()"><code class="function">gck_module_initialize()</code></a> call. If you already
have a loaded and initialized module that you'd like to use with the various gck functions, then
you can use <a class="link" href="GckModule.html#gck-module-new" title="gck_module_new ()"><code class="function">gck_module_new()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="GckModule.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GckModule-struct"></a><h3>struct GckModule</h3>
<pre class="programlisting">struct GckModule;</pre>
<p>
Holds a loaded and initialized PKCS#11 module.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-initialize"></a><h3>gck_module_initialize ()</h3>
<pre class="programlisting"><a class="link" href="GckModule.html" title="GckModule"><span class="returnvalue">GckModule</span></a> *         gck_module_initialize               (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>
Load and initialize a PKCS#11 module represented by a GckModule object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>The file system path to the PKCS#11 module to load.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional cancellation object. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A location to store an error resulting from a failed load.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The loaded PKCS#11 module or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if failed. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-initialize-async"></a><h3>gck_module_initialize_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gck_module_initialize_async         (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Asynchronously load and initialize a PKCS#11 module represented by a
<a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the file system path to the PKCS#11 module to load</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional cancellation object. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a callback which will be called when the operation completes</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-initialize-finish"></a><h3>gck_module_initialize_finish ()</h3>
<pre class="programlisting"><a class="link" href="GckModule.html" title="GckModule"><span class="returnvalue">GckModule</span></a> *         gck_module_initialize_finish        (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</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>
Finishes the asynchronous initialize operation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>the asynchronous result</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>location to place an error on failure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The initialized module, or NULL. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-new"></a><h3>gck_module_new ()</h3>
<pre class="programlisting"><a class="link" href="GckModule.html" title="GckModule"><span class="returnvalue">GckModule</span></a> *         gck_module_new                      (<em class="parameter"><code><a class="link" href="pkcs11-links.html#CK-FUNCTION-LIST-PTR:CAPS"><span class="type">CK_FUNCTION_LIST_PTR</span></a> funcs</code></em>);</pre>
<p>
Create a GckModule representing a PKCS#11 module. It is assumed that
this the module is already initialized. In addition it will not be
finalized when complete.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>funcs</code></em> :</span></p></td>
<td>Initialized PKCS#11 function list pointer</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The new PKCS#11 module.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-equal"></a><h3>gck_module_equal ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gck_module_equal                    (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> module1</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> module2</code></em>);</pre>
<p>
Checks equality of two modules. Two GckModule objects can point to the same
underlying PKCS#11 module.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module1</code></em> :</span></p></td>
<td>a pointer to the first <a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gck.Module]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>module2</code></em> :</span></p></td>
<td>a pointer to the second <a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gck.Module]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if module1 and module2 are equal. FALSE if either is not a GckModule.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-hash"></a><h3>gck_module_hash ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               gck_module_hash                     (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> module</code></em>);</pre>
<p>
Create a hash value for the GckModule.
</p>
<p>
This function is intended for easily hashing a GckModule to add to
a GHashTable or similar data structure.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td>a pointer to a <a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Gck.Module]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An integer that can be used as a hash value, or 0 if invalid.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-match"></a><h3>gck_module_match ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gck_module_match                    (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gck-PKCS11-URIs.html#GckUriData"><span class="type">GckUriData</span></a> *uri</code></em>);</pre>
<p>
Check whether the PKCS#11 URI matches the module
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the module to match</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the uri to match against the module</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether the URI matches or not</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-get-path"></a><h3>gck_module_get_path ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gck_module_get_path                 (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>);</pre>
<p>
Get the file path of this module. This may not be an absolute path, and
usually reflects the path passed to <a class="link" href="GckModule.html#gck-module-initialize" title="gck_module_initialize ()"><code class="function">gck_module_initialize()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The module for which to get the path.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The path, do not modify or free this value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-get-functions"></a><h3>gck_module_get_functions ()</h3>
<pre class="programlisting"><a class="link" href="pkcs11-links.html#CK-FUNCTION-LIST-PTR:CAPS"><span class="returnvalue">CK_FUNCTION_LIST_PTR</span></a> gck_module_get_functions           (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>);</pre>
<p>
Get the PKCS#11 function list for the module.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The module for which to get the function list.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The function list, do not modify this structure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-get-info"></a><h3>gck_module_get_info ()</h3>
<pre class="programlisting"><a class="link" href="GckModule.html#GckModuleInfo"><span class="returnvalue">GckModuleInfo</span></a> *     gck_module_get_info                 (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>);</pre>
<p>
Get the info about a PKCS#11 module.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The module to get info for.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the module info; release this with <a class="link" href="GckModule.html#gck-module-info-free" title="gck_module_info_free ()"><code class="function">gck_module_info_free()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-get-slots"></a><h3>gck_module_get_slots ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             gck_module_get_slots                (<em class="parameter"><code><a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> token_present</code></em>);</pre>
<p>
Get the GckSlot objects for a given module.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The module for which to get the slots.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>token_present</code></em> :</span></p></td>
<td>Whether to limit only to slots with a token present.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The possibly empty
list of slots. Release this with <a class="link" href="gck-Miscellaneous-Functions.html#gck-list-unref-free" title="gck_list_unref_free ()"><code class="function">gck_list_unref_free()</code></a>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gck.Slot][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GckModuleInfo-struct"></a><h3>struct GckModuleInfo</h3>
<pre class="programlisting">struct GckModuleInfo {
	guint8 pkcs11_version_major;
	guint8 pkcs11_version_minor;

	gchar *manufacturer_id;
	gulong flags;

	gchar *library_description;
	guint8 library_version_major;
	guint8 library_version_minor;
};
</pre>
<p>
Holds information about the PKCS#11 module.
</p>
<p>
This structure corresponds to CK_MODULE_INFO in the PKCS#11 standard. The
strings are NULL terminated for easier use.
</p>
<p>
Use <a class="link" href="GckModule.html#gck-module-info-free" title="gck_module_info_free ()"><code class="function">gck_module_info_free()</code></a> to release this structure when done with it.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="GckModuleInfo-struct.pkcs11-version-major"></a>pkcs11_version_major</code></em>;</span></p></td>
<td>The major version of the module.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="GckModuleInfo-struct.pkcs11-version-minor"></a>pkcs11_version_minor</code></em>;</span></p></td>
<td>The minor version of the module.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GckModuleInfo-struct.manufacturer-id"></a>manufacturer_id</code></em>;</span></p></td>
<td>The module manufacturer.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> <em class="structfield"><code><a name="GckModuleInfo-struct.flags"></a>flags</code></em>;</span></p></td>
<td>The module PKCS#11 flags.</td>
</tr>
<tr>
<td><p><span class="term"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GckModuleInfo-struct.library-description"></a>library_description</code></em>;</span></p></td>
<td>The module description.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="GckModuleInfo-struct.library-version-major"></a>library_version_major</code></em>;</span></p></td>
<td>The major version of the library.</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">guint8</span> <em class="structfield"><code><a name="GckModuleInfo-struct.library-version-minor"></a>library_version_minor</code></em>;</span></p></td>
<td>The minor version of the library.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-info-copy"></a><h3>gck_module_info_copy ()</h3>
<pre class="programlisting"><a class="link" href="GckModule.html#GckModuleInfo"><span class="returnvalue">GckModuleInfo</span></a> *     gck_module_info_copy                (<em class="parameter"><code><a class="link" href="GckModule.html#GckModuleInfo"><span class="type">GckModuleInfo</span></a> *module_info</code></em>);</pre>
<p>
Make a copy of the module info.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module_info</code></em> :</span></p></td>
<td>a module info</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated copy module info. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gck-module-info-free"></a><h3>gck_module_info_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gck_module_info_free                (<em class="parameter"><code><a class="link" href="GckModule.html#GckModuleInfo"><span class="type">GckModuleInfo</span></a> *module_info</code></em>);</pre>
<p>
Free a GckModuleInfo structure.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>module_info</code></em> :</span></p></td>
<td>The module info to free, or NULL.</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GckModule.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GckModule--functions"></a><h3>The <code class="literal">"functions"</code> property</h3>
<pre class="programlisting">  "functions"                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write / Construct Only</pre>
<p>
The raw PKCS#11 function list for the module.
</p>
<p>
This points to a CK_FUNCTION_LIST structure.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GckModule--path"></a><h3>The <code class="literal">"path"</code> property</h3>
<pre class="programlisting">  "path"                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>
The PKCS#11 module file path.
</p>
<p>
This may be set to NULL if this object was created from an already
initialized module via the <a class="link" href="GckModule.html#gck-module-new" title="gck_module_new ()"><code class="function">gck_module_new()</code></a> function.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GckModule.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GckModule-authenticate-object"></a><h3>The <code class="literal">"authenticate-object"</code> signal</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *module,
                                                        <a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>     *label,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   password,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GckModule::authenticate-object</code> is deprecated and should not be used in newly-written code. Since 3.4</p>
</div>
<p>
Use <a class="link" href="GckSession.html#gck-session-set-interaction" title="gck_session_set_interaction ()"><code class="function">gck_session_set_interaction()</code></a> instead of connecting to this signal.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td>The module.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>The object to be authenticated.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>A displayable label which describes the object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td>A gchar** where a password should be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GckModule-authenticate-slot"></a><h3>The <code class="literal">"authenticate-slot"</code> signal</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GckModule.html" title="GckModule"><span class="type">GckModule</span></a> *module,
                                                        <a class="link" href="GckSlot.html" title="GckSlot"><span class="type">GckSlot</span></a>   *slot,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>     *string,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   password,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GckModule::authenticate-slot</code> is deprecated and should not be used in newly-written code. Since 3.4</p>
</div>
<p>
Use <a class="link" href="GckSession.html#gck-session-set-interaction" title="gck_session_set_interaction ()"><code class="function">gck_session_set_interaction()</code></a> instead of connecting to this signal.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td>The module</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>slot</code></em> :</span></p></td>
<td>The slot to be authenticated.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>A displayable label which describes the object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td>A gchar** where a password should be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.