GpgFrontend-Doxygen/docs/html/GpgSubKey_8h_source.html

175 lines
16 KiB
HTML
Raw Normal View History

2022-05-08 19:59:26 +00:00
<!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"/>
2022-05-08 22:01:23 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
2022-05-08 19:59:26 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GpgFrontend Project: src/core/model/GpgSubKey.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>
2022-05-08 22:01:23 +00:00
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
2022-05-08 19:59:26 +00:00
<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 -->
2022-05-08 19:59:26 +00:00
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2022-05-08 19:59:26 +00:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-05-08 22:01:23 +00:00
/* @license-end */</script>
2022-05-08 19:59:26 +00:00
<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">
2022-05-08 22:01:23 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
2022-05-08 19:59:26 +00:00
$(document).ready(function(){initNavTree('GpgSubKey_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">
2022-05-08 22:01:23 +00:00
<div class="headertitle">
<div class="title">GpgSubKey.h</div> </div>
2022-05-08 19:59:26 +00:00
</div><!--header-->
<div class="contents">
2022-05-08 22:01:23 +00:00
<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_GPGSUBKEY_H</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define GPGFRONTEND_GPGSUBKEY_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 &lt;boost/date_time.hpp&gt;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;string&gt;</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="preprocessor">#include &quot;core/GpgConstants.h&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceGpgFrontend.html">GpgFrontend</a> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html"> 43</a></span>&#160;<span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; [[nodiscard]] std::string GetID() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; [[nodiscard]] std::string GetFingerprint() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; [[nodiscard]] std::string GetPubkeyAlgo() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; [[nodiscard]] <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetKeyLength() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsHasEncryptionCapability() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsHasSigningCapability() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsHasCertificationCapability() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsHasAuthenticationCapability() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsPrivateKey() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsExpired() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsRevoked() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsDisabled() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsSecretKey() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; [[nodiscard]] <span class="keywordtype">bool</span> IsCardKey() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; [[nodiscard]] boost::posix_time::ptime GetCreateTime() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; [[nodiscard]] boost::posix_time::ptime GetExpireTime() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html#a59eba8a9d23429140e9a68126c9c7c5e"> 171</a></span>&#160; <a class="code" href="classGpgFrontend_1_1GpgSubKey.html#a59eba8a9d23429140e9a68126c9c7c5e">GpgSubKey</a>();</div>
2022-05-08 22:01:23 +00:00
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; </div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>(gpgme_subkey_t subkey);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>(<a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;&amp; o) noexcept;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; </div>
<div class="line"><a name="l00191"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html#a6e8df85f8c1dea7705b761e68bb949ab"> 191</a></span>&#160; <a class="code" href="classGpgFrontend_1_1GpgSubKey.html#a6e8df85f8c1dea7705b761e68bb949ab">GpgSubKey</a>(<span class="keyword">const</span> <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;) = <span class="keyword">delete</span>;</div>
2022-05-08 22:01:23 +00:00
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp; operator=(<a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;&amp; o) noexcept;</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; </div>
<div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html#ac4187d50f525188c6aaea29a86f83bba"> 206</a></span>&#160; <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp; <a class="code" href="classGpgFrontend_1_1GpgSubKey.html#ac4187d50f525188c6aaea29a86f83bba">operator=</a>(<span class="keyword">const</span> <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;) = <span class="keyword">delete</span>;</div>
2022-05-08 22:01:23 +00:00
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; </div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp; o) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; </div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keyword">using</span> SubkeyRefHandler =</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; std::unique_ptr&lt;<span class="keyword">struct </span>_gpgme_subkey,</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; std::function&lt;void(gpgme_subkey_t)&gt;&gt;; </div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; </div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; SubkeyRefHandler _subkey_ref = nullptr; </div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;};</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; </div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;} <span class="comment">// namespace GpgFrontend</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; </div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// GPGFRONTEND_GPGSUBKEY_H</span></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgSubKey_html"><div class="ttname"><a href="classGpgFrontend_1_1GpgSubKey.html">GpgFrontend::GpgSubKey</a></div><div class="ttdef"><b>Definition:</b> GpgSubKey.h:43</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgSubKey_html_a59eba8a9d23429140e9a68126c9c7c5e"><div class="ttname"><a href="classGpgFrontend_1_1GpgSubKey.html#a59eba8a9d23429140e9a68126c9c7c5e">GpgFrontend::GpgSubKey::GpgSubKey</a></div><div class="ttdeci">GpgSubKey()</div><div class="ttdoc">Construct a new Gpg Sub Key object.</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgSubKey_html_a6e8df85f8c1dea7705b761e68bb949ab"><div class="ttname"><a href="classGpgFrontend_1_1GpgSubKey.html#a6e8df85f8c1dea7705b761e68bb949ab">GpgFrontend::GpgSubKey::GpgSubKey</a></div><div class="ttdeci">GpgSubKey(const GpgSubKey &amp;)=delete</div><div class="ttdoc">Construct a new Gpg Sub Key object.</div></div>
<div class="ttc" id="aclassGpgFrontend_1_1GpgSubKey_html_ac4187d50f525188c6aaea29a86f83bba"><div class="ttname"><a href="classGpgFrontend_1_1GpgSubKey.html#ac4187d50f525188c6aaea29a86f83bba">GpgFrontend::GpgSubKey::operator=</a></div><div class="ttdeci">GpgSubKey &amp; operator=(const GpgSubKey &amp;)=delete</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>
2022-05-08 19:59:26 +00:00
</div><!-- fragment --></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="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_db6209eff64d15a114e6ff7aefbf1abd.html">model</a></li><li class="navelem"><b>GpgSubKey.h</b></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>
2022-05-08 19:59:26 +00:00
</ul>
</div>
</body>
</html>