<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: base32.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="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">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">base32.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="base32_8h.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="comment">// base32.h - written and placed in the public domain by Frank Palazzolo, based on hex.cpp by Wei Dai</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// extended hex alphabet added by JW in November, 2017.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// \file base32.h</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/// \brief Classes for Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef CRYPTOPP_BASE32_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define CRYPTOPP_BASE32_H</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="basecode_8h.html">basecode.h</a>"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</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="comment">/// \brief Base32 encodes data using DUDE encoding</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span><span class="comment">/// \details Converts data to base32 using DUDE encoding. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span><span class="comment">/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="class_base32_encoder.html"> 18</a></span> <span class="comment"></span>class <a class="code" href="class_base32_encoder.html">Base32Encoder</a> : public <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> /// \brief Construct a Base32Encoder</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> /// \param attachment a BufferedTrasformation to attach to this object</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> /// \param uppercase a flag indicating uppercase output</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// \param groupSize the size of the grouping</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /// \param separator the separator to use between groups</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /// \param terminator the terminator appeand after processing</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// \details Base32Encoder() constructs a default encoder. The constructor lacks fields for padding and</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// line breaks. You must use IsolatedInitialize() to change the default padding character or suppress it.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="class_base32_encoder.html#a573f15d574aa5c5377963d3b44ca02be"> 30</a></span> <span class="comment"></span> <a class="code" href="class_base32_encoder.html#a573f15d574aa5c5377963d3b44ca02be">Base32Encoder</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <span class="keywordtype">bool</span> uppercase = <span class="keyword">true</span>, <span class="keywordtype">int</span> groupSize = 0, <span class="keyword">const</span> std::string &separator = <span class="stringliteral">":"</span>, <span class="keyword">const</span> std::string &terminator = <span class="stringliteral">""</span>)</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  : <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a>(new <a class="code" href="class_base_n___encoder.html">BaseN_Encoder</a>(new <a class="code" href="class_grouper.html">Grouper</a>), attachment)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  IsolatedInitialize(<a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<a class="code" href="namespace_name.html#afc26b6002da461c2c47f9499606eea75">Name::Uppercase</a>(), uppercase)(<a class="code" href="namespace_name.html#a7f4ebc815a21415c8887db5386683e6d">Name::GroupSize</a>(), groupSize)(<a class="code" href="namespace_name.html#ae643e94c7650c4954138160967a1a336">Name::Separator</a>(), <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(separator))(<a class="code" href="namespace_name.html#a874ade26c7b181c3272a1c89deb0f8bf">Name::Terminator</a>(), <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(terminator)));</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> <span class="comment"></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> /// \brief Initialize or reinitialize this object, without signal propagation</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// \param parameters a set of NameValuePairs used to initialize this object</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// \details IsolatedInitialize() is used to initialize or reinitialize an object using a variable</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// number of arbitrarily typed arguments. IsolatedInitialize() does not call Initialize() on attached</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// transformations. If initialization should be propagated, then use the Initialize() function.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// \details The following code modifies the padding and line break parameters for an encoder:</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// Base32Encoder encoder;</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// AlgorithmParameters params = MakeParameters(Pad(), false)(InsertLineBreaks(), false);</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// encoder.IsolatedInitialize(params);</pre></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// \details You can change the encoding to <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// 32 Encoding with Extended Hex Alphabet</A> by performing the following:</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// Base32Encoder encoder;</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// const byte ALPHABET[] = "0123456789ABCDEFGHIJKLMNOPQRSTUV";</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /// AlgorithmParameters params = MakeParameters(Name::EncodingLookupArray(),(const byte *)ALPHABET);</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /// encoder.IsolatedInitialize(params);</pre></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /// \details If you change the encoding alphabet, then you will need to change the decoding alphabet \a and</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// the decoder's lookup table.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> <span class="keywordtype">void</span> IsolatedInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/// \brief Base32 decodes data using DUDE encoding</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/// \details Converts data from base32 using DUDE encoding. The default code is based on <A HREF="http://www.ietf.org/proceedings/51/I-D/draft-ietf-idn-dude-02.txt">Differential Unicode Domain Encoding (DUDE) (draft-ietf-idn-dude-02.txt)</A>.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="class_base32_decoder.html"> 62</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_base32_decoder.html">Base32Decoder</a> : <span class="keyword">public</span> <a class="code" href="class_base_n___decoder.html">BaseN_Decoder</a></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">public</span>:<span class="comment"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /// \brief Construct a Base32Decoder</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /// \param attachment a BufferedTrasformation to attach to this object</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// \sa IsolatedInitialize() for an example of modifying a Base32Decoder after construction.</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="class_base32_decoder.html#a943fd123a4eff191401db619bb821f49"> 68</a></span> <span class="comment"></span> <a class="code" href="class_base32_decoder.html#a943fd123a4eff191401db619bb821f49">Base32Decoder</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  : <a class="code" href="class_base_n___decoder.html">BaseN_Decoder</a>(GetDefaultDecodingLookupArray(), 5, attachment) {}</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// \brief Initialize or reinitialize this object, without signal propagation</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /// \param parameters a set of NameValuePairs used to initialize this object</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> /// \details IsolatedInitialize() is used to initialize or reinitialize an object using a variable</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// number of arbitrarily typed arguments. IsolatedInitialize() does not call Initialize() on attached</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// transformations. If initialization should be propagated, then use the Initialize() function.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> /// \details You can change the encoding to <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /// 32 Encoding with Extended Hex Alphabet</A> by performing the following:</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> /// int lookup[256];</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> /// const byte ALPHABET[] = "0123456789ABCDEFGHIJKLMNOPQRSTUV";</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// Base32Decoder::InitializeDecodingLookupArray(lookup, ALPHABET, 32, true /*insensitive*/);</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> ///</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> /// Base32Decoder decoder;</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> /// AlgorithmParameters params = MakeParameters(Name::DecodingLookupArray(),(const int *)lookup);</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /// decoder.IsolatedInitialize(params);</pre></span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_base32_decoder.html#a4b013b73a5fa3038c9ac654cd0aceb40">IsolatedInitialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">private</span>:<span class="comment"></span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /// \brief Provides the default decoding lookup table</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /// \return default decoding lookup table</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> * CRYPTOPP_API GetDefaultDecodingLookupArray();</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/// \brief Base32 encodes data using extended hex</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/// \details Converts data to base32 using extended hex alphabet. The alphabet is different than Base32Encoder.</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base 32 Encoding with Extended Hex Alphabet</A>.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/// \since Crypto++ 6.0</span></div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="class_base32_hex_encoder.html"> 99</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_base32_hex_encoder.html">Base32HexEncoder</a> : <span class="keyword">public</span> <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a></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> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// \brief Construct a Base32HexEncoder</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /// \param attachment a BufferedTrasformation to attach to this object</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /// \param uppercase a flag indicating uppercase output</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /// \param groupSize the size of the grouping</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> /// \param separator the separator to use between groups</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /// \param terminator the terminator appeand after processing</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// \details Base32HexEncoder() constructs a default encoder. The constructor lacks fields for padding and</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// line breaks. You must use IsolatedInitialize() to change the default padding character or suppress it.</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="class_base32_hex_encoder.html#acb1149899322e7ffc42ecc9c13145e72"> 111</a></span> <span class="comment"></span> <a class="code" href="class_base32_hex_encoder.html#acb1149899322e7ffc42ecc9c13145e72">Base32HexEncoder</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <span class="keywordtype">bool</span> uppercase = <span class="keyword">true</span>, <span class="keywordtype">int</span> groupSize = 0, <span class="keyword">const</span> std::string &separator = <span class="stringliteral">":"</span>, <span class="keyword">const</span> std::string &terminator = <span class="stringliteral">""</span>)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  : <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a>(new <a class="code" href="class_base_n___encoder.html">BaseN_Encoder</a>(new <a class="code" href="class_grouper.html">Grouper</a>), attachment)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="class_base32_hex_encoder.html#acf376889cb49d2eb9d795d3290b7c204">IsolatedInitialize</a>(<a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<a class="code" href="namespace_name.html#afc26b6002da461c2c47f9499606eea75">Name::Uppercase</a>(), uppercase)(<a class="code" href="namespace_name.html#a7f4ebc815a21415c8887db5386683e6d">Name::GroupSize</a>(), groupSize)(<a class="code" href="namespace_name.html#ae643e94c7650c4954138160967a1a336">Name::Separator</a>(), <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(separator))(<a class="code" href="namespace_name.html#a874ade26c7b181c3272a1c89deb0f8bf">Name::Terminator</a>(), <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(terminator)));</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /// \brief Initialize or reinitialize this object, without signal propagation</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> /// \param parameters a set of NameValuePairs used to initialize this object</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> /// \details IsolatedInitialize() is used to initialize or reinitialize an object using a variable</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /// number of arbitrarily typed arguments. IsolatedInitialize() does not call Initialize() on attached</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /// transformations. If initialization should be propagated, then use the Initialize() function.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> /// \details The following code modifies the padding and line break parameters for an encoder:</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> /// Base32HexEncoder encoder;</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> /// AlgorithmParameters params = MakeParameters(Pad(), false)(InsertLineBreaks(), false);</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /// encoder.IsolatedInitialize(params);</pre></span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_base32_hex_encoder.html#acf376889cb49d2eb9d795d3290b7c204">IsolatedInitialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> };</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"></span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">/// \brief Base32 decodes data using extended hex</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">/// \details Converts data from base32 using extended hex alphabet. The alphabet is different than Base32Decoder.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder, <A HREF="http://tools.ietf.org/html/rfc4648#page-10">RFC 4648, Base 32 Encoding with Extended Hex Alphabet</A>.</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/// \since Crypto++ 6.0</span></div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="class_base32_hex_decoder.html"> 134</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_base32_hex_decoder.html">Base32HexDecoder</a> : <span class="keyword">public</span> <a class="code" href="class_base_n___decoder.html">BaseN_Decoder</a></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /// \brief Construct a Base32HexDecoder</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /// \param attachment a BufferedTrasformation to attach to this object</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> /// \sa Base32Encoder, Base32Decoder, Base32HexEncoder and Base32HexDecoder</span></div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="class_base32_hex_decoder.html#a714100c1881792c70bfdd75b2e1b9720"> 140</a></span> <span class="comment"></span> <a class="code" href="class_base32_hex_decoder.html#a714100c1881792c70bfdd75b2e1b9720">Base32HexDecoder</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  : <a class="code" href="class_base_n___decoder.html">BaseN_Decoder</a>(GetDefaultDecodingLookupArray(), 5, attachment) {}</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"></span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> /// \brief Initialize or reinitialize this object, without signal propagation</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> /// \param parameters a set of NameValuePairs used to initialize this object</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /// \details IsolatedInitialize() is used to initialize or reinitialize an object using a variable</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /// number of arbitrarily typed arguments. IsolatedInitialize() does not call Initialize() on attached</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> /// transformations. If initialization should be propagated, then use the Initialize() function.</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_base32_hex_decoder.html#a6d6e227952e5ab9046ccca6460d67e62">IsolatedInitialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="keyword">private</span>:<span class="comment"></span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> /// \brief Provides the default decoding lookup table</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> /// \return default decoding lookup table</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> * CRYPTOPP_API GetDefaultDecodingLookupArray();</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> };</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> NAMESPACE_END</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_const_byte_array_parameter_html"><div class="ttname"><a href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a></div><div class="ttdoc">Used to pass byte array input as part of a NameValuePairs object. </div><div class="ttdef"><b>Definition:</b> <a href="algparam_8h_source.html#l00020">algparam.h:20</a></div></div>
<div class="ttc" id="class_base32_encoder_html"><div class="ttname"><a href="class_base32_encoder.html">Base32Encoder</a></div><div class="ttdoc">Base32 encodes data using DUDE encoding. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00018">base32.h:18</a></div></div>
<div class="ttc" id="namespace_name_html_afc26b6002da461c2c47f9499606eea75"><div class="ttname"><a href="namespace_name.html#afc26b6002da461c2c47f9499606eea75">Name::Uppercase</a></div><div class="ttdeci">const char * Uppercase()</div><div class="ttdoc">bool </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00070">argnames.h:70</a></div></div>
<div class="ttc" id="class_base32_hex_encoder_html_acf376889cb49d2eb9d795d3290b7c204"><div class="ttname"><a href="class_base32_hex_encoder.html#acf376889cb49d2eb9d795d3290b7c204">Base32HexEncoder::IsolatedInitialize</a></div><div class="ttdeci">void IsolatedInitialize(const NameValuePairs &parameters)</div><div class="ttdoc">Initialize or reinitialize this object, without signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8cpp_source.html#l00076">base32.cpp:76</a></div></div>
<div class="ttc" id="class_base32_hex_encoder_html"><div class="ttname"><a href="class_base32_hex_encoder.html">Base32HexEncoder</a></div><div class="ttdoc">Base32 encodes data using extended hex. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00099">base32.h:99</a></div></div>
<div class="ttc" id="class_base32_hex_decoder_html_a6d6e227952e5ab9046ccca6460d67e62"><div class="ttname"><a href="class_base32_hex_decoder.html#a6d6e227952e5ab9046ccca6460d67e62">Base32HexDecoder::IsolatedInitialize</a></div><div class="ttdeci">void IsolatedInitialize(const NameValuePairs &parameters)</div><div class="ttdoc">Initialize or reinitialize this object, without signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8cpp_source.html#l00084">base32.cpp:84</a></div></div>
<div class="ttc" id="cryptlib_8h_html"><div class="ttname"><a href="cryptlib_8h.html">cryptlib.h</a></div><div class="ttdoc">Abstract base classes that provide a uniform interface to this library. </div></div>
<div class="ttc" id="class_buffered_transformation_html"><div class="ttname"><a href="class_buffered_transformation.html">BufferedTransformation</a></div><div class="ttdoc">Interface for buffered transformations. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01545">cryptlib.h:1545</a></div></div>
<div class="ttc" id="namespace_name_html_ae643e94c7650c4954138160967a1a336"><div class="ttname"><a href="namespace_name.html#ae643e94c7650c4954138160967a1a336">Name::Separator</a></div><div class="ttdeci">const char * Separator()</div><div class="ttdoc">ConstByteArrayParameter. </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00068">argnames.h:68</a></div></div>
<div class="ttc" id="class_base32_encoder_html_a573f15d574aa5c5377963d3b44ca02be"><div class="ttname"><a href="class_base32_encoder.html#a573f15d574aa5c5377963d3b44ca02be">Base32Encoder::Base32Encoder</a></div><div class="ttdeci">Base32Encoder(BufferedTransformation *attachment=NULL, bool uppercase=true, int groupSize=0, const std::string &separator=":", const std::string &terminator="")</div><div class="ttdoc">Construct a Base32Encoder. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00030">base32.h:30</a></div></div>
<div class="ttc" id="algparam_8h_html_aa13eee74de98cf8aaa7e83f4fae7f28b"><div class="ttname"><a href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a></div><div class="ttdeci">AlgorithmParameters MakeParameters(const char *name, const T &value, bool throwIfNotUsed=true)</div><div class="ttdoc">Create an object that implements NameValuePairs. </div><div class="ttdef"><b>Definition:</b> <a href="algparam_8h_source.html#l00502">algparam.h:502</a></div></div>
<div class="ttc" id="class_base32_hex_encoder_html_acb1149899322e7ffc42ecc9c13145e72"><div class="ttname"><a href="class_base32_hex_encoder.html#acb1149899322e7ffc42ecc9c13145e72">Base32HexEncoder::Base32HexEncoder</a></div><div class="ttdeci">Base32HexEncoder(BufferedTransformation *attachment=NULL, bool uppercase=true, int groupSize=0, const std::string &separator=":", const std::string &terminator="")</div><div class="ttdoc">Construct a Base32HexEncoder. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00111">base32.h:111</a></div></div>
<div class="ttc" id="class_simple_proxy_filter_html"><div class="ttname"><a href="class_simple_proxy_filter.html">SimpleProxyFilter</a></div><div class="ttdoc">Proxy filter that doesn&#39;t modify the underlying filter&#39;s input or output. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01002">filters.h:1002</a></div></div>
<div class="ttc" id="namespace_name_html_a7f4ebc815a21415c8887db5386683e6d"><div class="ttname"><a href="namespace_name.html#a7f4ebc815a21415c8887db5386683e6d">Name::GroupSize</a></div><div class="ttdeci">const char * GroupSize()</div><div class="ttdoc">int </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00071">argnames.h:71</a></div></div>
<div class="ttc" id="namespace_name_html_a874ade26c7b181c3272a1c89deb0f8bf"><div class="ttname"><a href="namespace_name.html#a874ade26c7b181c3272a1c89deb0f8bf">Name::Terminator</a></div><div class="ttdeci">const char * Terminator()</div><div class="ttdoc">ConstByteArrayParameter. </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00069">argnames.h:69</a></div></div>
<div class="ttc" id="class_base32_decoder_html_a4b013b73a5fa3038c9ac654cd0aceb40"><div class="ttname"><a href="class_base32_decoder.html#a4b013b73a5fa3038c9ac654cd0aceb40">Base32Decoder::IsolatedInitialize</a></div><div class="ttdeci">void IsolatedInitialize(const NameValuePairs &parameters)</div><div class="ttdoc">Initialize or reinitialize this object, without signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8cpp_source.html#l00063">base32.cpp:63</a></div></div>
<div class="ttc" id="class_base32_decoder_html_a943fd123a4eff191401db619bb821f49"><div class="ttname"><a href="class_base32_decoder.html#a943fd123a4eff191401db619bb821f49">Base32Decoder::Base32Decoder</a></div><div class="ttdeci">Base32Decoder(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a Base32Decoder. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00068">base32.h:68</a></div></div>
<div class="ttc" id="class_base32_hex_decoder_html_a714100c1881792c70bfdd75b2e1b9720"><div class="ttname"><a href="class_base32_hex_decoder.html#a714100c1881792c70bfdd75b2e1b9720">Base32HexDecoder::Base32HexDecoder</a></div><div class="ttdeci">Base32HexDecoder(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a Base32HexDecoder. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00140">base32.h:140</a></div></div>
<div class="ttc" id="class_base32_hex_decoder_html"><div class="ttname"><a href="class_base32_hex_decoder.html">Base32HexDecoder</a></div><div class="ttdoc">Base32 decodes data using extended hex. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00134">base32.h:134</a></div></div>
<div class="ttc" id="class_grouper_html"><div class="ttname"><a href="class_grouper.html">Grouper</a></div><div class="ttdoc">Filter that breaks input stream into groups of fixed size. </div><div class="ttdef"><b>Definition:</b> <a href="basecode_8h_source.html#l00107">basecode.h:107</a></div></div>
<div class="ttc" id="class_base32_decoder_html"><div class="ttname"><a href="class_base32_decoder.html">Base32Decoder</a></div><div class="ttdoc">Base32 decodes data using DUDE encoding. </div><div class="ttdef"><b>Definition:</b> <a href="base32_8h_source.html#l00062">base32.h:62</a></div></div>
<div class="ttc" id="namespace_crypto_p_p_html"><div class="ttname"><a href="namespace_crypto_p_p.html">CryptoPP</a></div><div class="ttdoc">Crypto++ library namespace. </div></div>
<div class="ttc" id="class_base_n___encoder_html"><div class="ttname"><a href="class_base_n___encoder.html">BaseN_Encoder</a></div><div class="ttdoc">Encoder for bases that are a power of 2. </div><div class="ttdef"><b>Definition:</b> <a href="basecode_8h_source.html#l00017">basecode.h:17</a></div></div>
<div class="ttc" id="basecode_8h_html"><div class="ttname"><a href="basecode_8h.html">basecode.h</a></div><div class="ttdoc">Base classes for working with encoders and decoders. </div></div>
<div class="ttc" id="class_base_n___decoder_html"><div class="ttname"><a href="class_base_n___decoder.html">BaseN_Decoder</a></div><div class="ttdoc">Decoder for bases that are a power of 2. </div><div class="ttdef"><b>Definition:</b> <a href="basecode_8h_source.html#l00056">basecode.h:56</a></div></div>
<div class="ttc" id="class_name_value_pairs_html"><div class="ttname"><a href="class_name_value_pairs.html">NameValuePairs</a></div><div class="ttdoc">Interface for retrieving values given their names. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00290">cryptlib.h:290</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:57:45 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
204
