Google Git
Sign in
apache / incubator-resilientdb-python-sdk / refs/heads/gh-pages / . / namespaceresdb__driver_1_1crypto.html
blob: df7fb1210acdc6272e826558dd8c98ffbfa3c4b8 [file] [log] [blame]
<!-- 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_driver.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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('namespaceresdb__driver_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> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">resdb_driver.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:aece6c66cd73f4f29a81189e90a28d01f" id="r_aece6c66cd73f4f29a81189e90a28d01f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceresdb__driver_1_1crypto.html#a89d590a0327198b1d67cd14ded3c424d">CryptoKeypair</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1crypto.html#aece6c66cd73f4f29a81189e90a28d01f">generate_keypair</a> (seed=None)</td></tr>
<tr class="memdesc:aece6c66cd73f4f29a81189e90a28d01f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a cryptographic key pair. <br /></td></tr>
<tr class="separator:aece6c66cd73f4f29a81189e90a28d01f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f8a3663fd8cb10692bde9e75c68a123" id="r_a7f8a3663fd8cb10692bde9e75c68a123"><td class="memItemLeft" align="right" valign="top">sha3.sha3_256&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1crypto.html#a7f8a3663fd8cb10692bde9e75c68a123">hash_data</a> (data)</td></tr>
<tr class="memdesc:a7f8a3663fd8cb10692bde9e75c68a123"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash the provided data using SHA3-256. <br /></td></tr>
<tr class="separator:a7f8a3663fd8cb10692bde9e75c68a123"><td class="memSeparator" colspan="2">&#160;</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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1crypto.html#a89d590a0327198b1d67cd14ded3c424d">CryptoKeypair</a> = namedtuple(&quot;CryptoKeypair&quot;, (&quot;private_key&quot;, &quot;public_key&quot;))</td></tr>
<tr class="separator:a89d590a0327198b1d67cd14ded3c424d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32010f4ded5408a76cb0db31416438bc" id="r_a32010f4ded5408a76cb0db31416438bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1crypto.html#a32010f4ded5408a76cb0db31416438bc">PrivateKey</a> = crypto.Ed25519SigningKey</td></tr>
<tr class="separator:a32010f4ded5408a76cb0db31416438bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a047dfef5e326f49ee6c832332e0f7763" id="r_a047dfef5e326f49ee6c832332e0f7763"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceresdb__driver_1_1crypto.html#a047dfef5e326f49ee6c832332e0f7763">PublicKey</a> = crypto.Ed25519VerifyingKey</td></tr>
<tr class="separator:a047dfef5e326f49ee6c832332e0f7763"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="aece6c66cd73f4f29a81189e90a28d01f" name="aece6c66cd73f4f29a81189e90a28d01f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aece6c66cd73f4f29a81189e90a28d01f">&#9670;&#160;</a></span>generate_keypair()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> <a class="el" href="namespaceresdb__driver_1_1crypto.html#a89d590a0327198b1d67cd14ded3c424d">CryptoKeypair</a> generate_keypair </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>seed</em> = <code>None</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates a cryptographic key pair. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seed</td><td>(bytes): 32-byte seed for deterministic generation. Defaults to <code>None</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>collections.namedtuple object containing the public and private keys. </dd></dl>
</div>
</div>
<a id="a7f8a3663fd8cb10692bde9e75c68a123" name="a7f8a3663fd8cb10692bde9e75c68a123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f8a3663fd8cb10692bde9e75c68a123">&#9670;&#160;</a></span>hash_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> sha3.sha3_256 hash_data </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hash the provided data using SHA3-256. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Data to be hashed using SHA3-256</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Hashed data </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a89d590a0327198b1d67cd14ded3c424d" name="a89d590a0327198b1d67cd14ded3c424d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89d590a0327198b1d67cd14ded3c424d">&#9670;&#160;</a></span>CryptoKeypair</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CryptoKeypair = namedtuple(&quot;CryptoKeypair&quot;, (&quot;private_key&quot;, &quot;public_key&quot;))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a32010f4ded5408a76cb0db31416438bc" name="a32010f4ded5408a76cb0db31416438bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32010f4ded5408a76cb0db31416438bc">&#9670;&#160;</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">&#9670;&#160;</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__driver.html">resdb_driver</a></li><li class="navelem"><a class="el" href="namespaceresdb__driver_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>