88 lines
22 KiB
HTML
88 lines
22 KiB
HTML
<!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>Shaka Packager SDK: packager/media/crypto/encryption_handler.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>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Shaka Packager SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</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');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../dir_3f8eec2fc361645de4b1ec14c19fffc7.html">packager</a></li><li class="navelem"><a class="el" href="../../dir_f99dae54fe7170f791f339b952d5067a.html">media</a></li><li class="navelem"><a class="el" href="../../dir_aa847bee70cdde822696c7e33a504139.html">crypto</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">encryption_handler.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2017 Google Inc. All rights reserved.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Use of this source code is governed by a BSD-style</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// license that can be found in the LICENSE file or at</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// https://developers.google.com/open-source/licenses/bsd</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef PACKAGER_MEDIA_CRYPTO_ENCRYPTION_HANDLER_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define PACKAGER_MEDIA_CRYPTO_ENCRYPTION_HANDLER_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "packager/media/base/key_source.h"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "packager/media/base/media_handler.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "packager/media/public/crypto_params.h"</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span><a class="code" href="../../d8/daf/namespaceshaka.html">shaka</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>media {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">class </span>AesCryptor;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">class </span>AesEncryptorFactory;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>SubsampleGenerator;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">struct </span>EncryptionKey;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html"> 22</a></span> <span class="keyword">class </span><a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a> : <span class="keyword">public</span> <a class="code" href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">MediaHandler</a> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a>(<span class="keyword">const</span> <a class="code" href="../../dc/da0/structshaka_1_1EncryptionParams.html">EncryptionParams</a>& encryption_params,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">KeySource</a>* key_source);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  ~<a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html#a3f1808a4386081e5e1c9a798a1a69dd0">InitializeInternal</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html#a7887e6060eb572036674ecb9a7e045c4">Process</a>(std::unique_ptr<StreamData> stream_data) <span class="keyword">override</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">friend</span> <span class="keyword">class </span>EncryptionHandlerTest;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a>(<span class="keyword">const</span> <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a>& operator=(<span class="keyword">const</span> <a class="code" href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">EncryptionHandler</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Processes |stream_info| and sets up stream specific variables.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> ProcessStreamInfo(<span class="keyword">const</span> <a class="code" href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">StreamInfo</a>& stream_info);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// Processes media sample and encrypts it if needed.</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="../../d2/d20/classshaka_1_1Status.html">Status</a> ProcessMediaSample(std::shared_ptr<const MediaSample> clear_sample);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> SetupProtectionPattern(StreamType stream_type);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">bool</span> CreateEncryptor(<span class="keyword">const</span> <a class="code" href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">EncryptionKey</a>& encryption_key);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Encrypt an E-AC3 frame with size |source_size| according to SAMPLE-AES</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// specification. |dest| should have at least |source_size| bytes.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">bool</span> SampleAesEncryptEac3Frame(<span class="keyword">const</span> uint8_t* source,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">size_t</span> source_size,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  uint8_t* dest);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Encrypt an array with size |source_size|. |dest| should have at</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// least |source_size| bytes.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">void</span> EncryptBytes(<span class="keyword">const</span> uint8_t* source, <span class="keywordtype">size_t</span> source_size, uint8_t* dest);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// An E-AC3 frame comprises of one or more syncframes. This function extracts</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// the syncframe sizes from the source bytes.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// Returns false if the frame is not well formed.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> ExtractEac3SyncframeSizes(<span class="keyword">const</span> uint8_t* source,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">size_t</span> source_size,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::vector<size_t>* syncframe_sizes);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// Testing injections.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> InjectSubsampleGeneratorForTesting(</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::unique_ptr<SubsampleGenerator> generator);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> InjectEncryptorFactoryForTesting(</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::unique_ptr<AesEncryptorFactory> encryptor_factory);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> <a class="code" href="../../dc/da0/structshaka_1_1EncryptionParams.html">EncryptionParams</a> encryption_params_;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">const</span> FourCC protection_scheme_ = FOURCC_NULL;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">KeySource</a>* key_source_ = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  std::string stream_label_;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// Current encryption config and encryptor.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::shared_ptr<EncryptionConfig> encryption_config_;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::unique_ptr<AesCryptor> encryptor_;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  Codec codec_ = kUnknownCodec;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// Remaining clear lead in the stream's time scale.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  int64_t remaining_clear_lead_ = 0;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// Crypto period duration in the stream's time scale.</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  uint64_t crypto_period_duration_ = 0;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// Previous crypto period index if key rotation is enabled.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  int64_t prev_crypto_period_index_ = -1;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> check_new_crypto_period_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::unique_ptr<SubsampleGenerator> subsample_generator_;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::unique_ptr<AesEncryptorFactory> encryptor_factory_;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">// Number of encrypted blocks (16-byte-block) in pattern based encryption.</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  uint8_t crypt_byte_block_ = 0;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  uint8_t skip_byte_block_ = 0;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } <span class="comment">// namespace media</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> } <span class="comment">// namespace shaka</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif // PACKAGER_MEDIA_CRYPTO_ENCRYPTION_HANDLER_H_</span></div><div class="ttc" id="classshaka_1_1media_1_1StreamInfo_html"><div class="ttname"><a href="../../d5/db1/classshaka_1_1media_1_1StreamInfo.html">shaka::media::StreamInfo</a></div><div class="ttdoc">Abstract class holds stream information. </div><div class="ttdef"><b>Definition:</b> <a href="../../d8/daa/stream__info_8h_source.html#l00061">stream_info.h:61</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1EncryptionHandler_html"><div class="ttname"><a href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html">shaka::media::EncryptionHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dd/dbc/encryption__handler_8h_source.html#l00022">encryption_handler.h:22</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1MediaHandler_html"><div class="ttname"><a href="../../da/dfd/classshaka_1_1media_1_1MediaHandler.html">shaka::media::MediaHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d93/media__handler_8h_source.html#l00154">media_handler.h:154</a></div></div>
|
|
<div class="ttc" id="namespaceshaka_html"><div class="ttname"><a href="../../d8/daf/namespaceshaka.html">shaka</a></div><div class="ttdoc">All the methods that are virtual are virtual for mocking. </div><div class="ttdef"><b>Definition:</b> <a href="../../d4/d15/gflags__hex__bytes_8cc_source.html#l00011">gflags_hex_bytes.cc:11</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1Status_html"><div class="ttname"><a href="../../d2/d20/classshaka_1_1Status.html">shaka::Status</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d1/d13/status_8h_source.html#l00110">status.h:110</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1EncryptionHandler_html_a3f1808a4386081e5e1c9a798a1a69dd0"><div class="ttname"><a href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html#a3f1808a4386081e5e1c9a798a1a69dd0">shaka::media::EncryptionHandler::InitializeInternal</a></div><div class="ttdeci">Status InitializeInternal() override</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d9c/encryption__handler_8cc_source.html#l00082">encryption_handler.cc:82</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1EncryptionHandler_html_a7887e6060eb572036674ecb9a7e045c4"><div class="ttname"><a href="../../d6/d4c/classshaka_1_1media_1_1EncryptionHandler.html#a7887e6060eb572036674ecb9a7e045c4">shaka::media::EncryptionHandler::Process</a></div><div class="ttdeci">Status Process(std::unique_ptr< StreamData > stream_data) override</div><div class="ttdef"><b>Definition:</b> <a href="../../d3/d9c/encryption__handler_8cc_source.html#l00093">encryption_handler.cc:93</a></div></div>
|
|
<div class="ttc" id="structshaka_1_1media_1_1EncryptionKey_html"><div class="ttname"><a href="../../dd/dbd/structshaka_1_1media_1_1EncryptionKey.html">shaka::media::EncryptionKey</a></div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d3f/key__source_8h_source.html#l00038">key_source.h:38</a></div></div>
|
|
<div class="ttc" id="structshaka_1_1EncryptionParams_html"><div class="ttname"><a href="../../dc/da0/structshaka_1_1EncryptionParams.html">shaka::EncryptionParams</a></div><div class="ttdoc">Encryption parameters. </div><div class="ttdef"><b>Definition:</b> <a href="../../dd/d58/crypto__params_8h_source.html#l00108">crypto_params.h:108</a></div></div>
|
|
<div class="ttc" id="classshaka_1_1media_1_1KeySource_html"><div class="ttname"><a href="../../d1/d1f/classshaka_1_1media_1_1KeySource.html">shaka::media::KeySource</a></div><div class="ttdoc">KeySource is responsible for encryption key acquisition. </div><div class="ttdef"><b>Definition:</b> <a href="../../dc/d3f/key__source_8h_source.html#l00048">key_source.h:48</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Dec 20 2018 14:37:37 for Shaka Packager SDK 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>
|