| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>pskc: PSKC Library (libpskc) Manual</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> |
| 7 |
<link rel="home" href="index.html" title="PSKC Library (libpskc) Manual"> |
| 8 |
<link rel="up" href="pskc-reference.html" title="Part II. API Reference"> |
| 9 |
<link rel="prev" href="pskc-reference.html" title="Part II. API Reference"> |
| 10 |
<link rel="next" href="libpskc-version.html" title="version"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| 16 |
<td width="100%" align="left" class="shortcuts"></td> |
| 17 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 18 |
<td><a accesskey="u" href="pskc-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 19 |
<td><a accesskey="p" href="pskc-reference.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 20 |
<td><a accesskey="n" href="libpskc-version.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 21 |
</tr></table> |
| 22 |
<div class="refentry"> |
| 23 |
<a name="libpskc-pskc"></a><div class="titlepage"></div> |
| 24 |
<div class="refnamediv"> |
| 25 |
<h2><span class="refentrytitle"><a name="libpskc-pskc.top_of_page"></a>pskc</span></h2> |
| 26 |
<p>pskc — Top-level include file.</p> |
| 27 |
</div> |
| 28 |
<div class="refsect1"> |
| 29 |
<a name="libpskc-pskc.other"></a><h2>Types and Values</h2> |
| 30 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 31 |
<colgroup> |
| 32 |
<col width="150px" class="other_proto_type"> |
| 33 |
<col class="other_proto_name"> |
| 34 |
</colgroup> |
| 35 |
<tbody> |
| 36 |
<tr> |
| 37 |
<td class="typedef_keyword">typedef</td> |
| 38 |
<td class="function_name"><a class="link" href="libpskc-pskc.html#pskc-t" title="pskc_t">pskc_t</a></td> |
| 39 |
</tr> |
| 40 |
<tr> |
| 41 |
<td class="typedef_keyword">typedef</td> |
| 42 |
<td class="function_name"><a class="link" href="libpskc-pskc.html#pskc-key-t" title="pskc_key_t">pskc_key_t</a></td> |
| 43 |
</tr> |
| 44 |
</tbody> |
| 45 |
</table></div> |
| 46 |
</div> |
| 47 |
<div class="refsect1"> |
| 48 |
<a name="libpskc-pskc.description"></a><h2>Description</h2> |
| 49 |
<p>The top-level <pskc/pskc.h> include file is responsible for |
| 50 |
declaring top-level types and including all other header files. |
| 51 |
The <a class="link" href="libpskc-pskc.html#pskc-t" title="pskc_t"><span class="type">pskc_t</span></a> type is used for the high-level PSKC container type and |
| 52 |
the <a class="link" href="libpskc-pskc.html#pskc-key-t" title="pskc_key_t"><span class="type">pskc_key_t</span></a> type represent each key package within the |
| 53 |
container.</p> |
| 54 |
</div> |
| 55 |
<div class="refsect1"> |
| 56 |
<a name="libpskc-pskc.functions_details"></a><h2>Functions</h2> |
| 57 |
<p></p> |
| 58 |
</div> |
| 59 |
<div class="refsect1"> |
| 60 |
<a name="libpskc-pskc.other_details"></a><h2>Types and Values</h2> |
| 61 |
<div class="refsect2"> |
| 62 |
<a name="pskc-t"></a><h3>pskc_t</h3> |
| 63 |
<a class="indexterm" name="id-1.3.3.6.2.2"></a><pre class="programlisting"> typedef struct pskc pskc_t; |
| 64 |
</pre> |
| 65 |
<p>All PSKC data is represented through the <a class="link" href="libpskc-pskc.html#pskc-t" title="pskc_t"><span class="type">pskc_t</span></a> container type, |
| 66 |
which is a high-level structure that only carries a version |
| 67 |
indicator (see <a class="link" href="libpskc-container.html#pskc-get-version" title="pskc_get_version ()"><code class="function">pskc_get_version()</code></a>), an optional identity field (see |
| 68 |
<a class="link" href="libpskc-container.html#pskc-get-id" title="pskc_get_id ()"><code class="function">pskc_get_id()</code></a>) and any number of <a class="link" href="libpskc-pskc.html#pskc-key-t" title="pskc_key_t"><span class="type">pskc_key_t</span></a> types, each containing |
| 69 |
one key (see <a class="link" href="libpskc-container.html#pskc-get-keypackage" title="pskc_get_keypackage ()"><code class="function">pskc_get_keypackage()</code></a>).</p> |
| 70 |
</div> |
| 71 |
<div class="refsect2"> |
| 72 |
<a name="pskc-key-t"></a><h3>pskc_key_t</h3> |
| 73 |
<a class="indexterm" name="id-1.3.3.6.3.2"></a><pre class="programlisting"> typedef struct pskc_key pskc_key_t; |
| 74 |
</pre> |
| 75 |
<p>PSKC keys are represented through the <a class="link" href="libpskc-pskc.html#pskc-key-t" title="pskc_key_t"><span class="type">pskc_key_t</span></a> type. Each key |
| 76 |
is part of a higher level <a class="link" href="libpskc-pskc.html#pskc-t" title="pskc_t"><span class="type">pskc_t</span></a> container type. The |
| 77 |
<a class="link" href="libpskc-container.html#pskc-get-keypackage" title="pskc_get_keypackage ()"><code class="function">pskc_get_keypackage()</code></a> function is used to retrieve the <a class="link" href="libpskc-pskc.html#pskc-key-t" title="pskc_key_t"><span class="type">pskc_key_t</span></a> |
| 78 |
values from the <a class="link" href="libpskc-pskc.html#pskc-t" title="pskc_t"><span class="type">pskc_t</span></a> structure.</p> |
| 79 |
</div> |
| 80 |
</div> |
| 81 |
</div> |
| 82 |
<div class="footer"> |
| 83 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 84 |
</body> |
| 85 |
</html> |