GpgFrontend-Doxygen/docs/html/KeyPackageOperator_8h_source.html

153 lines
16 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>GpgFrontend Project: src/core/function/KeyPackageOperator.h Source File</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" />
</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">GpgFrontend Project
</div>
<div id="projectbrief">A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.</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>
</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('KeyPackageOperator_8h_source.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">KeyPackageOperator.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#ifndef GPGFRONTEND_KEYPACKAGEOPERATOR_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define GPGFRONTEND_KEYPACKAGEOPERATOR_H</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;core/GpgFrontendCore.h&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;core/function/gpg/GpgKeyImportExporter.h&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceGpgFrontend.html">GpgFrontend</a> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1KeyPackageOperator.html"> 41</a></span>&#160;<span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code" href="classGpgFrontend_1_1KeyPackageOperator.html">KeyPackageOperator</a> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> GeneratePassphrase(<span class="keyword">const</span> std::filesystem::path &amp;phrase_path,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; std::string &amp;phrase);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">static</span> std::string GenerateKeyPackageName();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> GenerateKeyPackage(<span class="keyword">const</span> std::filesystem::path &amp;key_package_path,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">const</span> std::string &amp;key_package_name,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; KeyIdArgsListPtr &amp;key_ids, std::string &amp;phrase,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">bool</span> secret);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> ImportKeyPackage(<span class="keyword">const</span> std::filesystem::path &amp;key_package_path,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">const</span> std::filesystem::path &amp;phrase_path,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="code" href="classGpgFrontend_1_1GpgImportInformation.html">GpgFrontend::GpgImportInformation</a> &amp;import_info);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1KeyPackageOperator.html#a825d987dacd8a99d9d87729e1861a152"> 96</a></span>&#160; <span class="keyword">static</span> std::string <a class="code" href="classGpgFrontend_1_1KeyPackageOperator.html#a825d987dacd8a99d9d87729e1861a152">generate_key_package_name</a>() {</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; std::random_device rd_; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keyword">auto</span> mt_ = std::mt19937(rd_()); </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; std::uniform_int_distribution&lt;int&gt; dist(999, 99999);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">auto</span> file_string = boost::format(<span class="stringliteral">&quot;KeyPackage_%1%&quot;</span>) % dist(mt_);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> file_string.str();</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;};</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;} <span class="comment">// namespace GpgFrontend</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="preprocessor">#endif // GPGFRONTEND_KEYPACKAGEOPERATOR_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassGpgFrontend_1_1FileOperator_html_a51121c94dc32a83d7073fbe7138b603b"><div class="ttname"><a href="classGpgFrontend_1_1FileOperator.html#a51121c94dc32a83d7073fbe7138b603b">GpgFrontend::FileOperator::WriteFileStd</a></div><div class="ttdeci">static bool WriteFileStd(const std::filesystem::path &amp;file_name, const std::string &amp;data)</div><div class="ttdoc">write file content using std struct</div><div class="ttdef"><b>Definition:</b> FileOperator.cpp:67</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1KeyPackageOperator_html_a825d987dacd8a99d9d87729e1861a152"><div class="ttname"><a href="classGpgFrontend_1_1KeyPackageOperator.html#a825d987dacd8a99d9d87729e1861a152">GpgFrontend::KeyPackageOperator::generate_key_package_name</a></div><div class="ttdeci">static std::string generate_key_package_name()</div><div class="ttdoc">generate key package name</div><div class="ttdef"><b>Definition:</b> KeyPackageOperator.h:96</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1KeyPackageOperator_html_a89538b180a42eb7d6ae53583fe10ee07"><div class="ttname"><a href="classGpgFrontend_1_1KeyPackageOperator.html#a89538b180a42eb7d6ae53583fe10ee07">GpgFrontend::KeyPackageOperator::ImportKeyPackage</a></div><div class="ttdeci">static bool ImportKeyPackage(const std::filesystem::path &amp;key_package_path, const std::filesystem::path &amp;phrase_path, GpgFrontend::GpgImportInformation &amp;import_info)</div><div class="ttdoc">import key package</div><div class="ttdef"><b>Definition:</b> KeyPackageOperator.cpp:71</div></div>
<div class="ttc" id="anamespaceGpgFrontend_html"><div class="ttname"><a href="namespaceGpgFrontend.html">GpgFrontend</a></div><div class="ttdef"><b>Definition:</b> CoreCommonUtil.cpp:29</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1KeyPackageOperator_html_ae90b362a32b6f6014cda1dc232bd3f0e"><div class="ttname"><a href="classGpgFrontend_1_1KeyPackageOperator.html#ae90b362a32b6f6014cda1dc232bd3f0e">GpgFrontend::KeyPackageOperator::GenerateKeyPackageName</a></div><div class="ttdeci">static std::string GenerateKeyPackageName()</div><div class="ttdoc">generate the name of the key package</div><div class="ttdef"><b>Definition:</b> KeyPackageOperator.cpp:116</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1SingletonFunctionObject_html_a70484d7cfe9f9dcbcd5f8bb749250f36"><div class="ttname"><a href="classGpgFrontend_1_1SingletonFunctionObject.html#a70484d7cfe9f9dcbcd5f8bb749250f36">GpgFrontend::SingletonFunctionObject&lt; PassphraseGenerator &gt;::GetInstance</a></div><div class="ttdeci">static PassphraseGenerator &amp; GetInstance(int channel=GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL)</div><div class="ttdoc">Get the Instance object.</div><div class="ttdef"><b>Definition:</b> GpgFunctionObject.h:181</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1PassphraseGenerator_html_a8b4ee1083343fba6d947b85cd66079b8"><div class="ttname"><a href="classGpgFrontend_1_1PassphraseGenerator.html#a8b4ee1083343fba6d947b85cd66079b8">GpgFrontend::PassphraseGenerator::Generate</a></div><div class="ttdeci">std::string Generate(int len)</div><div class="ttdoc">generate passphrase</div><div class="ttdef"><b>Definition:</b> PassphraseGenerator.h:60</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1KeyPackageOperator_html_ade02f022e405e98377343c4667c206e9"><div class="ttname"><a href="classGpgFrontend_1_1KeyPackageOperator.html#ade02f022e405e98377343c4667c206e9">GpgFrontend::KeyPackageOperator::GenerateKeyPackage</a></div><div class="ttdeci">static bool GenerateKeyPackage(const std::filesystem::path &amp;key_package_path, const std::string &amp;key_package_name, KeyIdArgsListPtr &amp;key_ids, std::string &amp;phrase, bool secret)</div><div class="ttdoc">generate key package</div><div class="ttdef"><b>Definition:</b> KeyPackageOperator.cpp:46</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1KeyPackageOperator_html_a6d9cf022a1e0cf54c061495f59c1b4b9"><div class="ttname"><a href="classGpgFrontend_1_1KeyPackageOperator.html#a6d9cf022a1e0cf54c061495f59c1b4b9">GpgFrontend::KeyPackageOperator::GeneratePassphrase</a></div><div class="ttdeci">static bool GeneratePassphrase(const std::filesystem::path &amp;phrase_path, std::string &amp;phrase)</div><div class="ttdoc">generate passphrase for key package and save it to file</div><div class="ttdef"><b>Definition:</b> KeyPackageOperator.cpp:39</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1FileOperator_html_ad4424bce4f22ae75a16c542dfb4ddf0a"><div class="ttname"><a href="classGpgFrontend_1_1FileOperator.html#ad4424bce4f22ae75a16c542dfb4ddf0a">GpgFrontend::FileOperator::ReadFileStd</a></div><div class="ttdeci">static bool ReadFileStd(const std::filesystem::path &amp;file_name, std::string &amp;data)</div><div class="ttdoc">read file content using std struct</div><div class="ttdef"><b>Definition:</b> FileOperator.cpp:55</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgKeyImportExporter_html_ab7a9be5283047695cd47562775adf79d"><div class="ttname"><a href="classGpgFrontend_1_1GpgKeyImportExporter.html#ab7a9be5283047695cd47562775adf79d">GpgFrontend::GpgKeyImportExporter::ImportKey</a></div><div class="ttdeci">GpgImportInformation ImportKey(StdBypeArrayPtr inBuffer)</div><div class="ttdef"><b>Definition:</b> GpgKeyImportExporter.cpp:42</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1KeyPackageOperator_html"><div class="ttname"><a href="classGpgFrontend_1_1KeyPackageOperator.html">GpgFrontend::KeyPackageOperator</a></div><div class="ttdoc">give the possibility to import or export a key package</div><div class="ttdef"><b>Definition:</b> KeyPackageOperator.h:41</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgImportInformation_html"><div class="ttname"><a href="classGpgFrontend_1_1GpgImportInformation.html">GpgFrontend::GpgImportInformation</a></div><div class="ttdef"><b>Definition:</b> GpgKeyImportExporter.h:57</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_f8a0abd6d3586538a5b71803e0ab7ffa.html">function</a></li><li class="navelem"><b>KeyPackageOperator.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>