209 lines
10 KiB
HTML
209 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">
|
|
<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::RsaPublicKey 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&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&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="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html">RsaPublicKey</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="../../d3/d7b/classshaka_1_1media_1_1RsaPublicKey-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::media::RsaPublicKey Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Rsa public key, used for signature verification and encryption.
|
|
<a href="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="../../d5/dcf/rsa__key_8h_source.html">rsa_key.h</a>></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:ab9dcf591f3235b8f4eaa02886f9845e3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html#ab9dcf591f3235b8f4eaa02886f9845e3">Encrypt</a> (const std::string &clear_message, std::string *encrypted_message)</td></tr>
|
|
<tr class="separator:ab9dcf591f3235b8f4eaa02886f9845e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a146cc97c8fcacadde1b08c373b766fe4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html#a146cc97c8fcacadde1b08c373b766fe4">VerifySignature</a> (const std::string &message, const std::string &signature)</td></tr>
|
|
<tr class="separator:a146cc97c8fcacadde1b08c373b766fe4"><td class="memSeparator" colspan="2"> </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:aabe4a2f1541ca1e741305f58329e3881"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html">RsaPublicKey</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html#aabe4a2f1541ca1e741305f58329e3881">Create</a> (const std::string &serialized_key)</td></tr>
|
|
<tr class="separator:aabe4a2f1541ca1e741305f58329e3881"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Rsa public key, used for signature verification and encryption. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../d5/dcf/rsa__key_8h_source.html#l00053">53</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="aabe4a2f1541ca1e741305f58329e3881"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabe4a2f1541ca1e741305f58329e3881">◆ </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="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html">RsaPublicKey</a> * shaka::media::RsaPublicKey::Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </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="../../d9/d0c/classshaka_1_1media_1_1RsaPublicKey.html" title="Rsa public key, used for signature verification and encryption.">RsaPublicKey</a> object using a DER encoded PKCS#1 RSAPublicKey. </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#l00171">171</a> of file <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html">rsa_key.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9dcf591f3235b8f4eaa02886f9845e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9dcf591f3235b8f4eaa02886f9845e3">◆ </a></span>Encrypt()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::media::RsaPublicKey::Encrypt </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>clear_message</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::string * </td>
|
|
<td class="paramname"><em>encrypted_message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Encrypt a message using RSA-OAEP. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">encrypted_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#l00176">176</a> of file <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html">rsa_key.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a146cc97c8fcacadde1b08c373b766fe4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a146cc97c8fcacadde1b08c373b766fe4">◆ </a></span>VerifySignature()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool shaka::media::RsaPublicKey::VerifySignature </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>message</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>signature</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Verify RSASSA-PSS signature. </p><dl class="section return"><dt>Returns</dt><dd>true if verification succeeds, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../dc/dd9/rsa__key_8cc_source.html#l00200">200</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|