Files
pcp/man/html/struct__pcp__pubkey__t.html
2014-02-20 21:02:52 +01:00

326 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libpcp: _pcp_pubkey_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libpcp
&#160;<span id="projectnumber">0.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct__pcp__pubkey__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">_pcp_pubkey_t Struct Reference<div class="ingroups"><a class="el" href="group__KEYS.html">KEYS</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>PCP public key structure.
<a href="struct__pcp__pubkey__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="key_8h_source.html">key.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0c503b0cdf8a331d54f3affb18fd068e"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a0c503b0cdf8a331d54f3affb18fd068e">masterpub</a> [32]</td></tr>
<tr class="memdesc:a0c503b0cdf8a331d54f3affb18fd068e"><td class="mdescLeft">&#160;</td><td class="mdescRight">ED25519 master public key signing key. <a href="#a0c503b0cdf8a331d54f3affb18fd068e"></a><br/></td></tr>
<tr class="separator:a0c503b0cdf8a331d54f3affb18fd068e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e6b30f39e7107c4b3b7cd67cdc019f9"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a7e6b30f39e7107c4b3b7cd67cdc019f9">sigpub</a> [32]</td></tr>
<tr class="memdesc:a7e6b30f39e7107c4b3b7cd67cdc019f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">ED25519 public signing key. <a href="#a7e6b30f39e7107c4b3b7cd67cdc019f9"></a><br/></td></tr>
<tr class="separator:a7e6b30f39e7107c4b3b7cd67cdc019f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10cb7717fbf5cc0ba9584fd3c1d7bb33"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a10cb7717fbf5cc0ba9584fd3c1d7bb33">pub</a> [32]</td></tr>
<tr class="memdesc:a10cb7717fbf5cc0ba9584fd3c1d7bb33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Curve25519 encryption public key. <a href="#a10cb7717fbf5cc0ba9584fd3c1d7bb33"></a><br/></td></tr>
<tr class="separator:a10cb7717fbf5cc0ba9584fd3c1d7bb33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d4d53e88c0ca2b09364394cf1dee200"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a7d4d53e88c0ca2b09364394cf1dee200">edpub</a> [32]</td></tr>
<tr class="memdesc:a7d4d53e88c0ca2b09364394cf1dee200"><td class="mdescLeft">&#160;</td><td class="mdescRight">ED25519 public signing key (FIXME: huh? 2 of them???) <a href="#a7d4d53e88c0ca2b09364394cf1dee200"></a><br/></td></tr>
<tr class="separator:a7d4d53e88c0ca2b09364394cf1dee200"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cc906382ef13dc456e9a15b84843a79"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a1cc906382ef13dc456e9a15b84843a79">owner</a> [255]</td></tr>
<tr class="memdesc:a1cc906382ef13dc456e9a15b84843a79"><td class="mdescLeft">&#160;</td><td class="mdescRight">the key owner, string <a href="#a1cc906382ef13dc456e9a15b84843a79"></a><br/></td></tr>
<tr class="separator:a1cc906382ef13dc456e9a15b84843a79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d4e99518b3c0edcccd2917274e7cc29"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a5d4e99518b3c0edcccd2917274e7cc29">mail</a> [255]</td></tr>
<tr class="memdesc:a5d4e99518b3c0edcccd2917274e7cc29"><td class="mdescLeft">&#160;</td><td class="mdescRight">mail address of the owner, string <a href="#a5d4e99518b3c0edcccd2917274e7cc29"></a><br/></td></tr>
<tr class="separator:a5d4e99518b3c0edcccd2917274e7cc29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad10eadcb9325538e71c9fd8b140dbdd2"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#ad10eadcb9325538e71c9fd8b140dbdd2">id</a> [17]</td></tr>
<tr class="memdesc:ad10eadcb9325538e71c9fd8b140dbdd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">key-id, used internally only, jenhash of public keys <a href="#ad10eadcb9325538e71c9fd8b140dbdd2"></a><br/></td></tr>
<tr class="separator:ad10eadcb9325538e71c9fd8b140dbdd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2154caabdc447e21106e117205c1259d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a2154caabdc447e21106e117205c1259d">type</a></td></tr>
<tr class="memdesc:a2154caabdc447e21106e117205c1259d"><td class="mdescLeft">&#160;</td><td class="mdescRight">key type: MASTER_SECRET or SECRET <a href="#a2154caabdc447e21106e117205c1259d"></a><br/></td></tr>
<tr class="separator:a2154caabdc447e21106e117205c1259d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ac602791697d90bf56ecb0a7a7c3714"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#a9ac602791697d90bf56ecb0a7a7c3714">ctime</a></td></tr>
<tr class="memdesc:a9ac602791697d90bf56ecb0a7a7c3714"><td class="mdescLeft">&#160;</td><td class="mdescRight">creation time, epoch <a href="#a9ac602791697d90bf56ecb0a7a7c3714"></a><br/></td></tr>
<tr class="separator:a9ac602791697d90bf56ecb0a7a7c3714"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaebe0105dd79f3d22575dd29ff1d7356"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#aaebe0105dd79f3d22575dd29ff1d7356">version</a></td></tr>
<tr class="memdesc:aaebe0105dd79f3d22575dd29ff1d7356"><td class="mdescLeft">&#160;</td><td class="mdescRight">key version <a href="#aaebe0105dd79f3d22575dd29ff1d7356"></a><br/></td></tr>
<tr class="separator:aaebe0105dd79f3d22575dd29ff1d7356"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd1941bc57da1a65f8038b47e3ccd21d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#afd1941bc57da1a65f8038b47e3ccd21d">serial</a></td></tr>
<tr class="memdesc:afd1941bc57da1a65f8038b47e3ccd21d"><td class="mdescLeft">&#160;</td><td class="mdescRight">serial number of the key, randomly generated <a href="#afd1941bc57da1a65f8038b47e3ccd21d"></a><br/></td></tr>
<tr class="separator:afd1941bc57da1a65f8038b47e3ccd21d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af93af4b3e259d6fa9e05009e564be8f7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#af93af4b3e259d6fa9e05009e564be8f7">valid</a></td></tr>
<tr class="memdesc:af93af4b3e259d6fa9e05009e564be8f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if import signature verified, 0 if not <a href="#af93af4b3e259d6fa9e05009e564be8f7"></a><br/></td></tr>
<tr class="separator:af93af4b3e259d6fa9e05009e564be8f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6952d39d4ebc81d0677649e5f369013"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__pcp__pubkey__t.html#ad6952d39d4ebc81d0677649e5f369013">signature</a> [crypto_generichash_BYTES_MAX+crypto_sign_BYTES]</td></tr>
<tr class="memdesc:ad6952d39d4ebc81d0677649e5f369013"><td class="mdescLeft">&#160;</td><td class="mdescRight">raw binary blob of pubkey export signature <a href="#ad6952d39d4ebc81d0677649e5f369013"></a><br/></td></tr>
<tr class="separator:ad6952d39d4ebc81d0677649e5f369013"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>PCP public key structure. </p>
<p>This structure contains a subset of the pcp_key_t structure without the secret and nonce fields. </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00122">122</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a9ac602791697d90bf56ecb0a7a7c3714"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t _pcp_pubkey_t::ctime</td>
</tr>
</table>
</div><div class="memdoc">
<p>creation time, epoch </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00131">131</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7d4d53e88c0ca2b09364394cf1dee200"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte _pcp_pubkey_t::edpub[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>ED25519 public signing key (FIXME: huh? 2 of them???) </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00126">126</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad10eadcb9325538e71c9fd8b140dbdd2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char _pcp_pubkey_t::id[17]</td>
</tr>
</table>
</div><div class="memdoc">
<p>key-id, used internally only, jenhash of public keys </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00129">129</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5d4e99518b3c0edcccd2917274e7cc29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char _pcp_pubkey_t::mail[255]</td>
</tr>
</table>
</div><div class="memdoc">
<p>mail address of the owner, string </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00128">128</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0c503b0cdf8a331d54f3affb18fd068e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte _pcp_pubkey_t::masterpub[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>ED25519 master public key signing key. </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00123">123</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1cc906382ef13dc456e9a15b84843a79"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char _pcp_pubkey_t::owner[255]</td>
</tr>
</table>
</div><div class="memdoc">
<p>the key owner, string </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00127">127</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a10cb7717fbf5cc0ba9584fd3c1d7bb33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte _pcp_pubkey_t::pub[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Curve25519 encryption public key. </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00125">125</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="afd1941bc57da1a65f8038b47e3ccd21d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t _pcp_pubkey_t::serial</td>
</tr>
</table>
</div><div class="memdoc">
<p>serial number of the key, randomly generated </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00133">133</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad6952d39d4ebc81d0677649e5f369013"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte _pcp_pubkey_t::signature[crypto_generichash_BYTES_MAX+crypto_sign_BYTES]</td>
</tr>
</table>
</div><div class="memdoc">
<p>raw binary blob of pubkey export signature </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00135">135</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7e6b30f39e7107c4b3b7cd67cdc019f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte _pcp_pubkey_t::sigpub[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>ED25519 public signing key. </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00124">124</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2154caabdc447e21106e117205c1259d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _pcp_pubkey_t::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>key type: MASTER_SECRET or SECRET </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00130">130</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="af93af4b3e259d6fa9e05009e564be8f7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _pcp_pubkey_t::valid</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 if import signature verified, 0 if not </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00134">134</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaebe0105dd79f3d22575dd29ff1d7356"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t _pcp_pubkey_t::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>key version </p>
<p>Definition at line <a class="el" href="key_8h_source.html#l00132">132</a> of file <a class="el" href="key_8h_source.html">key.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="key_8h_source.html">key.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 20 2014 20:58:12 for libpcp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>