/usr/share/doc/liblzma-doc/html/check_8c.html is in liblzma-doc 5.2.2-1.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | <!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: liblzma/check/check.c 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>
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2e0898c272e1f0f93c8ef15f5da2a912.html">liblzma</a></li><li class="navelem"><a class="el" href="dir_32e8ef00be12127410478e93c5f07fec.html">check</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">check.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Single API to access different integrity checks.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "check.h"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad30cfdef37f0da36b908299845f63ef2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="check_8c.html#ad30cfdef37f0da36b908299845f63ef2">lzma_check_is_supported</a> (<a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> type)</td></tr>
<tr class="memdesc:ad30cfdef37f0da36b908299845f63ef2"><td class="mdescLeft"> </td><td class="mdescRight">Test if the given Check ID is supported. <a href="#ad30cfdef37f0da36b908299845f63ef2">More...</a><br /></td></tr>
<tr class="separator:ad30cfdef37f0da36b908299845f63ef2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17e75c39b6cb8a0151a6eabfbe78cca9"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="check_8c.html#a17e75c39b6cb8a0151a6eabfbe78cca9">lzma_check_size</a> (<a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> type)</td></tr>
<tr class="memdesc:a17e75c39b6cb8a0151a6eabfbe78cca9"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the Check field with the given Check ID. <a href="#a17e75c39b6cb8a0151a6eabfbe78cca9">More...</a><br /></td></tr>
<tr class="separator:a17e75c39b6cb8a0151a6eabfbe78cca9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb14796081bbe051ca7a08952c7383e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="check_8c.html#aeb14796081bbe051ca7a08952c7383e8">lzma_check_init</a> (<a class="el" href="structlzma__check__state.html">lzma_check_state</a> *<a class="el" href="coder_8c.html#a5c94b0defea7996f245faec2693056cb">check</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> type)</td></tr>
<tr class="memdesc:aeb14796081bbe051ca7a08952c7383e8"><td class="mdescLeft"> </td><td class="mdescRight">Initialize *check depending on type. <a href="#aeb14796081bbe051ca7a08952c7383e8">More...</a><br /></td></tr>
<tr class="separator:aeb14796081bbe051ca7a08952c7383e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5e9d54e127d31eda8e4f31cbe69e150"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="check_8c.html#aa5e9d54e127d31eda8e4f31cbe69e150">lzma_check_update</a> (<a class="el" href="structlzma__check__state.html">lzma_check_state</a> *<a class="el" href="coder_8c.html#a5c94b0defea7996f245faec2693056cb">check</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> type, const uint8_t *buf, size_t size)</td></tr>
<tr class="memdesc:aa5e9d54e127d31eda8e4f31cbe69e150"><td class="mdescLeft"> </td><td class="mdescRight">Update the check state. <a href="#aa5e9d54e127d31eda8e4f31cbe69e150">More...</a><br /></td></tr>
<tr class="separator:aa5e9d54e127d31eda8e4f31cbe69e150"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a682bfef0e2be646de63dbcba0eb6a33e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="check_8c.html#a682bfef0e2be646de63dbcba0eb6a33e">lzma_check_finish</a> (<a class="el" href="structlzma__check__state.html">lzma_check_state</a> *<a class="el" href="coder_8c.html#a5c94b0defea7996f245faec2693056cb">check</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> type)</td></tr>
<tr class="memdesc:a682bfef0e2be646de63dbcba0eb6a33e"><td class="mdescLeft"> </td><td class="mdescRight">Finish the check calculation and store the result to check->buffer.u8. <a href="#a682bfef0e2be646de63dbcba0eb6a33e">More...</a><br /></td></tr>
<tr class="separator:a682bfef0e2be646de63dbcba0eb6a33e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Single API to access different integrity checks. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ad30cfdef37f0da36b908299845f63ef2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad30cfdef37f0da36b908299845f63ef2">◆ </a></span>lzma_check_is_supported()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> lzma_check_is_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> </td>
<td class="paramname"><em>check</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if the given Check ID is supported. </p>
<p>Return true if the given Check ID is supported by this liblzma build. Otherwise false is returned. It is safe to call this with a value that is not in the range [0, 15]; in that case the return value is always false.</p>
<p>You can assume that LZMA_CHECK_NONE and LZMA_CHECK_CRC32 are always supported (even if liblzma is built with limited features). </p>
<p class="reference">References <a class="el" href="api_2lzma_2check_8h.html#acd221ababe30230d9647aab469ad80cb">LZMA_CHECK_ID_MAX</a>.</p>
</div>
</div>
<a id="a17e75c39b6cb8a0151a6eabfbe78cca9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e75c39b6cb8a0151a6eabfbe78cca9">◆ </a></span>lzma_check_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t lzma_check_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> </td>
<td class="paramname"><em>check</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of the Check field with the given Check ID. </p>
<p>Although not all Check IDs have a check algorithm associated, the size of every Check is already frozen. This function returns the size (in bytes) of the Check field with the specified Check ID. The values are: { 0, 4, 4, 4, 8, 8, 8, 16, 16, 16, 32, 32, 32, 64, 64, 64 }</p>
<p>If the argument is not in the range [0, 15], UINT32_MAX is returned. </p>
<p class="reference">References <a class="el" href="api_2lzma_2check_8h.html#acd221ababe30230d9647aab469ad80cb">LZMA_CHECK_ID_MAX</a>.</p>
<p class="reference">Referenced by <a class="el" href="block_8h.html#a6c3e102d76db06a07126a569abc6e2bc">lzma_block_compressed_size()</a>, <a class="el" href="index__hash_8c.html#aedf75aefbcc0b3263898afbb9cab3ef5">lzma_index_hash_decode()</a>, and <a class="el" href="list_8c.html#a9e7a2155d21e8e64be85e248e8a77f62">parse_check_value()</a>.</p>
</div>
</div>
<a id="aeb14796081bbe051ca7a08952c7383e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb14796081bbe051ca7a08952c7383e8">◆ </a></span>lzma_check_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lzma_check_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__check__state.html">lzma_check_state</a> * </td>
<td class="paramname"><em>check</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize *check depending on type. </p>
<dl class="section return"><dt>Returns</dt><dd>LZMA_OK on success. LZMA_UNSUPPORTED_CHECK if the type is not supported by the current version or build of liblzma. LZMA_PROG_ERROR if type > LZMA_CHECK_ID_MAX. </dd></dl>
<p class="reference">References <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3fa0be65014a40b5cb4ab32252b3709bef7">LZMA_CHECK_CRC32</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3fa87b4b0697a1e1ccb6766dd5c2fa24afc">LZMA_CHECK_CRC64</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3fa7b9851d75abfabc08d7fc5b4aaeb6f20">LZMA_CHECK_NONE</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3faf26a55ddd204a50ae87ec3432e7bc309">LZMA_CHECK_SHA256</a>, <a class="el" href="sha256_8c.html#a50600904325e18ab14051ee24bd3264b">lzma_sha256_init()</a>, and <a class="el" href="structlzma__check__state.html#af30e2332a697d110c3fb2e4aa6b99178">lzma_check_state::state</a>.</p>
</div>
</div>
<a id="aa5e9d54e127d31eda8e4f31cbe69e150"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5e9d54e127d31eda8e4f31cbe69e150">◆ </a></span>lzma_check_update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lzma_check_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__check__state.html">lzma_check_state</a> * </td>
<td class="paramname"><em>check</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the check state. </p>
<p class="reference">References <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3fa0be65014a40b5cb4ab32252b3709bef7">LZMA_CHECK_CRC32</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3fa87b4b0697a1e1ccb6766dd5c2fa24afc">LZMA_CHECK_CRC64</a>, <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3faf26a55ddd204a50ae87ec3432e7bc309">LZMA_CHECK_SHA256</a>, <a class="el" href="api_2lzma_2check_8h.html#a760b569cce91bdd01e4ce9d78823c96d">lzma_crc32()</a>, <a class="el" href="api_2lzma_2check_8h.html#aff2e74ce671b9f82a96adb549c68cea2">lzma_crc64()</a>, <a class="el" href="sha256_8c.html#a35110ebc966a6e20c018151ddb556e4a">lzma_sha256_update()</a>, and <a class="el" href="structlzma__check__state.html#af30e2332a697d110c3fb2e4aa6b99178">lzma_check_state::state</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__hash_8c.html#a1670b0c9e4dd89cecdae1327c661efba">hash_append()</a>.</p>
</div>
</div>
<a id="a682bfef0e2be646de63dbcba0eb6a33e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a682bfef0e2be646de63dbcba0eb6a33e">◆ </a></span>lzma_check_finish()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lzma_check_finish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__check__state.html">lzma_check_state</a> * </td>
<td class="paramname"><em>check</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finish the check calculation and store the result to check->buffer.u8. </p>
<p class="reference">References <a class="el" href="structlzma__check__state.html#a66d54715269b349088561ee800cd2356">lzma_check_state::buffer</a>, and <a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3fa0be65014a40b5cb4ab32252b3709bef7">LZMA_CHECK_CRC32</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__hash_8c.html#aedf75aefbcc0b3263898afbb9cab3ef5">lzma_index_hash_decode()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|