← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gnome-keyring/oneiric-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gcr/html/GcrParser.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2011-09-18 14:58:20 UTC
  • mfrom: (1.1.73 upstream)
  • Revision ID: package-import@ubuntu.com-20110918145820-shept32ld5q718hx
Tags: 3.1.92-0ubuntu1
* New upstream release:
  - Add back the file format "documentation"
  - Make .desktop file match prompt process so icon and title are shown
  - Fix packaging issues installing the pkcs11 module
  - return correct error code in gpg-agent for unimplemented stuff
  - Fixes for parsing/viewing various (sometimes slightly invalid) PKCS#12 files
  - Allow daemon to access secrets of internal PKCS#11 modules, so that we can
    do things like hash NTLM and Kerberos secrets in the future.
  - Build and documentation fixes
  - Updated translations
* debian/control.in: Bump libp11-kit-dev build dependency to >= 0.6
  according to configure.ac.
* Drop 01_git_fix_build.patch, upstream now.
* Drop 05_correct_gpg_agent_error_code.patch, upstream now.
* 99_ltmain_as-needed.patch: Refresh.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gcr/html/GcrParser.html
66
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
67
67
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
68
68
<span class="returnvalue">void</span>                <a class="link" href="GcrParser.html#gcr-parser-format-enable" title="gcr_parser_format_enable ()">gcr_parser_format_enable</a>            (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
69
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format_id</code></em>);
 
69
                                                         <em class="parameter"><code><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="type">GcrDataFormat</span></a> format</code></em>);
70
70
<span class="returnvalue">void</span>                <a class="link" href="GcrParser.html#gcr-parser-format-disable" title="gcr_parser_format_disable ()">gcr_parser_format_disable</a>           (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
71
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format_id</code></em>);
 
71
                                                         <em class="parameter"><code><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="type">GcrDataFormat</span></a> format</code></em>);
72
72
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GcrParser.html#gcr-parser-format-supported" title="gcr_parser_format_supported ()">gcr_parser_format_supported</a>         (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
73
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format_id</code></em>);
 
73
                                                         <em class="parameter"><code><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="type">GcrDataFormat</span></a> format</code></em>);
74
74
<span class="returnvalue">void</span>                <a class="link" href="GcrParser.html#gcr-parser-add-password" title="gcr_parser_add_password ()">gcr_parser_add_password</a>             (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
75
75
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>);
76
76
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *              <a class="link" href="GcrParser.html#gcr-parser-get-parsed-label" title="gcr_parser_get_parsed_label ()">gcr_parser_get_parsed_label</a>  (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>);
77
77
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *              <a class="link" href="GcrParser.html#gcr-parser-get-parsed-description" title="gcr_parser_get_parsed_description ()">gcr_parser_get_parsed_description</a>
78
78
                                                        (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>);
79
 
<a href="http://library.gnome.org/devel/gck/unstable/gck-GckAttributes.html#GckAttributes"><span class="returnvalue">GckAttributes</span></a> *            <a class="link" href="GcrParser.html#gcr-parser-get-parsed-attributes" title="gcr_parser_get_parsed_attributes ()">gcr_parser_get_parsed_attributes</a>
 
79
<a href="../gck/gck-GckAttributes.html#GckAttributes"><span class="returnvalue">GckAttributes</span></a> *            <a class="link" href="GcrParser.html#gcr-parser-get-parsed-attributes" title="gcr_parser_get_parsed_attributes ()">gcr_parser_get_parsed_attributes</a>
80
80
                                                        (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>);
81
81
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a>       <a class="link" href="GcrParser.html#gcr-parser-get-parsed-block" title="gcr_parser_get_parsed_block ()">gcr_parser_get_parsed_block</a>         (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
82
82
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> *n_block</code></em>);
 
83
<a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="returnvalue">GcrDataFormat</span></a>       <a class="link" href="GcrParser.html#gcr-parser-get-parsed-format" title="gcr_parser_get_parsed_format ()">gcr_parser_get_parsed_format</a>        (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>);
83
84
</pre>
84
85
</div>
85
86
<div class="refsect1">
92
93
<div class="refsect1">
93
94
<a name="GcrParser.properties"></a><h2>Properties</h2>
94
95
<pre class="synopsis">
95
 
  "<a class="link" href="GcrParser.html#GcrParser--parsed-attributes" title='The "parsed-attributes" property'>parsed-attributes</a>"        <a href="http://library.gnome.org/devel/gck/unstable/gck-GckAttributes.html#GckAttributes"><span class="type">GckAttributes</span></a>*        : Read
 
96
  "<a class="link" href="GcrParser.html#GcrParser--parsed-attributes" title='The "parsed-attributes" property'>parsed-attributes</a>"        <a href="../gck/gck-GckAttributes.html#GckAttributes"><span class="type">GckAttributes</span></a>*        : Read
96
97
  "<a class="link" href="GcrParser.html#GcrParser--parsed-description" title='The "parsed-description" property'>parsed-description</a>"       <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
97
98
  "<a class="link" href="GcrParser.html#GcrParser--parsed-label" title='The "parsed-label" property'>parsed-label</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
98
99
</pre>
192
193
 
193
194
        GCR_FORMAT_DER_PKCS12 = 500,
194
195
 
 
196
        GCR_FORMAT_OPENSSH_PUBLIC = 600,
 
197
 
 
198
        GCR_FORMAT_OPENPGP_PACKET = 700,
 
199
        GCR_FORMAT_OPENPGP_ARMOR,
 
200
 
195
201
        GCR_FORMAT_PEM = 1000,
196
202
        GCR_FORMAT_PEM_PRIVATE_KEY_RSA,
197
203
        GCR_FORMAT_PEM_PRIVATE_KEY_DSA,
199
205
        GCR_FORMAT_PEM_PKCS7,
200
206
        GCR_FORMAT_PEM_PKCS8_PLAIN,
201
207
        GCR_FORMAT_PEM_PKCS8_ENCRYPTED,
202
 
        GCR_FORMAT_PEM_PKCS12
 
208
        GCR_FORMAT_PEM_PKCS12,
 
209
        GCR_FORMAT_PEM_PRIVATE_KEY
203
210
} GcrDataFormat;
204
211
</pre>
205
212
<p>
259
266
</td>
260
267
</tr>
261
268
<tr>
 
269
<td><p><a name="GCR-FORMAT-OPENSSH-PUBLIC:CAPS"></a><span class="term"><code class="literal">GCR_FORMAT_OPENSSH_PUBLIC</code></span></p></td>
 
270
<td>OpenSSH v1 or v2 public key
 
271
</td>
 
272
</tr>
 
273
<tr>
 
274
<td><p><a name="GCR-FORMAT-OPENPGP-PACKET:CAPS"></a><span class="term"><code class="literal">GCR_FORMAT_OPENPGP_PACKET</code></span></p></td>
 
275
<td>OpenPGP key packet(s)
 
276
</td>
 
277
</tr>
 
278
<tr>
 
279
<td><p><a name="GCR-FORMAT-OPENPGP-ARMOR:CAPS"></a><span class="term"><code class="literal">GCR_FORMAT_OPENPGP_ARMOR</code></span></p></td>
 
280
<td>OpenPGP public or private key armor encoded data
 
281
</td>
 
282
</tr>
 
283
<tr>
262
284
<td><p><a name="GCR-FORMAT-PEM:CAPS"></a><span class="term"><code class="literal">GCR_FORMAT_PEM</code></span></p></td>
263
285
<td>An OpenSSL style PEM file with unspecified contents
264
286
</td>
298
320
<td>An OpenSSL style PEM file containing PKCS#12
299
321
</td>
300
322
</tr>
 
323
<tr>
 
324
<td><p><a name="GCR-FORMAT-PEM-PRIVATE-KEY:CAPS"></a><span class="term"><code class="literal">GCR_FORMAT_PEM_PRIVATE_KEY</code></span></p></td>
 
325
<td>PEM encoded private key
 
326
</td>
 
327
</tr>
301
328
</tbody>
302
329
</table></div>
303
330
</div>
516
543
<div class="refsect2">
517
544
<a name="gcr-parser-format-enable"></a><h3>gcr_parser_format_enable ()</h3>
518
545
<pre class="programlisting"><span class="returnvalue">void</span>                gcr_parser_format_enable            (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
519
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format_id</code></em>);</pre>
 
546
                                                         <em class="parameter"><code><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="type">GcrDataFormat</span></a> format</code></em>);</pre>
520
547
<p>
521
548
Enable parsing of the given format. Use -1 to enable all the formats.
522
549
</p>
528
555
<td>The parser</td>
529
556
</tr>
530
557
<tr>
531
 
<td><p><span class="term"><em class="parameter"><code>format_id</code></em> :</span></p></td>
 
558
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
532
559
<td>The format identifier</td>
533
560
</tr>
534
561
</tbody>
538
565
<div class="refsect2">
539
566
<a name="gcr-parser-format-disable"></a><h3>gcr_parser_format_disable ()</h3>
540
567
<pre class="programlisting"><span class="returnvalue">void</span>                gcr_parser_format_disable           (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
541
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format_id</code></em>);</pre>
 
568
                                                         <em class="parameter"><code><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="type">GcrDataFormat</span></a> format</code></em>);</pre>
542
569
<p>
543
570
Disable parsing of the given format. Use -1 to disable all the formats.
544
571
</p>
550
577
<td>The parser</td>
551
578
</tr>
552
579
<tr>
553
 
<td><p><span class="term"><em class="parameter"><code>format_id</code></em> :</span></p></td>
 
580
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
554
581
<td>The format identifier</td>
555
582
</tr>
556
583
</tbody>
560
587
<div class="refsect2">
561
588
<a name="gcr-parser-format-supported"></a><h3>gcr_parser_format_supported ()</h3>
562
589
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gcr_parser_format_supported         (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>,
563
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> format_id</code></em>);</pre>
 
590
                                                         <em class="parameter"><code><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="type">GcrDataFormat</span></a> format</code></em>);</pre>
564
591
<p>
565
592
Check whether the given format is supported by the parser.
566
593
</p>
572
599
<td>The parser</td>
573
600
</tr>
574
601
<tr>
575
 
<td><p><span class="term"><em class="parameter"><code>format_id</code></em> :</span></p></td>
 
602
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
576
603
<td>The format identifier</td>
577
604
</tr>
578
605
<tr>
655
682
<hr>
656
683
<div class="refsect2">
657
684
<a name="gcr-parser-get-parsed-attributes"></a><h3>gcr_parser_get_parsed_attributes ()</h3>
658
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gck/unstable/gck-GckAttributes.html#GckAttributes"><span class="returnvalue">GckAttributes</span></a> *            gcr_parser_get_parsed_attributes
 
685
<pre class="programlisting"><a href="../gck/gck-GckAttributes.html#GckAttributes"><span class="returnvalue">GckAttributes</span></a> *            gcr_parser_get_parsed_attributes
659
686
                                                        (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>);</pre>
660
687
<p>
661
688
Get the attributes which make up the currently parsed item. This is generally
704
731
</tbody>
705
732
</table></div>
706
733
</div>
 
734
<hr>
 
735
<div class="refsect2">
 
736
<a name="gcr-parser-get-parsed-format"></a><h3>gcr_parser_get_parsed_format ()</h3>
 
737
<pre class="programlisting"><a class="link" href="GcrParser.html#GcrDataFormat" title="enum GcrDataFormat"><span class="returnvalue">GcrDataFormat</span></a>       gcr_parser_get_parsed_format        (<em class="parameter"><code><a class="link" href="GcrParser.html" title="GcrParser"><span class="type">GcrParser</span></a> *self</code></em>);</pre>
 
738
<p>
 
739
Get the format of the raw data block that represents this parsed object.
 
740
This corresponds with the data returned from <a class="link" href="GcrParser.html#gcr-parser-get-parsed-block" title="gcr_parser_get_parsed_block ()"><code class="function">gcr_parser_get_parsed_block()</code></a>.
 
741
</p>
 
742
<p>
 
743
This is only valid during the GcrParser::parsed signal.
 
744
</p>
 
745
<div class="variablelist"><table border="0">
 
746
<col align="left" valign="top">
 
747
<tbody>
 
748
<tr>
 
749
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
750
<td>a parser</td>
 
751
</tr>
 
752
<tr>
 
753
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
754
<td>The data format of the currently parsed item.</td>
 
755
</tr>
 
756
</tbody>
 
757
</table></div>
 
758
</div>
707
759
</div>
708
760
<div class="refsect1">
709
761
<a name="GcrParser.property-details"></a><h2>Property Details</h2>
710
762
<div class="refsect2">
711
763
<a name="GcrParser--parsed-attributes"></a><h3>The <code class="literal">"parsed-attributes"</code> property</h3>
712
 
<pre class="programlisting">  "parsed-attributes"        <a href="http://library.gnome.org/devel/gck/unstable/gck-GckAttributes.html#GckAttributes"><span class="type">GckAttributes</span></a>*        : Read</pre>
 
764
<pre class="programlisting">  "parsed-attributes"        <a href="../gck/gck-GckAttributes.html#GckAttributes"><span class="type">GckAttributes</span></a>*        : Read</pre>
713
765
<p>
714
766
Get the attributes that make up the currently parsed item. This is
715
767
generally only valid during a <a class="link" href="GcrParser.html#GcrParser-parsed" title='The "parsed" signal'><span class="type">"parsed"</span></a> signal.