Files
libaaruformat/docs/html/ps3__encryption__map_8h_source.html

172 lines
17 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.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: src/ps3/ps3_encryption_map.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.16.1 -->
<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('ps3__encryption__map_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">ps3_encryption_map.h</div></div>
</div><!--header-->
<div class="contents">
<a href="ps3__encryption__map_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-2026 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; version 2.1 of the License.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * License along with this library; if not, see</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * &lt;https://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><span class="comment"> * PS3 encryption map: plaintext region parsing, serialization, and lookup.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> */</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef LIBAARUFORMAT_PS3_ENCRYPTION_MAP_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define LIBAARUFORMAT_PS3_ENCRYPTION_MAP_H</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">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>{</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structPs3PlaintextRegion.html"> 33</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structPs3PlaintextRegion.html#a0f8d51bfa05ef8ec55608186331e7991"> 35</a></span> uint32_t <a class="code hl_variable" href="structPs3PlaintextRegion.html#a0f8d51bfa05ef8ec55608186331e7991">start_sector</a>; </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structPs3PlaintextRegion.html#a71978362decd504b3e3ecfb8e05980e4"> 36</a></span> uint32_t <a class="code hl_variable" href="structPs3PlaintextRegion.html#a71978362decd504b3e3ecfb8e05980e4">end_sector</a>; </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="ps3__encryption__map_8h.html#ac127d41fe0c4d12fbef68b46445ea38b"> 37</a></span>} <a class="code hl_struct" href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a>;</div>
</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="ps3__encryption__map_8h.html#a11c7d813ba3cb354fa9998a382e26c97"> 39</a></span><span class="preprocessor">#define PS3_MAX_PLAINTEXT_REGIONS 64</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>int32_t <a class="code hl_function" href="ps3__encryption__map_8h.html#ab646921aa4c83e38af36f38b8b3d068a">ps3_parse_encryption_map</a>(<span class="keyword">const</span> uint8_t *sector0, uint32_t length, <a class="code hl_struct" href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a> **regions,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> uint32_t *count);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>int32_t <a class="code hl_function" href="ps3__encryption__map_8h.html#aebc9066937e11649d0a81351ddd83582">ps3_serialize_encryption_map</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a> *regions, uint32_t count, uint8_t **out_data,</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> uint32_t *out_length);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>int32_t <a class="code hl_function" href="ps3__encryption__map_8h.html#a49a5e6c2b524988714513c446e2d200d">ps3_deserialize_encryption_map</a>(<span class="keyword">const</span> uint8_t *data, uint32_t length, <a class="code hl_struct" href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a> **regions,</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> uint32_t *count);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="keywordtype">bool</span> <a class="code hl_function" href="ps3__encryption__map_8h.html#a058b5191df4b4a83a6bc55052fad503f">ps3_is_sector_encrypted</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a> *plaintext_regions, uint32_t region_count,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> uint64_t sector_address);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#ifdef __cplusplus</span></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"> 92</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif </span><span class="comment">/* LIBAARUFORMAT_PS3_ENCRYPTION_MAP_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aps3__encryption__map_8h_html_a058b5191df4b4a83a6bc55052fad503f"><div class="ttname"><a href="ps3__encryption__map_8h.html#a058b5191df4b4a83a6bc55052fad503f">ps3_is_sector_encrypted</a></div><div class="ttdeci">bool ps3_is_sector_encrypted(const Ps3PlaintextRegion *plaintext_regions, uint32_t region_count, uint64_t sector_address)</div><div class="ttdoc">Check whether a sector is encrypted (i.e., not in any plaintext region).</div><div class="ttdef"><b>Definition</b> <a href="ps3__encryption__map_8c_source.html#l00151">ps3_encryption_map.c:151</a></div></div>
<div class="ttc" id="aps3__encryption__map_8h_html_a49a5e6c2b524988714513c446e2d200d"><div class="ttname"><a href="ps3__encryption__map_8h.html#a49a5e6c2b524988714513c446e2d200d">ps3_deserialize_encryption_map</a></div><div class="ttdeci">int32_t ps3_deserialize_encryption_map(const uint8_t *data, uint32_t length, Ps3PlaintextRegion **regions, uint32_t *count)</div><div class="ttdoc">Deserialize plaintext regions from little-endian binary (media tag format).</div><div class="ttdef"><b>Definition</b> <a href="ps3__encryption__map_8c_source.html#l00117">ps3_encryption_map.c:117</a></div></div>
<div class="ttc" id="aps3__encryption__map_8h_html_ab646921aa4c83e38af36f38b8b3d068a"><div class="ttname"><a href="ps3__encryption__map_8h.html#ab646921aa4c83e38af36f38b8b3d068a">ps3_parse_encryption_map</a></div><div class="ttdeci">int32_t ps3_parse_encryption_map(const uint8_t *sector0, uint32_t length, Ps3PlaintextRegion **regions, uint32_t *count)</div><div class="ttdoc">Parse the encryption map from PS3 disc sector 0 (big-endian on disc).</div><div class="ttdef"><b>Definition</b> <a href="ps3__encryption__map_8c_source.html#l00048">ps3_encryption_map.c:48</a></div></div>
<div class="ttc" id="aps3__encryption__map_8h_html_aebc9066937e11649d0a81351ddd83582"><div class="ttname"><a href="ps3__encryption__map_8h.html#aebc9066937e11649d0a81351ddd83582">ps3_serialize_encryption_map</a></div><div class="ttdeci">int32_t ps3_serialize_encryption_map(const Ps3PlaintextRegion *regions, uint32_t count, uint8_t **out_data, uint32_t *out_length)</div><div class="ttdoc">Serialize plaintext regions to little-endian binary for storage as a media tag.</div><div class="ttdef"><b>Definition</b> <a href="ps3__encryption__map_8c_source.html#l00094">ps3_encryption_map.c:94</a></div></div>
<div class="ttc" id="astructPs3PlaintextRegion_html"><div class="ttname"><a href="structPs3PlaintextRegion.html">Ps3PlaintextRegion</a></div><div class="ttdoc">A plaintext (unencrypted) region on a PS3 disc.</div><div class="ttdef"><b>Definition</b> <a href="#l00033">ps3_encryption_map.h:34</a></div></div>
<div class="ttc" id="astructPs3PlaintextRegion_html_a0f8d51bfa05ef8ec55608186331e7991"><div class="ttname"><a href="structPs3PlaintextRegion.html#a0f8d51bfa05ef8ec55608186331e7991">Ps3PlaintextRegion::start_sector</a></div><div class="ttdeci">uint32_t start_sector</div><div class="ttdoc">First sector of plaintext region (inclusive).</div><div class="ttdef"><b>Definition</b> <a href="#l00035">ps3_encryption_map.h:35</a></div></div>
<div class="ttc" id="astructPs3PlaintextRegion_html_a71978362decd504b3e3ecfb8e05980e4"><div class="ttname"><a href="structPs3PlaintextRegion.html#a71978362decd504b3e3ecfb8e05980e4">Ps3PlaintextRegion::end_sector</a></div><div class="ttdeci">uint32_t end_sector</div><div class="ttdoc">Last sector of plaintext region (inclusive).</div><div class="ttdef"><b>Definition</b> <a href="#l00036">ps3_encryption_map.h:36</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="dir_334a95085ca661c6475619df5f6eaf52.html">ps3</a></li><li class="navelem"><a href="ps3__encryption__map_8h.html">ps3_encryption_map.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.16.1 </li>
</ul>
</div>
</body>
</html>