<!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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libfilezilla: signature.hpp 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="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="libfilezilla.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libfilezilla </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> <!-- 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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_bfd4f94fea6b65a4615f91ddf59adbf8.html">libfilezilla</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">signature.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="signature_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef LIBFILEZILLA_SIGNATURE_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_SIGNATURE_HEADER</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="libfilezilla_8hpp.html">libfilezilla.hpp</a>"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classfz_1_1public__verification__key.html"> 21</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1public__verification__key.html">public_verification_key</a></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">enum</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  key_size = 32</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  };</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">return</span> key_.size() == key_size;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> operator==(<a class="code" href="classfz_1_1public__verification__key.html">public_verification_key</a> <span class="keyword">const</span>& rhs)<span class="keyword"> const </span>{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">return</span> key_ == rhs.key_;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">bool</span> operator!=(<a class="code" href="classfz_1_1public__verification__key.html">public_verification_key</a> <span class="keyword">const</span>& rhs)<span class="keyword"> const </span>{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == rhs);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">bool</span> operator<(<a class="code" href="classfz_1_1public__verification__key.html">public_verification_key</a> <span class="keyword">const</span>& rhs)<span class="keyword"> const </span>{</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">return</span> key_ < rhs.key_;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::string to_base64() <span class="keyword">const</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">static</span> <a class="code" href="classfz_1_1public__verification__key.html">public_verification_key</a> from_base64(std::string_view <span class="keyword">const</span>& base64);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::vector<uint8_t> key_;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> };</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classfz_1_1private__signing__key.html"> 54</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1private__signing__key.html">private_signing_key</a></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">enum</span> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  key_size = 32</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">static</span> <a class="code" href="classfz_1_1private__signing__key.html">private_signing_key</a> generate();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> key_.size() == key_size;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classfz_1_1public__verification__key.html">public_verification_key</a> pubkey() <span class="keyword">const</span>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  std::vector<uint8_t> <span class="keyword">const</span>& data()<span class="keyword"> const </span>{</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">return</span> key_;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  std::string to_base64() <span class="keyword">const</span>; <span class="comment">// Keep secret!</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">static</span> <a class="code" href="classfz_1_1private__signing__key.html">private_signing_key</a> from_base64(std::string_view <span class="keyword">const</span>& base64);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::vector<uint8_t> key_;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> };</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  signature_size = 64</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> };</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> std::vector<uint8_t> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#ad44b800153b4a4ff947abc680d1c5dda">sign</a>(std::vector<uint8_t> <span class="keyword">const</span>& message, private_signing_key <span class="keyword">const</span>& priv, <span class="keywordtype">bool</span> include_message = <span class="keyword">true</span>);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> std::vector<uint8_t> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#ad44b800153b4a4ff947abc680d1c5dda">sign</a>(std::string_view <span class="keyword">const</span>& message, private_signing_key <span class="keyword">const</span>& priv, <span class="keywordtype">bool</span> include_message = <span class="keyword">true</span>);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> std::vector<uint8_t> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#ad44b800153b4a4ff947abc680d1c5dda">sign</a>(uint8_t <span class="keyword">const</span>* message, <span class="keywordtype">size_t</span> <span class="keyword">const</span> size, private_signing_key <span class="keyword">const</span>& priv, <span class="keywordtype">bool</span> include_message = <span class="keyword">true</span>);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">bool</span> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">verify</a>(std::vector<uint8_t> <span class="keyword">const</span>& message, public_verification_key <span class="keyword">const</span>& pub);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">bool</span> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">verify</a>(std::string_view <span class="keyword">const</span>& message, public_verification_key <span class="keyword">const</span>& pub);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="keywordtype">bool</span> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">verify</a>(uint8_t <span class="keyword">const</span>* message, <span class="keywordtype">size_t</span> <span class="keyword">const</span> size, public_verification_key <span class="keyword">const</span>& pub);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">bool</span> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">verify</a>(std::vector<uint8_t> <span class="keyword">const</span>& message, std::vector<uint8_t> <span class="keyword">const</span>& signature, public_verification_key <span class="keyword">const</span>& pub);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">bool</span> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">verify</a>(std::string_view <span class="keyword">const</span>& message, std::string_view <span class="keyword">const</span>& signature, public_verification_key <span class="keyword">const</span>& pub);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">bool</span> FZ_PUBLIC_SYMBOL <a class="code" href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">verify</a>(uint8_t <span class="keyword">const</span>* message, <span class="keywordtype">size_t</span> <span class="keyword">const</span> message_size, uint8_t <span class="keyword">const</span>* signature, <span class="keywordtype">size_t</span> <span class="keyword">const</span> sig_size, public_verification_key <span class="keyword">const</span>& pub);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classfz_1_1private__signing__key_html"><div class="ttname"><a href="classfz_1_1private__signing__key.html">fz::private_signing_key</a></div><div class="ttdoc">Represents a private key to sign message with using Ed25519.</div><div class="ttdef"><b>Definition:</b> signature.hpp:54</div></div> <div class="ttc" id="classfz_1_1public__verification__key_html"><div class="ttname"><a href="classfz_1_1public__verification__key.html">fz::public_verification_key</a></div><div class="ttdoc">Represents a public key to verify messages signed using Ed25519.</div><div class="ttdef"><b>Definition:</b> signature.hpp:21</div></div> <div class="ttc" id="namespacefz_html"><div class="ttname"><a href="namespacefz.html">fz</a></div><div class="ttdoc">The namespace used by libfilezilla.</div><div class="ttdef"><b>Definition:</b> apply.hpp:17</div></div> <div class="ttc" id="namespacefz_html_ad44b800153b4a4ff947abc680d1c5dda"><div class="ttname"><a href="namespacefz.html#ad44b800153b4a4ff947abc680d1c5dda">fz::sign</a></div><div class="ttdeci">std::vector< uint8_t > sign(std::vector< uint8_t > const &message, private_signing_key const &priv, bool include_message=true)</div><div class="ttdoc">Returns the message with the signature appended, created using the passed private key.</div></div> <div class="ttc" id="libfilezilla_8hpp_html"><div class="ttname"><a href="libfilezilla_8hpp.html">libfilezilla.hpp</a></div><div class="ttdoc">Sets some global macros and further includes string.hpp.</div></div> <div class="ttc" id="namespacefz_html_a69813290d622d4c1c1973f50008904c3"><div class="ttname"><a href="namespacefz.html#a69813290d622d4c1c1973f50008904c3">fz::verify</a></div><div class="ttdeci">bool verify(std::vector< uint8_t > const &message, public_verification_key const &pub)</div><div class="ttdoc">Verify a message with attached signature. Returns true iff it has been signed by the private key corr...</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>