/usr/share/gtk-doc/html/libepc-1.0/libepc-1.0-EpcTls.html is in libepc-doc 0.4.4-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EpcTls</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Easy Publish and Consume Reference Manual">
<link rel="up" href="internal-api.html" title="Internal API">
<link rel="prev" href="libepc-1.0-EpcShell.html" title="EpcShell">
<meta name="generator" content="GTK-Doc V1.18.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="2">
<tr valign="middle">
<td><a accesskey="p" href="libepc-1.0-EpcShell.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="internal-api.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">Easy Publish and Consume Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libepc-1.0-EpcTls.synopsis" class="shortcut">Top</a>
|
<a href="#libepc-1.0-EpcTls.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libepc-1.0-EpcTls"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libepc-1.0-EpcTls.top_of_page"></a>EpcTls</span></h2>
<p>EpcTls — TLS support</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libepc-1.0-EpcTls.stability-level"></a><h2>Stability Level</h2>
Private, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libepc-1.0-EpcTls.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libepc/shell.h>
#define <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR">EPC_TLS_ERROR</a>
#define <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-SECONDS-PER-DAY:CAPS" title="EPC_TLS_SECONDS_PER_DAY">EPC_TLS_SECONDS_PER_DAY</a>
#define <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-SECONDS-PER-HOUR:CAPS" title="EPC_TLS_SECONDS_PER_HOUR">EPC_TLS_SECONDS_PER_HOUR</a>
#define <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-SECONDS-PER-MINUTE:CAPS" title="EPC_TLS_SECONDS_PER_MINUTE">EPC_TLS_SECONDS_PER_MINUTE</a>
<span class="returnvalue">gnutls_x509_crt_t</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-certificate-load" title="epc_tls_certificate_load ()">epc_tls_certificate_load</a> (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gnutls_x509_crt_t</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-certificate-new" title="epc_tls_certificate_new ()">epc_tls_certificate_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>,
<em class="parameter"><code><span class="type">guint</span> validity</code></em>,
<em class="parameter"><code><span class="type">gnutls_x509_privkey_t</span> key</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-certificate-save" title="epc_tls_certificate_save ()">epc_tls_certificate_save</a> (<em class="parameter"><code><span class="type">gnutls_x509_crt_t</span> certificate</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gnutls_x509_privkey_t</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-private-key-load" title="epc_tls_private_key_load ()">epc_tls_private_key_load</a> (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gnutls_x509_privkey_t</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-private-key-new" title="epc_tls_private_key_new ()">epc_tls_private_key_new</a> (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-private-key-save" title="epc_tls_private_key_save ()">epc_tls_private_key_save</a> (<em class="parameter"><code><span class="type">gnutls_x509_privkey_t</span> key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-get-private-key-filename" title="epc_tls_get_private_key_filename ()">epc_tls_get_private_key_filename</a> (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-get-certificate-filename" title="epc_tls_get_certificate_filename ()">epc_tls_get_certificate_filename</a> (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-get-server-credentials" title="epc_tls_get_server_credentials ()">epc_tls_get_server_credentials</a> (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **crtfile</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **keyfile</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libepc-1.0-EpcTls.description"></a><h2>Description</h2>
<p>
Functions for handling TLS (X.509) certificates and keys.
</p>
</div>
<div class="refsect1">
<a name="libepc-1.0-EpcTls.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EPC-TLS-ERROR:CAPS"></a><h3>EPC_TLS_ERROR</h3>
<pre class="programlisting">#define EPC_TLS_ERROR (epc_tls_error_quark ())
</pre>
<p>
Error domain for TLS operations. Errors in this domain will
be <em class="citetitle">GNU TLS</em> error codes. See GError
for information on error domains.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EPC-TLS-SECONDS-PER-DAY:CAPS"></a><h3>EPC_TLS_SECONDS_PER_DAY</h3>
<pre class="programlisting">#define EPC_TLS_SECONDS_PER_DAY (24 * EPC_TLS_SECONDS_PER_HOUR)
</pre>
<p>
The number of seconds per day.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EPC-TLS-SECONDS-PER-HOUR:CAPS"></a><h3>EPC_TLS_SECONDS_PER_HOUR</h3>
<pre class="programlisting">#define EPC_TLS_SECONDS_PER_HOUR (60 * EPC_TLS_SECONDS_PER_MINUTE)
</pre>
<p>
The number of seconds per hour.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EPC-TLS-SECONDS-PER-MINUTE:CAPS"></a><h3>EPC_TLS_SECONDS_PER_MINUTE</h3>
<pre class="programlisting">#define EPC_TLS_SECONDS_PER_MINUTE (60)
</pre>
<p>
The number of seconds per minute.
</p>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-certificate-load"></a><h3>epc_tls_certificate_load ()</h3>
<pre class="programlisting"><span class="returnvalue">gnutls_x509_crt_t</span> epc_tls_certificate_load (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Reads a PEM encoded X.509 certificate.
</p>
<p>
If the call was successful, the newly created certificate object is
returned. This key can be used with functions of the <em class="citetitle">GNU
TLS</em> library. If the call was not successful, it returns <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
and sets <em class="parameter"><code>error</code></em>. The error domain is <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken
from the <em class="citetitle">GNU TLS</em> library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of a file to read the certificate from, in the GLib file name encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>The newly created certificate object, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-certificate-new"></a><h3>epc_tls_certificate_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gnutls_x509_crt_t</span> epc_tls_certificate_new (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>,
<em class="parameter"><code><span class="type">guint</span> validity</code></em>,
<em class="parameter"><code><span class="type">gnutls_x509_privkey_t</span> key</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Creates a self signed X.509 certificate. The certificate will mention
<em class="parameter"><code>hostname</code></em> as common name and as DNS host name, and it will be valid
for <em class="parameter"><code>validity</code></em> days.
</p>
<p>
If the call was successful, the newly created certificate is returned. This
certificate can be used with functions of the <em class="citetitle">GNU TLS</em>
library. If the call was not successful, it returns <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> and sets <em class="parameter"><code>error</code></em>.
The error domain is <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken from the
<em class="citetitle">GNU TLS</em> library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
<td>the name of the host that will use this certificate</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>validity</code></em> :</span></p></td>
<td>the number of days the certificate will remain valid</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the private key for signing the certificate</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>The newly created certificate object, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-certificate-save"></a><h3>epc_tls_certificate_save ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> epc_tls_certificate_save (<em class="parameter"><code><span class="type">gnutls_x509_crt_t</span> certificate</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Writes a PEM encoded X.509 certificate.
</p>
<p>
If the call was successful, it returns <code class="literal">TRUE</code>. If the call was not
successful, it returns <code class="literal">FALSE</code> and sets <em class="parameter"><code>error</code></em>. The error domain is
<a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken from the <em class="citetitle">GNU
TLS</em> library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>certificate</code></em> :</span></p></td>
<td>a X.509 certificate</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of a file to write the certificate to, in the GLib file name encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>
<code class="literal">TRUE</code> on successful, <code class="literal">FALSE</code> if an error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-private-key-load"></a><h3>epc_tls_private_key_load ()</h3>
<pre class="programlisting"><span class="returnvalue">gnutls_x509_privkey_t</span> epc_tls_private_key_load (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Reads a PEM encoded private X.509 key.
</p>
<p>
If the call was successful, the newly created private key object is
returned. This key can be used with functions of the <em class="citetitle">GNU
TLS</em> library. If the call was not successful, it returns <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
and sets <em class="parameter"><code>error</code></em>. The error domain is <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken
from the <em class="citetitle">GNU TLS</em> library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of a file to read the key from, in the GLib file name encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>The newly created key object, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-private-key-new"></a><h3>epc_tls_private_key_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gnutls_x509_privkey_t</span> epc_tls_private_key_new (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Creates a self private X.509 key. Generating secure keys needs quite
some time. Call <code class="function">epc_tls_set_private_key_hooks()</code> to install hooks providing
some feedback to your users. Key generation takes place in a separate
background thread, whilst the calling thread waits in a GMainLoop. So
for instance the GTK+ widget system remains responsible during that
phase.
</p>
<p>
If the call was successful, the newly created key is returned. This
certificate can be used with functions of the <em class="citetitle">GNU TLS</em>
library. If the call was not successful, it returns <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> and sets <em class="parameter"><code>error</code></em>.
The error domain is <a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken from the
<em class="citetitle">GNU TLS</em> library.
</p>
<p>
See also: <span class="type">EpcEntropyProgress</span>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>The newly created private key object, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-private-key-save"></a><h3>epc_tls_private_key_save ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> epc_tls_private_key_save (<em class="parameter"><code><span class="type">gnutls_x509_privkey_t</span> key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Writes a PEM encoded private X.509 key.
</p>
<p>
If the call was successful, it returns <code class="literal">TRUE</code>. If the call was not
successful, it returns <code class="literal">FALSE</code> and sets <em class="parameter"><code>error</code></em>. The error domain is
<a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken from the <em class="citetitle">GNU
TLS</em> library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a private X.509 key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of a file to write the private key to, in the GLib file name encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>
<code class="literal">TRUE</code> on successful, <code class="literal">FALSE</code> if an error occured</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-get-private-key-filename"></a><h3>epc_tls_get_private_key_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * epc_tls_get_private_key_filename (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>);</pre>
<p>
Queries the preferred location for storing private X.509 keys for the server
identified by <em class="parameter"><code>hostname</code></em>. This file is located in the current user's XDG
configuration folder (<code class="function">g_get_user_config_dir()</code>). The filename also contains
program's name when specified by <code class="function">g_set_prgname()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
<td>the server's host name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The preferred private key location for <em class="parameter"><code>hostname</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-get-certificate-filename"></a><h3>epc_tls_get_certificate_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * epc_tls_get_certificate_filename (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>);</pre>
<p>
Queries the preferred location for storing X.509 certificates for the server
identified by <em class="parameter"><code>hostname</code></em>. This file is located in the current user's XDG
configuration folder (<code class="function">g_get_user_config_dir()</code>). The filename also contains
program's name when specified by <code class="function">g_set_prgname()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
<td>the server's host name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The preferred certificate location for <em class="parameter"><code>hostname</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-tls-get-server-credentials"></a><h3>epc_tls_get_server_credentials ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> epc_tls_get_server_credentials (<em class="parameter"><code>const <span class="type">gchar</span> *hostname</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **crtfile</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **keyfile</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Searches or creates X.509 certificate and key for the server identified
by <em class="parameter"><code>hostname</code></em>. This function uses <a class="link" href="libepc-1.0-EpcTls.html#epc-tls-get-certificate-filename" title="epc_tls_get_certificate_filename ()"><code class="function">epc_tls_get_certificate_filename()</code></a> and
<a class="link" href="libepc-1.0-EpcTls.html#epc-tls-get-private-key-filename" title="epc_tls_get_private_key_filename ()"><code class="function">epc_tls_get_private_key_filename()</code></a> to locate existing certificates and
keys. New certificates and keys are generated, when the files cannot
be found, or the existing files contain invalid or expired information.
</p>
<p>
If the call was successful, it returns <code class="literal">TRUE</code>. If the call was not
successful, it returns <code class="literal">FALSE</code> and sets <em class="parameter"><code>error</code></em>. The error domain is
<a class="link" href="libepc-1.0-EpcTls.html#EPC-TLS-ERROR:CAPS" title="EPC_TLS_ERROR"><span class="type">EPC_TLS_ERROR</span></a>. Error codes are taken from the <em class="citetitle">GNU
TLS</em> library.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hostname</code></em> :</span></p></td>
<td>the server's host name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>crtfile</code></em> :</span></p></td>
<td>location for storing the certificate's filename in GLib filename encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keyfile</code></em> :</span></p></td>
<td>location for storing the private key's filename in GLib filename encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.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>
<code class="literal">TRUE</code> on successful, <code class="literal">FALSE</code> if an error occurred</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|