mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
180 lines
10 KiB
HTML
180 lines
10 KiB
HTML
<!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 File 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>
|
|
<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"> 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.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 File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>On-disk layout definitions for the checksum block (BlockType::ChecksumBlock).
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <stdint.h></code><br />
|
|
</div>
|
|
<p><a href="checksum_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:ChecksumHeader" id="r_ChecksumHeader"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structChecksumHeader.html">ChecksumHeader</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Header that precedes the sequence of checksum entries for a checksum block. <a href="structChecksumHeader.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:ChecksumEntry" id="r_ChecksumEntry"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structChecksumEntry.html">ChecksumEntry</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Per-checksum metadata immediately followed by the digest / signature bytes. <a href="structChecksumEntry.html#details">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a64152a064d0f42344886c7c5576ede2c" id="r_a64152a064d0f42344886c7c5576ede2c"><td class="memItemLeft" align="right" valign="top">typedef struct ChecksumHeader </td><td class="memItemRight" valign="bottom"><a class="el" href="#a64152a064d0f42344886c7c5576ede2c">ChecksumHeader</a></td></tr>
|
|
<tr class="memitem:aeba107584fd6e2db8dcc1d790c24734f" id="r_aeba107584fd6e2db8dcc1d790c24734f"><td class="memItemLeft" align="right" valign="top">typedef struct ChecksumEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeba107584fd6e2db8dcc1d790c24734f">ChecksumEntry</a></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>On-disk layout definitions for the checksum block (BlockType::ChecksumBlock). </p>
|
|
<p>A checksum block stores one or more whole-image (user data) checksums. For optical media the user data definition follows the format's raw sector rules (e.g. 2352-byte raw sector when available).</p>
|
|
<p>Binary layout (all integers are little-endian, structure is packed):</p>
|
|
<p>+---------------------------—+----------------------------—+ | Field | Size (bytes) | +==============================+===============================+ | <a class="el" href="structChecksumHeader.html" title="Header that precedes the sequence of checksum entries for a checksum block.">ChecksumHeader</a> | sizeof(ChecksumHeader)=9 | | identifier | 4 (BlockType::ChecksumBlock) | | length | 4 (payload bytes that follow)| | entries | 1 (number of checksum entries)| +---------------------------—+----------------------------—+ | Repeated for each entry: | | <a class="el" href="structChecksumEntry.html" title="Per-checksum metadata immediately followed by the digest / signature bytes.">ChecksumEntry</a> | sizeof(ChecksumEntry)=5 | | type | 1 (<a class="el" href="enums_8h.html#abda1f9cb04c30fc71ee8c6081d21ee0e" title="Supported checksum / hash algorithms.">ChecksumAlgorithm</a>) | | length | 4 (digest length) | | digest bytes | length | +---------------------------—+----------------------------—+</p>
|
|
<p>Thus, the payload size (<a class="el" href="structChecksumHeader.html#a56f776d418d05f7284ce811aa3ff1e06" title="Length in bytes of the payload (all entries + their digest data, excluding this header).">ChecksumHeader.length</a>) MUST equal the sum over all entries of: sizeof(ChecksumEntry) + entry.length.</p>
|
|
<p>Typical digest lengths:</p><ul>
|
|
<li>Md5: 16 bytes</li>
|
|
<li>Sha1: 20 bytes</li>
|
|
<li>Sha256: 32 bytes</li>
|
|
<li>SpamSum: variable length ASCII, NOT null-terminated on disk (a terminating '\0' may be appended in memory).</li>
|
|
</ul>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The structures are packed; never rely on host compiler default padding or directly casting from a buffer without ensuring correct endianness if porting to big-endian systems (current implementation assumes LE).</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3" title="List of known block types contained in an Aaru image.">BlockType</a> </dd>
|
|
<dd>
|
|
<a class="el" href="enums_8h.html#abda1f9cb04c30fc71ee8c6081d21ee0e" title="Supported checksum / hash algorithms.">ChecksumAlgorithm</a> </dd></dl>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="checksum_8h_source.html">checksum.h</a>.</p>
|
|
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
|
|
<a id="aeba107584fd6e2db8dcc1d790c24734f" name="aeba107584fd6e2db8dcc1d790c24734f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeba107584fd6e2db8dcc1d790c24734f">◆ </a></span>ChecksumEntry</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct ChecksumEntry ChecksumEntry</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a64152a064d0f42344886c7c5576ede2c" name="a64152a064d0f42344886c7c5576ede2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a64152a064d0f42344886c7c5576ede2c">◆ </a></span>ChecksumHeader</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct ChecksumHeader ChecksumHeader</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</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>
|