dash-docs/en/doxygen/html/classCMasterKey.html

336 lines
16 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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Dash Core: CMasterKey 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="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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectlogo"><img alt="Logo" src="bitcoin_logo_doxygen.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Dash Core
&#160;<span id="projectnumber">0.12.2.1</span>
</div>
<div id="projectbrief">P2P Digital Currency</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classCMasterKey.html','');});
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classCMasterKey-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CMasterKey Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="crypter_8h_source.html">crypter.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:a32456e3080cf3a9818850f3c458594ea"><td class="memTemplParams" colspan="2">template&lt;typename Stream , typename Operation &gt; </td></tr>
<tr class="memitem:a32456e3080cf3a9818850f3c458594ea"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#a32456e3080cf3a9818850f3c458594ea">SerializationOp</a> (Stream &amp;s, Operation ser_action, int nType, int nVersion)</td></tr>
<tr class="separator:a32456e3080cf3a9818850f3c458594ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a267244f9eaaf6ef5a71cb2faa393cdea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#a267244f9eaaf6ef5a71cb2faa393cdea">CMasterKey</a> ()</td></tr>
<tr class="separator:a267244f9eaaf6ef5a71cb2faa393cdea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab52e0eaabb0eb3af78fc4879c192e163"><td class="memItemLeft" align="right" valign="top">std::vector&lt; unsigned char &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#ab52e0eaabb0eb3af78fc4879c192e163">vchCryptedKey</a></td></tr>
<tr class="separator:ab52e0eaabb0eb3af78fc4879c192e163"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00009f4b4feaa2ebe630a0d7cc854d3a"><td class="memItemLeft" align="right" valign="top">std::vector&lt; unsigned char &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#a00009f4b4feaa2ebe630a0d7cc854d3a">vchSalt</a></td></tr>
<tr class="separator:a00009f4b4feaa2ebe630a0d7cc854d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a4b1e432a30011297f496441769957f"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#a7a4b1e432a30011297f496441769957f">nDerivationMethod</a></td></tr>
<tr class="separator:a7a4b1e432a30011297f496441769957f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec53e0be82d1053cf5a70a67fd4cc25d"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#aec53e0be82d1053cf5a70a67fd4cc25d">nDeriveIterations</a></td></tr>
<tr class="separator:aec53e0be82d1053cf5a70a67fd4cc25d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfd00b311d5e5cf9ae1a6f3877ed35f7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; unsigned char &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#abfd00b311d5e5cf9ae1a6f3877ed35f7">vchOtherDerivationParameters</a></td></tr>
<tr class="separator:abfd00b311d5e5cf9ae1a6f3877ed35f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e49e2a9206051c91388b2077eacb8c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCMasterKey.html#a0e49e2a9206051c91388b2077eacb8c8">ADD_SERIALIZE_METHODS</a></td></tr>
<tr class="separator:a0e49e2a9206051c91388b2077eacb8c8"><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>Private key encryption is done based on a <a class="el" href="classCMasterKey.html">CMasterKey</a>, which holds a salt and random encryption key.</p>
<p>CMasterKeys are encrypted using AES-256-CBC using a key derived using derivation method nDerivationMethod (0 == EVP_sha512()) and derivation iterations nDeriveIterations. vchOtherDerivationParameters is provided for alternative algorithms which may require more parameters (such as scrypt).</p>
<p>Wallet Private Keys are then encrypted using AES-256-CBC with the double-sha256 of the public key as the IV, and the master key's key as the encryption key (see keystore.[ch]).Master key for wallet encryption </p>
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00033">33</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a267244f9eaaf6ef5a71cb2faa393cdea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a267244f9eaaf6ef5a71cb2faa393cdea">&#9670;&nbsp;</a></span>CMasterKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CMasterKey::CMasterKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00057">57</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a32456e3080cf3a9818850f3c458594ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32456e3080cf3a9818850f3c458594ea">&#9670;&nbsp;</a></span>SerializationOp()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Stream , typename Operation &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CMasterKey::SerializationOp </td>
<td>(</td>
<td class="paramtype">Stream &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Operation&#160;</td>
<td class="paramname"><em>ser_action</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nVersion</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00049">49</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0e49e2a9206051c91388b2077eacb8c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e49e2a9206051c91388b2077eacb8c8">&#9670;&nbsp;</a></span>ADD_SERIALIZE_METHODS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CMasterKey::ADD_SERIALIZE_METHODS</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00046">46</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
</div>
</div>
<a id="a7a4b1e432a30011297f496441769957f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a4b1e432a30011297f496441769957f">&#9670;&nbsp;</a></span>nDerivationMethod</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int CMasterKey::nDerivationMethod</td>
</tr>
</table>
</div><div class="memdoc">
<p>0 = EVP_sha512() 1 = scrypt() </p>
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00040">40</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="crypter_8h_source.html#l00057">CMasterKey()</a>, <a class="el" href="wallet_8cpp_source.html#l00723">CWallet::EncryptWallet()</a>, and <a class="el" href="crypter_8h_source.html#l00049">SerializationOp()</a>.</p>
</div>
</div>
<a id="aec53e0be82d1053cf5a70a67fd4cc25d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec53e0be82d1053cf5a70a67fd4cc25d">&#9670;&nbsp;</a></span>nDeriveIterations</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int CMasterKey::nDeriveIterations</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00041">41</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="crypter_8h_source.html#l00057">CMasterKey()</a>, <a class="el" href="wallet_8cpp_source.html#l00723">CWallet::EncryptWallet()</a>, and <a class="el" href="crypter_8h_source.html#l00049">SerializationOp()</a>.</p>
</div>
</div>
<a id="ab52e0eaabb0eb3af78fc4879c192e163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab52e0eaabb0eb3af78fc4879c192e163">&#9670;&nbsp;</a></span>vchCryptedKey</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;unsigned char&gt; CMasterKey::vchCryptedKey</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00036">36</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="wallet_8cpp_source.html#l00723">CWallet::EncryptWallet()</a>, and <a class="el" href="crypter_8h_source.html#l00049">SerializationOp()</a>.</p>
</div>
</div>
<a id="abfd00b311d5e5cf9ae1a6f3877ed35f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfd00b311d5e5cf9ae1a6f3877ed35f7">&#9670;&nbsp;</a></span>vchOtherDerivationParameters</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;unsigned char&gt; CMasterKey::vchOtherDerivationParameters</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this for more parameters to key derivation, such as the various parameters to scrypt </p>
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00044">44</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="crypter_8h_source.html#l00057">CMasterKey()</a>, and <a class="el" href="crypter_8h_source.html#l00049">SerializationOp()</a>.</p>
</div>
</div>
<a id="a00009f4b4feaa2ebe630a0d7cc854d3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00009f4b4feaa2ebe630a0d7cc854d3a">&#9670;&nbsp;</a></span>vchSalt</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;unsigned char&gt; CMasterKey::vchSalt</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="crypter_8h_source.html#l00037">37</a> of file <a class="el" href="crypter_8h_source.html">crypter.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="wallet_8cpp_source.html#l00723">CWallet::EncryptWallet()</a>, and <a class="el" href="crypter_8h_source.html#l00049">SerializationOp()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/wallet/<a class="el" href="crypter_8h_source.html">crypter.h</a></li>
</ul>
</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="classCMasterKey.html">CMasterKey</a></li>
<li class="footer">Generated on Thu Dec 14 2017 13:15:12 for Dash Core by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>