Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/d0/dce/classshaka_1_1media_1_1RsaP...

215 lines
10 KiB
HTML
Raw Permalink Blame History

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Shaka Packager SDK: shaka::media::RsaPrivateKey Class 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="../../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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><b>media</b></li><li class="navelem"><a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html">RsaPrivateKey</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="../../df/d51/classshaka_1_1media_1_1RsaPrivateKey-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shaka::media::RsaPrivateKey Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Rsa private key, used for message signing and decryption.
<a href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../d5/dcf/rsa__key_8h_source.html">rsa_key.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a89a475ffe2d96bfab09536b864038ca4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html#a89a475ffe2d96bfab09536b864038ca4">Decrypt</a> (const std::string &amp;encrypted_message, std::string *decrypted_message)</td></tr>
<tr class="separator:a89a475ffe2d96bfab09536b864038ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad05d8951dfe3a8af754490022e95e5f2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html#ad05d8951dfe3a8af754490022e95e5f2">GenerateSignature</a> (const std::string &amp;message, std::string *signature)</td></tr>
<tr class="separator:ad05d8951dfe3a8af754490022e95e5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aef45d0014d7971b936ce3d0109935ba8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html">RsaPrivateKey</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html#aef45d0014d7971b936ce3d0109935ba8">Create</a> (const std::string &amp;serialized_key)</td></tr>
<tr class="separator:aef45d0014d7971b936ce3d0109935ba8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Rsa private key, used for message signing and decryption. </p>
<p class="definition">Definition at line <a class="el" href="../../d5/dcf/rsa__key_8h_source.html#l00024">24</a> of file <a class="el" href="../../d5/dcf/rsa__key_8h_source.html">rsa_key.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aef45d0014d7971b936ce3d0109935ba8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef45d0014d7971b936ce3d0109935ba8">&#9670;&nbsp;</a></span>Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html">RsaPrivateKey</a> * shaka::media::RsaPrivateKey::Create </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>serialized_key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an <a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html" title="Rsa private key, used for message signing and decryption.">RsaPrivateKey</a> object using a DER encoded PKCS#1 RSAPrivateKey. </p><dl class="section return"><dt>Returns</dt><dd>The created <a class="el" href="../../d0/dce/classshaka_1_1media_1_1RsaPrivateKey.html" title="Rsa private key, used for message signing and decryption.">RsaPrivateKey</a> object on success, NULL otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html#l00096">96</a> of file <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html">rsa_key.cc</a>.</p>
</div>
</div>
<a id="a89a475ffe2d96bfab09536b864038ca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89a475ffe2d96bfab09536b864038ca4">&#9670;&nbsp;</a></span>Decrypt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::RsaPrivateKey::Decrypt </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>encrypted_message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>decrypted_message</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrypt a message using RSA-OAEP. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">decrypted_message</td><td>must not be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html#l00101">101</a> of file <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html">rsa_key.cc</a>.</p>
</div>
</div>
<a id="ad05d8951dfe3a8af754490022e95e5f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad05d8951dfe3a8af754490022e95e5f2">&#9670;&nbsp;</a></span>GenerateSignature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool shaka::media::RsaPrivateKey::GenerateSignature </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>signature</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate RSASSA-PSS signature. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">signature</td><td>must not be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html#l00127">127</a> of file <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html">rsa_key.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>packager/media/base/<a class="el" href="../../d5/dcf/rsa__key_8h_source.html">rsa_key.h</a></li>
<li>packager/media/base/<a class="el" href="../../dc/dd9/rsa__key_8cc_source.html">rsa_key.cc</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 22 2021 00:16:05 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink