aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b89ffee88412ea9a575b1bcea491d8b48cc5acd7
libaaruformat/docs/html/checksum_8h_source.html

160 lines
14 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/structs/checksum.h Source File</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('checksum_8h_source.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">checksum.h</div></div>
</div><!--header-->
<div class="contents">
<a href="checksum_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_CHECKSUM_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_CHECKSUM_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;stdint.h&gt;</span> <span class="comment">// Fixed-width integer types for on-disk structures.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#pragma pack(push, 1)</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span></div>
<div class="foldopen" id="foldopen00073" data-start="{" data-end="};">
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="structChecksumHeader.html"> 73</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structChecksumHeader.html">ChecksumHeader</a></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>{</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="structChecksumHeader.html#a2cb8589c2733e9a1cc0c8387da8ae3e3"> 75</a></span> uint32_t <a class="code hl_variable" href="structChecksumHeader.html#a2cb8589c2733e9a1cc0c8387da8ae3e3">identifier</a>; </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structChecksumHeader.html#a56f776d418d05f7284ce811aa3ff1e06"> 76</a></span> uint32_t <a class="code hl_variable" href="structChecksumHeader.html#a56f776d418d05f7284ce811aa3ff1e06">length</a>; </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="structChecksumHeader.html#aa82464bce9c97dda1066930b9250cfbe"> 77</a></span> uint8_t <a class="code hl_variable" href="structChecksumHeader.html#aa82464bce9c97dda1066930b9250cfbe">entries</a>; </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="checksum_8h.html#a64152a064d0f42344886c7c5576ede2c"> 78</a></span>} <a class="code hl_struct" href="structChecksumHeader.html">ChecksumHeader</a>;</div>
</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span></div>
<div class="foldopen" id="foldopen00090" data-start="{" data-end="};">
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="structChecksumEntry.html"> 90</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structChecksumEntry.html">ChecksumEntry</a></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>{</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="structChecksumEntry.html#aae2307548d69d23749ffdfd9d4acd627"> 92</a></span> uint8_t <a class="code hl_variable" href="structChecksumEntry.html#aae2307548d69d23749ffdfd9d4acd627">type</a>; </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"><a class="line" href="structChecksumEntry.html#a271a3b60fe8dfbbb540bb00c85762c58"> 93</a></span> uint32_t <a class="code hl_variable" href="structChecksumEntry.html#a271a3b60fe8dfbbb540bb00c85762c58">length</a>; </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="checksum_8h.html#aeba107584fd6e2db8dcc1d790c24734f"> 94</a></span>} <a class="code hl_struct" href="structChecksumEntry.html">ChecksumEntry</a>;</div>
</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_CHECKSUM_H</span></div>
<div class="ttc" id="astructChecksumEntry_html"><div class="ttname"><a href="structChecksumEntry.html">ChecksumEntry</a></div><div class="ttdoc">Per-checksum metadata immediately followed by the digest / signature bytes.</div><div class="ttdef"><b>Definition</b> <a href="#l00090">checksum.h:91</a></div></div>
<div class="ttc" id="astructChecksumEntry_html_a271a3b60fe8dfbbb540bb00c85762c58"><div class="ttname"><a href="structChecksumEntry.html#a271a3b60fe8dfbbb540bb00c85762c58">ChecksumEntry::length</a></div><div class="ttdeci">uint32_t length</div><div class="ttdoc">Length in bytes of the digest that immediately follows this structure.</div><div class="ttdef"><b>Definition</b> <a href="#l00093">checksum.h:93</a></div></div>
<div class="ttc" id="astructChecksumEntry_html_aae2307548d69d23749ffdfd9d4acd627"><div class="ttname"><a href="structChecksumEntry.html#aae2307548d69d23749ffdfd9d4acd627">ChecksumEntry::type</a></div><div class="ttdeci">uint8_t type</div><div class="ttdoc">Algorithm used (value from ChecksumAlgorithm).</div><div class="ttdef"><b>Definition</b> <a href="#l00092">checksum.h:92</a></div></div>
<div class="ttc" id="astructChecksumHeader_html"><div class="ttname"><a href="structChecksumHeader.html">ChecksumHeader</a></div><div class="ttdoc">Header that precedes the sequence of checksum entries for a checksum block.</div><div class="ttdef"><b>Definition</b> <a href="#l00073">checksum.h:74</a></div></div>
<div class="ttc" id="astructChecksumHeader_html_a2cb8589c2733e9a1cc0c8387da8ae3e3"><div class="ttname"><a href="structChecksumHeader.html#a2cb8589c2733e9a1cc0c8387da8ae3e3">ChecksumHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::ChecksumBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l00075">checksum.h:75</a></div></div>
<div class="ttc" id="astructChecksumHeader_html_a56f776d418d05f7284ce811aa3ff1e06"><div class="ttname"><a href="structChecksumHeader.html#a56f776d418d05f7284ce811aa3ff1e06">ChecksumHeader::length</a></div><div class="ttdeci">uint32_t length</div><div class="ttdoc">Length in bytes of the payload (all entries + their digest data, excluding this header).</div><div class="ttdef"><b>Definition</b> <a href="#l00076">checksum.h:76</a></div></div>
<div class="ttc" id="astructChecksumHeader_html_aa82464bce9c97dda1066930b9250cfbe"><div class="ttname"><a href="structChecksumHeader.html#aa82464bce9c97dda1066930b9250cfbe">ChecksumHeader::entries</a></div><div class="ttdeci">uint8_t entries</div><div class="ttdoc">Number of checksum entries that follow in the payload.</div><div class="ttdef"><b>Definition</b> <a href="#l00077">checksum.h:77</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="checksum_8h.html">checksum.h</a></li>
<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.14.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink