Skip to content

Commit

Permalink
Release 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dorssel committed Nov 5, 2024
1 parent 3f706e1 commit cbb28cb
Show file tree
Hide file tree
Showing 164 changed files with 6,088 additions and 3,199 deletions.
18 changes: 10 additions & 8 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,17 @@
# Boilerplate
.gitattributes text
.txt text
.nojekyll text
.md text

# Documentation
*.css text
*.html text
*.js text
*.map text
*.md5 text
*.svg text
# Documentation (built on Linux)
docs/.nojekyll text eol=lf
docs/**/*.txt text eol=lf
docs/**/*.css text eol=lf
docs/**/*.html text eol=lf
docs/**/*.js text eol=lf
docs/**/*.map text eol=lf
docs/**/*.md5 text eol=lf
docs/**/*.svg text eol=lf

*.png binary
*.ttf binary
Expand Down
10 changes: 5 additions & 5 deletions docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,11 +131,11 @@
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssPrivateKeyStatefulBlob.html" target="_self">XmssPrivateKeyStatefulBlob</a></td><td class="desc">A stored stateful private key part </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssPrivateKeyStatelessBlob.html" target="_self">XmssPrivateKeyStatelessBlob</a></td><td class="desc">A stored stateless private key part </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssPublicKey.html" target="_self">XmssPublicKey</a></td><td class="desc">Exportable format for a public key </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssPublicKeyBlob.html" target="_self">XmssPublicKeyBlob</a></td><td class="desc">Structure containing the size and the public key formatted for export </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssPublicKeyInternalBlob.html" target="_self">XmssPublicKeyInternalBlob</a></td><td class="desc">A stored public key for the signing library </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssSignature.html" target="_self">XmssSignature</a></td><td class="desc">Exportable format for a signature </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssSignatureBlob.html" target="_self">XmssSignatureBlob</a></td><td class="desc">Structure that embeds the exportable format for a signature, along with the signature's data size </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssValue256.html" target="_self">XmssValue256</a></td><td class="desc">A generic 256-bit value, represented as a byte stream </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssPublicKeyInternalBlob.html" target="_self">XmssPublicKeyInternalBlob</a></td><td class="desc">A stored public key for the signing library </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssSignature.html" target="_self">XmssSignature</a></td><td class="desc">Exportable format for a signature </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssSignatureBlob.html" target="_self">XmssSignatureBlob</a></td><td class="desc">Structure that embeds the exportable format for a signature, along with the signature's data size </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structXmssValue256.html" target="_self">XmssValue256</a></td><td class="desc">A generic 256-bit value, represented as a byte stream </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionXmssVerificationContext.html" target="_self">XmssVerificationContext</a></td><td class="desc">The context for signature verification </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
4 changes: 2 additions & 2 deletions docs/annotated_dup.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ var annotated_dup =
[ "XmssPrivateKeyStatefulBlob", "structXmssPrivateKeyStatefulBlob.html", "structXmssPrivateKeyStatefulBlob" ],
[ "XmssPrivateKeyStatelessBlob", "structXmssPrivateKeyStatelessBlob.html", "structXmssPrivateKeyStatelessBlob" ],
[ "XmssPublicKey", "structXmssPublicKey.html", "structXmssPublicKey" ],
[ "XmssPublicKeyBlob", "structXmssPublicKeyBlob.html", "structXmssPublicKeyBlob" ],
[ "XmssPublicKeyInternalBlob", "structXmssPublicKeyInternalBlob.html", "structXmssPublicKeyInternalBlob" ],
[ "XmssSignature", "structXmssSignature.html", "structXmssSignature" ],
[ "XmssSignatureBlob", "structXmssSignatureBlob.html", "structXmssSignatureBlob" ],
[ "XmssValue256", "structXmssValue256.html", "structXmssValue256" ]
[ "XmssValue256", "structXmssValue256.html", "structXmssValue256" ],
[ "XmssVerificationContext", "unionXmssVerificationContext.html", "unionXmssVerificationContext" ]
];
2 changes: 1 addition & 1 deletion docs/auto-render.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a name="letter_X">X</a></dt>
<dd><a class="el" href="structXmssBuffer.html">XmssBuffer</a></dd><dd><a class="el" href="structXmssNativeValue256.html">XmssNativeValue256</a></dd><dd><a class="el" href="structXmssPrivateKeyStatefulBlob.html">XmssPrivateKeyStatefulBlob</a></dd><dd><a class="el" href="structXmssPrivateKeyStatelessBlob.html">XmssPrivateKeyStatelessBlob</a></dd><dd><a class="el" href="structXmssPublicKey.html">XmssPublicKey</a></dd><dd><a class="el" href="structXmssPublicKeyBlob.html">XmssPublicKeyBlob</a></dd><dd><a class="el" href="structXmssPublicKeyInternalBlob.html">XmssPublicKeyInternalBlob</a></dd><dd><a class="el" href="structXmssSignature.html">XmssSignature</a></dd><dd><a class="el" href="structXmssSignatureBlob.html">XmssSignatureBlob</a></dd><dd><a class="el" href="structXmssValue256.html">XmssValue256</a></dd></dl>
<dd><a class="el" href="structXmssBuffer.html">XmssBuffer</a></dd><dd><a class="el" href="structXmssNativeValue256.html">XmssNativeValue256</a></dd><dd><a class="el" href="structXmssPrivateKeyStatefulBlob.html">XmssPrivateKeyStatefulBlob</a></dd><dd><a class="el" href="structXmssPrivateKeyStatelessBlob.html">XmssPrivateKeyStatelessBlob</a></dd><dd><a class="el" href="structXmssPublicKey.html">XmssPublicKey</a></dd><dd><a class="el" href="structXmssPublicKeyInternalBlob.html">XmssPublicKeyInternalBlob</a></dd><dd><a class="el" href="structXmssSignature.html">XmssSignature</a></dd><dd><a class="el" href="structXmssSignatureBlob.html">XmssSignatureBlob</a></dd><dd><a class="el" href="structXmssValue256.html">XmssValue256</a></dd><dd><a class="el" href="unionXmssVerificationContext.html">XmssVerificationContext</a></dd></dl>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
Expand Down
18 changes: 9 additions & 9 deletions docs/compat_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="compat_8h__dep__incl.svg" width="1327" height="351"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
<div class="center"><iframe scrolling="no" frameborder="0" src="compat_8h__dep__incl.svg" width="1571" height="351"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
Expand All @@ -151,23 +151,23 @@
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compat_8h.html#a4195b499fd6d588922f59d858fec245d">XMSS_COMPAT_H_INCLUDED</a></td></tr>
<tr class="memdesc:a4195b499fd6d588922f59d858fec245d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Include guard. <br /></td></tr>
<tr class="separator:a4195b499fd6d588922f59d858fec245d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ce491b27b644889db1ca99d8c99c24e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compat_8h.html#a8ce491b27b644889db1ca99d8c99c24e">STATIC_ASSERT</a>(cond, msg)&#160;&#160;&#160;_Static_assert(cond, msg)</td></tr>
<tr class="memdesc:a8ce491b27b644889db1ca99d8c99c24e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Syntactical equivalent of _Static_assert(), which is C11. <a href="compat_8h.html#a8ce491b27b644889db1ca99d8c99c24e">More...</a><br /></td></tr>
<tr class="separator:a8ce491b27b644889db1ca99d8c99c24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7b0a273cdffb714d79fe2581f30f9a2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="compat_8h.html#ab7b0a273cdffb714d79fe2581f30f9a2">XMSS_STATIC_ASSERT</a>(cond, msg)&#160;&#160;&#160;_Static_assert(cond, msg)</td></tr>
<tr class="memdesc:ab7b0a273cdffb714d79fe2581f30f9a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Syntactical equivalent of <code>_Static_assert()</code>, which is C11. <a href="compat_8h.html#ab7b0a273cdffb714d79fe2581f30f9a2">More...</a><br /></td></tr>
<tr class="separator:ab7b0a273cdffb714d79fe2581f30f9a2"><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>C99 compatibility layer. </p>
<p>There is no need to include this header explicitly. Instead, include either <a class="el" href="verification_8h.html" title="Public API for the XMSS verification library.">verification.h</a> or <a class="el" href="signing_8h.html" title="Public API for the XMSS signing library.">signing.h</a>.</p>
<p>The XMSS library is compatible with C99 compilers, but it also allows certain C11 features if they are available for the compiler at hand. This header ensures that the code does not get cluttered with preprocessor <code>#if</code>s. You can simply use the compatibility macros defined here, which will automatically either use the C11 feature (when available) or become a no-op (when not available). </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a8ce491b27b644889db1ca99d8c99c24e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ce491b27b644889db1ca99d8c99c24e">&#9670;&nbsp;</a></span>STATIC_ASSERT</h2>
<a id="ab7b0a273cdffb714d79fe2581f30f9a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7b0a273cdffb714d79fe2581f30f9a2">&#9670;&nbsp;</a></span>XMSS_STATIC_ASSERT</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define STATIC_ASSERT</td>
<td class="memname">#define XMSS_STATIC_ASSERT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cond, </td>
Expand All @@ -186,8 +186,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8ce491b27b644889db1ca99d
</table>
</div><div class="memdoc">

<p>Syntactical equivalent of _Static_assert(), which is C11. </p>
<p>C11 supports _Static_assert(). CMake can detect if it is available anyway, even if the compiler is not C11. If CMake detects that static asserts are not supported, then this macro is a no-op.</p>
<p>Syntactical equivalent of <code>_Static_assert()</code>, which is C11. </p>
<p>C11 supports <code>_Static_assert()</code>. CMake can detect if it is available anyway, even if the compiler is not C11. If CMake detects that static asserts are not supported, then this macro is a no-op.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xmss__config_8h.html#aa34c54b7aaa58b37c69138b5f308fb80" title="Indicates whether the compiler supports _Static_assert().">XMSS_CAN_USE_STATIC_ASSERT</a> </dd>
<dd>
<a class="el" href="xmss__config_8h.html#ad1edca72b4957256583b9426087c65e8" title="Indicates whether the compiler supports __extension__ _Static_assert().">XMSS_CAN_USE_EXTENSION_STATIC_ASSERT</a> </dd></dl>
Expand Down
4 changes: 2 additions & 2 deletions docs/compat_8h.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
var compat_8h =
[
[ "STATIC_ASSERT", "compat_8h.html#a8ce491b27b644889db1ca99d8c99c24e", null ],
[ "XMSS_COMPAT_H_INCLUDED", "compat_8h.html#a4195b499fd6d588922f59d858fec245d", null ]
[ "XMSS_COMPAT_H_INCLUDED", "compat_8h.html#a4195b499fd6d588922f59d858fec245d", null ],
[ "XMSS_STATIC_ASSERT", "compat_8h.html#ab7b0a273cdffb714d79fe2581f30f9a2", null ]
];
Loading

0 comments on commit cbb28cb

Please sign in to comment.