GpgFrontend/GpgFrontend-Doxygen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
f9b8d4e563
GpgFrontend-Doxygen/docs/html/classGpgFrontend_1_1KeyPackageOperator.html

388 lines
19 KiB
HTML
Raw Blame History

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: GpgFrontend::KeyPackageOperator 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>
<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.9.1 -->
<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','.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: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('classGpgFrontend_1_1KeyPackageOperator.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="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="classGpgFrontend_1_1KeyPackageOperator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GpgFrontend::KeyPackageOperator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>give the possibility to import or export a key package
<a href="classGpgFrontend_1_1KeyPackageOperator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="KeyPackageOperator_8h_source.html">KeyPackageOperator.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for GpgFrontend::KeyPackageOperator:</div>
<div class="dyncontent">
<div class="center"><img src="classGpgFrontend_1_1KeyPackageOperator__coll__graph.png" border="0" usemap="#aGpgFrontend_1_1KeyPackageOperator_coll__map" alt="Collaboration graph"/></div>
<map name="aGpgFrontend_1_1KeyPackageOperator_coll__map" id="aGpgFrontend_1_1KeyPackageOperator_coll__map">
<area shape="rect" title="give the possibility to import or export a key package" alt="" coords="5,5,252,156"/>
</map>
</div>
<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:a17bd5bca63876fcd201e98c2fca0582c"><td class="memItemLeft" align="right" valign="top">static auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1KeyPackageOperator.html#a17bd5bca63876fcd201e98c2fca0582c">GeneratePassphrase</a> (const QString &amp;phrase_path, QString &amp;phrase) -&gt; bool</td></tr>
<tr class="memdesc:a17bd5bca63876fcd201e98c2fca0582c"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate passphrase for key package and save it to file <a href="classGpgFrontend_1_1KeyPackageOperator.html#a17bd5bca63876fcd201e98c2fca0582c">More...</a><br /></td></tr>
<tr class="separator:a17bd5bca63876fcd201e98c2fca0582c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c987efc6e6a137ac3eb11170220e299"><td class="memItemLeft" align="right" valign="top">static auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1KeyPackageOperator.html#a6c987efc6e6a137ac3eb11170220e299">GenerateKeyPackageName</a> () -&gt; QString</td></tr>
<tr class="memdesc:a6c987efc6e6a137ac3eb11170220e299"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate the name of the key package <a href="classGpgFrontend_1_1KeyPackageOperator.html#a6c987efc6e6a137ac3eb11170220e299">More...</a><br /></td></tr>
<tr class="separator:a6c987efc6e6a137ac3eb11170220e299"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae01e32a99a0008f8b01ad7afb95b93a3"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1KeyPackageOperator.html#ae01e32a99a0008f8b01ad7afb95b93a3">GenerateKeyPackage</a> (const QString &amp;key_package_path, const QString &amp;key_package_name, const KeyArgsList &amp;keys, QString &amp;phrase, bool secret, const OperationCallback &amp;cb)</td></tr>
<tr class="memdesc:ae01e32a99a0008f8b01ad7afb95b93a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate key package <a href="classGpgFrontend_1_1KeyPackageOperator.html#ae01e32a99a0008f8b01ad7afb95b93a3">More...</a><br /></td></tr>
<tr class="separator:ae01e32a99a0008f8b01ad7afb95b93a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b5e580bfd67cfda094c664e2987e319"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1KeyPackageOperator.html#a3b5e580bfd67cfda094c664e2987e319">ImportKeyPackage</a> (const QString &amp;key_package_path, const QString &amp;phrase_path, const OperationCallback &amp;cb)</td></tr>
<tr class="memdesc:a3b5e580bfd67cfda094c664e2987e319"><td class="mdescLeft">&#160;</td><td class="mdescRight">import key package <a href="classGpgFrontend_1_1KeyPackageOperator.html#a3b5e580bfd67cfda094c664e2987e319">More...</a><br /></td></tr>
<tr class="separator:a3b5e580bfd67cfda094c664e2987e319"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr class="memitem:ab0fc5ef8145005f0851311f73f4e7039"><td class="memItemLeft" align="right" valign="top">static auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGpgFrontend_1_1KeyPackageOperator.html#ab0fc5ef8145005f0851311f73f4e7039">generate_key_package_name</a> () -&gt; QString</td></tr>
<tr class="memdesc:ab0fc5ef8145005f0851311f73f4e7039"><td class="mdescLeft">&#160;</td><td class="mdescRight">generate key package name <a href="classGpgFrontend_1_1KeyPackageOperator.html#ab0fc5ef8145005f0851311f73f4e7039">More...</a><br /></td></tr>
<tr class="separator:ab0fc5ef8145005f0851311f73f4e7039"><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>give the possibility to import or export a key package </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab0fc5ef8145005f0851311f73f4e7039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0fc5ef8145005f0851311f73f4e7039">&#9670;&nbsp;</a></span>generate_key_package_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::KeyPackageOperator::generate_key_package_name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; QString</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>generate key package name </p>
<dl class="section return"><dt>Returns</dt><dd>QString key package name </dd></dl>
</div>
</div>
<a id="ae01e32a99a0008f8b01ad7afb95b93a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae01e32a99a0008f8b01ad7afb95b93a3">&#9670;&nbsp;</a></span>GenerateKeyPackage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::KeyPackageOperator::GenerateKeyPackage </td>
<td>(</td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>key_package_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>key_package_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const KeyArgsList &amp;&#160;</td>
<td class="paramname"><em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString &amp;&#160;</td>
<td class="paramname"><em>phrase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>secret</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const OperationCallback &amp;&#160;</td>
<td class="paramname"><em>cb</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>generate key package </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key_package_path</td><td>path to key package </td></tr>
<tr><td class="paramname">key_package_name</td><td>name of the key package </td></tr>
<tr><td class="paramname">key_ids</td><td>key ids to export </td></tr>
<tr><td class="paramname">phrase</td><td>passphrase to encrypt key package </td></tr>
<tr><td class="paramname">secret</td><td>true if secret key should be exported </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if key package was generated </dd>
<dd>
false if key package was not generated </dd></dl>
<p class="reference">References <a class="el" href="namespaceGpgFrontend.html#a864178db4c07b932c2ae6e7a20fe87bf">GpgFrontend::CheckGpgError()</a>, <a class="el" href="namespaceGpgFrontend.html#aa22dc541423cb09a1dd250d458eb069c">GpgFrontend::DescribeGpgErrCode()</a>, <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#ac963fee992753970bfb5c81608d4070f">GpgFrontend::SingletonFunctionObject&lt; GpgKeyImportExporter &gt;::GetInstance()</a>, and <a class="el" href="namespaceGpgFrontend.html#acc93a10f79f6479f72940fba39b780e1">GpgFrontend::WriteFile()</a>.</p>
</div>
</div>
<a id="a6c987efc6e6a137ac3eb11170220e299"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c987efc6e6a137ac3eb11170220e299">&#9670;&nbsp;</a></span>GenerateKeyPackageName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::KeyPackageOperator::GenerateKeyPackageName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> -&gt; QString</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>generate the name of the key package </p>
<dl class="section return"><dt>Returns</dt><dd>QString name of the key package </dd></dl>
<p class="reference">Referenced by <a class="el" href="classGpgFrontend_1_1UI_1_1ExportKeyPackageDialog.html#a7d1899302ef743671c3002d04f6c9dd8">GpgFrontend::UI::ExportKeyPackageDialog::ExportKeyPackageDialog()</a>.</p>
</div>
</div>
<a id="a17bd5bca63876fcd201e98c2fca0582c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17bd5bca63876fcd201e98c2fca0582c">&#9670;&nbsp;</a></span>GeneratePassphrase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto GpgFrontend::KeyPackageOperator::GeneratePassphrase </td>
<td>(</td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>phrase_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString &amp;&#160;</td>
<td class="paramname"><em>phrase</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> -&gt; bool</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>generate passphrase for key package and save it to file </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">phrase_path</td><td>path to passphrase file </td></tr>
<tr><td class="paramname">phrase</td><td>passphrase generated </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if passphrase was generated and saved </dd>
<dd>
false if passphrase was not generated and saved </dd></dl>
<p class="reference">References <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#ac963fee992753970bfb5c81608d4070f">GpgFrontend::SingletonFunctionObject&lt; PassphraseGenerator &gt;::GetInstance()</a>, and <a class="el" href="namespaceGpgFrontend.html#acc93a10f79f6479f72940fba39b780e1">GpgFrontend::WriteFile()</a>.</p>
</div>
</div>
<a id="a3b5e580bfd67cfda094c664e2987e319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b5e580bfd67cfda094c664e2987e319">&#9670;&nbsp;</a></span>ImportKeyPackage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void GpgFrontend::KeyPackageOperator::ImportKeyPackage </td>
<td>(</td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>key_package_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString &amp;&#160;</td>
<td class="paramname"><em>phrase_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const OperationCallback &amp;&#160;</td>
<td class="paramname"><em>cb</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>import key package </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key_package_path</td><td>path to key package </td></tr>
<tr><td class="paramname">phrase_path</td><td>path to passphrase file </td></tr>
<tr><td class="paramname">import_info</td><td>import info </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if key package was imported </dd>
<dd>
false if key package was not imported </dd></dl>
<p class="reference">References <a class="el" href="classGpgFrontend_1_1SingletonFunctionObject.html#ac963fee992753970bfb5c81608d4070f">GpgFrontend::SingletonFunctionObject&lt; GpgKeyImportExporter &gt;::GetInstance()</a>, <a class="el" href="namespaceGpgFrontend.html#a253c30d60238c5c0ed1545d0c7bf31de">GpgFrontend::ReadFile()</a>, and <a class="el" href="namespaceGpgFrontend.html#a9eb3f1dfac3cab84bb08712c3953eb61">GpgFrontend::RunOperaAsync()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/core/function/<a class="el" href="KeyPackageOperator_8h_source.html">KeyPackageOperator.h</a></li>
<li>src/core/function/KeyPackageOperator.cpp</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="namespaceGpgFrontend.html">GpgFrontend</a></li><li class="navelem"><a class="el" href="classGpgFrontend_1_1KeyPackageOperator.html">KeyPackageOperator</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.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink