GpgFrontend-Doxygen/docs/html/GpgSubKey_8h_source.html
2022-05-09 03:59:26 +08:00

175 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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<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>
<tr id="projectrow">
<td id="projectalign">
<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.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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('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">
<div class="headertitle"><div class="title">GpgSubKey.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#ifndef GPGFRONTEND_GPGSUBKEY_H</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#define GPGFRONTEND_GPGSUBKEY_H</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &lt;boost/date_time.hpp&gt;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#include &quot;core/GpgConstants.h&quot;</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceGpgFrontend.html">GpgFrontend</a> {</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html"> 43</a></span><span class="keyword">class </span>GPGFRONTEND_CORE_EXPORT <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> [[nodiscard]] std::string GetID() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> [[nodiscard]] std::string GetFingerprint() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> [[nodiscard]] std::string GetPubkeyAlgo() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> [[nodiscard]] <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetKeyLength() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> [[nodiscard]] <span class="keywordtype">bool</span> IsHasEncryptionCapability() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> [[nodiscard]] <span class="keywordtype">bool</span> IsHasSigningCapability() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> [[nodiscard]] <span class="keywordtype">bool</span> IsHasCertificationCapability() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> [[nodiscard]] <span class="keywordtype">bool</span> IsHasAuthenticationCapability() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> [[nodiscard]] <span class="keywordtype">bool</span> IsPrivateKey() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> [[nodiscard]] <span class="keywordtype">bool</span> IsExpired() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> [[nodiscard]] <span class="keywordtype">bool</span> IsRevoked() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> [[nodiscard]] <span class="keywordtype">bool</span> IsDisabled() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> [[nodiscard]] <span class="keywordtype">bool</span> IsSecretKey() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> [[nodiscard]] <span class="keywordtype">bool</span> IsCardKey() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> [[nodiscard]] boost::posix_time::ptime GetCreateTime() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> [[nodiscard]] boost::posix_time::ptime GetExpireTime() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html#a59eba8a9d23429140e9a68126c9c7c5e"> 171</a></span> <a class="code hl_function" href="classGpgFrontend_1_1GpgSubKey.html#a59eba8a9d23429140e9a68126c9c7c5e">GpgSubKey</a>();</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>(gpgme_subkey_t subkey);</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>(<a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;&amp; o) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html#a6e8df85f8c1dea7705b761e68bb949ab"> 191</a></span> <a class="code hl_function" href="classGpgFrontend_1_1GpgSubKey.html#a6e8df85f8c1dea7705b761e68bb949ab">GpgSubKey</a>(<span class="keyword">const</span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp; operator=(<a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;&amp; o) <span class="keyword">noexcept</span>;</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"><a class="line" href="classGpgFrontend_1_1GpgSubKey.html#aaac65bcd0a1236a0a09ecde285a59e29"> 206</a></span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp; <a class="code hl_function" href="classGpgFrontend_1_1GpgSubKey.html#aaac65bcd0a1236a0a09ecde285a59e29">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_class" href="classGpgFrontend_1_1GpgSubKey.html">GpgSubKey</a>&amp; o) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> <span class="keyword">using</span> SubkeyRefHandler =</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> std::unique_ptr&lt;<span class="keyword">struct </span>_gpgme_subkey,</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> std::function&lt;void(gpgme_subkey_t)&gt;&gt;; </div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> </div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> SubkeyRefHandler _subkey_ref = nullptr; </div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span>};</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span>} <span class="comment">// namespace GpgFrontend</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span><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_aaac65bcd0a1236a0a09ecde285a59e29"><div class="ttname"><a href="classGpgFrontend_1_1GpgSubKey.html#aaac65bcd0a1236a0a09ecde285a59e29">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>
</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.3 </li>
</ul>
</div>
</body>
</html>