source-git / gcr

Clone
Source Code
GIT

Files

  1.   b00eeb04ed99e7486f76dabe082c410d0627c81e
  2.   docs
  3.   reference
  4.   gcr
  5.   html
  6.   GcrPkcs11Certificate.html
Blob Blame History Raw 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GcrPkcs11Certificate: Gcr Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gcr Library Reference Manual">
<link rel="up" href="certificates.html" title="Part I. Certificates">
<link rel="prev" href="GcrSimpleCertificate.html" title="GcrSimpleCertificate">
<link rel="next" href="GcrCertificateChain.html" title="GcrCertificateChain">
<meta name="generator" content="GTK-Doc V1.27.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GcrPkcs11Certificate.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GcrPkcs11Certificate.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GcrPkcs11Certificate.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GcrPkcs11Certificate.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="certificates.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GcrSimpleCertificate.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GcrCertificateChain.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GcrPkcs11Certificate"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GcrPkcs11Certificate.top_of_page"></a>GcrPkcs11Certificate</span></h2>
<p>GcrPkcs11Certificate — A certificate loaded from PKCS#11 storage</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="returnvalue">GcrCertificate</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer" title="gcr_pkcs11_certificate_lookup_issuer ()">gcr_pkcs11_certificate_lookup_issuer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer-async" title="gcr_pkcs11_certificate_lookup_issuer_async ()">gcr_pkcs11_certificate_lookup_issuer_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="returnvalue">GcrCertificate</span></a> *
</td>
<td class="function_name">
<a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer-finish" title="gcr_pkcs11_certificate_lookup_issuer_finish ()">gcr_pkcs11_certificate_lookup_issuer_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GckAttributes</span> *
</td>
<td class="function_name">
<a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-get-attributes" title="gcr_pkcs11_certificate_get_attributes ()">gcr_pkcs11_certificate_get_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<span class="type">GckAttributes</span> *</td>
<td class="property_name"><a class="link" href="GcrPkcs11Certificate.html#GcrPkcs11Certificate--attributes" title="The “attributes” property">attributes</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GcrPkcs11Certificate.html#GcrPkcs11Certificate-struct" title="struct GcrPkcs11Certificate">GcrPkcs11Certificate</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GcrPkcs11Certificate.html#GcrPkcs11CertificateClass" title="struct GcrPkcs11CertificateClass">GcrPkcs11CertificateClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GckObject
        <span class="lineart">╰──</span> GcrPkcs11Certificate
</pre>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GcrPkcs11Certificate implements
 <a class="link" href="GcrComparable.html" title="GcrComparable">GcrComparable</a> and  <a class="link" href="GcrCertificate.html" title="GcrCertificate">GcrCertificate</a>.</p>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.description"></a><h2>Description</h2>
<p>A <a class="link" href="GcrPkcs11Certificate.html" title="GcrPkcs11Certificate"><span class="type">GcrPkcs11Certificate</span></a> is a certificate loaded from a PKCS#11 storage.
It is also a valid <span class="type">GckObject</span> and can be used as such.</p>
<p>Use <a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer" title="gcr_pkcs11_certificate_lookup_issuer ()"><code class="function">gcr_pkcs11_certificate_lookup_issuer()</code></a> to lookup the issuer of a given
certificate in the PKCS#11 store.</p>
<p>Various common PKCS#11 certificate attributes are automatically loaded and
are available via <a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-get-attributes" title="gcr_pkcs11_certificate_get_attributes ()"><code class="function">gcr_pkcs11_certificate_get_attributes()</code></a>.</p>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gcr-pkcs11-certificate-lookup-issuer"></a><h3>gcr_pkcs11_certificate_lookup_issuer ()</h3>
<pre class="programlisting"><a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="returnvalue">GcrCertificate</span></a> *
gcr_pkcs11_certificate_lookup_issuer (<em class="parameter"><code><a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="type">GcrCertificate</span></a> *certificate</code></em>,
                                      <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                      <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Lookup a the issuer of a <em class="parameter"><code>certificate</code></em>
 in the PKCS#11 storage. The
lookup is done using the issuer DN of the certificate. No certificate chain
verification is done. Use a crypto library to make trust decisions.</p>
<p>This call may block, see <a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer" title="gcr_pkcs11_certificate_lookup_issuer ()"><code class="function">gcr_pkcs11_certificate_lookup_issuer()</code></a> for the
non-blocking version.</p>
<p>Will return <code class="literal">NULL</code> if no issuer certificate is found. Use <em class="parameter"><code>error</code></em>
 to determine
if an error occurred.</p>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-lookup-issuer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>certificate</p></td>
<td class="parameter_description"><p>a <a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="type">GcrCertificate</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>, or NULL</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-lookup-issuer.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GcrPkcs11Certificate.html" title="GcrPkcs11Certificate"><span class="type">GcrPkcs11Certificate</span></a>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-pkcs11-certificate-lookup-issuer-async"></a><h3>gcr_pkcs11_certificate_lookup_issuer_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gcr_pkcs11_certificate_lookup_issuer_async
                               (<em class="parameter"><code><a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="type">GcrCertificate</span></a> *certificate</code></em>,
                                <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Lookup a the issuer of a <em class="parameter"><code>certificate</code></em>
 in the PKCS#11 storage. The
lookup is done using the issuer DN of the certificate. No certificate chain
verification is done. Use a crypto library to make trust decisions.</p>
<p>When the operation is finished, callback will be called. You can then call
<a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer-finish" title="gcr_pkcs11_certificate_lookup_issuer_finish ()"><code class="function">gcr_pkcs11_certificate_lookup_issuer_finish()</code></a> to get the result of the
operation.</p>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-lookup-issuer-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>certificate</p></td>
<td class="parameter_description"><p>a <a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="type">GcrCertificate</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span> to call when the operation completes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-pkcs11-certificate-lookup-issuer-finish"></a><h3>gcr_pkcs11_certificate_lookup_issuer_finish ()</h3>
<pre class="programlisting"><a class="link" href="GcrCertificate.html" title="GcrCertificate"><span class="returnvalue">GcrCertificate</span></a> *
gcr_pkcs11_certificate_lookup_issuer_finish
                               (<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Finishes an asynchronous operation started by
<a class="link" href="GcrPkcs11Certificate.html#gcr-pkcs11-certificate-lookup-issuer-async" title="gcr_pkcs11_certificate_lookup_issuer_async ()"><code class="function">gcr_pkcs11_certificate_lookup_issuer_async()</code></a>.</p>
<p>Will return <code class="literal">NULL</code> if no issuer certificate is found. Use <em class="parameter"><code>error</code></em>
 to determine
if an error occurred.</p>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-lookup-issuer-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>the <span class="type">GAsyncResult</span> passed to the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>, or NULL</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-lookup-issuer-finish.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GcrPkcs11Certificate.html" title="GcrPkcs11Certificate"><span class="type">GcrPkcs11Certificate</span></a>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gcr-pkcs11-certificate-get-attributes"></a><h3>gcr_pkcs11_certificate_get_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">GckAttributes</span> *
gcr_pkcs11_certificate_get_attributes (<em class="parameter"><code><a class="link" href="GcrPkcs11Certificate.html" title="GcrPkcs11Certificate"><span class="type">GcrPkcs11Certificate</span></a> *self</code></em>);</pre>
<p>Access the automatically loaded attributes for this certificate.</p>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-get-attributes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="GcrPkcs11Certificate.html" title="GcrPkcs11Certificate"><span class="type">GcrPkcs11Certificate</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gcr-pkcs11-certificate-get-attributes.returns"></a><h4>Returns</h4>
<p>the certificate attributes. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GcrPkcs11Certificate-struct"></a><h3>struct GcrPkcs11Certificate</h3>
<pre class="programlisting">struct GcrPkcs11Certificate;</pre>
<p>A certificate loaded from PKCS#11 storage.</p>
</div>
<hr>
<div class="refsect2">
<a name="GcrPkcs11CertificateClass"></a><h3>struct GcrPkcs11CertificateClass</h3>
<pre class="programlisting">struct GcrPkcs11CertificateClass {
};
</pre>
<p>The class for <a class="link" href="GcrPkcs11Certificate.html" title="GcrPkcs11Certificate"><span class="type">GcrPkcs11Certificate</span></a>.</p>
</div>
</div>
<div class="refsect1">
<a name="GcrPkcs11Certificate.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GcrPkcs11Certificate--attributes"></a><h3>The <code class="literal">“attributes”</code> property</h3>
<pre class="programlisting">  “attributes”               <span class="type">GckAttributes</span> *</pre>
<p>Automatically loaded attributes for this certificate.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27.1</div>
</body>
</html>

Powered by Pagure 5.13.3

SSH Hostkey/Fingerprint | Documentation