| <!-- HTML header for doxygen 1.9.8--> |
| <!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.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>ResilientDB SDK: resdb_validator.crypto Namespace 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.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" /> |
| <link href="doxygen_html_style.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="projectlogo"><img alt="Logo" src="logo.png"/></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </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"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function(){initNavTree('namespaceresdb__validator_1_1crypto.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <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="summary"> |
| <a href="#func-members">Functions</a> | |
| <a href="#var-members">Variables</a> </div> |
| <div class="headertitle"><div class="title">resdb_validator.crypto Namespace Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a871a9b3d787044ba017d316a104dd739" id="r_a871a9b3d787044ba017d316a104dd739"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#a871a9b3d787044ba017d316a104dd739">generate_key_pair</a> ()</td></tr> |
| <tr class="separator:a871a9b3d787044ba017d316a104dd739"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adcc8a1a96df1980c8db7f4e62ba6bf06" id="r_adcc8a1a96df1980c8db7f4e62ba6bf06"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#adcc8a1a96df1980c8db7f4e62ba6bf06">hash_data</a> (data)</td></tr> |
| <tr class="separator:adcc8a1a96df1980c8db7f4e62ba6bf06"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac53b67466e3762ec0cbbaf63755db7de" id="r_ac53b67466e3762ec0cbbaf63755db7de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#ac53b67466e3762ec0cbbaf63755db7de">key_pair_from_ed25519_key</a> (hex_private_key)</td></tr> |
| <tr class="separator:ac53b67466e3762ec0cbbaf63755db7de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3888b8a31538fdcf0f75083ac65bb198" id="r_a3888b8a31538fdcf0f75083ac65bb198"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#a3888b8a31538fdcf0f75083ac65bb198">public_key_from_ed25519_key</a> (hex_public_key)</td></tr> |
| <tr class="separator:a3888b8a31538fdcf0f75083ac65bb198"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a> |
| Variables</h2></td></tr> |
| <tr class="memitem:a89d590a0327198b1d67cd14ded3c424d" id="r_a89d590a0327198b1d67cd14ded3c424d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#a89d590a0327198b1d67cd14ded3c424d">CryptoKeypair</a> = namedtuple('CryptoKeypair', ('private_key', 'public_key'))</td></tr> |
| <tr class="separator:a89d590a0327198b1d67cd14ded3c424d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a32010f4ded5408a76cb0db31416438bc" id="r_a32010f4ded5408a76cb0db31416438bc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#a32010f4ded5408a76cb0db31416438bc">PrivateKey</a> = crypto.Ed25519SigningKey</td></tr> |
| <tr class="separator:a32010f4ded5408a76cb0db31416438bc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a047dfef5e326f49ee6c832332e0f7763" id="r_a047dfef5e326f49ee6c832332e0f7763"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__validator_1_1crypto.html#a047dfef5e326f49ee6c832332e0f7763">PublicKey</a> = crypto.Ed25519VerifyingKey</td></tr> |
| <tr class="separator:a047dfef5e326f49ee6c832332e0f7763"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="a871a9b3d787044ba017d316a104dd739" name="a871a9b3d787044ba017d316a104dd739"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a871a9b3d787044ba017d316a104dd739">◆ </a></span>generate_key_pair()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">generate_key_pair </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Generates a cryptographic key pair. |
| |
| Returns: |
| :class:`~resdb_validator.crypto.CryptoKeypair`: A |
| :obj:`collections.namedtuple` with named fields |
| :attr:`~resdb_validator.crypto.CryptoKeypair.private_key` and |
| :attr:`~resdb_validator.crypto.CryptoKeypair.public_key`.</pre> |
| </div> |
| </div> |
| <a id="adcc8a1a96df1980c8db7f4e62ba6bf06" name="adcc8a1a96df1980c8db7f4e62ba6bf06"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adcc8a1a96df1980c8db7f4e62ba6bf06">◆ </a></span>hash_data()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">hash_data </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>data</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Hash the provided data using SHA3-256</pre> |
| </div> |
| </div> |
| <a id="ac53b67466e3762ec0cbbaf63755db7de" name="ac53b67466e3762ec0cbbaf63755db7de"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac53b67466e3762ec0cbbaf63755db7de">◆ </a></span>key_pair_from_ed25519_key()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">key_pair_from_ed25519_key </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>hex_private_key</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Generate base58 encode public-private key pair from a hex encoded private key</pre> |
| </div> |
| </div> |
| <a id="a3888b8a31538fdcf0f75083ac65bb198" name="a3888b8a31538fdcf0f75083ac65bb198"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3888b8a31538fdcf0f75083ac65bb198">◆ </a></span>public_key_from_ed25519_key()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">public_key_from_ed25519_key </td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname"><em>hex_public_key</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <pre class="fragment">Generate base58 public key from hex encoded public key</pre> |
| </div> |
| </div> |
| <h2 class="groupheader">Variable Documentation</h2> |
| <a id="a89d590a0327198b1d67cd14ded3c424d" name="a89d590a0327198b1d67cd14ded3c424d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a89d590a0327198b1d67cd14ded3c424d">◆ </a></span>CryptoKeypair</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">CryptoKeypair = namedtuple('CryptoKeypair', ('private_key', 'public_key'))</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a32010f4ded5408a76cb0db31416438bc" name="a32010f4ded5408a76cb0db31416438bc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a32010f4ded5408a76cb0db31416438bc">◆ </a></span>PrivateKey</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PrivateKey = crypto.Ed25519SigningKey</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a047dfef5e326f49ee6c832332e0f7763" name="a047dfef5e326f49ee6c832332e0f7763"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a047dfef5e326f49ee6c832332e0f7763">◆ </a></span>PublicKey</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PublicKey = crypto.Ed25519VerifyingKey</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceresdb__validator.html">resdb_validator</a></li><li class="navelem"><a class="el" href="namespaceresdb__validator_1_1crypto.html">crypto</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.9.8 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
