Skip to content

Commit 3f706e1

Browse files
dorsseldorssel
committed
Release 1.0.0
1 parent 99fdfac commit 3f706e1

File tree

348 files changed

+29563
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

348 files changed

+29563
-0
lines changed

‎.reuse/dep5‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
Upstream-Name: xmss-documentation
3+
Source: https://github.com/FoxCryptoNL/xmss-documentation
4+
5+
Files: docs/*
6+
Copyright: 2023 Fox Crypto B.V.
7+
License: CC-BY-4.0
8+
9+
Files: docs/doxygen-awesome*
10+
Copyright: 2021-2023 jothepro
11+
License: MIT
12+
13+
Files: docs/katex* docs/fonts/KaTeX*
14+
Copyright: 2013-2020 Khan Academy and other contributors
15+
License: MIT
16+
17+
Files: docs/mermaid*
18+
Copyright: 2014-2022 Knut Sveidqvist
19+
License: MIT

‎LICENSES/CC-BY-4.0.txt‎

Lines changed: 156 additions & 0 deletions
Large diffs are not rendered by default.

‎LICENSES/MIT.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) <year> <copyright holders>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2023 Fox Crypto B.V.
3+
SPDX-License-Identifier: CC-BY-4.0
4+
-->
5+
6+
# XMSS
7+
8+
eXtended Merkle Signature Scheme is a post-quantum safe signature algorithm
9+
([RFC](https://datatracker.ietf.org/doc/html/rfc8391)).
10+
11+
![XMSS C Documentation License](https://img.shields.io/github/license/FoxCryptoNL/xmss-documentation?style=plastic)
12+
[![XMSS C Documentation Release](https://img.shields.io/github/v/release/FoxCryptoNL/xmss-documentation?style=plastic)](https://github.com/FoxCryptoNL/xmss-documentation/releases)
13+
14+
## XMSS C Library Documentation
15+
16+
This repository contains the documentation of the XMSS C Library. For more information about the complete project,
17+
please visit [https://github.com/FoxCryptoNL/xmss](https://github.com/FoxCryptoNL/xmss).
18+
19+
The documentation can be viewed online via
20+
[https://FoxCryptoNL.github.io/xmss-documentation](https://FoxCryptoNL.github.io/xmss-documentation).
21+
22+
This repository will only be updated when a new release of the documentation of the XMSS C Library is published. The
23+
documentation may be updated more frequently than the library source code. This includes the API documentation that is
24+
generated from the source code. While this means that the source code and the published API documentation may slightly
25+
differ, this will allow the documentation to be updated more frequently.
26+
27+
## Issues
28+
29+
Issues regarding the documentation, including the API documentation generated from the source code, can be reported in
30+
this repository's [issue tracker](https://github.com/FoxCryptoNL/xmss-documentation/issues).
31+
32+
For reporting (security) issues regarding the implementation, please refer to the
33+
[library's repository](https://github.com/FoxCryptoNL/xmss-library).
34+
35+
## Discussions
36+
37+
Discussions about the documentation, including the API documentation generated from the source code, can be held in the
38+
[documentation discussions](https://github.com/FoxCryptoNL/xmss-documentation/discussions).

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/FOX-CRYPTO.png‎

3.64 KB
Loading

‎docs/LICENSE.txt‎

Lines changed: 397 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/annotated.html‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<!-- HTML header for doxygen 1.9.1-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
4+
<head>
5+
<meta charset="utf-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7+
<meta name="generator" content="Doxygen 1.9.1"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
9+
<title>XMSS Library: Class List</title>
10+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
11+
<script type="text/javascript" src="jquery.js"></script>
12+
<script type="text/javascript" src="dynsections.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="resize.js"></script>
15+
<script type="text/javascript" src="navtreedata.js"></script>
16+
<script type="text/javascript" src="navtree.js"></script>
17+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
18+
<script type="text/javascript" src="search/searchdata.js"></script>
19+
<script type="text/javascript" src="search/search.js"></script>
20+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
21+
<link href="custom.css" rel="stylesheet" type="text/css"/>
22+
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23+
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24+
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25+
<link href="katex.min.css" rel="stylesheet" type="text/css"/>
26+
<!-- KaTeX -->
27+
<script type="text/javascript" defer src="katex.min.js"></script>
28+
<script type="text/javascript" defer src="auto-render.min.js"></script>
29+
<script type="text/javascript">
30+
document.addEventListener("DOMContentLoaded", function() {
31+
renderMathInElement(document.body, {
32+
delimiters: [
33+
{left: '$$', right: '$$', display: true},
34+
{left: '$', right: '$', display: false}
35+
],
36+
macros: {
37+
'\\Keccak': '\\text{K\\footnotesize{ECCAK}}'
38+
}
39+
});
40+
});
41+
</script>
42+
<!-- end: KaTeX -->
43+
<!-- Doxygen Awesome -->
44+
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
45+
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
46+
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
47+
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
48+
<script type="text/javascript">
49+
DoxygenAwesomeDarkModeToggle.init()
50+
DoxygenAwesomeFragmentCopyButton.init()
51+
DoxygenAwesomeParagraphLink.init()
52+
DoxygenAwesomeInteractiveToc.init()
53+
</script>
54+
<!-- end: Doxygen Awesome -->
55+
<!-- Final overrides (glue) -->
56+
<link href="custom.css" rel="stylesheet" type="text/css"/>
57+
<!-- end: Final overrides (glue) -->
58+
</head>
59+
<body>
60+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
61+
<div id="titlearea">
62+
<table cellspacing="0" cellpadding="0">
63+
<tbody>
64+
<tr style="height: 56px;">
65+
<td id="projectlogo"><img alt="Logo" src="FOX-CRYPTO.png"/></td>
66+
<td id="projectalign" style="padding-left: 0.5em;">
67+
<div id="projectname">XMSS Library
68+
</div>
69+
</td>
70+
</tr>
71+
</tbody>
72+
</table>
73+
</div>
74+
<!-- end header part -->
75+
<!-- Generated by Doxygen 1.9.1 -->
76+
<script type="text/javascript">
77+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
78+
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
79+
/* @license-end */
80+
</script>
81+
<script type="text/javascript" src="menudata.js"></script>
82+
<script type="text/javascript" src="menu.js"></script>
83+
<script type="text/javascript">
84+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
85+
$(function() {
86+
initMenu('',true,false,'search.php','Search');
87+
$(document).ready(function() { init_search(); });
88+
});
89+
/* @license-end */</script>
90+
<div id="main-nav"></div>
91+
</div><!-- top -->
92+
<div id="side-nav" class="ui-resizable side-nav-resizable">
93+
<div id="nav-tree">
94+
<div id="nav-tree-contents">
95+
<div id="nav-sync" class="sync"></div>
96+
</div>
97+
</div>
98+
<div id="splitbar" style="-moz-user-select:none;"
99+
class="ui-resizable-handle">
100+
</div>
101+
</div>
102+
<script type="text/javascript">
103+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
104+
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
105+
/* @license-end */
106+
</script>
107+
<div id="doc-content">
108+
<!-- window showing the filter options -->
109+
<div id="MSearchSelectWindow"
110+
onmouseover="return searchBox.OnSearchSelectShow()"
111+
onmouseout="return searchBox.OnSearchSelectHide()"
112+
onkeydown="return searchBox.OnSearchSelectKey(event)">
113+
</div>
114+
115+
<!-- iframe showing the search results (closed by default) -->
116+
<div id="MSearchResultsWindow">
117+
<iframe src="javascript:void(0)" frameborder="0"
118+
name="MSearchResults" id="MSearchResults">
119+
</iframe>
120+
</div>
121+
122+
<div class="header">
123+
<div class="headertitle">
124+
<div class="title">Class List</div> </div>
125+
</div><!--header-->
126+
<div class="contents">
127+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
128+
<table class="directory">
129+
<tr id="row_0_" 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="structXmssBuffer.html" target="_self">XmssBuffer</a></td><td class="desc">A pointer to a buffer with a given size </td></tr>
130+
<tr id="row_1_"><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="structXmssNativeValue256.html" target="_self">XmssNativeValue256</a></td><td class="desc">The internal (native) representation of a 256-bit value </td></tr>
131+
<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>
132+
<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>
133+
<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>
134+
<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>
135+
<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>
136+
<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>
137+
<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>
138+
<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>
139+
</table>
140+
</div><!-- directory -->
141+
</div><!-- contents -->
142+
</div><!-- doc-content -->
143+
<!-- HTML footer for doxygen 1.9.1-->
144+
<!-- start footer part -->
145+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
146+
<ul>
147+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
148+
</ul>
149+
</div>
150+
</body>
151+
<!-- Mermaid -->
152+
<script type="text/javascript" defer src="mermaid.min.js"></script>
153+
<!-- end: Mermaid -->
154+
</html>

‎docs/annotated_dup.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
var annotated_dup =
2+
[
3+
[ "XmssBuffer", "structXmssBuffer.html", "structXmssBuffer" ],
4+
[ "XmssNativeValue256", "structXmssNativeValue256.html", "structXmssNativeValue256" ],
5+
[ "XmssPrivateKeyStatefulBlob", "structXmssPrivateKeyStatefulBlob.html", "structXmssPrivateKeyStatefulBlob" ],
6+
[ "XmssPrivateKeyStatelessBlob", "structXmssPrivateKeyStatelessBlob.html", "structXmssPrivateKeyStatelessBlob" ],
7+
[ "XmssPublicKey", "structXmssPublicKey.html", "structXmssPublicKey" ],
8+
[ "XmssPublicKeyBlob", "structXmssPublicKeyBlob.html", "structXmssPublicKeyBlob" ],
9+
[ "XmssPublicKeyInternalBlob", "structXmssPublicKeyInternalBlob.html", "structXmssPublicKeyInternalBlob" ],
10+
[ "XmssSignature", "structXmssSignature.html", "structXmssSignature" ],
11+
[ "XmssSignatureBlob", "structXmssSignatureBlob.html", "structXmssSignatureBlob" ],
12+
[ "XmssValue256", "structXmssValue256.html", "structXmssValue256" ]
13+
];

‎docs/auto-render.min.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)