<!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++: filters.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">filters.h</div> </div> </div><!--header--> <div class="contents"> <a href="filters_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">// filters.h - originally written and placed in the public domain by Wei Dai</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/// \file filters.h</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// \brief Implementation of BufferedTransformation's attachment interface.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef CRYPTOPP_FILTERS_H</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define CRYPTOPP_FILTERS_H</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#if CRYPTOPP_MSC_VERSION</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"># pragma warning(push)</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"># pragma warning(disable: 4127 4189 4231 4275 4514)</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "<a class="code" href="cryptlib_8h.html">cryptlib.h</a>"</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "<a class="code" href="simple_8h.html">simple.h</a>"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="secblock_8h.html">secblock.h</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="misc_8h.html">misc.h</a>"</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="smartptr_8h.html">smartptr.h</a>"</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="queue_8h.html">queue.h</a>"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="algparam_8h.html">algparam.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="stdcpp_8h.html">stdcpp.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> NAMESPACE_BEGIN(<a class="code" href="namespace_crypto_p_p.html">CryptoPP</a>)</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> <span class="comment">/// \brief Implementation of BufferedTransformation's attachment interface</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span><span class="comment">/// \details Filter is a cornerstone of the Pipeline trinitiy. Data flows from</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span><span class="comment">/// Sources, through Filters, and then terminates in Sinks. The difference</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span><span class="comment">/// between a Source and Filter is a Source \a pumps data, while a Filter does</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="comment">/// not. The difference between a Filter and a Sink is a Filter allows an</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span><span class="comment">/// attached transformation, while a Sink does not.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span><span class="comment">/// \details See the discussion of BufferedTransformation in cryptlib.h for</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span><span class="comment">/// more details.</span></div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_filter.html"> 35</a></span> <span class="comment"></span>class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE <a class="code" href="class_filter.html">Filter</a> : public <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a>, public <a class="code" href="class_not_copyable.html">NotCopyable</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_filter.html">Filter</a>() {}</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// \name ATTACHMENT</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span><span class="comment"> //@{</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// \brief Construct a Filter</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// \details attachment can be \p NULL.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span> <a class="code" href="class_filter.html">Filter</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// \brief Determine if attachable</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// \returns \p true if the object allows attached transformations, \p false otherwise.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// \note Source and Filter offer attached transformations; while Sink does not.</span></div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="class_filter.html#a6e7251247b5c2cc3b0c15e861cc88e16"> 51</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="class_filter.html#a6e7251247b5c2cc3b0c15e861cc88e16">Attachable</a>() {<span class="keywordflow">return</span> <span class="keyword">true</span>;}</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /// \brief Retrieve attached transformation</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// \returns pointer to a BufferedTransformation if there is an attached transformation, \p NULL otherwise.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span> <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *AttachedTransformation();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// \brief Retrieve attached transformation</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /// \returns pointer to a BufferedTransformation if there is an attached transformation, \p NULL otherwise.</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *AttachedTransformation() <span class="keyword">const</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /// \brief Replace an attached transformation</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /// \param newAttachment an optional attached transformation</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// \details newAttachment can be a single filter, a chain of filters or \p NULL.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// Pass \p NULL to remove an existing BufferedTransformation or chain of filters</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> <span class="keywordtype">void</span> Detach(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *newAttachment = NULLPTR);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> //@}</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="comment">// See the documentation for BufferedTransformation in cryptlib.h</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">size_t</span> TransferTo2(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">size_t</span> CopyRangeTo2(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// See the documentation for BufferedTransformation in cryptlib.h</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> Initialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters=<a class="code" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>, <span class="keywordtype">int</span> propagation=-1);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> Flush(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> MessageSeriesEnd(<span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</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">protected</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> * NewDefaultAttachment() <span class="keyword">const</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> Insert(<a class="code" href="class_filter.html">Filter</a> *nextFilter); <span class="comment">// insert filter after this one</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">virtual</span> <span class="keywordtype">bool</span> ShouldPropagateMessageEnd()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">true</span>;}</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ShouldPropagateMessageSeriesEnd()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">true</span>;}</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>  <span class="keywordtype">void</span> PropagateInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">int</span> propagation);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /// \brief Forward processed data on to attached transformation</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /// \param outputSite unknown, system crash between keyboard and chair...</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /// \param inString the byte buffer to process</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /// \param length the size of the string, in bytes</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /// \param messageEnd means how many filters to signal MessageEnd() to, including this one</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /// \param channel the channel to process the data</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /// \returns the number of bytes that remain in the block (i.e., bytes not processed)</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <span class="keywordtype">size_t</span> Output(<span class="keywordtype">int</span> outputSite, <span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /// \brief Output multiple bytes that may be modified by callee.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /// \param outputSite unknown, system crash between keyboard and chair...</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /// \param inString the byte buffer to process</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> /// \param length the size of the string, in bytes</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /// \param messageEnd means how many filters to signal MessageEnd() to, including this one</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /// \param channel the channel to process the data</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /// \returns the number of bytes that remain in the block (i.e., bytes not processed)</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span> <span class="keywordtype">size_t</span> OutputModifiable(<span class="keywordtype">int</span> outputSite, byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /// \brief Signals the end of messages to the object</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// \param outputSite unknown, system crash between keyboard and chair...</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// \param propagation the number of attached transformations the MessageEnd() signal should be passed</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /// \param channel the channel to process the data</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// \returns TODO</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// \details propagation count includes this object. Setting propagation to <tt>1</tt> means this</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> /// object only. Setting propagation to <tt>-1</tt> means unlimited propagation.</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span> <span class="keywordtype">bool</span> OutputMessageEnd(<span class="keywordtype">int</span> outputSite, <span class="keywordtype">int</span> propagation, <span class="keywordtype">bool</span> blocking, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>);</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 Flush buffered input and/or output, with signal propagation</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> /// \param outputSite unknown, system crash between keyboard and chair...</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> /// \param hardFlush is used to indicate whether all data should be flushed</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /// \param propagation the number of attached transformations the Flush() signal should be passed</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> /// \param channel the channel to process the data</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /// \returns TODO</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> /// \details propagation count includes this object. Setting propagation to <tt>1</tt> means this</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> /// object only. Setting propagation to <tt>-1</tt> means unlimited propagation.</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /// \note Hard flushes must be used with care. It means try to process and output everything, even if</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> /// there may not be enough data to complete the action. For example, hard flushing a HexDecoder</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /// would cause an error if you do it after inputing an odd number of hex encoded characters.</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /// \note For some types of filters, like ZlibDecompressor, hard flushes can only</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> /// be done at "synchronization points". These synchronization points are positions in the data</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> /// stream that are created by hard flushes on the corresponding reverse filters, in this</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> /// example ZlibCompressor. This is useful when zlib compressed data is moved across a</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> /// network in packets and compression state is preserved across packets, as in the SSH2 protocol.</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span> <span class="keywordtype">bool</span> OutputFlush(<span class="keywordtype">int</span> outputSite, <span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation, <span class="keywordtype">bool</span> blocking, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> /// \brief Marks the end of a series of messages, with signal propagation</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /// \param outputSite unknown, system crash between keyboard and chair...</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /// \param propagation the number of attached transformations the MessageSeriesEnd() signal should be passed</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> /// \param channel the channel to process the data</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /// \returns TODO</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> /// \details Each object that receives the signal will perform its processing, decrement</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> /// propagation, and then pass the signal on to attached transformations if the value is not 0.</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> /// \details propagation count includes this object. Setting propagation to <tt>1</tt> means this</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /// object only. Setting propagation to <tt>-1</tt> means unlimited propagation.</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /// \note There should be a MessageEnd() immediately before MessageSeriesEnd().</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span> <span class="keywordtype">bool</span> OutputMessageSeriesEnd(<span class="keywordtype">int</span> outputSite, <span class="keywordtype">int</span> propagation, <span class="keywordtype">bool</span> blocking, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <a class="code" href="classmember__ptr.html">member_ptr<BufferedTransformation></a> m_attachment;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">size_t</span> m_inputPosition;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">int</span> m_continueAt;</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> <span class="comment"></span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/// \brief Create a working space in a BufferedTransformation</span></div><div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="struct_filter_put_space_helper.html"> 158</a></span> <span class="comment"></span><span class="keyword">struct </span>CRYPTOPP_DLL <a class="code" href="struct_filter_put_space_helper.html">FilterPutSpaceHelper</a></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> {</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">virtual</span> ~<a class="code" href="struct_filter_put_space_helper.html">FilterPutSpaceHelper</a>() {}</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> /// \brief Create a working space in a BufferedTransformation</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> /// \param target BufferedTransformation for the working space</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> /// \param channel channel for the working space</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> /// \param minSize minimum size of the allocation, in bytes</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> /// \param desiredSize preferred size of the allocation, in bytes</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> /// \param bufferSize actual size of the allocation, in bytes</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> /// \pre <tt>desiredSize >= minSize</tt> and <tt>bufferSize >= minSize</tt>.</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> /// \details \p bufferSize is an IN and OUT parameter. If HelpCreatePutSpace() returns a non-NULL value, then</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> /// bufferSize is valid and provides the size of the working space created for the caller.</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> /// \details Internally, HelpCreatePutSpace() calls \ref BufferedTransformation::ChannelCreatePutSpace</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> /// "ChannelCreatePutSpace()" using \p desiredSize. If the target returns \p desiredSize with a size less</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> /// than \p minSize (i.e., the request could not be fulfilled), then an internal SecByteBlock</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> /// called \p m_tempSpace is resized and used for the caller.</span></div><div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39"> 175</a></span> <span class="comment"></span> byte *<a class="code" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39">HelpCreatePutSpace</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, <span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> minSize, <span class="keywordtype">size_t</span> desiredSize, <span class="keywordtype">size_t</span> &bufferSize)</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  {</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(desiredSize >= minSize && bufferSize >= minSize);</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordflow">if</span> (m_tempSpace.size() < minSize)</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  {</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  byte *result = target.<a class="code" href="class_buffered_transformation.html#a877494d8de597af935cb770034f7f170">ChannelCreatePutSpace</a>(channel, desiredSize);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordflow">if</span> (desiredSize >= minSize)</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  {</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  bufferSize = desiredSize;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  }</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  m_tempSpace.New(bufferSize);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  }</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  bufferSize = m_tempSpace.size();</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordflow">return</span> m_tempSpace.begin();</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  }</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> /// \brief Create a working space in a BufferedTransformation</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> /// \param target the BufferedTransformation for the working space</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> /// \param channel channel for the working space</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> /// \param minSize minimum size of the allocation, in bytes</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> /// \details Internally, the overload calls HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize) using \p minSize for missing arguments.</span></div><div class="line"><a name="l00198"></a><span class="lineno"><a class="line" href="struct_filter_put_space_helper.html#a01f7232d4f27bc0c0a20115aa5090924"> 198</a></span> <span class="comment"></span> byte *<a class="code" href="struct_filter_put_space_helper.html#a01f7232d4f27bc0c0a20115aa5090924">HelpCreatePutSpace</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, <span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> minSize)</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  {<span class="keywordflow">return</span> HelpCreatePutSpace(target, channel, minSize, minSize, minSize);}</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"></span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> /// \brief Create a working space in a BufferedTransformation</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> /// \param target the BufferedTransformation for the working space</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> /// \param channel channel for the working space</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> /// \param minSize minimum size of the allocation, in bytes</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> /// \param bufferSize the actual size of the allocation, in bytes</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> /// \details Internally, the overload calls HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize) using \p minSize for missing arguments.</span></div><div class="line"><a name="l00207"></a><span class="lineno"><a class="line" href="struct_filter_put_space_helper.html#aa6549687729073e4900e0867f59c0f4f"> 207</a></span> <span class="comment"></span> byte *<a class="code" href="struct_filter_put_space_helper.html#aa6549687729073e4900e0867f59c0f4f">HelpCreatePutSpace</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, <span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> minSize, <span class="keywordtype">size_t</span> bufferSize)</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  {<span class="keywordflow">return</span> HelpCreatePutSpace(target, channel, minSize, minSize, bufferSize);}</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"></span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> /// \brief Temporay working space</span></div><div class="line"><a name="l00211"></a><span class="lineno"><a class="line" href="struct_filter_put_space_helper.html#ac50ca63d7b1a529a32e8596aa44df9c4"> 211</a></span> <span class="comment"></span> <a class="code" href="class_sec_byte_block.html">SecByteBlock</a> <a class="code" href="struct_filter_put_space_helper.html#ac50ca63d7b1a529a32e8596aa44df9c4">m_tempSpace</a>;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> };</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"></span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">/// \brief Measure how many bytes and messages pass through the filter</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">/// \details measure how many bytes and messages pass through the filter. The filter also serves as valve by</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">/// maintaining a list of ranges to skip during processing.</span></div><div class="line"><a name="l00217"></a><span class="lineno"><a class="line" href="class_meter_filter.html"> 217</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_meter_filter.html">MeterFilter</a> : <span class="keyword">public</span> <a class="code" href="class_bufferless.html">Bufferless</a><Filter></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> {</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_meter_filter.html">MeterFilter</a>() {}</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"></span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> /// \brief Construct a MeterFilter</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> /// \param transparent flag indicating if the filter should function transparently</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> /// \details \p attachment can be \p NULL. The filter is transparent by default. If the filter is</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> /// transparent, then PutMaybeModifiable() does not process a request and always returns 0.</span></div><div class="line"><a name="l00227"></a><span class="lineno"><a class="line" href="class_meter_filter.html#a6d458e027fdc3b9a481a633ae04459d2"> 227</a></span> <span class="comment"></span> <a class="code" href="class_meter_filter.html#a6d458e027fdc3b9a481a633ae04459d2">MeterFilter</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULLPTR, <span class="keywordtype">bool</span> transparent=<span class="keyword">true</span>)</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  : m_transparent(transparent), m_currentMessageBytes(0), m_totalBytes(0)</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  , m_currentSeriesMessages(0), m_totalMessages(0), m_totalMessageSeries(0)</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  , m_begin(NULLPTR), m_length(0) {Detach(attachment); ResetMeter();}</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"></span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> /// \brief Set or change the transparent mode of this object</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> /// \param transparent the new transparent mode</span></div><div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="class_meter_filter.html#ad6f0f8c7bbc82fefb44c3c4747e3d3e9"> 234</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_meter_filter.html#ad6f0f8c7bbc82fefb44c3c4747e3d3e9">SetTransparent</a>(<span class="keywordtype">bool</span> transparent) {m_transparent = transparent;}</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"></span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> /// \brief Adds a range to skip during processing</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> /// \param message the message to apply the range</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> /// \param position the 0-based index in the current stream</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> /// \param size the length of the range</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> /// \param sortNow flag indicating whether the range should be sorted</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> /// \details Internally, MeterFilter maitains a deque of ranges to skip. As messages are processed,</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> /// ranges of bytes are skipped according to the list of ranges.</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"></span> <span class="keywordtype">void</span> AddRangeToSkip(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> message, lword position, lword size, <span class="keywordtype">bool</span> sortNow = <span class="keyword">true</span>);</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"></span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> /// \brief Resets the meter</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> /// \details ResetMeter() reinitializes the meter by setting counters to 0 and removing previous</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> /// skip ranges.</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"></span> <span class="keywordtype">void</span> ResetMeter();</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="class_meter_filter.html#a141a6f8b09072847dbdd6a3f0f33f865"> 250</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_meter_filter.html#a141a6f8b09072847dbdd6a3f0f33f865">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="l00251"></a><span class="lineno"> 251</span>  {CRYPTOPP_UNUSED(parameters); ResetMeter();}</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> </div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  lword GetCurrentMessageBytes()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_currentMessageBytes;}</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  lword GetTotalBytes()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_totalBytes;}</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetCurrentSeriesMessages()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_currentSeriesMessages;}</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetTotalMessages()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_totalMessages;}</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetTotalMessageSeries()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_totalMessageSeries;}</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div><div class="line"><a name="l00259"></a><span class="lineno"><a class="line" href="class_meter_filter.html#a49d92192dcbd3366ff0576159ea62e9d"> 259</a></span>  byte * <a class="code" href="class_meter_filter.html#a49d92192dcbd3366ff0576159ea62e9d">CreatePutSpace</a>(<span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  {<span class="keywordflow">return</span> AttachedTransformation()->CreatePutSpace(size);}</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keywordtype">size_t</span> Put2(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keywordtype">size_t</span> PutModifiable2(byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keywordtype">bool</span> IsolatedMessageSeriesEnd(<span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keywordtype">size_t</span> PutMaybeModifiable(byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking, <span class="keywordtype">bool</span> modifiable);</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keywordtype">bool</span> ShouldPropagateMessageEnd()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_transparent;}</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keywordtype">bool</span> ShouldPropagateMessageSeriesEnd()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_transparent;}</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keyword">struct </span>MessageRange</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  {</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="asn_8h.html#a9485364a916ed0474eb263a307ecc0f0">operator<</a>(<span class="keyword">const</span> MessageRange &b) <span class="keyword">const</span> <span class="comment">// BCB2006 workaround: this has to be a member function</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  {<span class="keywordflow">return</span> message < b.message || (message == b.message && position < b.position);}</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> message; lword position; lword size;</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  };</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordtype">bool</span> m_transparent;</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  lword m_currentMessageBytes, m_totalBytes;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_currentSeriesMessages, m_totalMessages, m_totalMessageSeries;</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  std::deque<MessageRange> m_rangesToSkip;</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  byte *m_begin;</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keywordtype">size_t</span> m_length;</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> };</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"></span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment">/// \brief A transparent MeterFilter</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">/// \sa MeterFilter, OpaqueFilter</span></div><div class="line"><a name="l00287"></a><span class="lineno"><a class="line" href="class_transparent_filter.html"> 287</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_transparent_filter.html">TransparentFilter</a> : <span class="keyword">public</span> <a class="code" href="class_meter_filter.html">MeterFilter</a></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> {</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> /// \brief Construct a TransparentFilter</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00292"></a><span class="lineno"><a class="line" href="class_transparent_filter.html#aed955b969c7623d108346f2a97d0e1cd"> 292</a></span> <span class="comment"></span> <a class="code" href="class_transparent_filter.html#aed955b969c7623d108346f2a97d0e1cd">TransparentFilter</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULLPTR) : <a class="code" href="class_meter_filter.html">MeterFilter</a>(attachment, true) {}</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> };</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"></span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment">/// \brief A non-transparent MeterFilter</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment">/// \sa MeterFilter, TransparentFilter</span></div><div class="line"><a name="l00297"></a><span class="lineno"><a class="line" href="class_opaque_filter.html"> 297</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_opaque_filter.html">OpaqueFilter</a> : <span class="keyword">public</span> <a class="code" href="class_meter_filter.html">MeterFilter</a></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> {</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> /// \brief Construct an OpaqueFilter</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00302"></a><span class="lineno"><a class="line" href="class_opaque_filter.html#af1cce756d535a725ac0f490c48e6ab50"> 302</a></span> <span class="comment"></span> <a class="code" href="class_opaque_filter.html#af1cce756d535a725ac0f490c48e6ab50">OpaqueFilter</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULLPTR) : <a class="code" href="class_meter_filter.html">MeterFilter</a>(attachment, false) {}</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> };</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"></span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">/// \brief Divides an input stream into discrete blocks</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment">/// \details FilterWithBufferedInput divides the input stream into a first block, a number of</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment">/// middle blocks, and a last block. First and last blocks are optional, and middle blocks may</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment">/// be a stream instead (i.e. <tt>blockSize == 1</tt>).</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">/// \sa AuthenticatedEncryptionFilter, AuthenticatedDecryptionFilter, HashVerificationFilter,</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">/// SignatureVerificationFilter, StreamTransformationFilter</span></div><div class="line"><a name="l00311"></a><span class="lineno"><a class="line" href="class_filter_with_buffered_input.html"> 311</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a> : <span class="keyword">public</span> <a class="code" href="class_filter.html">Filter</a></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> {</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a>() {}</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"></span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> /// \brief Construct a FilterWithBufferedInput with an attached transformation</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> /// \param attachment an attached transformation</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"></span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment);</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"></span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> /// \brief Construct a FilterWithBufferedInput with an attached transformation</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> /// \param firstSize the size of the first block</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> /// \param blockSize the size of middle blocks</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> /// \param lastSize the size of the last block</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> /// \param attachment an attached transformation</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> /// \details \p firstSize and \p lastSize may be 0. \p blockSize must be at least 1.</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"></span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a>(<span class="keywordtype">size_t</span> firstSize, <span class="keywordtype">size_t</span> blockSize, <span class="keywordtype">size_t</span> lastSize, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment);</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> </div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  <span class="keywordtype">void</span> <a class="code" href="class_buffered_transformation.html#a7bb05ac3b6302e2ab994586d526fa804">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="l00329"></a><span class="lineno"><a class="line" href="class_filter_with_buffered_input.html#a9885841f5ecee1403b57c5b1fc28a928"> 329</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_filter_with_buffered_input.html#a9885841f5ecee1403b57c5b1fc28a928">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  {</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keywordflow">return</span> PutMaybeModifiable(const_cast<byte *>(inString), length, messageEnd, blocking, <span class="keyword">false</span>);</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  }</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> </div><div class="line"><a name="l00334"></a><span class="lineno"><a class="line" href="class_filter_with_buffered_input.html#abc7a44af560a17d30a48651683e18e6e"> 334</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_filter_with_buffered_input.html#abc7a44af560a17d30a48651683e18e6e">PutModifiable2</a>(byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  {</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  <span class="keywordflow">return</span> PutMaybeModifiable(inString, length, messageEnd, blocking, <span class="keyword">true</span>);</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  }</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"></span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> /// \brief Flushes data buffered by this object, without signal propagation</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> /// \param hardFlush indicates whether all data should be flushed</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> /// \details IsolatedFlush() calls ForceNextPut() if hardFlush is true</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> /// \note hardFlush must be used with care</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="class_buffered_transformation.html#a68044dc8d57bc02edee1ce02b459a63d">IsolatedFlush</a>(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"></span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> /// \brief Flushes data buffered by this object</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> /// \details The input buffer may contain more than blockSize bytes if <tt>lastSize != 0</tt>.</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> /// ForceNextPut() forces a call to NextPut() if this is the case.</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"></span> <span class="keywordtype">void</span> ForceNextPut();</div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> </div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> DidFirstPut()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_firstInputDone;}</div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetFirstPutSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_firstSize;}</div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetBlockPutSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_blockSize;}</div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetLastPutSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_lastSize;}</div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> </div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> InitializeDerivedAndReturnNewSizes(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">size_t</span> &firstSize, <span class="keywordtype">size_t</span> &blockSize, <span class="keywordtype">size_t</span> &lastSize)</div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  {CRYPTOPP_UNUSED(parameters); CRYPTOPP_UNUSED(firstSize); CRYPTOPP_UNUSED(blockSize); CRYPTOPP_UNUSED(lastSize); InitializeDerived(parameters);}</div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> InitializeDerived(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  {CRYPTOPP_UNUSED(parameters);}</div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  <span class="comment">// FirstPut() is called if (firstSize != 0 and totalLength >= firstSize)</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  <span class="comment">// or (firstSize == 0 and (totalLength > 0 or a MessageEnd() is received)).</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  <span class="comment">// inString is m_firstSize in length.</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> FirstPut(<span class="keyword">const</span> byte *inString) =0;</div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  <span class="comment">// NextPut() is called if totalLength >= firstSize+blockSize+lastSize</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> NextPutSingle(<span class="keyword">const</span> byte *inString)</div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  {CRYPTOPP_UNUSED(inString); <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">false</span>);}</div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  <span class="comment">// Same as NextPut() except length can be a multiple of blockSize</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  <span class="comment">// Either NextPut() or NextPutMultiple() must be overridden</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> NextPutMultiple(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  <span class="comment">// Same as NextPutMultiple(), but inString can be modified</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> NextPutModifiable(byte *inString, <span class="keywordtype">size_t</span> length)</div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  {NextPutMultiple(inString, length);}<span class="comment"></span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> /// \brief Input the last block of data</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> /// \param inString the input byte buffer</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> /// \param length the size of the input buffer, in bytes</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> /// \details LastPut() processes the last block of data and signals attached filters to do the same.</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> /// LastPut() is always called. The pseudo algorithm for the logic is:</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> /// if totalLength < firstSize then length == totalLength</span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> /// else if totalLength <= firstSize+lastSize then length == totalLength-firstSize</span></div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> /// else lastSize <= length < lastSize+blockSize</span></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> /// </pre></span></div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> LastPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length) =0;</div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> FlushDerived() {}</div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> </div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span>  <span class="keywordtype">size_t</span> PutMaybeModifiable(byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking, <span class="keywordtype">bool</span> modifiable);</div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  <span class="keywordtype">void</span> NextPutMaybeModifiable(byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">bool</span> modifiable)</div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  {</div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  <span class="keywordflow">if</span> (modifiable) NextPutModifiable(inString, length);</div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  <span class="keywordflow">else</span> NextPutMultiple(inString, length);</div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  }</div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span> </div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  <span class="comment">// This function should no longer be used, put this here to cause a compiler error</span></div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="comment">// if someone tries to override NextPut().</span></div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> NextPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length)</div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span>  {CRYPTOPP_UNUSED(inString); CRYPTOPP_UNUSED(length); <a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0;}</div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span> </div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>  <span class="keyword">class </span>BlockQueue</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>  {</div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <span class="keywordtype">void</span> ResetQueue(<span class="keywordtype">size_t</span> blockSize, <span class="keywordtype">size_t</span> maxBlocks);</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>  byte *<a class="code" href="class_get_block.html">GetBlock</a>();</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  byte *GetContigousBlocks(<span class="keywordtype">size_t</span> &numberOfBytes);</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  <span class="keywordtype">size_t</span> GetAll(byte *outString);</div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  <span class="keywordtype">void</span> Put(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>  <span class="keywordtype">size_t</span> CurrentSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_size;}</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  <span class="keywordtype">size_t</span> MaxSize()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_buffer.size();}</div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span> </div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  <a class="code" href="class_sec_byte_block.html">SecByteBlock</a> m_buffer;</div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  <span class="keywordtype">size_t</span> m_blockSize, m_maxBlocks, m_size;</div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  byte *m_begin;</div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  };</div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span> </div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span>  <span class="keywordtype">size_t</span> m_firstSize, m_blockSize, m_lastSize;</div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span>  <span class="keywordtype">bool</span> m_firstInputDone;</div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  BlockQueue m_queue;</div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span> };</div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"></span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment">/// \brief A filter that buffers input using a ByteQueue</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment">/// \details FilterWithInputQueue will buffer input using a ByteQueue. When the filter receives</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment">/// a \ref BufferedTransformation::MessageEnd() "MessageEnd()" signal it will pass the data</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment">/// on to its attached transformation.</span></div><div class="line"><a name="l00426"></a><span class="lineno"><a class="line" href="class_filter_with_input_queue.html"> 426</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_filter_with_input_queue.html">FilterWithInputQueue</a> : <span class="keyword">public</span> <a class="code" href="class_filter.html">Filter</a></div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span> {</div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_filter_with_input_queue.html">FilterWithInputQueue</a>() {}</div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"></span></div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> /// \brief Construct a FilterWithInputQueue</span></div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00433"></a><span class="lineno"><a class="line" href="class_filter_with_input_queue.html#a4cbafb997e9f2a310ed490eea49fb1ab"> 433</a></span> <span class="comment"></span> <a class="code" href="class_filter_with_input_queue.html#a4cbafb997e9f2a310ed490eea49fb1ab">FilterWithInputQueue</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment=NULLPTR) : <a class="code" href="class_filter.html">Filter</a>(attachment) {}</div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span> </div><div class="line"><a name="l00435"></a><span class="lineno"><a class="line" href="class_filter_with_input_queue.html#a91c11ca74a8ba2350da6ad6ca8d721a0"> 435</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_filter_with_input_queue.html#a91c11ca74a8ba2350da6ad6ca8d721a0">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  {</div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  <span class="keywordflow">if</span> (!blocking)</div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  <span class="keywordflow">throw</span> <a class="code" href="struct_buffered_transformation_1_1_blocking_input_only.html">BlockingInputOnly</a>(<span class="stringliteral">"FilterWithInputQueue"</span>);</div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span> </div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  m_inQueue.Put(inString, length);</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>  <span class="keywordflow">if</span> (messageEnd)</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  {</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>  IsolatedMessageEnd(blocking);</div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>  Output(0, NULLPTR, 0, messageEnd, blocking);</div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  }</div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  }</div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span> </div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsolatedMessageEnd(<span class="keywordtype">bool</span> blocking) =0;</div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  <span class="keywordtype">void</span> <a class="code" href="class_buffered_transformation.html#a7bb05ac3b6302e2ab994586d526fa804">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="l00452"></a><span class="lineno"> 452</span>  {CRYPTOPP_UNUSED(parameters); m_inQueue.Clear();}</div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span> </div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  <a class="code" href="class_byte_queue.html">ByteQueue</a> m_inQueue;</div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span> };</div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"></span></div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment">/// \struct BlockPaddingSchemeDef</span></div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment">/// \brief Padding schemes used for block ciphers</span></div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l00460"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html"> 460</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="struct_block_padding_scheme_def.html">BlockPaddingSchemeDef</a></div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span> {<span class="comment"></span></div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> /// \enum BlockPaddingScheme</span></div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> /// \brief Padding schemes used for block ciphers.</span></div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> /// \details DEFAULT_PADDING means PKCS_PADDING if <tt>cipher.MandatoryBlockSize() > 1 &&</span></div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> /// cipher.MinLastBlockSize() == 0</tt>, which holds for ECB or CBC mode. Otherwise,</span></div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> /// NO_PADDING for modes like OFB, CFB, CTR, CBC-CTS.</span></div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> /// \sa <A HREF="http://www.weidai.com/scan-mirror/csp.html">Block Cipher Padding</A> for</span></div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> /// additional details.</span></div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> /// \since Crypto++ 5.0</span></div><div class="line"><a name="l00470"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979"> 470</a></span> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979">BlockPaddingScheme</a> {<span class="comment"></span></div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> /// \brief No padding added to a block</span></div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> /// \since Crypto++ 5.0</span></div><div class="line"><a name="l00473"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979ad929ced62ab4871b2d9b87cab0b47887"> 473</a></span> <span class="comment"></span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979ad929ced62ab4871b2d9b87cab0b47887">NO_PADDING</a>,<span class="comment"></span></div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> /// \brief 0's padding added to a block</span></div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> /// \since Crypto++ 5.0</span></div><div class="line"><a name="l00476"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979ae6ae59c8e974534a292a2f0b11131f08"> 476</a></span> <span class="comment"></span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979ae6ae59c8e974534a292a2f0b11131f08">ZEROS_PADDING</a>,<span class="comment"></span></div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> /// \brief PKCS #5 padding added to a block</span></div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> /// \since Crypto++ 5.0</span></div><div class="line"><a name="l00479"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a622df395c2f0edc35f722d938faaad1f"> 479</a></span> <span class="comment"></span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a622df395c2f0edc35f722d938faaad1f">PKCS_PADDING</a>,<span class="comment"></span></div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> /// \brief 1 and 0's padding added to a block</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> /// \since Crypto++ 5.0</span></div><div class="line"><a name="l00482"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a77a93fa2940abd30d0678927ab6f3587"> 482</a></span> <span class="comment"></span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a77a93fa2940abd30d0678927ab6f3587">ONE_AND_ZEROS_PADDING</a>,<span class="comment"></span></div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> /// \brief W3C padding added to a block</span></div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> /// \sa <A HREF="http://www.w3.org/TR/2002/REC-xmlenc-core-20021210/Overview.html">XML</span></div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> /// Encryption Syntax and Processing</A></span></div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> /// \since Crypto++ 6.0</span></div><div class="line"><a name="l00487"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a33d1ed83310e9d60f606a60af3cc6559"> 487</a></span> <span class="comment"></span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a33d1ed83310e9d60f606a60af3cc6559">W3C_PADDING</a>,<span class="comment"></span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> /// \brief Default padding scheme</span></div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"> /// \since Crypto++ 5.0</span></div><div class="line"><a name="l00490"></a><span class="lineno"><a class="line" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a0ae39772a46aee3e0dbf3e91afff751c"> 490</a></span> <span class="comment"></span> <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a0ae39772a46aee3e0dbf3e91afff751c">DEFAULT_PADDING</a></div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  };</div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span> };</div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"></span></div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment">/// \brief Filter wrapper for StreamTransformation</span></div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment">/// \details StreamTransformationFilter() is a filter wrapper for StreamTransformation(). It is used when</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment">/// pipelining data for stream ciphers and confidentiality-only block ciphers. The filter will optionally</span></div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment">/// handle padding and unpadding when needed. If you are using an authenticated encryption mode of operation,</span></div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment">/// then use AuthenticatedEncryptionFilter() and AuthenticatedDecryptionFilter()</span></div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l00500"></a><span class="lineno"><a class="line" href="class_stream_transformation_filter.html"> 500</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_stream_transformation_filter.html">StreamTransformationFilter</a> : <span class="keyword">public</span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a>, <span class="keyword">public</span> <a class="code" href="struct_block_padding_scheme_def.html">BlockPaddingSchemeDef</a>, <span class="keyword">private</span> <a class="code" href="struct_filter_put_space_helper.html">FilterPutSpaceHelper</a></div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span> {</div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_stream_transformation_filter.html">StreamTransformationFilter</a>() {}</div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"></span></div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> /// \brief Construct a StreamTransformationFilter</span></div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> /// \param c reference to a StreamTransformation</span></div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> /// \param padding the \ref BlockPaddingSchemeDef "padding scheme"</span></div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> /// \details This contructor creates a StreamTransformationFilter() for stream ciphers and</span></div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> /// confidentiality-only block cipher modes of operation. If you are using an authenticated</span></div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> /// encryption mode of operation, then use either AuthenticatedEncryptionFilter() or</span></div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> /// AuthenticatedDecryptionFilter().</span></div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> /// \sa AuthenticatedEncryptionFilter() and AuthenticatedDecryptionFilter()</span></div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"></span> <a class="code" href="class_stream_transformation_filter.html">StreamTransformationFilter</a>(<a class="code" href="class_stream_transformation.html">StreamTransformation</a> &c, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979">BlockPaddingScheme</a> padding = DEFAULT_PADDING);</div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span> </div><div class="line"><a name="l00516"></a><span class="lineno"><a class="line" href="class_stream_transformation_filter.html#ace011a28ce65458013b722a005b909a4"> 516</a></span>  std::string <a class="code" href="class_stream_transformation_filter.html#ace011a28ce65458013b722a005b909a4">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_cipher.AlgorithmName();}</div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span> </div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span> </div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_authenticated_encryption_filter.html">AuthenticatedEncryptionFilter</a>;</div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_authenticated_decryption_filter.html">AuthenticatedDecryptionFilter</a>;</div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"></span></div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> /// \brief Construct a StreamTransformationFilter</span></div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> /// \param c reference to a StreamTransformation</span></div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> /// \param padding the \ref BlockPaddingSchemeDef "padding scheme"</span></div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> /// \param authenticated flag indicating whether the filter should allow authenticated encryption schemes</span></div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> /// \details This constructor is used for authenticated encryption mode of operation and by</span></div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> /// AuthenticatedEncryptionFilter() and AuthenticatedDecryptionFilter().</span></div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"></span> <a class="code" href="class_stream_transformation_filter.html">StreamTransformationFilter</a>(<a class="code" href="class_stream_transformation.html">StreamTransformation</a> &c, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment, <a class="code" href="namespace_name.html#a48820945ba488fac5d5507eea9a5114e">BlockPaddingScheme</a> padding, <span class="keywordtype">bool</span> authenticated);</div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span> </div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  <span class="keywordtype">void</span> InitializeDerivedAndReturnNewSizes(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">size_t</span> &firstSize, <span class="keywordtype">size_t</span> &blockSize, <span class="keywordtype">size_t</span> &lastSize);</div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  <span class="keywordtype">void</span> FirstPut(<span class="keyword">const</span> byte *inString);</div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  <span class="keywordtype">void</span> NextPutMultiple(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  <span class="keywordtype">void</span> NextPutModifiable(byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="keywordtype">void</span> LastPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span> </div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span>  <span class="keyword">static</span> <span class="keywordtype">size_t</span> LastBlockSize(<a class="code" href="class_stream_transformation.html">StreamTransformation</a> &c, <a class="code" href="namespace_name.html#a48820945ba488fac5d5507eea9a5114e">BlockPaddingScheme</a> padding);</div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span> </div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  <a class="code" href="class_stream_transformation.html">StreamTransformation</a> &m_cipher;</div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  <a class="code" href="namespace_name.html#a48820945ba488fac5d5507eea9a5114e">BlockPaddingScheme</a> m_padding;</div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_mandatoryBlockSize;</div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_optimalBufferSize;</div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_reservedBufferSize;</div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  <span class="keywordtype">bool</span> m_isSpecial;</div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span> };</div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"></span></div><div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment">/// \brief Filter wrapper for HashTransformation</span></div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment">/// \since Crypto++ 1.0</span></div><div class="line"><a name="l00550"></a><span class="lineno"><a class="line" href="class_hash_filter.html"> 550</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_hash_filter.html">HashFilter</a> : <span class="keyword">public</span> <a class="code" href="class_bufferless.html">Bufferless</a><Filter>, <span class="keyword">private</span> <a class="code" href="struct_filter_put_space_helper.html">FilterPutSpaceHelper</a></div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span> {</div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_hash_filter.html">HashFilter</a>() {}</div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"></span></div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> /// \brief Construct a HashFilter</span></div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> /// \param hm reference to a HashTransformation</span></div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> /// \param putMessage flag indicating whether the original message should be passed to an attached transformation</span></div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> /// \param truncatedDigestSize the size of the digest</span></div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> /// \param messagePutChannel the channel on which the message should be output</span></div><div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> /// \param hashPutChannel the channel on which the digest should be output</span></div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"></span> <a class="code" href="class_hash_filter.html">HashFilter</a>(<a class="code" href="class_hash_transformation.html">HashTransformation</a> &hm, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <span class="keywordtype">bool</span> putMessage=<span class="keyword">false</span>, <span class="keywordtype">int</span> truncatedDigestSize=-1, <span class="keyword">const</span> std::string &messagePutChannel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keyword">const</span> std::string &hashPutChannel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>);</div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span> </div><div class="line"><a name="l00564"></a><span class="lineno"><a class="line" href="class_hash_filter.html#a8ddeda93399d4767574798eb555bd5ea"> 564</a></span>  std::string <a class="code" href="class_hash_filter.html#a8ddeda93399d4767574798eb555bd5ea">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_hashModule.AlgorithmName();}</div><div class="line"><a name="l00565"></a><span class="lineno"> 565</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="l00566"></a><span class="lineno"> 566</span>  <span class="keywordtype">size_t</span> Put2(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00567"></a><span class="lineno"><a class="line" href="class_hash_filter.html#a5c2f3a90ced66c835969ce1aa235b63e"> 567</a></span>  byte * <a class="code" href="class_hash_filter.html#a5c2f3a90ced66c835969ce1aa235b63e">CreatePutSpace</a>(<span class="keywordtype">size_t</span> &size) {<span class="keywordflow">return</span> m_hashModule.CreateUpdateSpace(size);}</div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span> </div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span>  <a class="code" href="class_hash_transformation.html">HashTransformation</a> &m_hashModule;</div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span>  <span class="keywordtype">bool</span> m_putMessage;</div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_digestSize;</div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  byte *m_space;</div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  std::string m_messagePutChannel, m_hashPutChannel;</div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span> };</div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"></span></div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment">/// \brief Filter wrapper for HashTransformation</span></div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l00579"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html"> 579</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_hash_verification_filter.html">HashVerificationFilter</a> : <span class="keyword">public</span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a></div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span> {</div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_hash_verification_filter.html">HashVerificationFilter</a>() {}</div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"></span></div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> /// \brief Exception thrown when a data integrity check failure is encountered</span></div><div class="line"><a name="l00585"></a><span class="lineno"><a class="line" href="class_hash_verification_filter_1_1_hash_verification_failed.html"> 585</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="class_hash_verification_filter_1_1_hash_verification_failed.html">HashVerificationFailed</a> : <span class="keyword">public</span> <a class="code" href="class_exception.html">Exception</a></div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span>  {</div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  <a class="code" href="class_hash_verification_filter_1_1_hash_verification_failed.html">HashVerificationFailed</a>()</div><div class="line"><a name="l00589"></a><span class="lineno"> 589</span>  : <a class="code" href="class_exception.html">Exception</a>(DATA_INTEGRITY_CHECK_FAILED, <span class="stringliteral">"HashVerificationFilter: message hash or MAC not valid"</span>) {}</div><div class="line"><a name="l00590"></a><span class="lineno"> 590</span>  };</div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"></span></div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> /// \enum Flags</span></div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> /// \brief Flags controlling filter behavior.</span></div><div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> /// \details The flags are a bitmask and can be OR'd together.</span></div><div class="line"><a name="l00595"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70"> 595</a></span> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70">Flags</a> {<span class="comment"></span></div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> /// \brief Indicates the hash is at the end of the message (i.e., concatenation of message+hash)</span></div><div class="line"><a name="l00597"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70a6a42669e2662e070a0c31f4fe5f62777"> 597</a></span> <span class="comment"></span> HASH_AT_END=0,<span class="comment"></span></div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> /// \brief Indicates the hash is at the beginning of the message (i.e., concatenation of hash+message)</span></div><div class="line"><a name="l00599"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70a3974fb63ec975408ce7ab672d99ee004"> 599</a></span> <span class="comment"></span> HASH_AT_BEGIN=1,<span class="comment"></span></div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> /// \brief Indicates the message should be passed to an attached transformation</span></div><div class="line"><a name="l00601"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70aaba5187c6265a8684096f2b4d4bfa9d1"> 601</a></span> <span class="comment"></span> PUT_MESSAGE=2,<span class="comment"></span></div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"> /// \brief Indicates the hash should be passed to an attached transformation</span></div><div class="line"><a name="l00603"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70a9b5a23f94ba704e8fa6b801a1a813de6"> 603</a></span> <span class="comment"></span> PUT_HASH=4,<span class="comment"></span></div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> /// \brief Indicates the result of the verification should be passed to an attached transformation</span></div><div class="line"><a name="l00605"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70ac27995bd5aca3bef2fc7863c1a5bbe0b"> 605</a></span> <span class="comment"></span> PUT_RESULT=8,<span class="comment"></span></div><div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> /// \brief Indicates the filter should throw a HashVerificationFailed if a failure is encountered</span></div><div class="line"><a name="l00607"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70a56c0daa4f424032c82a53d8dcdf78c55"> 607</a></span> <span class="comment"></span> THROW_EXCEPTION=16,<span class="comment"></span></div><div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> /// \brief Default flags using \p HASH_AT_BEGIN and \p PUT_RESULT</span></div><div class="line"><a name="l00609"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70a036f9abd0e6bf25ca9d0e2e9141e505b"> 609</a></span> <span class="comment"></span> DEFAULT_FLAGS = HASH_AT_BEGIN | PUT_RESULT</div><div class="line"><a name="l00610"></a><span class="lineno"> 610</span>  };</div><div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"></span></div><div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> /// \brief Construct a HashVerificationFilter</span></div><div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> /// \param hm reference to a HashTransformation</span></div><div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"> /// \param flags flags indicating behaviors for the filter</span></div><div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> /// \param truncatedDigestSize the size of the digest</span></div><div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> /// \details <tt>truncatedDigestSize = -1</tt> indicates \ref HashTransformation::DigestSize() "DigestSize" should be used.</span></div><div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"></span> <a class="code" href="class_hash_verification_filter.html">HashVerificationFilter</a>(<a class="code" href="class_hash_transformation.html">HashTransformation</a> &hm, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, word32 flags = DEFAULT_FLAGS, <span class="keywordtype">int</span> truncatedDigestSize=-1);</div><div class="line"><a name="l00619"></a><span class="lineno"> 619</span> </div><div class="line"><a name="l00620"></a><span class="lineno"><a class="line" href="class_hash_verification_filter.html#a63841de72c6930234941a89c4989de13"> 620</a></span>  std::string <a class="code" href="class_hash_verification_filter.html#a63841de72c6930234941a89c4989de13">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_hashModule.AlgorithmName();}</div><div class="line"><a name="l00621"></a><span class="lineno"> 621</span>  <span class="keywordtype">bool</span> GetLastResult()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_verified;}</div><div class="line"><a name="l00622"></a><span class="lineno"> 622</span> </div><div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00624"></a><span class="lineno"> 624</span>  <span class="keywordtype">void</span> InitializeDerivedAndReturnNewSizes(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">size_t</span> &firstSize, <span class="keywordtype">size_t</span> &blockSize, <span class="keywordtype">size_t</span> &lastSize);</div><div class="line"><a name="l00625"></a><span class="lineno"> 625</span>  <span class="keywordtype">void</span> FirstPut(<span class="keyword">const</span> byte *inString);</div><div class="line"><a name="l00626"></a><span class="lineno"> 626</span>  <span class="keywordtype">void</span> NextPutMultiple(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00627"></a><span class="lineno"> 627</span>  <span class="keywordtype">void</span> LastPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00628"></a><span class="lineno"> 628</span> </div><div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_authenticated_decryption_filter.html">AuthenticatedDecryptionFilter</a>;</div><div class="line"><a name="l00631"></a><span class="lineno"> 631</span> </div><div class="line"><a name="l00632"></a><span class="lineno"> 632</span>  <a class="code" href="class_hash_transformation.html">HashTransformation</a> &m_hashModule;</div><div class="line"><a name="l00633"></a><span class="lineno"> 633</span>  word32 m_flags;</div><div class="line"><a name="l00634"></a><span class="lineno"> 634</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_digestSize;</div><div class="line"><a name="l00635"></a><span class="lineno"> 635</span>  <span class="keywordtype">bool</span> m_verified;</div><div class="line"><a name="l00636"></a><span class="lineno"> 636</span>  <a class="code" href="class_sec_byte_block.html">SecByteBlock</a> m_expectedHash;</div><div class="line"><a name="l00637"></a><span class="lineno"> 637</span> };</div><div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"></span></div><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment">/// \brief Filter wrapper for encrypting with AuthenticatedSymmetricCipher</span></div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment">/// \details AuthenticatedEncryptionFilter() is a wrapper for encrypting with AuthenticatedSymmetricCipher(),</span></div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment">/// optionally handling padding/unpadding when needed.</span></div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment">/// \sa AuthenticatedDecryptionFilter, EAX, CCM, GCM, AuthenticatedSymmetricCipher</span></div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment">/// \since Crypto++ 5.6.0</span></div><div class="line"><a name="l00644"></a><span class="lineno"><a class="line" href="class_authenticated_encryption_filter.html"> 644</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_authenticated_encryption_filter.html">AuthenticatedEncryptionFilter</a> : <span class="keyword">public</span> <a class="code" href="class_stream_transformation_filter.html">StreamTransformationFilter</a></div><div class="line"><a name="l00645"></a><span class="lineno"> 645</span> {</div><div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00647"></a><span class="lineno"> 647</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_authenticated_encryption_filter.html">AuthenticatedEncryptionFilter</a>() {}</div><div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"></span></div><div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"> /// \brief Construct a AuthenticatedEncryptionFilter</span></div><div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"> /// \param c reference to a AuthenticatedSymmetricCipher</span></div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> /// \param putAAD flag indicating whether the AAD should be passed to an attached transformation</span></div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> /// \param truncatedDigestSize the size of the digest</span></div><div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> /// \param macChannel the channel on which the MAC should be output</span></div><div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> /// \param padding the \ref BlockPaddingSchemeDef "padding scheme"</span></div><div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> /// \details <tt>truncatedDigestSize = -1</tt> indicates \ref HashTransformation::DigestSize() "DigestSize" should be used.</span></div><div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> /// \since Crypto++ 5.6.0</span></div><div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"></span> <a class="code" href="class_authenticated_encryption_filter.html">AuthenticatedEncryptionFilter</a>(<a class="code" href="class_authenticated_symmetric_cipher.html">AuthenticatedSymmetricCipher</a> &c, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <span class="keywordtype">bool</span> putAAD=<span class="keyword">false</span>, <span class="keywordtype">int</span> truncatedDigestSize=-1, <span class="keyword">const</span> std::string &macChannel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <a class="code" href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979">BlockPaddingScheme</a> padding = DEFAULT_PADDING);</div><div class="line"><a name="l00659"></a><span class="lineno"> 659</span> </div><div class="line"><a name="l00660"></a><span class="lineno"> 660</span>  <span class="keywordtype">void</span> <a class="code" href="class_filter_with_buffered_input.html#ae97be71708e0020167e5c08856fd3f3b">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="l00661"></a><span class="lineno"> 661</span>  byte * <a class="code" href="class_buffered_transformation.html#a877494d8de597af935cb770034f7f170">ChannelCreatePutSpace</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> &size);</div><div class="line"><a name="l00662"></a><span class="lineno"> 662</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_buffered_transformation.html#ae6b026f47d8a0ea2e35a6cb8d9ec2c97">ChannelPut2</a>(<span class="keyword">const</span> std::string &channel, <span class="keyword">const</span> byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"></span></div><div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> /// \brief Input the last block of data</span></div><div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> /// \param inString the input byte buffer</span></div><div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> /// \param length the size of the input buffer, in bytes</span></div><div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> /// \details LastPut() processes the last block of data and signals attached filters to do the same.</span></div><div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> /// LastPut() is always called. The pseudo algorithm for the logic is:</span></div><div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> /// if totalLength < firstSize then length == totalLength</span></div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> /// else if totalLength <= firstSize+lastSize then length == totalLength-firstSize</span></div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> /// else lastSize <= length < lastSize+blockSize</span></div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> /// </pre></span></div><div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"></span> <span class="keywordtype">void</span> LastPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00675"></a><span class="lineno"> 675</span> </div><div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00677"></a><span class="lineno"> 677</span>  <a class="code" href="class_hash_filter.html">HashFilter</a> m_hf;</div><div class="line"><a name="l00678"></a><span class="lineno"> 678</span> };</div><div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment"></span></div><div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="comment">/// \brief Filter wrapper for decrypting with AuthenticatedSymmetricCipher</span></div><div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment">/// \details AuthenticatedDecryptionFilter() is a wrapper for decrypting with AuthenticatedSymmetricCipher(),</span></div><div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment">/// optionally handling padding/unpadding when needed.</span></div><div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment">/// \sa AuthenticatedEncryptionFilter, EAX, CCM, GCM, AuthenticatedSymmetricCipher</span></div><div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment">/// \since Crypto++ 5.6.0</span></div><div class="line"><a name="l00685"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html"> 685</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_authenticated_decryption_filter.html">AuthenticatedDecryptionFilter</a> : <span class="keyword">public</span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a>, <span class="keyword">public</span> <a class="code" href="struct_block_padding_scheme_def.html">BlockPaddingSchemeDef</a></div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span> {</div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> /// \enum Flags</span></div><div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> /// \brief Flags controlling filter behavior.</span></div><div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> /// \details The flags are a bitmask and can be OR'd together.</span></div><div class="line"><a name="l00691"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5df"> 691</a></span> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5df">Flags</a> {<span class="comment"></span></div><div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> /// \brief Indicates the MAC is at the end of the message (i.e., concatenation of message+mac)</span></div><div class="line"><a name="l00693"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5dfaa57547b3990dc2cd4d80f3b532ca2311"> 693</a></span> <span class="comment"></span> MAC_AT_END=0,<span class="comment"></span></div><div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> /// \brief Indicates the MAC is at the beginning of the message (i.e., concatenation of mac+message)</span></div><div class="line"><a name="l00695"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5dfa58885107951ef34859a41df12eaf452d"> 695</a></span> <span class="comment"></span> MAC_AT_BEGIN=1,<span class="comment"></span></div><div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> /// \brief Indicates the filter should throw a HashVerificationFailed if a failure is encountered</span></div><div class="line"><a name="l00697"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5dfacc64307f5369c0da5055c28fa7d36ba7"> 697</a></span> <span class="comment"></span> THROW_EXCEPTION=16,<span class="comment"></span></div><div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment"> /// \brief Default flags using \p THROW_EXCEPTION</span></div><div class="line"><a name="l00699"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5dfa4e00a012cd175ded3a65f1664620adec"> 699</a></span> <span class="comment"></span> DEFAULT_FLAGS = THROW_EXCEPTION</div><div class="line"><a name="l00700"></a><span class="lineno"> 700</span>  };</div><div class="line"><a name="l00701"></a><span class="lineno"> 701</span> </div><div class="line"><a name="l00702"></a><span class="lineno"> 702</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_authenticated_decryption_filter.html">AuthenticatedDecryptionFilter</a>() {}</div><div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"></span></div><div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"> /// \brief Construct a AuthenticatedDecryptionFilter</span></div><div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> /// \param c reference to a AuthenticatedSymmetricCipher</span></div><div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> /// \param flags flags indicating behaviors for the filter</span></div><div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="comment"> /// \param truncatedDigestSize the size of the digest</span></div><div class="line"><a name="l00709"></a><span class="lineno"> 709</span> <span class="comment"> /// \param padding the \ref BlockPaddingSchemeDef "padding scheme"</span></div><div class="line"><a name="l00710"></a><span class="lineno"> 710</span> <span class="comment"> /// \details Additional authenticated data should be given in channel "AAD".</span></div><div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment"> /// \details <tt>truncatedDigestSize = -1</tt> indicates \ref HashTransformation::DigestSize() "DigestSize" should be used.</span></div><div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"> /// \since Crypto++ 5.6.0</span></div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment"></span> <a class="code" href="class_authenticated_decryption_filter.html">AuthenticatedDecryptionFilter</a>(<a class="code" href="class_authenticated_symmetric_cipher.html">AuthenticatedSymmetricCipher</a> &c, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, word32 flags = DEFAULT_FLAGS, <span class="keywordtype">int</span> truncatedDigestSize=-1, <a class="code" href="namespace_name.html#a48820945ba488fac5d5507eea9a5114e">BlockPaddingScheme</a> padding = DEFAULT_PADDING);</div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span> </div><div class="line"><a name="l00715"></a><span class="lineno"><a class="line" href="class_authenticated_decryption_filter.html#a1029fdc7cf2317fad80c71a6684b0638"> 715</a></span>  std::string <a class="code" href="class_authenticated_decryption_filter.html#a1029fdc7cf2317fad80c71a6684b0638">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_hashVerifier.AlgorithmName();}</div><div class="line"><a name="l00716"></a><span class="lineno"> 716</span>  byte * <a class="code" href="class_buffered_transformation.html#a877494d8de597af935cb770034f7f170">ChannelCreatePutSpace</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> &size);</div><div class="line"><a name="l00717"></a><span class="lineno"> 717</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_buffered_transformation.html#ae6b026f47d8a0ea2e35a6cb8d9ec2c97">ChannelPut2</a>(<span class="keyword">const</span> std::string &channel, <span class="keyword">const</span> byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00718"></a><span class="lineno"> 718</span>  <span class="keywordtype">bool</span> GetLastResult()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_hashVerifier.GetLastResult();}</div><div class="line"><a name="l00719"></a><span class="lineno"> 719</span> </div><div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00721"></a><span class="lineno"> 721</span>  <span class="keywordtype">void</span> InitializeDerivedAndReturnNewSizes(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">size_t</span> &firstSize, <span class="keywordtype">size_t</span> &blockSize, <span class="keywordtype">size_t</span> &lastSize);</div><div class="line"><a name="l00722"></a><span class="lineno"> 722</span>  <span class="keywordtype">void</span> FirstPut(<span class="keyword">const</span> byte *inString);</div><div class="line"><a name="l00723"></a><span class="lineno"> 723</span>  <span class="keywordtype">void</span> NextPutMultiple(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"></span></div><div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"> /// \brief Input the last block of data</span></div><div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> /// \param inString the input byte buffer</span></div><div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment"> /// \param length the size of the input buffer, in bytes</span></div><div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment"> /// \details LastPut() processes the last block of data and signals attached filters to do the same.</span></div><div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment"> /// LastPut() is always called. The pseudo algorithm for the logic is:</span></div><div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment"> /// if totalLength < firstSize then length == totalLength</span></div><div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment"> /// else if totalLength <= firstSize+lastSize then length == totalLength-firstSize</span></div><div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment"> /// else lastSize <= length < lastSize+blockSize</span></div><div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> /// </pre></span></div><div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment"></span> <span class="keywordtype">void</span> LastPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span> </div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span>  <a class="code" href="class_hash_verification_filter.html">HashVerificationFilter</a> m_hashVerifier;</div><div class="line"><a name="l00738"></a><span class="lineno"> 738</span>  <a class="code" href="class_stream_transformation_filter.html">StreamTransformationFilter</a> m_streamFilter;</div><div class="line"><a name="l00739"></a><span class="lineno"> 739</span> };</div><div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="comment"></span></div><div class="line"><a name="l00741"></a><span class="lineno"> 741</span> <span class="comment">/// \brief Filter wrapper for PK_Signer</span></div><div class="line"><a name="l00742"></a><span class="lineno"> 742</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l00743"></a><span class="lineno"><a class="line" href="class_signer_filter.html"> 743</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_signer_filter.html">SignerFilter</a> : <span class="keyword">public</span> <a class="code" href="class_unflushable.html">Unflushable</a><Filter></div><div class="line"><a name="l00744"></a><span class="lineno"> 744</span> {</div><div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00746"></a><span class="lineno"> 746</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_signer_filter.html">SignerFilter</a>() {}</div><div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"></span></div><div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"> /// \brief Construct a SignerFilter</span></div><div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment"> /// \param rng a RandomNumberGenerator derived class</span></div><div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"> /// \param signer a PK_Signer derived class</span></div><div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment"> /// \param putMessage flag indicating whether the original message should be passed to an attached transformation</span></div><div class="line"><a name="l00753"></a><span class="lineno"><a class="line" href="class_signer_filter.html#a1676894ce3df207b64b6041bc129133e"> 753</a></span> <span class="comment"></span> <a class="code" href="class_signer_filter.html#a1676894ce3df207b64b6041bc129133e">SignerFilter</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, <span class="keyword">const</span> <a class="code" href="class_p_k___signer.html">PK_Signer</a> &signer, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, <span class="keywordtype">bool</span> putMessage=<span class="keyword">false</span>)</div><div class="line"><a name="l00754"></a><span class="lineno"> 754</span>  : m_rng(rng), m_signer(signer), m_messageAccumulator(signer.NewSignatureAccumulator(rng)), m_putMessage(putMessage) {Detach(attachment);}</div><div class="line"><a name="l00755"></a><span class="lineno"> 755</span> </div><div class="line"><a name="l00756"></a><span class="lineno"><a class="line" href="class_signer_filter.html#a8f2ff110b58fdb2b9d629f12b9d166bb"> 756</a></span>  std::string <a class="code" href="class_signer_filter.html#a8f2ff110b58fdb2b9d629f12b9d166bb">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_signer.AlgorithmName();}</div><div class="line"><a name="l00757"></a><span class="lineno"> 757</span> </div><div class="line"><a name="l00758"></a><span class="lineno"> 758</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="l00759"></a><span class="lineno"> 759</span>  <span class="keywordtype">size_t</span> Put2(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span> </div><div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00762"></a><span class="lineno"> 762</span>  <a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &m_rng;</div><div class="line"><a name="l00763"></a><span class="lineno"> 763</span>  <span class="keyword">const</span> <a class="code" href="class_p_k___signer.html">PK_Signer</a> &m_signer;</div><div class="line"><a name="l00764"></a><span class="lineno"> 764</span>  <a class="code" href="classmember__ptr.html">member_ptr<PK_MessageAccumulator></a> m_messageAccumulator;</div><div class="line"><a name="l00765"></a><span class="lineno"> 765</span>  <span class="keywordtype">bool</span> m_putMessage;</div><div class="line"><a name="l00766"></a><span class="lineno"> 766</span>  <a class="code" href="class_sec_byte_block.html">SecByteBlock</a> m_buf;</div><div class="line"><a name="l00767"></a><span class="lineno"> 767</span> };</div><div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"></span></div><div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment">/// \brief Filter wrapper for PK_Verifier</span></div><div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment">/// \details This filter was formerly named <tt>VerifierFilter</tt>. The name changed at Crypto++ 5.0.</span></div><div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l00772"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html"> 772</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_signature_verification_filter.html">SignatureVerificationFilter</a> : <span class="keyword">public</span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a></div><div class="line"><a name="l00773"></a><span class="lineno"> 773</span> {</div><div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment"> /// \brief Exception thrown when an invalid signature is encountered</span></div><div class="line"><a name="l00776"></a><span class="lineno"><a class="line" href="class_signature_verification_filter_1_1_signature_verification_failed.html"> 776</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="class_signature_verification_filter_1_1_signature_verification_failed.html">SignatureVerificationFailed</a> : <span class="keyword">public</span> <a class="code" href="class_exception.html">Exception</a></div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span>  {</div><div class="line"><a name="l00778"></a><span class="lineno"> 778</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00779"></a><span class="lineno"> 779</span>  <a class="code" href="class_signature_verification_filter_1_1_signature_verification_failed.html">SignatureVerificationFailed</a>()</div><div class="line"><a name="l00780"></a><span class="lineno"> 780</span>  : <a class="code" href="class_exception.html">Exception</a>(DATA_INTEGRITY_CHECK_FAILED, <span class="stringliteral">"VerifierFilter: digital signature not valid"</span>) {}</div><div class="line"><a name="l00781"></a><span class="lineno"> 781</span>  };</div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="comment"></span></div><div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="comment"> /// \enum Flags</span></div><div class="line"><a name="l00784"></a><span class="lineno"> 784</span> <span class="comment"> /// \brief Flags controlling filter behavior.</span></div><div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment"> /// \details The flags are a bitmask and can be OR'd together.</span></div><div class="line"><a name="l00786"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180"> 786</a></span> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180">Flags</a> {<span class="comment"></span></div><div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> /// \brief Indicates the signature is at the end of the message (i.e., concatenation of message+signature)</span></div><div class="line"><a name="l00788"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180a7ab35ff7b03a501d7156091d74452010"> 788</a></span> <span class="comment"></span> SIGNATURE_AT_END=0,<span class="comment"></span></div><div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment"> /// \brief Indicates the signature is at the beginning of the message (i.e., concatenation of signature+message)</span></div><div class="line"><a name="l00790"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180a26bac40d24e37a841fcd91b072708baa"> 790</a></span> <span class="comment"></span> SIGNATURE_AT_BEGIN=1,<span class="comment"></span></div><div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment"> /// \brief Indicates the message should be passed to an attached transformation</span></div><div class="line"><a name="l00792"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180a684aaa0090797d86a6929bb9922b6dd6"> 792</a></span> <span class="comment"></span> PUT_MESSAGE=2,<span class="comment"></span></div><div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment"> /// \brief Indicates the signature should be passed to an attached transformation</span></div><div class="line"><a name="l00794"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180aebf3d10447e668123dac4143e170189d"> 794</a></span> <span class="comment"></span> PUT_SIGNATURE=4,<span class="comment"></span></div><div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment"> /// \brief Indicates the result of the verification should be passed to an attached transformation</span></div><div class="line"><a name="l00796"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180a8b7c4e61666442d3db88e86fd985a2a5"> 796</a></span> <span class="comment"></span> PUT_RESULT=8,<span class="comment"></span></div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="comment"> /// \brief Indicates the filter should throw a HashVerificationFailed if a failure is encountered</span></div><div class="line"><a name="l00798"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180a2b9d85ccbc2be3ca34f45bf78b948c23"> 798</a></span> <span class="comment"></span> THROW_EXCEPTION=16,<span class="comment"></span></div><div class="line"><a name="l00799"></a><span class="lineno"> 799</span> <span class="comment"> /// \brief Default flags using \p SIGNATURE_AT_BEGIN and \p PUT_RESULT</span></div><div class="line"><a name="l00800"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180a41f7ffb499849a9d7ca6e0b82445e45f"> 800</a></span> <span class="comment"></span> DEFAULT_FLAGS = SIGNATURE_AT_BEGIN | PUT_RESULT</div><div class="line"><a name="l00801"></a><span class="lineno"> 801</span>  };</div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span> </div><div class="line"><a name="l00803"></a><span class="lineno"> 803</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_signature_verification_filter.html">SignatureVerificationFilter</a>() {}</div><div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"></span></div><div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> /// \brief Construct a SignatureVerificationFilter</span></div><div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> /// \param verifier a PK_Verifier derived class</span></div><div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="comment"> /// \param flags flags indicating behaviors for the filter</span></div><div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment"></span> <a class="code" href="class_signature_verification_filter.html">SignatureVerificationFilter</a>(<span class="keyword">const</span> <a class="code" href="class_p_k___verifier.html">PK_Verifier</a> &verifier, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR, word32 flags = DEFAULT_FLAGS);</div><div class="line"><a name="l00810"></a><span class="lineno"> 810</span> </div><div class="line"><a name="l00811"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#aa7e450a40faa8971970b6b8dcfa31694"> 811</a></span>  std::string <a class="code" href="class_signature_verification_filter.html#aa7e450a40faa8971970b6b8dcfa31694">AlgorithmName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_verifier.AlgorithmName();}</div><div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment"></span></div><div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment"> /// \brief Retrieves the result of the last verification</span></div><div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"> /// \returns true if the signature on the previosus message was valid, false otherwise</span></div><div class="line"><a name="l00815"></a><span class="lineno"><a class="line" href="class_signature_verification_filter.html#a8939c9cdd0f5ed772a8371e20a9bb468"> 815</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="class_signature_verification_filter.html#a8939c9cdd0f5ed772a8371e20a9bb468">GetLastResult</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_verified;}</div><div class="line"><a name="l00816"></a><span class="lineno"> 816</span> </div><div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00818"></a><span class="lineno"> 818</span>  <span class="keywordtype">void</span> InitializeDerivedAndReturnNewSizes(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">size_t</span> &firstSize, <span class="keywordtype">size_t</span> &blockSize, <span class="keywordtype">size_t</span> &lastSize);</div><div class="line"><a name="l00819"></a><span class="lineno"> 819</span>  <span class="keywordtype">void</span> FirstPut(<span class="keyword">const</span> byte *inString);</div><div class="line"><a name="l00820"></a><span class="lineno"> 820</span>  <span class="keywordtype">void</span> NextPutMultiple(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00821"></a><span class="lineno"> 821</span>  <span class="keywordtype">void</span> LastPut(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00822"></a><span class="lineno"> 822</span> </div><div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00824"></a><span class="lineno"> 824</span>  <span class="keyword">const</span> <a class="code" href="class_p_k___verifier.html">PK_Verifier</a> &m_verifier;</div><div class="line"><a name="l00825"></a><span class="lineno"> 825</span>  <a class="code" href="classmember__ptr.html">member_ptr<PK_MessageAccumulator></a> m_messageAccumulator;</div><div class="line"><a name="l00826"></a><span class="lineno"> 826</span>  word32 m_flags;</div><div class="line"><a name="l00827"></a><span class="lineno"> 827</span>  <a class="code" href="class_sec_byte_block.html">SecByteBlock</a> m_signature;</div><div class="line"><a name="l00828"></a><span class="lineno"> 828</span>  <span class="keywordtype">bool</span> m_verified;</div><div class="line"><a name="l00829"></a><span class="lineno"> 829</span> };</div><div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment"></span></div><div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="comment">/// \brief Redirect input to another BufferedTransformation without owning it</span></div><div class="line"><a name="l00832"></a><span class="lineno"> 832</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l00833"></a><span class="lineno"><a class="line" href="class_redirector.html"> 833</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_redirector.html">Redirector</a> : <span class="keyword">public</span> <a class="code" href="class_custom_signal_propagation.html">CustomSignalPropagation</a><Sink></div><div class="line"><a name="l00834"></a><span class="lineno"> 834</span> {</div><div class="line"><a name="l00835"></a><span class="lineno"> 835</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00836"></a><span class="lineno"> 836</span> <span class="comment"> /// \enum Behavior</span></div><div class="line"><a name="l00837"></a><span class="lineno"> 837</span> <span class="comment"> /// \brief Controls signal propagation behavior</span></div><div class="line"><a name="l00838"></a><span class="lineno"><a class="line" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67"> 838</a></span> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67">Behavior</a></div><div class="line"><a name="l00839"></a><span class="lineno"> 839</span>  {<span class="comment"></span></div><div class="line"><a name="l00840"></a><span class="lineno"> 840</span> <span class="comment"> /// \brief Pass data only</span></div><div class="line"><a name="l00841"></a><span class="lineno"><a class="line" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67a1ca858a44d042173d50b058a34c3403c"> 841</a></span> <span class="comment"></span> DATA_ONLY = 0x00,<span class="comment"></span></div><div class="line"><a name="l00842"></a><span class="lineno"> 842</span> <span class="comment"> /// \brief Pass signals</span></div><div class="line"><a name="l00843"></a><span class="lineno"><a class="line" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67a469c499eec32b53d40476c7ff7bb20d0"> 843</a></span> <span class="comment"></span> PASS_SIGNALS = 0x01,<span class="comment"></span></div><div class="line"><a name="l00844"></a><span class="lineno"> 844</span> <span class="comment"> /// \brief Pass wait events</span></div><div class="line"><a name="l00845"></a><span class="lineno"><a class="line" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67a619f260cb40cef8ab7a1bef2dfd568e1"> 845</a></span> <span class="comment"></span> PASS_WAIT_OBJECTS = 0x02,<span class="comment"></span></div><div class="line"><a name="l00846"></a><span class="lineno"> 846</span> <span class="comment"> /// \brief Pass everything</span></div><div class="line"><a name="l00847"></a><span class="lineno"> 847</span> <span class="comment"> /// \details PASS_EVERYTHING is default</span></div><div class="line"><a name="l00848"></a><span class="lineno"><a class="line" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67a9bedf58acdacc835d476e8783c169c2f"> 848</a></span> <span class="comment"></span> PASS_EVERYTHING = PASS_SIGNALS | PASS_WAIT_OBJECTS</div><div class="line"><a name="l00849"></a><span class="lineno"> 849</span>  };</div><div class="line"><a name="l00850"></a><span class="lineno"> 850</span> </div><div class="line"><a name="l00851"></a><span class="lineno"> 851</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_redirector.html">Redirector</a>() {}</div><div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment"></span></div><div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment"> /// \brief Construct a Redirector</span></div><div class="line"><a name="l00854"></a><span class="lineno"><a class="line" href="class_redirector.html#ad88cbf0d8971aa96eeaeff78dc743c25"> 854</a></span> <span class="comment"></span> <a class="code" href="class_redirector.html#ad88cbf0d8971aa96eeaeff78dc743c25">Redirector</a>() : m_target(NULLPTR), m_behavior(PASS_EVERYTHING) {}</div><div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"></span></div><div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"> /// \brief Construct a Redirector</span></div><div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"> /// \param target the destination BufferedTransformation</span></div><div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"> /// \param behavior Behavior "flags" specifying signal propagation</span></div><div class="line"><a name="l00859"></a><span class="lineno"><a class="line" href="class_redirector.html#a0ce7d175c4cf620add11915dcbe447fb"> 859</a></span> <span class="comment"></span> <a class="code" href="class_redirector.html#a0ce7d175c4cf620add11915dcbe447fb">Redirector</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, <a class="code" href="class_redirector.html#a2de79d5742280aa614c218c7b950de67">Behavior</a> behavior=PASS_EVERYTHING)</div><div class="line"><a name="l00860"></a><span class="lineno"> 860</span>  : m_target(&target), m_behavior(behavior) {}</div><div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment"></span></div><div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment"> /// \brief Redirect input to another BufferedTransformation</span></div><div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment"> /// \param target the destination BufferedTransformation</span></div><div class="line"><a name="l00864"></a><span class="lineno"><a class="line" href="class_redirector.html#a890fae5ac4297b1c06c6f93252a0f92c"> 864</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_redirector.html#a890fae5ac4297b1c06c6f93252a0f92c">Redirect</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target) {m_target = &target;}<span class="comment"></span></div><div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment"> /// \brief Stop redirecting input</span></div><div class="line"><a name="l00866"></a><span class="lineno"><a class="line" href="class_redirector.html#a72b5a632f5d66cd3943fa4eed1563956"> 866</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_redirector.html#a72b5a632f5d66cd3943fa4eed1563956">StopRedirection</a>() {m_target = NULLPTR;}</div><div class="line"><a name="l00867"></a><span class="lineno"> 867</span> </div><div class="line"><a name="l00868"></a><span class="lineno"> 868</span>  Behavior GetBehavior() {<span class="keywordflow">return</span> (Behavior) m_behavior;}</div><div class="line"><a name="l00869"></a><span class="lineno"> 869</span>  <span class="keywordtype">void</span> SetBehavior(Behavior behavior) {m_behavior=behavior;}</div><div class="line"><a name="l00870"></a><span class="lineno"> 870</span>  <span class="keywordtype">bool</span> GetPassSignals()<span class="keyword"> const </span>{<span class="keywordflow">return</span> (m_behavior & PASS_SIGNALS) != 0;}</div><div class="line"><a name="l00871"></a><span class="lineno"> 871</span>  <span class="keywordtype">void</span> SetPassSignals(<span class="keywordtype">bool</span> pass) { <span class="keywordflow">if</span> (pass) m_behavior |= PASS_SIGNALS; <span class="keywordflow">else</span> m_behavior &= ~(word32) PASS_SIGNALS; }</div><div class="line"><a name="l00872"></a><span class="lineno"> 872</span>  <span class="keywordtype">bool</span> GetPassWaitObjects()<span class="keyword"> const </span>{<span class="keywordflow">return</span> (m_behavior & PASS_WAIT_OBJECTS) != 0;}</div><div class="line"><a name="l00873"></a><span class="lineno"> 873</span>  <span class="keywordtype">void</span> SetPassWaitObjects(<span class="keywordtype">bool</span> pass) { <span class="keywordflow">if</span> (pass) m_behavior |= PASS_WAIT_OBJECTS; <span class="keywordflow">else</span> m_behavior &= ~(word32) PASS_WAIT_OBJECTS; }</div><div class="line"><a name="l00874"></a><span class="lineno"> 874</span> </div><div class="line"><a name="l00875"></a><span class="lineno"><a class="line" href="class_redirector.html#a2ee0003a41e0fbebe12ff2b4d9f19559"> 875</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_redirector.html#a2ee0003a41e0fbebe12ff2b4d9f19559">CanModifyInput</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="keyword"> </span>{<span class="keywordflow">return</span> m_target ? m_target->CanModifyInput() : <span class="keyword">false</span>;}</div><div class="line"><a name="l00877"></a><span class="lineno"> 877</span> </div><div class="line"><a name="l00878"></a><span class="lineno"> 878</span>  <span class="keywordtype">void</span> <a class="code" href="class_custom_signal_propagation.html#a74fd5f3bb893d25f73f5bbab2c2d89ef">Initialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters, <span class="keywordtype">int</span> propagation);</div><div class="line"><a name="l00879"></a><span class="lineno"><a class="line" href="class_redirector.html#a09afd32c22cc2d4ef9ddc8650b8657f5"> 879</a></span>  byte * <a class="code" href="class_redirector.html#a09afd32c22cc2d4ef9ddc8650b8657f5">CreatePutSpace</a>(<span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00880"></a><span class="lineno"> 880</span>  {</div><div class="line"><a name="l00881"></a><span class="lineno"> 881</span>  <span class="keywordflow">if</span> (m_target)</div><div class="line"><a name="l00882"></a><span class="lineno"> 882</span>  <span class="keywordflow">return</span> m_target->CreatePutSpace(size);</div><div class="line"><a name="l00883"></a><span class="lineno"> 883</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00884"></a><span class="lineno"> 884</span>  {</div><div class="line"><a name="l00885"></a><span class="lineno"> 885</span>  size = 0;</div><div class="line"><a name="l00886"></a><span class="lineno"> 886</span>  <span class="keywordflow">return</span> NULLPTR;</div><div class="line"><a name="l00887"></a><span class="lineno"> 887</span>  }</div><div class="line"><a name="l00888"></a><span class="lineno"> 888</span>  }</div><div class="line"><a name="l00889"></a><span class="lineno"><a class="line" href="class_redirector.html#a51620dc9565b323de2b55d3a85e830a1"> 889</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_redirector.html#a51620dc9565b323de2b55d3a85e830a1">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00890"></a><span class="lineno"> 890</span>  {<span class="keywordflow">return</span> m_target ? m_target->Put2(inString, length, GetPassSignals() ? messageEnd : 0, blocking) : 0;}</div><div class="line"><a name="l00891"></a><span class="lineno"><a class="line" href="class_redirector.html#a201243b803642ebfd392579953e75e92"> 891</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_redirector.html#a201243b803642ebfd392579953e75e92">Flush</a>(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00892"></a><span class="lineno"> 892</span>  {<span class="keywordflow">return</span> m_target && GetPassSignals() ? m_target->Flush(hardFlush, propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00893"></a><span class="lineno"><a class="line" href="class_redirector.html#a34c42c1730d031f486e5d285c6dc3314"> 893</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_redirector.html#a34c42c1730d031f486e5d285c6dc3314">MessageSeriesEnd</a>(<span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00894"></a><span class="lineno"> 894</span>  {<span class="keywordflow">return</span> m_target && GetPassSignals() ? m_target->MessageSeriesEnd(propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00895"></a><span class="lineno"> 895</span> </div><div class="line"><a name="l00896"></a><span class="lineno"><a class="line" href="class_redirector.html#a6e882384f0214dfc148abf38955ec0e5"> 896</a></span>  byte * <a class="code" href="class_redirector.html#a6e882384f0214dfc148abf38955ec0e5">ChannelCreatePutSpace</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00897"></a><span class="lineno"> 897</span>  {</div><div class="line"><a name="l00898"></a><span class="lineno"> 898</span>  <span class="keywordflow">if</span> (m_target)</div><div class="line"><a name="l00899"></a><span class="lineno"> 899</span>  <span class="keywordflow">return</span> m_target->ChannelCreatePutSpace(channel, size);</div><div class="line"><a name="l00900"></a><span class="lineno"> 900</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00901"></a><span class="lineno"> 901</span>  {</div><div class="line"><a name="l00902"></a><span class="lineno"> 902</span>  size = 0;</div><div class="line"><a name="l00903"></a><span class="lineno"> 903</span>  <span class="keywordflow">return</span> NULLPTR;</div><div class="line"><a name="l00904"></a><span class="lineno"> 904</span>  }</div><div class="line"><a name="l00905"></a><span class="lineno"> 905</span>  }</div><div class="line"><a name="l00906"></a><span class="lineno"><a class="line" href="class_redirector.html#acd6d9e39c8d0f95d99b41129f1c97dae"> 906</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_redirector.html#acd6d9e39c8d0f95d99b41129f1c97dae">ChannelPut2</a>(<span class="keyword">const</span> std::string &channel, <span class="keyword">const</span> byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00907"></a><span class="lineno"> 907</span>  {<span class="keywordflow">return</span> m_target ? m_target->ChannelPut2(channel, begin, length, GetPassSignals() ? messageEnd : 0, blocking) : 0;}</div><div class="line"><a name="l00908"></a><span class="lineno"><a class="line" href="class_redirector.html#aa39d3ce8654aede6c9473129125dffc7"> 908</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_redirector.html#aa39d3ce8654aede6c9473129125dffc7">ChannelPutModifiable2</a>(<span class="keyword">const</span> std::string &channel, byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00909"></a><span class="lineno"> 909</span>  {<span class="keywordflow">return</span> m_target ? m_target->ChannelPutModifiable2(channel, begin, length, GetPassSignals() ? messageEnd : 0, blocking) : 0;}</div><div class="line"><a name="l00910"></a><span class="lineno"><a class="line" href="class_redirector.html#a9dde3ac97812d4ba31245f46192cb627"> 910</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_redirector.html#a9dde3ac97812d4ba31245f46192cb627">ChannelFlush</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">bool</span> completeFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00911"></a><span class="lineno"> 911</span>  {<span class="keywordflow">return</span> m_target && GetPassSignals() ? m_target->ChannelFlush(channel, completeFlush, propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00912"></a><span class="lineno"><a class="line" href="class_redirector.html#a827e4af441934015de54ceb14334503d"> 912</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_redirector.html#a827e4af441934015de54ceb14334503d">ChannelMessageSeriesEnd</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00913"></a><span class="lineno"> 913</span>  {<span class="keywordflow">return</span> m_target && GetPassSignals() ? m_target->ChannelMessageSeriesEnd(channel, propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00914"></a><span class="lineno"> 914</span> </div><div class="line"><a name="l00915"></a><span class="lineno"><a class="line" href="class_redirector.html#a421073132346b5dc66750520cd859c94"> 915</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_redirector.html#a421073132346b5dc66750520cd859c94">GetMaxWaitObjectCount</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00916"></a><span class="lineno"> 916</span> <span class="keyword"> </span>{ <span class="keywordflow">return</span> m_target && GetPassWaitObjects() ? m_target->GetMaxWaitObjectCount() : 0; }</div><div class="line"><a name="l00917"></a><span class="lineno"><a class="line" href="class_redirector.html#ac0dc5f63f7a57af37f819aa9251a78bf"> 917</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_redirector.html#ac0dc5f63f7a57af37f819aa9251a78bf">GetWaitObjects</a>(<a class="code" href="class_wait_object_container.html">WaitObjectContainer</a> &container, <a class="code" href="class_call_stack.html">CallStack</a> <span class="keyword">const</span>& callStack)</div><div class="line"><a name="l00918"></a><span class="lineno"> 918</span>  { <span class="keywordflow">if</span> (m_target && GetPassWaitObjects()) m_target->GetWaitObjects(container, callStack); }</div><div class="line"><a name="l00919"></a><span class="lineno"> 919</span> </div><div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00921"></a><span class="lineno"> 921</span>  <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *m_target;</div><div class="line"><a name="l00922"></a><span class="lineno"> 922</span>  word32 m_behavior;</div><div class="line"><a name="l00923"></a><span class="lineno"> 923</span> };</div><div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="comment"></span></div><div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="comment">/// \brief Filter class that is a proxy for a sink</span></div><div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment">/// \details Used By ProxyFilter</span></div><div class="line"><a name="l00927"></a><span class="lineno"> 927</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l00928"></a><span class="lineno"><a class="line" href="class_output_proxy.html"> 928</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_output_proxy.html">OutputProxy</a> : <span class="keyword">public</span> <a class="code" href="class_custom_signal_propagation.html">CustomSignalPropagation</a><Sink></div><div class="line"><a name="l00929"></a><span class="lineno"> 929</span> {</div><div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00931"></a><span class="lineno"> 931</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_output_proxy.html">OutputProxy</a>() {}</div><div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment"></span></div><div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment"> /// \brief Construct an OutputProxy</span></div><div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment"> /// \param owner the owning transformation</span></div><div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment"> /// \param passSignal flag indicating if signals should be passed</span></div><div class="line"><a name="l00936"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a56e14de9505c46a71bf2cf565995cb64"> 936</a></span> <span class="comment"></span> <a class="code" href="class_output_proxy.html#a56e14de9505c46a71bf2cf565995cb64">OutputProxy</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &owner, <span class="keywordtype">bool</span> passSignal) : m_owner(owner), m_passSignal(passSignal) {}</div><div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"></span></div><div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"> /// \brief Retrieve passSignal flag</span></div><div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"> /// \returns flag indicating if signals should be passed</span></div><div class="line"><a name="l00940"></a><span class="lineno"><a class="line" href="class_output_proxy.html#aabd1f4183ac5222c62868e9e6aefce8b"> 940</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="class_output_proxy.html#aabd1f4183ac5222c62868e9e6aefce8b">GetPassSignal</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_passSignal;}<span class="comment"></span></div><div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment"> /// \brief Set passSignal flag</span></div><div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment"> /// \param passSignal flag indicating if signals should be passed</span></div><div class="line"><a name="l00943"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a997ff0e5b2ac162e96805f8753dfae40"> 943</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_output_proxy.html#a997ff0e5b2ac162e96805f8753dfae40">SetPassSignal</a>(<span class="keywordtype">bool</span> passSignal) {m_passSignal = passSignal;}</div><div class="line"><a name="l00944"></a><span class="lineno"> 944</span> </div><div class="line"><a name="l00945"></a><span class="lineno"><a class="line" href="class_output_proxy.html#ae0400c5e91f8d8c50e2b4da7d15bf646"> 945</a></span>  byte * <a class="code" href="class_output_proxy.html#ae0400c5e91f8d8c50e2b4da7d15bf646">CreatePutSpace</a>(<span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00946"></a><span class="lineno"> 946</span>  {<span class="keywordflow">return</span> m_owner.AttachedTransformation()->CreatePutSpace(size);}</div><div class="line"><a name="l00947"></a><span class="lineno"><a class="line" href="class_output_proxy.html#ade676bde70daea1949bab94e72d93b18"> 947</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_output_proxy.html#ade676bde70daea1949bab94e72d93b18">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00948"></a><span class="lineno"> 948</span>  {<span class="keywordflow">return</span> m_owner.AttachedTransformation()->Put2(inString, length, m_passSignal ? messageEnd : 0, blocking);}</div><div class="line"><a name="l00949"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a0b7247fde67865b260d55763e14fdfa5"> 949</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_output_proxy.html#a0b7247fde67865b260d55763e14fdfa5">PutModifiable2</a>(byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00950"></a><span class="lineno"> 950</span>  {<span class="keywordflow">return</span> m_owner.AttachedTransformation()->PutModifiable2(begin, length, m_passSignal ? messageEnd : 0, blocking);}</div><div class="line"><a name="l00951"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a48d4fa2095a31780f6bc0b37737de49f"> 951</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_output_proxy.html#a48d4fa2095a31780f6bc0b37737de49f">Initialize</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters=<a class="code" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>, <span class="keywordtype">int</span> propagation=-1)</div><div class="line"><a name="l00952"></a><span class="lineno"> 952</span>  {<span class="keywordflow">if</span> (m_passSignal) m_owner.AttachedTransformation()->Initialize(parameters, propagation);}</div><div class="line"><a name="l00953"></a><span class="lineno"><a class="line" href="class_output_proxy.html#aa6c68d78790266c60fa8b27176fbf969"> 953</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_output_proxy.html#aa6c68d78790266c60fa8b27176fbf969">Flush</a>(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00954"></a><span class="lineno"> 954</span>  {<span class="keywordflow">return</span> m_passSignal ? m_owner.AttachedTransformation()->Flush(hardFlush, propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00955"></a><span class="lineno"><a class="line" href="class_output_proxy.html#aecf5c216c060f2e6adfeb4019e6ad797"> 955</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_output_proxy.html#aecf5c216c060f2e6adfeb4019e6ad797">MessageSeriesEnd</a>(<span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00956"></a><span class="lineno"> 956</span>  {<span class="keywordflow">return</span> m_passSignal ? m_owner.AttachedTransformation()->MessageSeriesEnd(propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00957"></a><span class="lineno"> 957</span> </div><div class="line"><a name="l00958"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a51301674845151fb1e6b9f599d6ffbc9"> 958</a></span>  byte * <a class="code" href="class_output_proxy.html#a51301674845151fb1e6b9f599d6ffbc9">ChannelCreatePutSpace</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">size_t</span> &size)</div><div class="line"><a name="l00959"></a><span class="lineno"> 959</span>  {<span class="keywordflow">return</span> m_owner.AttachedTransformation()->ChannelCreatePutSpace(channel, size);}</div><div class="line"><a name="l00960"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a13ff9fb43d2b5d08e83a130b630c907a"> 960</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_output_proxy.html#a13ff9fb43d2b5d08e83a130b630c907a">ChannelPut2</a>(<span class="keyword">const</span> std::string &channel, <span class="keyword">const</span> byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00961"></a><span class="lineno"> 961</span>  {<span class="keywordflow">return</span> m_owner.AttachedTransformation()->ChannelPut2(channel, begin, length, m_passSignal ? messageEnd : 0, blocking);}</div><div class="line"><a name="l00962"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a7d01981113dfb1543b7e04b96522cc1e"> 962</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_output_proxy.html#a7d01981113dfb1543b7e04b96522cc1e">ChannelPutModifiable2</a>(<span class="keyword">const</span> std::string &channel, byte *begin, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l00963"></a><span class="lineno"> 963</span>  {<span class="keywordflow">return</span> m_owner.AttachedTransformation()->ChannelPutModifiable2(channel, begin, length, m_passSignal ? messageEnd : 0, blocking);}</div><div class="line"><a name="l00964"></a><span class="lineno"><a class="line" href="class_output_proxy.html#a7aeaa853d3be4abac2b65fa45b5763db"> 964</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_output_proxy.html#a7aeaa853d3be4abac2b65fa45b5763db">ChannelFlush</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">bool</span> completeFlush, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00965"></a><span class="lineno"> 965</span>  {<span class="keywordflow">return</span> m_passSignal ? m_owner.AttachedTransformation()->ChannelFlush(channel, completeFlush, propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00966"></a><span class="lineno"><a class="line" href="class_output_proxy.html#aae129d7efb204cbe5c733032de298fcc"> 966</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_output_proxy.html#aae129d7efb204cbe5c733032de298fcc">ChannelMessageSeriesEnd</a>(<span class="keyword">const</span> std::string &channel, <span class="keywordtype">int</span> propagation=-1, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l00967"></a><span class="lineno"> 967</span>  {<span class="keywordflow">return</span> m_passSignal ? m_owner.AttachedTransformation()->ChannelMessageSeriesEnd(channel, propagation, blocking) : <span class="keyword">false</span>;}</div><div class="line"><a name="l00968"></a><span class="lineno"> 968</span> </div><div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00970"></a><span class="lineno"> 970</span>  <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &m_owner;</div><div class="line"><a name="l00971"></a><span class="lineno"> 971</span>  <span class="keywordtype">bool</span> m_passSignal;</div><div class="line"><a name="l00972"></a><span class="lineno"> 972</span> };</div><div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"></span></div><div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment">/// \brief Base class for Filter classes that are proxies for a chain of other filters</span></div><div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l00976"></a><span class="lineno"><a class="line" href="class_proxy_filter.html"> 976</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_proxy_filter.html">ProxyFilter</a> : <span class="keyword">public</span> <a class="code" href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a></div><div class="line"><a name="l00977"></a><span class="lineno"> 977</span> {</div><div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00979"></a><span class="lineno"> 979</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_proxy_filter.html">ProxyFilter</a>() {}</div><div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"></span></div><div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment"> /// \brief Construct a ProxyFilter</span></div><div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> /// \param filter an output filter</span></div><div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment"> /// \param firstSize the first Put size</span></div><div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment"> /// \param lastSize the last Put size</span></div><div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment"> /// \param attachment an attached transformation</span></div><div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="comment"></span> <a class="code" href="class_proxy_filter.html">ProxyFilter</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *filter, <span class="keywordtype">size_t</span> firstSize, <span class="keywordtype">size_t</span> lastSize, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment);</div><div class="line"><a name="l00987"></a><span class="lineno"> 987</span> </div><div class="line"><a name="l00988"></a><span class="lineno"> 988</span>  <span class="keywordtype">bool</span> <a class="code" href="class_filter_with_buffered_input.html#a4261e0491864a31738cf53b3f9343806">IsolatedFlush</a>(<span class="keywordtype">bool</span> hardFlush, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l00989"></a><span class="lineno"> 989</span> <span class="comment"></span></div><div class="line"><a name="l00990"></a><span class="lineno"> 990</span> <span class="comment"> /// \brief Sets the OutputProxy filter</span></div><div class="line"><a name="l00991"></a><span class="lineno"> 991</span> <span class="comment"> /// \param filter an OutputProxy filter</span></div><div class="line"><a name="l00992"></a><span class="lineno"> 992</span> <span class="comment"></span> <span class="keywordtype">void</span> SetFilter(<a class="code" href="class_filter.html">Filter</a> *filter);</div><div class="line"><a name="l00993"></a><span class="lineno"> 993</span>  <span class="keywordtype">void</span> NextPutMultiple(<span class="keyword">const</span> byte *s, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00994"></a><span class="lineno"> 994</span>  <span class="keywordtype">void</span> NextPutModifiable(byte *inString, <span class="keywordtype">size_t</span> length);</div><div class="line"><a name="l00995"></a><span class="lineno"> 995</span> </div><div class="line"><a name="l00996"></a><span class="lineno"> 996</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00997"></a><span class="lineno"> 997</span>  <a class="code" href="classmember__ptr.html">member_ptr<BufferedTransformation></a> m_filter;</div><div class="line"><a name="l00998"></a><span class="lineno"> 998</span> };</div><div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment"></span></div><div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment">/// \brief Proxy filter that doesn't modify the underlying filter's input or output</span></div><div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l01002"></a><span class="lineno"><a class="line" href="class_simple_proxy_filter.html"> 1002</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a> : <span class="keyword">public</span> <a class="code" href="class_proxy_filter.html">ProxyFilter</a></div><div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> {</div><div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment"> /// \brief Construct a SimpleProxyFilter</span></div><div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="comment"> /// \param filter an output filter</span></div><div class="line"><a name="l01007"></a><span class="lineno"> 1007</span> <span class="comment"> /// \param attachment an attached transformation</span></div><div class="line"><a name="l01008"></a><span class="lineno"><a class="line" href="class_simple_proxy_filter.html#a8ff6d868e53aa3da69e9190884e4168d"> 1008</a></span> <span class="comment"></span> <a class="code" href="class_simple_proxy_filter.html#a8ff6d868e53aa3da69e9190884e4168d">SimpleProxyFilter</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *filter, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment)</div><div class="line"><a name="l01009"></a><span class="lineno"> 1009</span>  : <a class="code" href="class_proxy_filter.html">ProxyFilter</a>(filter, 0, 0, attachment) {}</div><div class="line"><a name="l01010"></a><span class="lineno"> 1010</span> </div><div class="line"><a name="l01011"></a><span class="lineno"> 1011</span>  <span class="keywordtype">void</span> FirstPut(<span class="keyword">const</span> byte * inString)</div><div class="line"><a name="l01012"></a><span class="lineno"> 1012</span>  {CRYPTOPP_UNUSED(inString);}</div><div class="line"><a name="l01013"></a><span class="lineno"> 1013</span> <span class="comment"></span></div><div class="line"><a name="l01014"></a><span class="lineno"> 1014</span> <span class="comment"> /// \brief Input the last block of data</span></div><div class="line"><a name="l01015"></a><span class="lineno"> 1015</span> <span class="comment"> /// \param inString the input byte buffer</span></div><div class="line"><a name="l01016"></a><span class="lineno"> 1016</span> <span class="comment"> /// \param length the size of the input buffer, in bytes</span></div><div class="line"><a name="l01017"></a><span class="lineno"> 1017</span> <span class="comment"> /// \details LastPut() processes the last block of data and signals attached filters to do the same.</span></div><div class="line"><a name="l01018"></a><span class="lineno"> 1018</span> <span class="comment"> /// LastPut() is always called. The pseudo algorithm for the logic is:</span></div><div class="line"><a name="l01019"></a><span class="lineno"> 1019</span> <span class="comment"> /// <pre></span></div><div class="line"><a name="l01020"></a><span class="lineno"> 1020</span> <span class="comment"> /// if totalLength < firstSize then length == totalLength</span></div><div class="line"><a name="l01021"></a><span class="lineno"> 1021</span> <span class="comment"> /// else if totalLength <= firstSize+lastSize then length == totalLength-firstSize</span></div><div class="line"><a name="l01022"></a><span class="lineno"> 1022</span> <span class="comment"> /// else lastSize <= length < lastSize+blockSize</span></div><div class="line"><a name="l01023"></a><span class="lineno"> 1023</span> <span class="comment"> /// </pre></span></div><div class="line"><a name="l01024"></a><span class="lineno"><a class="line" href="class_simple_proxy_filter.html#ac012ee6fab5a2a7de9071c61e0372123"> 1024</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_simple_proxy_filter.html#ac012ee6fab5a2a7de9071c61e0372123">LastPut</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length)</div><div class="line"><a name="l01025"></a><span class="lineno"> 1025</span>  {CRYPTOPP_UNUSED(inString), CRYPTOPP_UNUSED(length); m_filter->MessageEnd();}</div><div class="line"><a name="l01026"></a><span class="lineno"> 1026</span> };</div><div class="line"><a name="l01027"></a><span class="lineno"> 1027</span> <span class="comment"></span></div><div class="line"><a name="l01028"></a><span class="lineno"> 1028</span> <span class="comment">/// \brief Filter wrapper for PK_Encryptor</span></div><div class="line"><a name="l01029"></a><span class="lineno"> 1029</span> <span class="comment">/// \details PK_DecryptorFilter is a proxy for the filter created by PK_Encryptor::CreateEncryptionFilter.</span></div><div class="line"><a name="l01030"></a><span class="lineno"> 1030</span> <span class="comment">/// This class provides symmetry with VerifierFilter.</span></div><div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l01032"></a><span class="lineno"><a class="line" href="class_p_k___encryptor_filter.html"> 1032</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_p_k___encryptor_filter.html">PK_EncryptorFilter</a> : <span class="keyword">public</span> <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a></div><div class="line"><a name="l01033"></a><span class="lineno"> 1033</span> {</div><div class="line"><a name="l01034"></a><span class="lineno"> 1034</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l01035"></a><span class="lineno"> 1035</span> <span class="comment"> /// \brief Construct a PK_EncryptorFilter</span></div><div class="line"><a name="l01036"></a><span class="lineno"> 1036</span> <span class="comment"> /// \param rng a RandomNumberGenerator derived class</span></div><div class="line"><a name="l01037"></a><span class="lineno"> 1037</span> <span class="comment"> /// \param encryptor a PK_Encryptor derived class</span></div><div class="line"><a name="l01038"></a><span class="lineno"> 1038</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01039"></a><span class="lineno"><a class="line" href="class_p_k___encryptor_filter.html#aea9b12fbe885a3f5c7c9a1a048d1a8b8"> 1039</a></span> <span class="comment"></span> <a class="code" href="class_p_k___encryptor_filter.html#aea9b12fbe885a3f5c7c9a1a048d1a8b8">PK_EncryptorFilter</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, <span class="keyword">const</span> <a class="code" href="class_p_k___encryptor.html">PK_Encryptor</a> &encryptor, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01040"></a><span class="lineno"> 1040</span>  : <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a>(encryptor.CreateEncryptionFilter(rng), attachment) {}</div><div class="line"><a name="l01041"></a><span class="lineno"> 1041</span> };</div><div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment"></span></div><div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment">/// \brief Filter wrapper for PK_Decryptor</span></div><div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment">/// \details PK_DecryptorFilter is a proxy for the filter created by PK_Decryptor::CreateDecryptionFilter.</span></div><div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment">/// This class provides symmetry with SignerFilter.</span></div><div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l01047"></a><span class="lineno"><a class="line" href="class_p_k___decryptor_filter.html"> 1047</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_p_k___decryptor_filter.html">PK_DecryptorFilter</a> : <span class="keyword">public</span> <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a></div><div class="line"><a name="l01048"></a><span class="lineno"> 1048</span> {</div><div class="line"><a name="l01049"></a><span class="lineno"> 1049</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l01050"></a><span class="lineno"> 1050</span> <span class="comment"> /// \brief Construct a PK_DecryptorFilter</span></div><div class="line"><a name="l01051"></a><span class="lineno"> 1051</span> <span class="comment"> /// \param rng a RandomNumberGenerator derived class</span></div><div class="line"><a name="l01052"></a><span class="lineno"> 1052</span> <span class="comment"> /// \param decryptor a PK_Decryptor derived class</span></div><div class="line"><a name="l01053"></a><span class="lineno"> 1053</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01054"></a><span class="lineno"><a class="line" href="class_p_k___decryptor_filter.html#ae4807490fea0a4bc861279d8a4b2bb05"> 1054</a></span> <span class="comment"></span> <a class="code" href="class_p_k___decryptor_filter.html#ae4807490fea0a4bc861279d8a4b2bb05">PK_DecryptorFilter</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, <span class="keyword">const</span> <a class="code" href="class_p_k___decryptor.html">PK_Decryptor</a> &decryptor, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01055"></a><span class="lineno"> 1055</span>  : <a class="code" href="class_simple_proxy_filter.html">SimpleProxyFilter</a>(decryptor.CreateDecryptionFilter(rng), attachment) {}</div><div class="line"><a name="l01056"></a><span class="lineno"> 1056</span> };</div><div class="line"><a name="l01057"></a><span class="lineno"> 1057</span> <span class="comment"></span></div><div class="line"><a name="l01058"></a><span class="lineno"> 1058</span> <span class="comment">/// \brief Append input to a string object</span></div><div class="line"><a name="l01059"></a><span class="lineno"> 1059</span> <span class="comment">/// \tparam T std::basic_string<char> type</span></div><div class="line"><a name="l01060"></a><span class="lineno"> 1060</span> <span class="comment">/// \details StringSinkTemplate is a StringSinkTemplate typedef</span></div><div class="line"><a name="l01061"></a><span class="lineno"> 1061</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l01062"></a><span class="lineno"> 1062</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l01063"></a><span class="lineno"><a class="line" href="class_string_sink_template.html"> 1063</a></span> <span class="keyword">class </span><a class="code" href="class_string_sink_template.html">StringSinkTemplate</a> : <span class="keyword">public</span> <a class="code" href="class_bufferless.html">Bufferless</a><Sink></div><div class="line"><a name="l01064"></a><span class="lineno"> 1064</span> {</div><div class="line"><a name="l01065"></a><span class="lineno"> 1065</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01066"></a><span class="lineno"> 1066</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_string_sink_template.html">StringSinkTemplate</a>() {}</div><div class="line"><a name="l01067"></a><span class="lineno"> 1067</span> <span class="comment"></span></div><div class="line"><a name="l01068"></a><span class="lineno"> 1068</span> <span class="comment"> /// \brief Construct a StringSinkTemplate</span></div><div class="line"><a name="l01069"></a><span class="lineno"> 1069</span> <span class="comment"> /// \param output std::basic_string<char> type</span></div><div class="line"><a name="l01070"></a><span class="lineno"><a class="line" href="class_string_sink_template.html#a7f718529861bfc5c77e3f6f230026c07"> 1070</a></span> <span class="comment"></span> <a class="code" href="class_string_sink_template.html#a7f718529861bfc5c77e3f6f230026c07">StringSinkTemplate</a>(T &output)</div><div class="line"><a name="l01071"></a><span class="lineno"> 1071</span>  : m_output(&output) {<a class="code" href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a>(<span class="keyword">sizeof</span>(output[0])==1);}</div><div class="line"><a name="l01072"></a><span class="lineno"> 1072</span> </div><div class="line"><a name="l01073"></a><span class="lineno"><a class="line" href="class_string_sink_template.html#aca537f96a83a3006a32a4848af2f47f5"> 1073</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_string_sink_template.html#aca537f96a83a3006a32a4848af2f47f5">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="l01074"></a><span class="lineno"> 1074</span>  {<span class="keywordflow">if</span> (!parameters.<a class="code" href="class_name_value_pairs.html#a5357c3a09602e44671d1e42cb9a9408d">GetValue</a>(<span class="stringliteral">"OutputStringPointer"</span>, m_output)) <span class="keywordflow">throw</span> <a class="code" href="class_invalid_argument.html">InvalidArgument</a>(<span class="stringliteral">"StringSink: OutputStringPointer not specified"</span>);}</div><div class="line"><a name="l01075"></a><span class="lineno"> 1075</span> </div><div class="line"><a name="l01076"></a><span class="lineno"><a class="line" href="class_string_sink_template.html#a167e78771671daf216f190bd4fe13c9b"> 1076</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_string_sink_template.html#a167e78771671daf216f190bd4fe13c9b">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking)</div><div class="line"><a name="l01077"></a><span class="lineno"> 1077</span>  {</div><div class="line"><a name="l01078"></a><span class="lineno"> 1078</span>  CRYPTOPP_UNUSED(messageEnd); CRYPTOPP_UNUSED(blocking);</div><div class="line"><a name="l01079"></a><span class="lineno"> 1079</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> T::traits_type::char_type char_type;</div><div class="line"><a name="l01080"></a><span class="lineno"> 1080</span> </div><div class="line"><a name="l01081"></a><span class="lineno"> 1081</span>  <span class="keywordflow">if</span> (length > 0)</div><div class="line"><a name="l01082"></a><span class="lineno"> 1082</span>  {</div><div class="line"><a name="l01083"></a><span class="lineno"> 1083</span>  <span class="keyword">typename</span> T::size_type size = m_output->size();</div><div class="line"><a name="l01084"></a><span class="lineno"> 1084</span>  <span class="keywordflow">if</span> (length < size && size + length > m_output->capacity())</div><div class="line"><a name="l01085"></a><span class="lineno"> 1085</span>  m_output->reserve(2*size);</div><div class="line"><a name="l01086"></a><span class="lineno"> 1086</span>  m_output->append((<span class="keyword">const</span> char_type *)inString, (<span class="keyword">const</span> char_type *)inString+length);</div><div class="line"><a name="l01087"></a><span class="lineno"> 1087</span>  }</div><div class="line"><a name="l01088"></a><span class="lineno"> 1088</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l01089"></a><span class="lineno"> 1089</span>  }</div><div class="line"><a name="l01090"></a><span class="lineno"> 1090</span> </div><div class="line"><a name="l01091"></a><span class="lineno"> 1091</span> <span class="keyword">private</span>:</div><div class="line"><a name="l01092"></a><span class="lineno"> 1092</span>  T *m_output;</div><div class="line"><a name="l01093"></a><span class="lineno"> 1093</span> };</div><div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="comment"></span></div><div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> <span class="comment">/// \brief Append input to a string object</span></div><div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="comment">/// \details StringSink is a typedef for StringSinkTemplate<std::string>.</span></div><div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> <span class="comment">/// \sa ArraySink, ArrayXorSink</span></div><div class="line"><a name="l01098"></a><span class="lineno"> 1098</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01099"></a><span class="lineno"><a class="line" href="class_string_sink.html"> 1099</a></span> <span class="comment"></span>DOCUMENTED_TYPEDEF(<a class="code" href="class_string_sink_template.html">StringSinkTemplate<std::string></a>, <a class="code" href="class_string_sink.html">StringSink</a>)</div><div class="line"><a name="l01100"></a><span class="lineno"> 1100</span> CRYPTOPP_DLL_TEMPLATE_CLASS <a class="code" href="class_string_sink_template.html">StringSinkTemplate<std::string></a>;</div><div class="line"><a name="l01101"></a><span class="lineno"> 1101</span> <span class="comment"></span></div><div class="line"><a name="l01102"></a><span class="lineno"> 1102</span> <span class="comment">/// \brief Incorporates input into RNG as additional entropy</span></div><div class="line"><a name="l01103"></a><span class="lineno"> 1103</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01104"></a><span class="lineno"><a class="line" href="class_random_number_sink.html"> 1104</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_random_number_sink.html">RandomNumberSink</a> : <span class="keyword">public</span> <a class="code" href="class_bufferless.html">Bufferless</a><Sink></div><div class="line"><a name="l01105"></a><span class="lineno"> 1105</span> {</div><div class="line"><a name="l01106"></a><span class="lineno"> 1106</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01107"></a><span class="lineno"> 1107</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_random_number_sink.html">RandomNumberSink</a>() {}</div><div class="line"><a name="l01108"></a><span class="lineno"> 1108</span> <span class="comment"></span></div><div class="line"><a name="l01109"></a><span class="lineno"> 1109</span> <span class="comment"> /// \brief Construct a RandomNumberSink</span></div><div class="line"><a name="l01110"></a><span class="lineno"><a class="line" href="class_random_number_sink.html#a8623fa452a55a1ae8af75efe640cde91"> 1110</a></span> <span class="comment"></span> <a class="code" href="class_random_number_sink.html#a8623fa452a55a1ae8af75efe640cde91">RandomNumberSink</a>()</div><div class="line"><a name="l01111"></a><span class="lineno"> 1111</span>  : m_rng(NULLPTR) {}</div><div class="line"><a name="l01112"></a><span class="lineno"> 1112</span> <span class="comment"></span></div><div class="line"><a name="l01113"></a><span class="lineno"> 1113</span> <span class="comment"> /// \brief Construct a RandomNumberSink</span></div><div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> <span class="comment"> /// \param rng a RandomNumberGenerator derived class</span></div><div class="line"><a name="l01115"></a><span class="lineno"><a class="line" href="class_random_number_sink.html#ab18490b9bb18559cd6274453a4efea2a"> 1115</a></span> <span class="comment"></span> <a class="code" href="class_random_number_sink.html#ab18490b9bb18559cd6274453a4efea2a">RandomNumberSink</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng)</div><div class="line"><a name="l01116"></a><span class="lineno"> 1116</span>  : m_rng(&rng) {}</div><div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> </div><div class="line"><a name="l01118"></a><span class="lineno"> 1118</span>  <span class="keywordtype">void</span> <a class="code" href="class_random_number_sink.html#ad9eb1681d33e03ebf6ef43dc70299c9e">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="l01119"></a><span class="lineno"> 1119</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_random_number_sink.html#aed57770519427841e3aac3abc251bc64">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l01120"></a><span class="lineno"> 1120</span> </div><div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> <span class="keyword">private</span>:</div><div class="line"><a name="l01122"></a><span class="lineno"> 1122</span>  <a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> *m_rng;</div><div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> };</div><div class="line"><a name="l01124"></a><span class="lineno"> 1124</span> <span class="comment"></span></div><div class="line"><a name="l01125"></a><span class="lineno"> 1125</span> <span class="comment">/// \brief Copy input to a memory buffer</span></div><div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> <span class="comment">/// \details ArraySink wraps a fixed size buffer. The buffer is full once Put returns non-0.</span></div><div class="line"><a name="l01127"></a><span class="lineno"> 1127</span> <span class="comment">/// When used in a pipleline, ArraySink silently discards input if the buffer is full.</span></div><div class="line"><a name="l01128"></a><span class="lineno"> 1128</span> <span class="comment">/// AvailableSize() can be used to determine how much space remains in the buffer.</span></div><div class="line"><a name="l01129"></a><span class="lineno"> 1129</span> <span class="comment">/// TotalPutLength() can be used to determine how many bytes were processed.</span></div><div class="line"><a name="l01130"></a><span class="lineno"> 1130</span> <span class="comment">/// \sa StringSink, ArrayXorSink</span></div><div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01132"></a><span class="lineno"><a class="line" href="class_array_sink.html"> 1132</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_array_sink.html">ArraySink</a> : <span class="keyword">public</span> <a class="code" href="class_bufferless.html">Bufferless</a><Sink></div><div class="line"><a name="l01133"></a><span class="lineno"> 1133</span> {</div><div class="line"><a name="l01134"></a><span class="lineno"> 1134</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01135"></a><span class="lineno"> 1135</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_array_sink.html">ArraySink</a>() {}</div><div class="line"><a name="l01136"></a><span class="lineno"> 1136</span> <span class="comment"></span></div><div class="line"><a name="l01137"></a><span class="lineno"> 1137</span> <span class="comment"> /// \brief Construct an ArraySink</span></div><div class="line"><a name="l01138"></a><span class="lineno"> 1138</span> <span class="comment"> /// \param parameters a set of NameValuePairs to initialize this object</span></div><div class="line"><a name="l01139"></a><span class="lineno"> 1139</span> <span class="comment"> /// \details Name::OutputBuffer() is a mandatory parameter using this constructor.</span></div><div class="line"><a name="l01140"></a><span class="lineno"><a class="line" href="class_array_sink.html#a70d9e1c3231cb190831fd16e132ace2b"> 1140</a></span> <span class="comment"></span> <a class="code" href="class_array_sink.html#a70d9e1c3231cb190831fd16e132ace2b">ArraySink</a>(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters = <a class="code" href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a>)</div><div class="line"><a name="l01141"></a><span class="lineno"> 1141</span>  : m_buf(NULLPTR), m_size(0), m_total(0) {IsolatedInitialize(parameters);}</div><div class="line"><a name="l01142"></a><span class="lineno"> 1142</span> <span class="comment"></span></div><div class="line"><a name="l01143"></a><span class="lineno"> 1143</span> <span class="comment"> /// \brief Construct an ArraySink</span></div><div class="line"><a name="l01144"></a><span class="lineno"> 1144</span> <span class="comment"> /// \param buf pointer to a memory buffer</span></div><div class="line"><a name="l01145"></a><span class="lineno"> 1145</span> <span class="comment"> /// \param size length of the memory buffer</span></div><div class="line"><a name="l01146"></a><span class="lineno"><a class="line" href="class_array_sink.html#a2651a72ad26f0ced19013a425195e0e1"> 1146</a></span> <span class="comment"></span> <a class="code" href="class_array_sink.html#a2651a72ad26f0ced19013a425195e0e1">ArraySink</a>(byte *buf, <span class="keywordtype">size_t</span> size)</div><div class="line"><a name="l01147"></a><span class="lineno"> 1147</span>  : m_buf(buf), m_size(size), m_total(0) {}</div><div class="line"><a name="l01148"></a><span class="lineno"> 1148</span> <span class="comment"></span></div><div class="line"><a name="l01149"></a><span class="lineno"> 1149</span> <span class="comment"> /// \brief Provides the size remaining in the Sink</span></div><div class="line"><a name="l01150"></a><span class="lineno"> 1150</span> <span class="comment"> /// \returns size remaining in the Sink, in bytes</span></div><div class="line"><a name="l01151"></a><span class="lineno"><a class="line" href="class_array_sink.html#a8a0b2bc344136755ae7edc83cea078cc"> 1151</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="class_array_sink.html#a8a0b2bc344136755ae7edc83cea078cc">AvailableSize</a>() {<span class="keywordflow">return</span> <a class="code" href="misc_8h.html#a30712a90999ad9d9152975f2e92d46b8">SaturatingSubtract</a>(m_size, m_total);}</div><div class="line"><a name="l01152"></a><span class="lineno"> 1152</span> <span class="comment"></span></div><div class="line"><a name="l01153"></a><span class="lineno"> 1153</span> <span class="comment"> /// \brief Provides the number of bytes written to the Sink</span></div><div class="line"><a name="l01154"></a><span class="lineno"> 1154</span> <span class="comment"> /// \returns number of bytes written to the Sink, in bytes</span></div><div class="line"><a name="l01155"></a><span class="lineno"><a class="line" href="class_array_sink.html#a36374569bfaf3711c3a7a306a46ea6d9"> 1155</a></span> <span class="comment"></span> lword <a class="code" href="class_array_sink.html#a36374569bfaf3711c3a7a306a46ea6d9">TotalPutLength</a>() {<span class="keywordflow">return</span> m_total;}</div><div class="line"><a name="l01156"></a><span class="lineno"> 1156</span> </div><div class="line"><a name="l01157"></a><span class="lineno"> 1157</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="l01158"></a><span class="lineno"> 1158</span>  byte * CreatePutSpace(<span class="keywordtype">size_t</span> &size);</div><div class="line"><a name="l01159"></a><span class="lineno"> 1159</span>  <span class="keywordtype">size_t</span> Put2(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l01160"></a><span class="lineno"> 1160</span> </div><div class="line"><a name="l01161"></a><span class="lineno"> 1161</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l01162"></a><span class="lineno"> 1162</span>  byte *m_buf;</div><div class="line"><a name="l01163"></a><span class="lineno"> 1163</span>  <span class="keywordtype">size_t</span> m_size;</div><div class="line"><a name="l01164"></a><span class="lineno"> 1164</span>  lword m_total;</div><div class="line"><a name="l01165"></a><span class="lineno"> 1165</span> };</div><div class="line"><a name="l01166"></a><span class="lineno"> 1166</span> <span class="comment"></span></div><div class="line"><a name="l01167"></a><span class="lineno"> 1167</span> <span class="comment">/// \brief Xor input to a memory buffer</span></div><div class="line"><a name="l01168"></a><span class="lineno"> 1168</span> <span class="comment">/// \details ArrayXorSink wraps a fixed size buffer. The buffer is full once Put returns non-0.</span></div><div class="line"><a name="l01169"></a><span class="lineno"> 1169</span> <span class="comment">/// When used in a pipleline, ArrayXorSink silently discards input if the buffer is full.</span></div><div class="line"><a name="l01170"></a><span class="lineno"> 1170</span> <span class="comment">/// AvailableSize() can be used to determine how much space remains in the buffer.</span></div><div class="line"><a name="l01171"></a><span class="lineno"> 1171</span> <span class="comment">/// TotalPutLength() can be used to determine how many bytes were processed.</span></div><div class="line"><a name="l01172"></a><span class="lineno"> 1172</span> <span class="comment">/// \sa StringSink, ArraySink</span></div><div class="line"><a name="l01173"></a><span class="lineno"> 1173</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01174"></a><span class="lineno"><a class="line" href="class_array_xor_sink.html"> 1174</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_array_xor_sink.html">ArrayXorSink</a> : <span class="keyword">public</span> <a class="code" href="class_array_sink.html">ArraySink</a></div><div class="line"><a name="l01175"></a><span class="lineno"> 1175</span> {</div><div class="line"><a name="l01176"></a><span class="lineno"> 1176</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01177"></a><span class="lineno"> 1177</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_array_xor_sink.html">ArrayXorSink</a>() {}</div><div class="line"><a name="l01178"></a><span class="lineno"> 1178</span> <span class="comment"></span></div><div class="line"><a name="l01179"></a><span class="lineno"> 1179</span> <span class="comment"> /// \brief Construct an ArrayXorSink</span></div><div class="line"><a name="l01180"></a><span class="lineno"> 1180</span> <span class="comment"> /// \param buf pointer to a memory buffer</span></div><div class="line"><a name="l01181"></a><span class="lineno"> 1181</span> <span class="comment"> /// \param size length of the memory buffer</span></div><div class="line"><a name="l01182"></a><span class="lineno"><a class="line" href="class_array_xor_sink.html#a2cb0d33318f1272826d235698191b68d"> 1182</a></span> <span class="comment"></span> <a class="code" href="class_array_xor_sink.html#a2cb0d33318f1272826d235698191b68d">ArrayXorSink</a>(byte *buf, <span class="keywordtype">size_t</span> size)</div><div class="line"><a name="l01183"></a><span class="lineno"> 1183</span>  : <a class="code" href="class_array_sink.html">ArraySink</a>(buf, size) {}</div><div class="line"><a name="l01184"></a><span class="lineno"> 1184</span> </div><div class="line"><a name="l01185"></a><span class="lineno"> 1185</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_array_sink.html#ad3459c605b5eb52fa24efcb4dc35d29d">Put2</a>(<span class="keyword">const</span> byte *inString, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> messageEnd, <span class="keywordtype">bool</span> blocking);</div><div class="line"><a name="l01186"></a><span class="lineno"><a class="line" href="class_array_xor_sink.html#a39567ce27137cc06ed9a2b0a1c834f01"> 1186</a></span>  byte * <a class="code" href="class_array_xor_sink.html#a39567ce27137cc06ed9a2b0a1c834f01">CreatePutSpace</a>(<span class="keywordtype">size_t</span> &size) {<span class="keywordflow">return</span> <a class="code" href="class_buffered_transformation.html#af390325c959c3d6a2c03a447d6cd469d">BufferedTransformation::CreatePutSpace</a>(size);}</div><div class="line"><a name="l01187"></a><span class="lineno"> 1187</span> };</div><div class="line"><a name="l01188"></a><span class="lineno"> 1188</span> <span class="comment"></span></div><div class="line"><a name="l01189"></a><span class="lineno"> 1189</span> <span class="comment">/// \brief String-based implementation of Store interface</span></div><div class="line"><a name="l01190"></a><span class="lineno"> 1190</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01191"></a><span class="lineno"><a class="line" href="class_string_store.html"> 1191</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="class_string_store.html">StringStore</a> : <span class="keyword">public</span> <a class="code" href="class_store.html">Store</a></div><div class="line"><a name="l01192"></a><span class="lineno"> 1192</span> {</div><div class="line"><a name="l01193"></a><span class="lineno"> 1193</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l01194"></a><span class="lineno"> 1194</span> <span class="comment"> /// \brief Construct a StringStore</span></div><div class="line"><a name="l01195"></a><span class="lineno"> 1195</span> <span class="comment"> /// \param string pointer to a C-String</span></div><div class="line"><a name="l01196"></a><span class="lineno"><a class="line" href="class_string_store.html#aa35e0ca808e5b5c5f433e95fe3a9e371"> 1196</a></span> <span class="comment"></span> <a class="code" href="class_string_store.html#aa35e0ca808e5b5c5f433e95fe3a9e371">StringStore</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span> = NULLPTR)</div><div class="line"><a name="l01197"></a><span class="lineno"> 1197</span>  {StoreInitialize(<a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"InputBuffer"</span>, <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(<span class="keywordtype">string</span>)));}</div><div class="line"><a name="l01198"></a><span class="lineno"> 1198</span> <span class="comment"></span></div><div class="line"><a name="l01199"></a><span class="lineno"> 1199</span> <span class="comment"> /// \brief Construct a StringStore</span></div><div class="line"><a name="l01200"></a><span class="lineno"> 1200</span> <span class="comment"> /// \param string pointer to a memory buffer</span></div><div class="line"><a name="l01201"></a><span class="lineno"> 1201</span> <span class="comment"> /// \param length size of the memory buffer</span></div><div class="line"><a name="l01202"></a><span class="lineno"><a class="line" href="class_string_store.html#a842dfd9b74c9539b12b3589028b78876"> 1202</a></span> <span class="comment"></span> <a class="code" href="class_string_store.html#a842dfd9b74c9539b12b3589028b78876">StringStore</a>(<span class="keyword">const</span> byte *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> length)</div><div class="line"><a name="l01203"></a><span class="lineno"> 1203</span>  {StoreInitialize(<a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"InputBuffer"</span>, <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(<span class="keywordtype">string</span>, length)));}</div><div class="line"><a name="l01204"></a><span class="lineno"> 1204</span> <span class="comment"></span></div><div class="line"><a name="l01205"></a><span class="lineno"> 1205</span> <span class="comment"> /// \brief Construct a StringStore</span></div><div class="line"><a name="l01206"></a><span class="lineno"> 1206</span> <span class="comment"> /// \tparam T std::basic_string<char> type</span></div><div class="line"><a name="l01207"></a><span class="lineno"> 1207</span> <span class="comment"> /// \param string reference to a std::basic_string<char> type</span></div><div class="line"><a name="l01208"></a><span class="lineno"><a class="line" href="class_string_store.html#a96eaf8d3dae545b6b4a44443a27d9ffb"> 1208</a></span> <span class="comment"></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <a class="code" href="class_string_store.html#a96eaf8d3dae545b6b4a44443a27d9ffb">StringStore</a>(<span class="keyword">const</span> T &<span class="keywordtype">string</span>)</div><div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>  {StoreInitialize(<a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"InputBuffer"</span>, <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(<span class="keywordtype">string</span>)));}</div><div class="line"><a name="l01210"></a><span class="lineno"> 1210</span> </div><div class="line"><a name="l01211"></a><span class="lineno"> 1211</span>  CRYPTOPP_DLL <span class="keywordtype">size_t</span> <a class="code" href="class_string_store.html#acca5c45df0db23ac71fb363d7005743b">TransferTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</div><div class="line"><a name="l01212"></a><span class="lineno"> 1212</span>  CRYPTOPP_DLL <span class="keywordtype">size_t</span> <a class="code" href="class_string_store.html#a1272eeca9a2496019bb524faa23ac557">CopyRangeTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l01213"></a><span class="lineno"> 1213</span> </div><div class="line"><a name="l01214"></a><span class="lineno"> 1214</span> <span class="keyword">private</span>:</div><div class="line"><a name="l01215"></a><span class="lineno"> 1215</span>  CRYPTOPP_DLL <span class="keywordtype">void</span> StoreInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters);</div><div class="line"><a name="l01216"></a><span class="lineno"> 1216</span> </div><div class="line"><a name="l01217"></a><span class="lineno"> 1217</span>  <span class="keyword">const</span> byte *m_store;</div><div class="line"><a name="l01218"></a><span class="lineno"> 1218</span>  <span class="keywordtype">size_t</span> m_length, m_count;</div><div class="line"><a name="l01219"></a><span class="lineno"> 1219</span> };</div><div class="line"><a name="l01220"></a><span class="lineno"> 1220</span> <span class="comment"></span></div><div class="line"><a name="l01221"></a><span class="lineno"> 1221</span> <span class="comment">/// \brief RNG-based implementation of Source interface</span></div><div class="line"><a name="l01222"></a><span class="lineno"> 1222</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01223"></a><span class="lineno"><a class="line" href="class_random_number_store.html"> 1223</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_random_number_store.html">RandomNumberStore</a> : <span class="keyword">public</span> <a class="code" href="class_store.html">Store</a></div><div class="line"><a name="l01224"></a><span class="lineno"> 1224</span> {</div><div class="line"><a name="l01225"></a><span class="lineno"> 1225</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01226"></a><span class="lineno"> 1226</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_random_number_store.html">RandomNumberStore</a>() {}</div><div class="line"><a name="l01227"></a><span class="lineno"> 1227</span> </div><div class="line"><a name="l01228"></a><span class="lineno"> 1228</span>  <a class="code" href="class_random_number_store.html">RandomNumberStore</a>()</div><div class="line"><a name="l01229"></a><span class="lineno"> 1229</span>  : m_rng(NULLPTR), m_length(0), m_count(0) {}</div><div class="line"><a name="l01230"></a><span class="lineno"> 1230</span> </div><div class="line"><a name="l01231"></a><span class="lineno"> 1231</span>  <a class="code" href="class_random_number_store.html">RandomNumberStore</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, lword length)</div><div class="line"><a name="l01232"></a><span class="lineno"> 1232</span>  : m_rng(&rng), m_length(length), m_count(0) {}</div><div class="line"><a name="l01233"></a><span class="lineno"> 1233</span> </div><div class="line"><a name="l01234"></a><span class="lineno"><a class="line" href="class_random_number_store.html#a036cdd35be6f6dc847b8ea17f6d8a9e8"> 1234</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_random_number_store.html#a036cdd35be6f6dc847b8ea17f6d8a9e8">AnyRetrievable</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <a class="code" href="class_buffered_transformation.html#a30b2076bce5fb29e992b6457485c67c2">MaxRetrievable</a>() != 0;}</div><div class="line"><a name="l01235"></a><span class="lineno"><a class="line" href="class_random_number_store.html#a32bb1cb70f9724ac88330fe516d7b076"> 1235</a></span>  lword <a class="code" href="class_random_number_store.html#a32bb1cb70f9724ac88330fe516d7b076">MaxRetrievable</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_length-m_count;}</div><div class="line"><a name="l01236"></a><span class="lineno"> 1236</span> </div><div class="line"><a name="l01237"></a><span class="lineno"> 1237</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_buffered_transformation.html#a27ac15af3ef43c5ad1e9db5812025fcd">TransferTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</div><div class="line"><a name="l01238"></a><span class="lineno"><a class="line" href="class_random_number_store.html#ab1007214c6ed0398440bb38b4db47d68"> 1238</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_random_number_store.html#ab1007214c6ed0398440bb38b4db47d68">CopyRangeTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)<span class="keyword"> const</span></div><div class="line"><a name="l01239"></a><span class="lineno"> 1239</span> <span class="keyword"> </span>{</div><div class="line"><a name="l01240"></a><span class="lineno"> 1240</span>  CRYPTOPP_UNUSED(target); CRYPTOPP_UNUSED(begin); CRYPTOPP_UNUSED(end); CRYPTOPP_UNUSED(channel); CRYPTOPP_UNUSED(blocking);</div><div class="line"><a name="l01241"></a><span class="lineno"> 1241</span>  <span class="keywordflow">throw</span> <a class="code" href="class_not_implemented.html">NotImplemented</a>(<span class="stringliteral">"RandomNumberStore: CopyRangeTo2() is not supported by this store"</span>);</div><div class="line"><a name="l01242"></a><span class="lineno"> 1242</span>  }</div><div class="line"><a name="l01243"></a><span class="lineno"> 1243</span> </div><div class="line"><a name="l01244"></a><span class="lineno"> 1244</span> <span class="keyword">private</span>:</div><div class="line"><a name="l01245"></a><span class="lineno"> 1245</span>  <span class="keywordtype">void</span> StoreInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters);</div><div class="line"><a name="l01246"></a><span class="lineno"> 1246</span> </div><div class="line"><a name="l01247"></a><span class="lineno"> 1247</span>  <a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> *m_rng;</div><div class="line"><a name="l01248"></a><span class="lineno"> 1248</span>  lword m_length, m_count;</div><div class="line"><a name="l01249"></a><span class="lineno"> 1249</span> };</div><div class="line"><a name="l01250"></a><span class="lineno"> 1250</span> <span class="comment"></span></div><div class="line"><a name="l01251"></a><span class="lineno"> 1251</span> <span class="comment">/// \brief Empty store</span></div><div class="line"><a name="l01252"></a><span class="lineno"> 1252</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l01253"></a><span class="lineno"><a class="line" href="class_null_store.html"> 1253</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_null_store.html">NullStore</a> : <span class="keyword">public</span> <a class="code" href="class_store.html">Store</a></div><div class="line"><a name="l01254"></a><span class="lineno"> 1254</span> {</div><div class="line"><a name="l01255"></a><span class="lineno"> 1255</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01256"></a><span class="lineno"> 1256</span>  <a class="code" href="class_null_store.html">NullStore</a>(lword size = ULONG_MAX) : m_size(size) {}</div><div class="line"><a name="l01257"></a><span class="lineno"> 1257</span>  <span class="keywordtype">void</span> StoreInitialize(<span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</div><div class="line"><a name="l01258"></a><span class="lineno"> 1258</span>  {CRYPTOPP_UNUSED(parameters);}</div><div class="line"><a name="l01259"></a><span class="lineno"><a class="line" href="class_null_store.html#ae34e25265289f889c8ea2e2bf6dda275"> 1259</a></span>  lword <a class="code" href="class_null_store.html#ae34e25265289f889c8ea2e2bf6dda275">MaxRetrievable</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_size;}</div><div class="line"><a name="l01260"></a><span class="lineno"> 1260</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_buffered_transformation.html#a27ac15af3ef43c5ad1e9db5812025fcd">TransferTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</div><div class="line"><a name="l01261"></a><span class="lineno"> 1261</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_buffered_transformation.html#a7f90ef36f633c97c1ae519b800527d8e">CopyRangeTo2</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, <span class="keyword">const</span> std::string &channel=<a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l01262"></a><span class="lineno"> 1262</span> </div><div class="line"><a name="l01263"></a><span class="lineno"> 1263</span> <span class="keyword">private</span>:</div><div class="line"><a name="l01264"></a><span class="lineno"> 1264</span>  lword m_size;</div><div class="line"><a name="l01265"></a><span class="lineno"> 1265</span> };</div><div class="line"><a name="l01266"></a><span class="lineno"> 1266</span> <span class="comment"></span></div><div class="line"><a name="l01267"></a><span class="lineno"> 1267</span> <span class="comment">/// \brief Implementation of BufferedTransformation's attachment interface</span></div><div class="line"><a name="l01268"></a><span class="lineno"> 1268</span> <span class="comment">/// \details Source is a cornerstone of the Pipeline trinitiy. Data flows from</span></div><div class="line"><a name="l01269"></a><span class="lineno"> 1269</span> <span class="comment">/// Sources, through Filters, and then terminates in Sinks. The difference</span></div><div class="line"><a name="l01270"></a><span class="lineno"> 1270</span> <span class="comment">/// between a Source and Filter is a Source \a pumps data, while a Filter does</span></div><div class="line"><a name="l01271"></a><span class="lineno"> 1271</span> <span class="comment">/// not. The difference between a Filter and a Sink is a Filter allows an</span></div><div class="line"><a name="l01272"></a><span class="lineno"> 1272</span> <span class="comment">/// attached transformation, while a Sink does not.</span></div><div class="line"><a name="l01273"></a><span class="lineno"> 1273</span> <span class="comment">/// \details See the discussion of BufferedTransformation in cryptlib.h for</span></div><div class="line"><a name="l01274"></a><span class="lineno"> 1274</span> <span class="comment">/// more details.</span></div><div class="line"><a name="l01275"></a><span class="lineno"> 1275</span> <span class="comment">/// \sa Store and SourceTemplate</span></div><div class="line"><a name="l01276"></a><span class="lineno"> 1276</span> <span class="comment">/// \since Crypto++ 1.0</span></div><div class="line"><a name="l01277"></a><span class="lineno"><a class="line" href="class_source.html"> 1277</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE <a class="code" href="class_source.html">Source</a> : <span class="keyword">public</span> <a class="code" href="class_input_rejecting.html">InputRejecting</a><Filter></div><div class="line"><a name="l01278"></a><span class="lineno"> 1278</span> {</div><div class="line"><a name="l01279"></a><span class="lineno"> 1279</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01280"></a><span class="lineno"> 1280</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_source.html">Source</a>() {}</div><div class="line"><a name="l01281"></a><span class="lineno"> 1281</span> <span class="comment"></span></div><div class="line"><a name="l01282"></a><span class="lineno"> 1282</span> <span class="comment"> /// \brief Construct a Source</span></div><div class="line"><a name="l01283"></a><span class="lineno"> 1283</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01284"></a><span class="lineno"><a class="line" href="class_source.html#a99d1d02e5d32ea8b21db7158f7cab2a9"> 1284</a></span> <span class="comment"></span> <a class="code" href="class_source.html#a99d1d02e5d32ea8b21db7158f7cab2a9">Source</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01285"></a><span class="lineno"> 1285</span>  {<a class="code" href="class_filter.html#a93817876b45172108fe0342de6442f75">Source::Detach</a>(attachment);}</div><div class="line"><a name="l01286"></a><span class="lineno"> 1286</span> <span class="comment"></span></div><div class="line"><a name="l01287"></a><span class="lineno"> 1287</span> <span class="comment"> /// \name PIPELINE</span></div><div class="line"><a name="l01288"></a><span class="lineno"> 1288</span> <span class="comment"></span><span class="comment"> //@{</span></div><div class="line"><a name="l01289"></a><span class="lineno"> 1289</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l01290"></a><span class="lineno"> 1290</span> <span class="comment"> /// \brief Pump data to attached transformation</span></div><div class="line"><a name="l01291"></a><span class="lineno"> 1291</span> <span class="comment"> /// \param pumpMax the maximpum number of bytes to pump</span></div><div class="line"><a name="l01292"></a><span class="lineno"> 1292</span> <span class="comment"> /// \returns the number of bytes that remain in the block (i.e., bytes not processed)</span></div><div class="line"><a name="l01293"></a><span class="lineno"> 1293</span> <span class="comment"> /// \details Internally, Pump() calls Pump2().</span></div><div class="line"><a name="l01294"></a><span class="lineno"> 1294</span> <span class="comment"> /// \note pumpMax is a \p lword, which is a 64-bit value that typically uses \p LWORD_MAX. The default</span></div><div class="line"><a name="l01295"></a><span class="lineno"> 1295</span> <span class="comment"> /// argument is a \p size_t that uses \p SIZE_MAX, and it can be 32-bits or 64-bits.</span></div><div class="line"><a name="l01296"></a><span class="lineno"><a class="line" href="class_source.html#ac7a9ccd5a212d6752be2abce0d90a6af"> 1296</a></span> <span class="comment"></span> lword <a class="code" href="class_source.html#ac7a9ccd5a212d6752be2abce0d90a6af">Pump</a>(lword pumpMax=(<span class="keywordtype">size_t</span>)<a class="code" href="misc_8h.html#a3c75bb398badb69c7577b21486f9963f">SIZE_MAX</a>)</div><div class="line"><a name="l01297"></a><span class="lineno"> 1297</span>  {Pump2(pumpMax); <span class="keywordflow">return</span> pumpMax;}</div><div class="line"><a name="l01298"></a><span class="lineno"> 1298</span> <span class="comment"></span></div><div class="line"><a name="l01299"></a><span class="lineno"> 1299</span> <span class="comment"> /// \brief Pump messages to attached transformation</span></div><div class="line"><a name="l01300"></a><span class="lineno"> 1300</span> <span class="comment"> /// \param count the maximpum number of messages to pump</span></div><div class="line"><a name="l01301"></a><span class="lineno"> 1301</span> <span class="comment"> /// \returns TODO</span></div><div class="line"><a name="l01302"></a><span class="lineno"> 1302</span> <span class="comment"> /// \details Internally, PumpMessages() calls PumpMessages2().</span></div><div class="line"><a name="l01303"></a><span class="lineno"><a class="line" href="class_source.html#a515aad3c590ad819ddaf37c1340d9b31"> 1303</a></span> <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_source.html#a515aad3c590ad819ddaf37c1340d9b31">PumpMessages</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> count=UINT_MAX)</div><div class="line"><a name="l01304"></a><span class="lineno"> 1304</span>  {PumpMessages2(count); <span class="keywordflow">return</span> count;}</div><div class="line"><a name="l01305"></a><span class="lineno"> 1305</span> <span class="comment"></span></div><div class="line"><a name="l01306"></a><span class="lineno"> 1306</span> <span class="comment"> /// \brief Pump all data to attached transformation</span></div><div class="line"><a name="l01307"></a><span class="lineno"> 1307</span> <span class="comment"> /// \details Internally, PumpAll() calls PumpAll2().</span></div><div class="line"><a name="l01308"></a><span class="lineno"><a class="line" href="class_source.html#a78f3f645fc7a1af7e7a814d8a7d22a69"> 1308</a></span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="class_source.html#a78f3f645fc7a1af7e7a814d8a7d22a69">PumpAll</a>()</div><div class="line"><a name="l01309"></a><span class="lineno"> 1309</span>  {PumpAll2();}</div><div class="line"><a name="l01310"></a><span class="lineno"> 1310</span> <span class="comment"></span></div><div class="line"><a name="l01311"></a><span class="lineno"> 1311</span> <span class="comment"> /// \brief Pump data to attached transformation</span></div><div class="line"><a name="l01312"></a><span class="lineno"> 1312</span> <span class="comment"> /// \param byteCount the maximpum number of bytes to pump</span></div><div class="line"><a name="l01313"></a><span class="lineno"> 1313</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l01314"></a><span class="lineno"> 1314</span> <span class="comment"> /// \returns the number of bytes that remain in the block (i.e., bytes not processed)</span></div><div class="line"><a name="l01315"></a><span class="lineno"> 1315</span> <span class="comment"> /// \details byteCount is an \a IN and \a OUT parameter. When the call is made, byteCount is the</span></div><div class="line"><a name="l01316"></a><span class="lineno"> 1316</span> <span class="comment"> /// requested size of the pump. When the call returns, byteCount is the number of bytes that</span></div><div class="line"><a name="l01317"></a><span class="lineno"> 1317</span> <span class="comment"> /// were pumped.</span></div><div class="line"><a name="l01318"></a><span class="lineno"> 1318</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> Pump2(lword &byteCount, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) =0;</div><div class="line"><a name="l01319"></a><span class="lineno"> 1319</span> <span class="comment"></span></div><div class="line"><a name="l01320"></a><span class="lineno"> 1320</span> <span class="comment"> /// \brief Pump messages to attached transformation</span></div><div class="line"><a name="l01321"></a><span class="lineno"> 1321</span> <span class="comment"> /// \param messageCount the maximpum number of messages to pump</span></div><div class="line"><a name="l01322"></a><span class="lineno"> 1322</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l01323"></a><span class="lineno"> 1323</span> <span class="comment"> /// \details messageCount is an IN and OUT parameter.</span></div><div class="line"><a name="l01324"></a><span class="lineno"> 1324</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> PumpMessages2(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &messageCount, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>) =0;</div><div class="line"><a name="l01325"></a><span class="lineno"> 1325</span> <span class="comment"></span></div><div class="line"><a name="l01326"></a><span class="lineno"> 1326</span> <span class="comment"> /// \brief Pump all data to attached transformation</span></div><div class="line"><a name="l01327"></a><span class="lineno"> 1327</span> <span class="comment"> /// \param blocking specifies whether the object should block when processing input</span></div><div class="line"><a name="l01328"></a><span class="lineno"> 1328</span> <span class="comment"> /// \returns the number of bytes that remain in the block (i.e., bytes not processed)</span></div><div class="line"><a name="l01329"></a><span class="lineno"> 1329</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> PumpAll2(<span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>);</div><div class="line"><a name="l01330"></a><span class="lineno"> 1330</span> <span class="comment"></span></div><div class="line"><a name="l01331"></a><span class="lineno"> 1331</span> <span class="comment"> /// \brief Determines if the Source is exhausted</span></div><div class="line"><a name="l01332"></a><span class="lineno"> 1332</span> <span class="comment"> /// \returns true if the source has been exhausted</span></div><div class="line"><a name="l01333"></a><span class="lineno"> 1333</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SourceExhausted() <span class="keyword">const</span> =0;</div><div class="line"><a name="l01334"></a><span class="lineno"> 1334</span> <span class="comment"></span></div><div class="line"><a name="l01335"></a><span class="lineno"> 1335</span> <span class="comment"> //@}</span></div><div class="line"><a name="l01336"></a><span class="lineno"> 1336</span> <span class="comment"></span></div><div class="line"><a name="l01337"></a><span class="lineno"> 1337</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l01338"></a><span class="lineno"> 1338</span>  <span class="keywordtype">void</span> SourceInitialize(<span class="keywordtype">bool</span> pumpAll, <span class="keyword">const</span> <a class="code" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</div><div class="line"><a name="l01339"></a><span class="lineno"> 1339</span>  {</div><div class="line"><a name="l01340"></a><span class="lineno"> 1340</span>  IsolatedInitialize(parameters);</div><div class="line"><a name="l01341"></a><span class="lineno"> 1341</span>  <span class="keywordflow">if</span> (pumpAll)</div><div class="line"><a name="l01342"></a><span class="lineno"> 1342</span>  PumpAll();</div><div class="line"><a name="l01343"></a><span class="lineno"> 1343</span>  }</div><div class="line"><a name="l01344"></a><span class="lineno"> 1344</span> };</div><div class="line"><a name="l01345"></a><span class="lineno"> 1345</span> <span class="comment"></span></div><div class="line"><a name="l01346"></a><span class="lineno"> 1346</span> <span class="comment">/// \brief Transform a Store into a Source</span></div><div class="line"><a name="l01347"></a><span class="lineno"> 1347</span> <span class="comment">/// \tparam T the class or type</span></div><div class="line"><a name="l01348"></a><span class="lineno"> 1348</span> <span class="comment">/// \since Crypto++ 5.0</span></div><div class="line"><a name="l01349"></a><span class="lineno"> 1349</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l01350"></a><span class="lineno"><a class="line" href="class_source_template.html"> 1350</a></span> <span class="keyword">class </span><a class="code" href="class_source_template.html">SourceTemplate</a> : <span class="keyword">public</span> <a class="code" href="class_source.html">Source</a></div><div class="line"><a name="l01351"></a><span class="lineno"> 1351</span> {</div><div class="line"><a name="l01352"></a><span class="lineno"> 1352</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01353"></a><span class="lineno"> 1353</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_source_template.html">SourceTemplate</a>() {}</div><div class="line"><a name="l01354"></a><span class="lineno"> 1354</span> <span class="comment"></span></div><div class="line"><a name="l01355"></a><span class="lineno"> 1355</span> <span class="comment"> /// \brief Construct a SourceTemplate</span></div><div class="line"><a name="l01356"></a><span class="lineno"> 1356</span> <span class="comment"> /// \param attachment an attached transformation</span></div><div class="line"><a name="l01357"></a><span class="lineno"><a class="line" href="class_source_template.html#a91f9615aa2a7ede51f3f64242c398851"> 1357</a></span> <span class="comment"></span> <a class="code" href="class_source_template.html">SourceTemplate<T></a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment)</div><div class="line"><a name="l01358"></a><span class="lineno"> 1358</span>  : <a class="code" href="class_source.html#a99d1d02e5d32ea8b21db7158f7cab2a9">Source</a>(attachment) {}</div><div class="line"><a name="l01359"></a><span class="lineno"><a class="line" href="class_source_template.html#ae0f81a7cfeb0cc6307e141907b62c5a3"> 1359</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_source_template.html#ae0f81a7cfeb0cc6307e141907b62c5a3">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="l01360"></a><span class="lineno"> 1360</span>  {m_store.IsolatedInitialize(parameters);}</div><div class="line"><a name="l01361"></a><span class="lineno"><a class="line" href="class_source_template.html#a09c47f0ee80586dc9495dbe2975b6dcd"> 1361</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_source_template.html#a09c47f0ee80586dc9495dbe2975b6dcd">Pump2</a>(lword &byteCount, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l01362"></a><span class="lineno"> 1362</span>  {<span class="keywordflow">return</span> m_store.TransferTo2(*<a class="code" href="class_filter.html#ac8fc888888b2dad88bf64fc703044a93">AttachedTransformation</a>(), byteCount, <a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, blocking);}</div><div class="line"><a name="l01363"></a><span class="lineno"><a class="line" href="class_source_template.html#a1e4b61addf5d1aaf71566ab4c625a103"> 1363</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_source_template.html#a1e4b61addf5d1aaf71566ab4c625a103">PumpMessages2</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &messageCount, <span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l01364"></a><span class="lineno"> 1364</span>  {<span class="keywordflow">return</span> m_store.TransferMessagesTo2(*<a class="code" href="class_filter.html#ac8fc888888b2dad88bf64fc703044a93">AttachedTransformation</a>(), messageCount, <a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, blocking);}</div><div class="line"><a name="l01365"></a><span class="lineno"><a class="line" href="class_source_template.html#adc1704305aff166b4a5afdb3a9929af4"> 1365</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="class_source_template.html#adc1704305aff166b4a5afdb3a9929af4">PumpAll2</a>(<span class="keywordtype">bool</span> blocking=<span class="keyword">true</span>)</div><div class="line"><a name="l01366"></a><span class="lineno"> 1366</span>  {<span class="keywordflow">return</span> m_store.TransferAllTo2(*<a class="code" href="class_filter.html#ac8fc888888b2dad88bf64fc703044a93">AttachedTransformation</a>(), <a class="code" href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a>, blocking);}</div><div class="line"><a name="l01367"></a><span class="lineno"><a class="line" href="class_source_template.html#abd4e1c80639fbbb06277581875ac2972"> 1367</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_source_template.html#abd4e1c80639fbbb06277581875ac2972">SourceExhausted</a>()<span class="keyword"> const</span></div><div class="line"><a name="l01368"></a><span class="lineno"> 1368</span> <span class="keyword"> </span>{<span class="keywordflow">return</span> !m_store.AnyRetrievable() && !m_store.AnyMessages();}</div><div class="line"><a name="l01369"></a><span class="lineno"><a class="line" href="class_source_template.html#af7f891477e9fcea66954f848b86de0a2"> 1369</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_source_template.html#af7f891477e9fcea66954f848b86de0a2">SetAutoSignalPropagation</a>(<span class="keywordtype">int</span> propagation)</div><div class="line"><a name="l01370"></a><span class="lineno"> 1370</span>  {m_store.SetAutoSignalPropagation(propagation);}</div><div class="line"><a name="l01371"></a><span class="lineno"><a class="line" href="class_source_template.html#aeb0d3d0a6e3f56d88e9dabcec2e096f9"> 1371</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_source_template.html#aeb0d3d0a6e3f56d88e9dabcec2e096f9">GetAutoSignalPropagation</a>()<span class="keyword"> const</span></div><div class="line"><a name="l01372"></a><span class="lineno"> 1372</span> <span class="keyword"> </span>{<span class="keywordflow">return</span> m_store.GetAutoSignalPropagation();}</div><div class="line"><a name="l01373"></a><span class="lineno"> 1373</span> </div><div class="line"><a name="l01374"></a><span class="lineno"> 1374</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l01375"></a><span class="lineno"> 1375</span>  T m_store;</div><div class="line"><a name="l01376"></a><span class="lineno"> 1376</span> };</div><div class="line"><a name="l01377"></a><span class="lineno"> 1377</span> <span class="comment"></span></div><div class="line"><a name="l01378"></a><span class="lineno"> 1378</span> <span class="comment">/// \brief String-based implementation of the Source interface</span></div><div class="line"><a name="l01379"></a><span class="lineno"> 1379</span> <span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01380"></a><span class="lineno"><a class="line" href="class_string_source.html"> 1380</a></span> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_string_source.html">StringSource</a> : <span class="keyword">public</span> <a class="code" href="class_source_template.html">SourceTemplate</a><StringStore></div><div class="line"><a name="l01381"></a><span class="lineno"> 1381</span> {</div><div class="line"><a name="l01382"></a><span class="lineno"> 1382</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l01383"></a><span class="lineno"> 1383</span> <span class="comment"> /// \brief Construct a StringSource</span></div><div class="line"><a name="l01384"></a><span class="lineno"> 1384</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01385"></a><span class="lineno"><a class="line" href="class_string_source.html#a0c56127a806471ead64e2b4e8956147f"> 1385</a></span> <span class="comment"></span> <a class="code" href="class_string_source.html#a0c56127a806471ead64e2b4e8956147f">StringSource</a>(<a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01386"></a><span class="lineno"> 1386</span>  : <a class="code" href="class_source_template.html">SourceTemplate</a><<a class="code" href="class_string_store.html">StringStore</a>>(attachment) {}</div><div class="line"><a name="l01387"></a><span class="lineno"> 1387</span> <span class="comment"></span></div><div class="line"><a name="l01388"></a><span class="lineno"> 1388</span> <span class="comment"> /// \brief Construct a StringSource</span></div><div class="line"><a name="l01389"></a><span class="lineno"> 1389</span> <span class="comment"> /// \param string C-String</span></div><div class="line"><a name="l01390"></a><span class="lineno"> 1390</span> <span class="comment"> /// \param pumpAll flag indicating if source data should be pumped to its attached transformation</span></div><div class="line"><a name="l01391"></a><span class="lineno"> 1391</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01392"></a><span class="lineno"><a class="line" href="class_string_source.html#a82dbf0b3d0b311f090344a88a86e010d"> 1392</a></span> <span class="comment"></span> <a class="code" href="class_string_source.html#a82dbf0b3d0b311f090344a88a86e010d">StringSource</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>, <span class="keywordtype">bool</span> pumpAll, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01393"></a><span class="lineno"> 1393</span>  : <a class="code" href="class_source_template.html">SourceTemplate</a><<a class="code" href="class_string_store.html">StringStore</a>>(attachment) {SourceInitialize(pumpAll, <a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"InputBuffer"</span>, <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(<span class="keywordtype">string</span>)));}</div><div class="line"><a name="l01394"></a><span class="lineno"> 1394</span> <span class="comment"></span></div><div class="line"><a name="l01395"></a><span class="lineno"> 1395</span> <span class="comment"> /// \brief Construct a StringSource</span></div><div class="line"><a name="l01396"></a><span class="lineno"> 1396</span> <span class="comment"> /// \param string binary byte array</span></div><div class="line"><a name="l01397"></a><span class="lineno"> 1397</span> <span class="comment"> /// \param length size of the byte array</span></div><div class="line"><a name="l01398"></a><span class="lineno"> 1398</span> <span class="comment"> /// \param pumpAll flag indicating if source data should be pumped to its attached transformation</span></div><div class="line"><a name="l01399"></a><span class="lineno"> 1399</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01400"></a><span class="lineno"><a class="line" href="class_string_source.html#a86185516e7339e3a6192be9b88493a00"> 1400</a></span> <span class="comment"></span> <a class="code" href="class_string_source.html#a86185516e7339e3a6192be9b88493a00">StringSource</a>(<span class="keyword">const</span> byte *<span class="keywordtype">string</span>, <span class="keywordtype">size_t</span> length, <span class="keywordtype">bool</span> pumpAll, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01401"></a><span class="lineno"> 1401</span>  : <a class="code" href="class_source_template.html">SourceTemplate</a><<a class="code" href="class_string_store.html">StringStore</a>>(attachment) {SourceInitialize(pumpAll, <a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"InputBuffer"</span>, <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(<span class="keywordtype">string</span>, length)));}</div><div class="line"><a name="l01402"></a><span class="lineno"> 1402</span> <span class="comment"></span></div><div class="line"><a name="l01403"></a><span class="lineno"> 1403</span> <span class="comment"> /// \brief Construct a StringSource</span></div><div class="line"><a name="l01404"></a><span class="lineno"> 1404</span> <span class="comment"> /// \param string std::string</span></div><div class="line"><a name="l01405"></a><span class="lineno"> 1405</span> <span class="comment"> /// \param pumpAll flag indicating if source data should be pumped to its attached transformation</span></div><div class="line"><a name="l01406"></a><span class="lineno"> 1406</span> <span class="comment"> /// \param attachment an optional attached transformation</span></div><div class="line"><a name="l01407"></a><span class="lineno"><a class="line" href="class_string_source.html#a331ddfd760abc69c72bd29b8940cd68f"> 1407</a></span> <span class="comment"></span> <a class="code" href="class_string_source.html#a331ddfd760abc69c72bd29b8940cd68f">StringSource</a>(<span class="keyword">const</span> std::string &<span class="keywordtype">string</span>, <span class="keywordtype">bool</span> pumpAll, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01408"></a><span class="lineno"> 1408</span>  : <a class="code" href="class_source_template.html">SourceTemplate</a><<a class="code" href="class_string_store.html">StringStore</a>>(attachment) {SourceInitialize(pumpAll, <a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"InputBuffer"</span>, <a class="code" href="class_const_byte_array_parameter.html">ConstByteArrayParameter</a>(<span class="keywordtype">string</span>)));}</div><div class="line"><a name="l01409"></a><span class="lineno"> 1409</span> };</div><div class="line"><a name="l01410"></a><span class="lineno"> 1410</span> <span class="comment"></span></div><div class="line"><a name="l01411"></a><span class="lineno"> 1411</span> <span class="comment">/// \brief Pointer-based implementation of the Source interface</span></div><div class="line"><a name="l01412"></a><span class="lineno"> 1412</span> <span class="comment">/// \details ArraySource is a typedef for StringSource. Use the third constructor for an array source.</span></div><div class="line"><a name="l01413"></a><span class="lineno"> 1413</span> <span class="comment">/// The third constructor takes a pointer and length.</span></div><div class="line"><a name="l01414"></a><span class="lineno"> 1414</span> <span class="comment">/// \since Crypto++ 5.6.0</span></div><div class="line"><a name="l01415"></a><span class="lineno"><a class="line" href="class_array_source.html"> 1415</a></span> <span class="comment"></span>DOCUMENTED_TYPEDEF(<a class="code" href="class_string_source.html">StringSource</a>, <a class="code" href="class_array_source.html">ArraySource</a>)</div><div class="line"><a name="l01416"></a><span class="lineno"> 1416</span> </div><div class="line"><a name="l01417"></a><span class="lineno"> 1417</span> <span class="comment">/// \brief RNG-based implementation of Source interface</span></div><div class="line"><a name="l01418"></a><span class="lineno"> 1418</span> <span class="comment"></span><span class="comment">/// \since Crypto++ 4.0</span></div><div class="line"><a name="l01419"></a><span class="lineno"><a class="line" href="class_random_number_source.html"> 1419</a></span> <span class="comment"></span>class CRYPTOPP_DLL <a class="code" href="class_random_number_source.html">RandomNumberSource</a> : public <a class="code" href="class_source_template.html">SourceTemplate</a><<a class="code" href="class_random_number_store.html">RandomNumberStore</a>></div><div class="line"><a name="l01420"></a><span class="lineno"> 1420</span> {</div><div class="line"><a name="l01421"></a><span class="lineno"> 1421</span> <span class="keyword">public</span>:</div><div class="line"><a name="l01422"></a><span class="lineno"> 1422</span>  <a class="code" href="class_random_number_source.html">RandomNumberSource</a>(<a class="code" href="class_random_number_generator.html">RandomNumberGenerator</a> &rng, <span class="keywordtype">int</span> length, <span class="keywordtype">bool</span> pumpAll, <a class="code" href="class_buffered_transformation.html">BufferedTransformation</a> *attachment = NULLPTR)</div><div class="line"><a name="l01423"></a><span class="lineno"> 1423</span>  : <a class="code" href="class_source_template.html">SourceTemplate<RandomNumberStore></a>(attachment)</div><div class="line"><a name="l01424"></a><span class="lineno"> 1424</span>  {SourceInitialize(pumpAll, <a class="code" href="algparam_8h.html#aa13eee74de98cf8aaa7e83f4fae7f28b">MakeParameters</a>(<span class="stringliteral">"RandomNumberGeneratorPointer"</span>, &rng)(<span class="stringliteral">"RandomNumberStoreSize"</span>, length));}</div><div class="line"><a name="l01425"></a><span class="lineno"> 1425</span> };</div><div class="line"><a name="l01426"></a><span class="lineno"> 1426</span> </div><div class="line"><a name="l01427"></a><span class="lineno"> 1427</span> NAMESPACE_END</div><div class="line"><a name="l01428"></a><span class="lineno"> 1428</span> </div><div class="line"><a name="l01429"></a><span class="lineno"> 1429</span> <span class="preprocessor">#if CRYPTOPP_MSC_VERSION</span></div><div class="line"><a name="l01430"></a><span class="lineno"> 1430</span> <span class="preprocessor"># pragma warning(pop)</span></div><div class="line"><a name="l01431"></a><span class="lineno"> 1431</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l01432"></a><span class="lineno"> 1432</span> </div><div class="line"><a name="l01433"></a><span class="lineno"> 1433</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_source_html_ac7a9ccd5a212d6752be2abce0d90a6af"><div class="ttname"><a href="class_source.html#ac7a9ccd5a212d6752be2abce0d90a6af">Source::Pump</a></div><div class="ttdeci">lword Pump(lword pumpMax=(size_t) ...)</div><div class="ttdoc">Pump data to attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01296">filters.h:1296</a></div></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="struct_filter_put_space_helper_html"><div class="ttname"><a href="struct_filter_put_space_helper.html">FilterPutSpaceHelper</a></div><div class="ttdoc">Create a working space in a BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00158">filters.h:158</a></div></div> <div class="ttc" id="class_exception_html"><div class="ttname"><a href="class_exception.html">Exception</a></div><div class="ttdoc">Base class for all exceptions thrown by the library. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00155">cryptlib.h:155</a></div></div> <div class="ttc" id="class_string_sink_html"><div class="ttname"><a href="class_string_sink.html">StringSink</a></div><div class="ttdoc">Append input to a string object. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01099">filters.h:1099</a></div></div> <div class="ttc" id="class_signature_verification_filter_html_a8939c9cdd0f5ed772a8371e20a9bb468"><div class="ttname"><a href="class_signature_verification_filter.html#a8939c9cdd0f5ed772a8371e20a9bb468">SignatureVerificationFilter::GetLastResult</a></div><div class="ttdeci">bool GetLastResult() const</div><div class="ttdoc">Retrieves the result of the last verification. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00815">filters.h:815</a></div></div> <div class="ttc" id="class_invalid_argument_html"><div class="ttname"><a href="class_invalid_argument.html">InvalidArgument</a></div><div class="ttdoc">An invalid argument was detected. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00199">cryptlib.h:199</a></div></div> <div class="ttc" id="struct_filter_put_space_helper_html_aa6549687729073e4900e0867f59c0f4f"><div class="ttname"><a href="struct_filter_put_space_helper.html#aa6549687729073e4900e0867f59c0f4f">FilterPutSpaceHelper::HelpCreatePutSpace</a></div><div class="ttdeci">byte * HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t bufferSize)</div><div class="ttdoc">Create a working space in a BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00207">filters.h:207</a></div></div> <div class="ttc" id="class_string_source_html_a82dbf0b3d0b311f090344a88a86e010d"><div class="ttname"><a href="class_string_source.html#a82dbf0b3d0b311f090344a88a86e010d">StringSource::StringSource</a></div><div class="ttdeci">StringSource(const char *string, bool pumpAll, BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a StringSource. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01392">filters.h:1392</a></div></div> <div class="ttc" id="class_simple_proxy_filter_html_a8ff6d868e53aa3da69e9190884e4168d"><div class="ttname"><a href="class_simple_proxy_filter.html#a8ff6d868e53aa3da69e9190884e4168d">SimpleProxyFilter::SimpleProxyFilter</a></div><div class="ttdeci">SimpleProxyFilter(BufferedTransformation *filter, BufferedTransformation *attachment)</div><div class="ttdoc">Construct a SimpleProxyFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01008">filters.h:1008</a></div></div> <div class="ttc" id="class_random_number_sink_html_ad9eb1681d33e03ebf6ef43dc70299c9e"><div class="ttname"><a href="class_random_number_sink.html#ad9eb1681d33e03ebf6ef43dc70299c9e">RandomNumberSink::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="filters_8cpp_source.html#l00522">filters.cpp:522</a></div></div> <div class="ttc" id="class_wait_object_container_html"><div class="ttname"><a href="class_wait_object_container.html">WaitObjectContainer</a></div><div class="ttdoc">container of wait objects </div><div class="ttdef"><b>Definition:</b> <a href="wait_8h_source.html#l00169">wait.h:169</a></div></div> <div class="ttc" id="class_array_source_html"><div class="ttname"><a href="class_array_source.html">ArraySource</a></div><div class="ttdoc">Pointer-based implementation of the Source interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01415">filters.h:1415</a></div></div> <div class="ttc" id="algparam_8h_html"><div class="ttname"><a href="algparam_8h.html">algparam.h</a></div><div class="ttdoc">Classes for working with NameValuePairs. </div></div> <div class="ttc" id="class_custom_signal_propagation_html_a74fd5f3bb893d25f73f5bbab2c2d89ef"><div class="ttname"><a href="class_custom_signal_propagation.html#a74fd5f3bb893d25f73f5bbab2c2d89ef">CustomSignalPropagation::Initialize</a></div><div class="ttdeci">virtual void Initialize(const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)=0</div><div class="ttdoc">Initialize or reinitialize this object, with signal propagation. </div></div> <div class="ttc" id="class_meter_filter_html_a49d92192dcbd3366ff0576159ea62e9d"><div class="ttname"><a href="class_meter_filter.html#a49d92192dcbd3366ff0576159ea62e9d">MeterFilter::CreatePutSpace</a></div><div class="ttdeci">byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00259">filters.h:259</a></div></div> <div class="ttc" id="class_signature_verification_filter_html"><div class="ttname"><a href="class_signature_verification_filter.html">SignatureVerificationFilter</a></div><div class="ttdoc">Filter wrapper for PK_Verifier. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00772">filters.h:772</a></div></div> <div class="ttc" id="class_proxy_filter_html"><div class="ttname"><a href="class_proxy_filter.html">ProxyFilter</a></div><div class="ttdoc">Base class for Filter classes that are proxies for a chain of other filters. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00976">filters.h:976</a></div></div> <div class="ttc" id="class_source_html"><div class="ttname"><a href="class_source.html">Source</a></div><div class="ttdoc">Implementation of BufferedTransformation&#39;s attachment interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01277">filters.h:1277</a></div></div> <div class="ttc" id="class_null_store_html_ae34e25265289f889c8ea2e2bf6dda275"><div class="ttname"><a href="class_null_store.html#ae34e25265289f889c8ea2e2bf6dda275">NullStore::MaxRetrievable</a></div><div class="ttdeci">lword MaxRetrievable() const</div><div class="ttdoc">Provides the number of bytes ready for retrieval. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01259">filters.h:1259</a></div></div> <div class="ttc" id="simple_8h_html"><div class="ttname"><a href="simple_8h.html">simple.h</a></div><div class="ttdoc">Classes providing basic library services. </div></div> <div class="ttc" id="misc_8h_html"><div class="ttname"><a href="misc_8h.html">misc.h</a></div><div class="ttdoc">Utility functions for the Crypto++ library. </div></div> <div class="ttc" id="class_source_template_html_abd4e1c80639fbbb06277581875ac2972"><div class="ttname"><a href="class_source_template.html#abd4e1c80639fbbb06277581875ac2972">SourceTemplate::SourceExhausted</a></div><div class="ttdeci">bool SourceExhausted() const</div><div class="ttdoc">Determines if the Source is exhausted. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01367">filters.h:1367</a></div></div> <div class="ttc" id="class_p_k___decryptor_filter_html_ae4807490fea0a4bc861279d8a4b2bb05"><div class="ttname"><a href="class_p_k___decryptor_filter.html#ae4807490fea0a4bc861279d8a4b2bb05">PK_DecryptorFilter::PK_DecryptorFilter</a></div><div class="ttdeci">PK_DecryptorFilter(RandomNumberGenerator &rng, const PK_Decryptor &decryptor, BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a PK_DecryptorFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01054">filters.h:1054</a></div></div> <div class="ttc" id="class_meter_filter_html_a6d458e027fdc3b9a481a633ae04459d2"><div class="ttname"><a href="class_meter_filter.html#a6d458e027fdc3b9a481a633ae04459d2">MeterFilter::MeterFilter</a></div><div class="ttdeci">MeterFilter(BufferedTransformation *attachment=NULL, bool transparent=true)</div><div class="ttdoc">Construct a MeterFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00227">filters.h:227</a></div></div> <div class="ttc" id="class_source_template_html_af7f891477e9fcea66954f848b86de0a2"><div class="ttname"><a href="class_source_template.html#af7f891477e9fcea66954f848b86de0a2">SourceTemplate::SetAutoSignalPropagation</a></div><div class="ttdeci">void SetAutoSignalPropagation(int propagation)</div><div class="ttdoc">Set propagation of automatically generated and transferred signals. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01369">filters.h:1369</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979">BlockPaddingSchemeDef::BlockPaddingScheme</a></div><div class="ttdeci">BlockPaddingScheme</div><div class="ttdoc">Padding schemes used for block ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00470">filters.h:470</a></div></div> <div class="ttc" id="class_authenticated_symmetric_cipher_html"><div class="ttname"><a href="class_authenticated_symmetric_cipher.html">AuthenticatedSymmetricCipher</a></div><div class="ttdoc">Interface for authenticated encryption modes of operation. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01267">cryptlib.h:1267</a></div></div> <div class="ttc" id="class_buffered_transformation_html_a7bb05ac3b6302e2ab994586d526fa804"><div class="ttname"><a href="class_buffered_transformation.html#a7bb05ac3b6302e2ab994586d526fa804">BufferedTransformation::IsolatedInitialize</a></div><div class="ttdeci">virtual 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="cryptlib_8h_source.html#l01702">cryptlib.h:1702</a></div></div> <div class="ttc" id="class_filter_with_buffered_input_html_ae97be71708e0020167e5c08856fd3f3b"><div class="ttname"><a href="class_filter_with_buffered_input.html#ae97be71708e0020167e5c08856fd3f3b">FilterWithBufferedInput::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="filters_8cpp_source.html#l00329">filters.cpp:329</a></div></div> <div class="ttc" id="class_output_proxy_html"><div class="ttname"><a href="class_output_proxy.html">OutputProxy</a></div><div class="ttdoc">Filter class that is a proxy for a sink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00928">filters.h:928</a></div></div> <div class="ttc" id="class_random_number_store_html_a036cdd35be6f6dc847b8ea17f6d8a9e8"><div class="ttname"><a href="class_random_number_store.html#a036cdd35be6f6dc847b8ea17f6d8a9e8">RandomNumberStore::AnyRetrievable</a></div><div class="ttdeci">bool AnyRetrievable() const</div><div class="ttdoc">Determines whether bytes are ready for retrieval. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01234">filters.h:1234</a></div></div> <div class="ttc" id="class_output_proxy_html_a7d01981113dfb1543b7e04b96522cc1e"><div class="ttname"><a href="class_output_proxy.html#a7d01981113dfb1543b7e04b96522cc1e">OutputProxy::ChannelPutModifiable2</a></div><div class="ttdeci">size_t ChannelPutModifiable2(const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes that may be modified by callee on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00962">filters.h:962</a></div></div> <div class="ttc" id="class_output_proxy_html_a13ff9fb43d2b5d08e83a130b630c907a"><div class="ttname"><a href="class_output_proxy.html#a13ff9fb43d2b5d08e83a130b630c907a">OutputProxy::ChannelPut2</a></div><div class="ttdeci">size_t ChannelPut2(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00960">filters.h:960</a></div></div> <div class="ttc" id="struct_filter_put_space_helper_html_a01f7232d4f27bc0c0a20115aa5090924"><div class="ttname"><a href="struct_filter_put_space_helper.html#a01f7232d4f27bc0c0a20115aa5090924">FilterPutSpaceHelper::HelpCreatePutSpace</a></div><div class="ttdeci">byte * HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize)</div><div class="ttdoc">Create a working space in a BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00198">filters.h:198</a></div></div> <div class="ttc" id="class_p_k___signer_html"><div class="ttname"><a href="class_p_k___signer.html">PK_Signer</a></div><div class="ttdoc">Interface for public-key signers. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02705">cryptlib.h:2705</a></div></div> <div class="ttc" id="class_redirector_html_acd6d9e39c8d0f95d99b41129f1c97dae"><div class="ttname"><a href="class_redirector.html#acd6d9e39c8d0f95d99b41129f1c97dae">Redirector::ChannelPut2</a></div><div class="ttdeci">size_t ChannelPut2(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00906">filters.h:906</a></div></div> <div class="ttc" id="class_p_k___encryptor_html"><div class="ttname"><a href="class_p_k___encryptor.html">PK_Encryptor</a></div><div class="ttdoc">Interface for public-key encryptors. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02526">cryptlib.h:2526</a></div></div> <div class="ttc" id="class_source_html_a78f3f645fc7a1af7e7a814d8a7d22a69"><div class="ttname"><a href="class_source.html#a78f3f645fc7a1af7e7a814d8a7d22a69">Source::PumpAll</a></div><div class="ttdeci">void PumpAll()</div><div class="ttdoc">Pump all data to attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01308">filters.h:1308</a></div></div> <div class="ttc" id="class_output_proxy_html_ade676bde70daea1949bab94e72d93b18"><div class="ttname"><a href="class_output_proxy.html#ade676bde70daea1949bab94e72d93b18">OutputProxy::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00947">filters.h:947</a></div></div> <div class="ttc" id="class_source_html_a515aad3c590ad819ddaf37c1340d9b31"><div class="ttname"><a href="class_source.html#a515aad3c590ad819ddaf37c1340d9b31">Source::PumpMessages</a></div><div class="ttdeci">unsigned int PumpMessages(unsigned int count=UINT_MAX)</div><div class="ttdoc">Pump messages to attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01303">filters.h:1303</a></div></div> <div class="ttc" id="namespace_name_html_a48820945ba488fac5d5507eea9a5114e"><div class="ttname"><a href="namespace_name.html#a48820945ba488fac5d5507eea9a5114e">Name::BlockPaddingScheme</a></div><div class="ttdeci">const char * BlockPaddingScheme()</div><div class="ttdoc">StreamTransformationFilter::BlockPaddingScheme. </div><div class="ttdef"><b>Definition:</b> <a href="argnames_8h_source.html#l00052">argnames.h:52</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979a0ae39772a46aee3e0dbf3e91afff751c"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a0ae39772a46aee3e0dbf3e91afff751c">BlockPaddingSchemeDef::DEFAULT_PADDING</a></div><div class="ttdoc">Default padding scheme. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00490">filters.h:490</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_source_template_html_ae0f81a7cfeb0cc6307e141907b62c5a3"><div class="ttname"><a href="class_source_template.html#ae0f81a7cfeb0cc6307e141907b62c5a3">SourceTemplate::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="filters_8h_source.html#l01359">filters.h:1359</a></div></div> <div class="ttc" id="class_source_template_html_adc1704305aff166b4a5afdb3a9929af4"><div class="ttname"><a href="class_source_template.html#adc1704305aff166b4a5afdb3a9929af4">SourceTemplate::PumpAll2</a></div><div class="ttdeci">size_t PumpAll2(bool blocking=true)</div><div class="ttdoc">Pump all data to attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01365">filters.h:1365</a></div></div> <div class="ttc" id="smartptr_8h_html"><div class="ttname"><a href="smartptr_8h.html">smartptr.h</a></div><div class="ttdoc">Classes for automatic resource management. </div></div> <div class="ttc" id="class_signer_filter_html"><div class="ttname"><a href="class_signer_filter.html">SignerFilter</a></div><div class="ttdoc">Filter wrapper for PK_Signer. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00743">filters.h:743</a></div></div> <div class="ttc" id="class_output_proxy_html_aae129d7efb204cbe5c733032de298fcc"><div class="ttname"><a href="class_output_proxy.html#aae129d7efb204cbe5c733032de298fcc">OutputProxy::ChannelMessageSeriesEnd</a></div><div class="ttdeci">bool ChannelMessageSeriesEnd(const std::string &channel, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Marks the end of a series of messages on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00966">filters.h:966</a></div></div> <div class="ttc" id="class_buffered_transformation_html_a27ac15af3ef43c5ad1e9db5812025fcd"><div class="ttname"><a href="class_buffered_transformation.html#a27ac15af3ef43c5ad1e9db5812025fcd">BufferedTransformation::TransferTo2</a></div><div class="ttdeci">virtual size_t TransferTo2(BufferedTransformation &target, lword &byteCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)=0</div><div class="ttdoc">Transfer bytes from this object to another BufferedTransformation. </div></div> <div class="ttc" id="class_filter_with_buffered_input_html_abc7a44af560a17d30a48651683e18e6e"><div class="ttname"><a href="class_filter_with_buffered_input.html#abc7a44af560a17d30a48651683e18e6e">FilterWithBufferedInput::PutModifiable2</a></div><div class="ttdeci">size_t PutModifiable2(byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes that may be modified by callee. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00334">filters.h:334</a></div></div> <div class="ttc" id="class_store_html"><div class="ttname"><a href="class_store.html">Store</a></div><div class="ttdoc">Acts as a Source for pre-existing, static data. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00306">simple.h:306</a></div></div> <div class="ttc" id="class_string_store_html_a96eaf8d3dae545b6b4a44443a27d9ffb"><div class="ttname"><a href="class_string_store.html#a96eaf8d3dae545b6b4a44443a27d9ffb">StringStore::StringStore</a></div><div class="ttdeci">StringStore(const T &string)</div><div class="ttdoc">Construct a StringStore. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01208">filters.h:1208</a></div></div> <div class="ttc" id="class_string_source_html_a86185516e7339e3a6192be9b88493a00"><div class="ttname"><a href="class_string_source.html#a86185516e7339e3a6192be9b88493a00">StringSource::StringSource</a></div><div class="ttdeci">StringSource(const byte *string, size_t length, bool pumpAll, BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a StringSource. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01400">filters.h:1400</a></div></div> <div class="ttc" id="class_random_number_generator_html"><div class="ttname"><a href="class_random_number_generator.html">RandomNumberGenerator</a></div><div class="ttdoc">Interface for random number generators. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01330">cryptlib.h:1330</a></div></div> <div class="ttc" id="stdcpp_8h_html"><div class="ttname"><a href="stdcpp_8h.html">stdcpp.h</a></div><div class="ttdoc">Common C++ header files. </div></div> <div class="ttc" id="class_input_rejecting_html"><div class="ttname"><a href="class_input_rejecting.html">InputRejecting</a></div><div class="ttdoc">Base class for input rejecting filters. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00134">simple.h:134</a></div></div> <div class="ttc" id="class_redirector_html_a421073132346b5dc66750520cd859c94"><div class="ttname"><a href="class_redirector.html#a421073132346b5dc66750520cd859c94">Redirector::GetMaxWaitObjectCount</a></div><div class="ttdeci">unsigned int GetMaxWaitObjectCount() const</div><div class="ttdoc">Retrieves the maximum number of waitable objects. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00915">filters.h:915</a></div></div> <div class="ttc" id="class_redirector_html_a51620dc9565b323de2b55d3a85e830a1"><div class="ttname"><a href="class_redirector.html#a51620dc9565b323de2b55d3a85e830a1">Redirector::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00889">filters.h:889</a></div></div> <div class="ttc" id="class_redirector_html_a09afd32c22cc2d4ef9ddc8650b8657f5"><div class="ttname"><a href="class_redirector.html#a09afd32c22cc2d4ef9ddc8650b8657f5">Redirector::CreatePutSpace</a></div><div class="ttdeci">byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00879">filters.h:879</a></div></div> <div class="ttc" id="class_string_sink_template_html"><div class="ttname"><a href="class_string_sink_template.html">StringSinkTemplate</a></div><div class="ttdoc">Append input to a string object. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01063">filters.h:1063</a></div></div> <div class="ttc" id="class_hash_filter_html_a8ddeda93399d4767574798eb555bd5ea"><div class="ttname"><a href="class_hash_filter.html#a8ddeda93399d4767574798eb555bd5ea">HashFilter::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00564">filters.h:564</a></div></div> <div class="ttc" id="class_sec_byte_block_html"><div class="ttname"><a href="class_sec_byte_block.html">SecByteBlock</a></div><div class="ttdoc">SecBlock<byte> typedef. </div><div class="ttdef"><b>Definition:</b> <a href="secblock_8h_source.html#l00822">secblock.h:822</a></div></div> <div class="ttc" id="class_string_source_html_a331ddfd760abc69c72bd29b8940cd68f"><div class="ttname"><a href="class_string_source.html#a331ddfd760abc69c72bd29b8940cd68f">StringSource::StringSource</a></div><div class="ttdeci">StringSource(const std::string &string, bool pumpAll, BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a StringSource. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01407">filters.h:1407</a></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="class_signature_verification_filter_1_1_signature_verification_failed_html"><div class="ttname"><a href="class_signature_verification_filter_1_1_signature_verification_failed.html">SignatureVerificationFilter::SignatureVerificationFailed</a></div><div class="ttdoc">Exception thrown when an invalid signature is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00776">filters.h:776</a></div></div> <div class="ttc" id="class_signature_verification_filter_html_a3673220151c47758b53dda37c8210180"><div class="ttname"><a href="class_signature_verification_filter.html#a3673220151c47758b53dda37c8210180">SignatureVerificationFilter::Flags</a></div><div class="ttdeci">Flags</div><div class="ttdoc">Flags controlling filter behavior. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00786">filters.h:786</a></div></div> <div class="ttc" id="class_string_source_html"><div class="ttname"><a href="class_string_source.html">StringSource</a></div><div class="ttdoc">String-based implementation of the Source interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01380">filters.h:1380</a></div></div> <div class="ttc" id="class_string_store_html_a842dfd9b74c9539b12b3589028b78876"><div class="ttname"><a href="class_string_store.html#a842dfd9b74c9539b12b3589028b78876">StringStore::StringStore</a></div><div class="ttdeci">StringStore(const byte *string, size_t length)</div><div class="ttdoc">Construct a StringStore. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01202">filters.h:1202</a></div></div> <div class="ttc" id="class_output_proxy_html_a7aeaa853d3be4abac2b65fa45b5763db"><div class="ttname"><a href="class_output_proxy.html#a7aeaa853d3be4abac2b65fa45b5763db">OutputProxy::ChannelFlush</a></div><div class="ttdeci">bool ChannelFlush(const std::string &channel, bool completeFlush, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Flush buffered input and/or output on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00964">filters.h:964</a></div></div> <div class="ttc" id="class_output_proxy_html_a51301674845151fb1e6b9f599d6ffbc9"><div class="ttname"><a href="class_output_proxy.html#a51301674845151fb1e6b9f599d6ffbc9">OutputProxy::ChannelCreatePutSpace</a></div><div class="ttdeci">byte * ChannelCreatePutSpace(const std::string &channel, size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00958">filters.h:958</a></div></div> <div class="ttc" id="classmember__ptr_html"><div class="ttname"><a href="classmember__ptr.html">member_ptr< BufferedTransformation ></a></div></div> <div class="ttc" id="class_hash_verification_filter_1_1_hash_verification_failed_html"><div class="ttname"><a href="class_hash_verification_filter_1_1_hash_verification_failed.html">HashVerificationFilter::HashVerificationFailed</a></div><div class="ttdoc">Exception thrown when a data integrity check failure is encountered. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00585">filters.h:585</a></div></div> <div class="ttc" id="secblock_8h_html"><div class="ttname"><a href="secblock_8h.html">secblock.h</a></div><div class="ttdoc">Classes and functions for secure memory allocations. </div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979a77a93fa2940abd30d0678927ab6f3587"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a77a93fa2940abd30d0678927ab6f3587">BlockPaddingSchemeDef::ONE_AND_ZEROS_PADDING</a></div><div class="ttdoc">1 and 0&#39;s padding added to a block </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00482">filters.h:482</a></div></div> <div class="ttc" id="class_redirector_html_a0ce7d175c4cf620add11915dcbe447fb"><div class="ttname"><a href="class_redirector.html#a0ce7d175c4cf620add11915dcbe447fb">Redirector::Redirector</a></div><div class="ttdeci">Redirector(BufferedTransformation &target, Behavior behavior=PASS_EVERYTHING)</div><div class="ttdoc">Construct a Redirector. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00859">filters.h:859</a></div></div> <div class="ttc" id="class_array_sink_html"><div class="ttname"><a href="class_array_sink.html">ArraySink</a></div><div class="ttdoc">Copy input to a memory buffer. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01132">filters.h:1132</a></div></div> <div class="ttc" id="class_null_store_html"><div class="ttname"><a href="class_null_store.html">NullStore</a></div><div class="ttdoc">Empty store. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01253">filters.h:1253</a></div></div> <div class="ttc" id="class_hash_verification_filter_html_a63841de72c6930234941a89c4989de13"><div class="ttname"><a href="class_hash_verification_filter.html#a63841de72c6930234941a89c4989de13">HashVerificationFilter::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00620">filters.h:620</a></div></div> <div class="ttc" id="class_authenticated_decryption_filter_html_a2181e843a0e19b1b256498d905e2c5df"><div class="ttname"><a href="class_authenticated_decryption_filter.html#a2181e843a0e19b1b256498d905e2c5df">AuthenticatedDecryptionFilter::Flags</a></div><div class="ttdeci">Flags</div><div class="ttdoc">Flags controlling filter behavior. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00691">filters.h:691</a></div></div> <div class="ttc" id="class_redirector_html_a6e882384f0214dfc148abf38955ec0e5"><div class="ttname"><a href="class_redirector.html#a6e882384f0214dfc148abf38955ec0e5">Redirector::ChannelCreatePutSpace</a></div><div class="ttdeci">byte * ChannelCreatePutSpace(const std::string &channel, size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00896">filters.h:896</a></div></div> <div class="ttc" id="class_source_template_html"><div class="ttname"><a href="class_source_template.html">SourceTemplate</a></div><div class="ttdoc">Transform a Store into a Source. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01350">filters.h:1350</a></div></div> <div class="ttc" id="queue_8h_html"><div class="ttname"><a href="queue_8h.html">queue.h</a></div><div class="ttdoc">Classes for an unlimited queue to store bytes. </div></div> <div class="ttc" id="class_array_xor_sink_html"><div class="ttname"><a href="class_array_xor_sink.html">ArrayXorSink</a></div><div class="ttdoc">Xor input to a memory buffer. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01174">filters.h:1174</a></div></div> <div class="ttc" id="class_random_number_sink_html_ab18490b9bb18559cd6274453a4efea2a"><div class="ttname"><a href="class_random_number_sink.html#ab18490b9bb18559cd6274453a4efea2a">RandomNumberSink::RandomNumberSink</a></div><div class="ttdeci">RandomNumberSink(RandomNumberGenerator &rng)</div><div class="ttdoc">Construct a RandomNumberSink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01115">filters.h:1115</a></div></div> <div class="ttc" id="class_p_k___decryptor_html"><div class="ttname"><a href="class_p_k___decryptor.html">PK_Decryptor</a></div><div class="ttdoc">Interface for public-key decryptors. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02561">cryptlib.h:2561</a></div></div> <div class="ttc" id="asn_8h_html_a9485364a916ed0474eb263a307ecc0f0"><div class="ttname"><a href="asn_8h.html#a9485364a916ed0474eb263a307ecc0f0">operator<</a></div><div class="ttdeci">bool operator<(const OID &lhs, const OID &rhs)</div><div class="ttdoc">Compare two OIDs for ordering. </div></div> <div class="ttc" id="class_not_implemented_html"><div class="ttname"><a href="class_not_implemented.html">NotImplemented</a></div><div class="ttdoc">A method was called which was not implemented. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00220">cryptlib.h:220</a></div></div> <div class="ttc" id="class_hash_verification_filter_html"><div class="ttname"><a href="class_hash_verification_filter.html">HashVerificationFilter</a></div><div class="ttdoc">Filter wrapper for HashTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00579">filters.h:579</a></div></div> <div class="ttc" id="class_hash_filter_html"><div class="ttname"><a href="class_hash_filter.html">HashFilter</a></div><div class="ttdoc">Filter wrapper for HashTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00550">filters.h:550</a></div></div> <div class="ttc" id="class_random_number_store_html"><div class="ttname"><a href="class_random_number_store.html">RandomNumberStore</a></div><div class="ttdoc">RNG-based implementation of Source interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01223">filters.h:1223</a></div></div> <div class="ttc" id="class_array_sink_html_ad3459c605b5eb52fa24efcb4dc35d29d"><div class="ttname"><a href="class_array_sink.html#ad3459c605b5eb52fa24efcb4dc35d29d">ArraySink::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l00534">filters.cpp:534</a></div></div> <div class="ttc" id="class_authenticated_decryption_filter_html"><div class="ttname"><a href="class_authenticated_decryption_filter.html">AuthenticatedDecryptionFilter</a></div><div class="ttdoc">Filter wrapper for decrypting with AuthenticatedSymmetricCipher. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00685">filters.h:685</a></div></div> <div class="ttc" id="class_filter_html_a93817876b45172108fe0342de6442f75"><div class="ttname"><a href="class_filter.html#a93817876b45172108fe0342de6442f75">Filter::Detach</a></div><div class="ttdeci">void Detach(BufferedTransformation *newAttachment=NULL)</div><div class="ttdoc">Replace an attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l00050">filters.cpp:50</a></div></div> <div class="ttc" id="cryptlib_8h_html_a9a69ab5a5e0f58279c43f4f51809c84a"><div class="ttname"><a href="cryptlib_8h.html#a9a69ab5a5e0f58279c43f4f51809c84a">DEFAULT_CHANNEL</a></div><div class="ttdeci">const std::string DEFAULT_CHANNEL</div><div class="ttdoc">Default channel for BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00481">cryptlib.h:481</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_output_proxy_html_aabd1f4183ac5222c62868e9e6aefce8b"><div class="ttname"><a href="class_output_proxy.html#aabd1f4183ac5222c62868e9e6aefce8b">OutputProxy::GetPassSignal</a></div><div class="ttdeci">bool GetPassSignal() const</div><div class="ttdoc">Retrieve passSignal flag. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00940">filters.h:940</a></div></div> <div class="ttc" id="class_output_proxy_html_a56e14de9505c46a71bf2cf565995cb64"><div class="ttname"><a href="class_output_proxy.html#a56e14de9505c46a71bf2cf565995cb64">OutputProxy::OutputProxy</a></div><div class="ttdeci">OutputProxy(BufferedTransformation &owner, bool passSignal)</div><div class="ttdoc">Construct an OutputProxy. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00936">filters.h:936</a></div></div> <div class="ttc" id="class_opaque_filter_html"><div class="ttname"><a href="class_opaque_filter.html">OpaqueFilter</a></div><div class="ttdoc">A non-transparent MeterFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00297">filters.h:297</a></div></div> <div class="ttc" id="class_authenticated_encryption_filter_html"><div class="ttname"><a href="class_authenticated_encryption_filter.html">AuthenticatedEncryptionFilter</a></div><div class="ttdoc">Filter wrapper for encrypting with AuthenticatedSymmetricCipher. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00644">filters.h:644</a></div></div> <div class="ttc" id="class_source_template_html_a1e4b61addf5d1aaf71566ab4c625a103"><div class="ttname"><a href="class_source_template.html#a1e4b61addf5d1aaf71566ab4c625a103">SourceTemplate::PumpMessages2</a></div><div class="ttdeci">size_t PumpMessages2(unsigned int &messageCount, bool blocking=true)</div><div class="ttdoc">Pump messages to attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01363">filters.h:1363</a></div></div> <div class="ttc" id="class_hash_verification_filter_html_a4e171785f3f9b00d0a10f4c2afa1cc70"><div class="ttname"><a href="class_hash_verification_filter.html#a4e171785f3f9b00d0a10f4c2afa1cc70">HashVerificationFilter::Flags</a></div><div class="ttdeci">Flags</div><div class="ttdoc">Flags controlling filter behavior. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00595">filters.h:595</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="class_buffered_transformation_html_a877494d8de597af935cb770034f7f170"><div class="ttname"><a href="class_buffered_transformation.html#a877494d8de597af935cb770034f7f170">BufferedTransformation::ChannelCreatePutSpace</a></div><div class="ttdeci">virtual byte * ChannelCreatePutSpace(const std::string &channel, size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8cpp_source.html#l00460">cryptlib.cpp:460</a></div></div> <div class="ttc" id="class_filter_html_ac8fc888888b2dad88bf64fc703044a93"><div class="ttname"><a href="class_filter.html#ac8fc888888b2dad88bf64fc703044a93">Filter::AttachedTransformation</a></div><div class="ttdeci">BufferedTransformation * AttachedTransformation()</div><div class="ttdoc">Retrieve attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l00036">filters.cpp:36</a></div></div> <div class="ttc" id="class_output_proxy_html_a48d4fa2095a31780f6bc0b37737de49f"><div class="ttname"><a href="class_output_proxy.html#a48d4fa2095a31780f6bc0b37737de49f">OutputProxy::Initialize</a></div><div class="ttdeci">void Initialize(const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)</div><div class="ttdoc">Initialize or reinitialize this object, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00951">filters.h:951</a></div></div> <div class="ttc" id="class_output_proxy_html_aecf5c216c060f2e6adfeb4019e6ad797"><div class="ttname"><a href="class_output_proxy.html#aecf5c216c060f2e6adfeb4019e6ad797">OutputProxy::MessageSeriesEnd</a></div><div class="ttdeci">bool MessageSeriesEnd(int propagation=-1, bool blocking=true)</div><div class="ttdoc">Marks the end of a series of messages, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00955">filters.h:955</a></div></div> <div class="ttc" id="class_redirector_html_a2ee0003a41e0fbebe12ff2b4d9f19559"><div class="ttname"><a href="class_redirector.html#a2ee0003a41e0fbebe12ff2b4d9f19559">Redirector::CanModifyInput</a></div><div class="ttdeci">bool CanModifyInput() const</div><div class="ttdoc">Determines whether input can be modified by the callee. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00875">filters.h:875</a></div></div> <div class="ttc" id="class_signature_verification_filter_html_aa7e450a40faa8971970b6b8dcfa31694"><div class="ttname"><a href="class_signature_verification_filter.html#aa7e450a40faa8971970b6b8dcfa31694">SignatureVerificationFilter::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00811">filters.h:811</a></div></div> <div class="ttc" id="class_filter_with_input_queue_html"><div class="ttname"><a href="class_filter_with_input_queue.html">FilterWithInputQueue</a></div><div class="ttdoc">A filter that buffers input using a ByteQueue. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00426">filters.h:426</a></div></div> <div class="ttc" id="misc_8h_html_a30712a90999ad9d9152975f2e92d46b8"><div class="ttname"><a href="misc_8h.html#a30712a90999ad9d9152975f2e92d46b8">SaturatingSubtract</a></div><div class="ttdeci">T1 SaturatingSubtract(const T1 &a, const T2 &b)</div><div class="ttdoc">Performs a saturating subtract clamped at 0. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l00890">misc.h:890</a></div></div> <div class="ttc" id="class_redirector_html_a72b5a632f5d66cd3943fa4eed1563956"><div class="ttname"><a href="class_redirector.html#a72b5a632f5d66cd3943fa4eed1563956">Redirector::StopRedirection</a></div><div class="ttdeci">void StopRedirection()</div><div class="ttdoc">Stop redirecting input. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00866">filters.h:866</a></div></div> <div class="ttc" id="class_array_sink_html_a8a0b2bc344136755ae7edc83cea078cc"><div class="ttname"><a href="class_array_sink.html#a8a0b2bc344136755ae7edc83cea078cc">ArraySink::AvailableSize</a></div><div class="ttdeci">size_t AvailableSize()</div><div class="ttdoc">Provides the size remaining in the Sink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01151">filters.h:1151</a></div></div> <div class="ttc" id="class_p_k___decryptor_filter_html"><div class="ttname"><a href="class_p_k___decryptor_filter.html">PK_DecryptorFilter</a></div><div class="ttdoc">Filter wrapper for PK_Decryptor. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01047">filters.h:1047</a></div></div> <div class="ttc" id="class_buffered_transformation_html_ae6b026f47d8a0ea2e35a6cb8d9ec2c97"><div class="ttname"><a href="class_buffered_transformation.html#ae6b026f47d8a0ea2e35a6cb8d9ec2c97">BufferedTransformation::ChannelPut2</a></div><div class="ttdeci">virtual size_t ChannelPut2(const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8cpp_source.html#l00470">cryptlib.cpp:470</a></div></div> <div class="ttc" id="class_string_sink_template_html_a167e78771671daf216f190bd4fe13c9b"><div class="ttname"><a href="class_string_sink_template.html#a167e78771671daf216f190bd4fe13c9b">StringSinkTemplate::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01076">filters.h:1076</a></div></div> <div class="ttc" id="class_string_store_html_a1272eeca9a2496019bb524faa23ac557"><div class="ttname"><a href="class_string_store.html#a1272eeca9a2496019bb524faa23ac557">StringStore::CopyRangeTo2</a></div><div class="ttdeci">size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const</div><div class="ttdoc">Copy bytes from this object to another BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l01204">filters.cpp:1204</a></div></div> <div class="ttc" id="class_random_number_sink_html"><div class="ttname"><a href="class_random_number_sink.html">RandomNumberSink</a></div><div class="ttdoc">Incorporates input into RNG as additional entropy. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01104">filters.h:1104</a></div></div> <div class="ttc" id="class_stream_transformation_html"><div class="ttname"><a href="class_stream_transformation.html">StreamTransformation</a></div><div class="ttdoc">Interface for the data processing portion of stream ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00898">cryptlib.h:898</a></div></div> <div class="ttc" id="class_string_sink_template_html_aca537f96a83a3006a32a4848af2f47f5"><div class="ttname"><a href="class_string_sink_template.html#aca537f96a83a3006a32a4848af2f47f5">StringSinkTemplate::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="filters_8h_source.html#l01073">filters.h:1073</a></div></div> <div class="ttc" id="class_random_number_sink_html_a8623fa452a55a1ae8af75efe640cde91"><div class="ttname"><a href="class_random_number_sink.html#a8623fa452a55a1ae8af75efe640cde91">RandomNumberSink::RandomNumberSink</a></div><div class="ttdeci">RandomNumberSink()</div><div class="ttdoc">Construct a RandomNumberSink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01110">filters.h:1110</a></div></div> <div class="ttc" id="class_buffered_transformation_html_a7f90ef36f633c97c1ae519b800527d8e"><div class="ttname"><a href="class_buffered_transformation.html#a7f90ef36f633c97c1ae519b800527d8e">BufferedTransformation::CopyRangeTo2</a></div><div class="ttdeci">virtual size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const =0</div><div class="ttdoc">Copy bytes from this object to another BufferedTransformation. </div></div> <div class="ttc" id="class_random_number_store_html_ab1007214c6ed0398440bb38b4db47d68"><div class="ttname"><a href="class_random_number_store.html#ab1007214c6ed0398440bb38b4db47d68">RandomNumberStore::CopyRangeTo2</a></div><div class="ttdeci">size_t CopyRangeTo2(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const</div><div class="ttdoc">Copy bytes from this object to another BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01238">filters.h:1238</a></div></div> <div class="ttc" id="class_filter_with_buffered_input_html"><div class="ttname"><a href="class_filter_with_buffered_input.html">FilterWithBufferedInput</a></div><div class="ttdoc">Divides an input stream into discrete blocks. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00311">filters.h:311</a></div></div> <div class="ttc" id="class_string_source_html_a0c56127a806471ead64e2b4e8956147f"><div class="ttname"><a href="class_string_source.html#a0c56127a806471ead64e2b4e8956147f">StringSource::StringSource</a></div><div class="ttdeci">StringSource(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a StringSource. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01385">filters.h:1385</a></div></div> <div class="ttc" id="class_string_store_html"><div class="ttname"><a href="class_string_store.html">StringStore</a></div><div class="ttdoc">String-based implementation of Store interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01191">filters.h:1191</a></div></div> <div class="ttc" id="trap_8h_html_adf3b392588bc94cbeae9f415a78c7b95"><div class="ttname"><a href="trap_8h.html#adf3b392588bc94cbeae9f415a78c7b95">CRYPTOPP_ASSERT</a></div><div class="ttdeci">#define CRYPTOPP_ASSERT(exp)</div><div class="ttdoc">Debugging and diagnostic assertion. </div><div class="ttdef"><b>Definition:</b> <a href="trap_8h_source.html#l00060">trap.h:60</a></div></div> <div class="ttc" id="class_filter_with_input_queue_html_a91c11ca74a8ba2350da6ad6ca8d721a0"><div class="ttname"><a href="class_filter_with_input_queue.html#a91c11ca74a8ba2350da6ad6ca8d721a0">FilterWithInputQueue::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00435">filters.h:435</a></div></div> <div class="ttc" id="class_redirector_html"><div class="ttname"><a href="class_redirector.html">Redirector</a></div><div class="ttdoc">Redirect input to another BufferedTransformation without owning it. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00833">filters.h:833</a></div></div> <div class="ttc" id="class_source_template_html_a09c47f0ee80586dc9495dbe2975b6dcd"><div class="ttname"><a href="class_source_template.html#a09c47f0ee80586dc9495dbe2975b6dcd">SourceTemplate::Pump2</a></div><div class="ttdeci">size_t Pump2(lword &byteCount, bool blocking=true)</div><div class="ttdoc">Pump data to attached transformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01361">filters.h:1361</a></div></div> <div class="ttc" id="class_byte_queue_html"><div class="ttname"><a href="class_byte_queue.html">ByteQueue</a></div><div class="ttdoc">Data structure used to store byte strings. </div><div class="ttdef"><b>Definition:</b> <a href="queue_8h_source.html#l00018">queue.h:18</a></div></div> <div class="ttc" id="class_transparent_filter_html_aed955b969c7623d108346f2a97d0e1cd"><div class="ttname"><a href="class_transparent_filter.html#aed955b969c7623d108346f2a97d0e1cd">TransparentFilter::TransparentFilter</a></div><div class="ttdeci">TransparentFilter(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a TransparentFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00292">filters.h:292</a></div></div> <div class="ttc" id="class_redirector_html_ad88cbf0d8971aa96eeaeff78dc743c25"><div class="ttname"><a href="class_redirector.html#ad88cbf0d8971aa96eeaeff78dc743c25">Redirector::Redirector</a></div><div class="ttdeci">Redirector()</div><div class="ttdoc">Construct a Redirector. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00854">filters.h:854</a></div></div> <div class="ttc" id="class_random_number_store_html_a32bb1cb70f9724ac88330fe516d7b076"><div class="ttname"><a href="class_random_number_store.html#a32bb1cb70f9724ac88330fe516d7b076">RandomNumberStore::MaxRetrievable</a></div><div class="ttdeci">lword MaxRetrievable() const</div><div class="ttdoc">Provides the number of bytes ready for retrieval. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01235">filters.h:1235</a></div></div> <div class="ttc" id="class_buffered_transformation_html_a68044dc8d57bc02edee1ce02b459a63d"><div class="ttname"><a href="class_buffered_transformation.html#a68044dc8d57bc02edee1ce02b459a63d">BufferedTransformation::IsolatedFlush</a></div><div class="ttdeci">virtual bool IsolatedFlush(bool hardFlush, bool blocking)=0</div><div class="ttdoc">Flushes data buffered by this object, without signal propagation. </div></div> <div class="ttc" id="class_random_number_sink_html_aed57770519427841e3aac3abc251bc64"><div class="ttname"><a href="class_random_number_sink.html#aed57770519427841e3aac3abc251bc64">RandomNumberSink::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l00527">filters.cpp:527</a></div></div> <div class="ttc" id="class_p_k___encryptor_filter_html"><div class="ttname"><a href="class_p_k___encryptor_filter.html">PK_EncryptorFilter</a></div><div class="ttdoc">Filter wrapper for PK_Encryptor. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01032">filters.h:1032</a></div></div> <div class="ttc" id="struct_buffered_transformation_1_1_blocking_input_only_html"><div class="ttname"><a href="struct_buffered_transformation_1_1_blocking_input_only.html">BufferedTransformation::BlockingInputOnly</a></div><div class="ttdoc">Exception thrown by objects that have not implemented nonblocking input processing. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01669">cryptlib.h:1669</a></div></div> <div class="ttc" id="class_stream_transformation_filter_html"><div class="ttname"><a href="class_stream_transformation_filter.html">StreamTransformationFilter</a></div><div class="ttdoc">Filter wrapper for StreamTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00500">filters.h:500</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979a33d1ed83310e9d60f606a60af3cc6559"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a33d1ed83310e9d60f606a60af3cc6559">BlockPaddingSchemeDef::W3C_PADDING</a></div><div class="ttdoc">W3C padding added to a block. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00487">filters.h:487</a></div></div> <div class="ttc" id="class_redirector_html_a890fae5ac4297b1c06c6f93252a0f92c"><div class="ttname"><a href="class_redirector.html#a890fae5ac4297b1c06c6f93252a0f92c">Redirector::Redirect</a></div><div class="ttdeci">void Redirect(BufferedTransformation &target)</div><div class="ttdoc">Redirect input to another BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00864">filters.h:864</a></div></div> <div class="ttc" id="class_redirector_html_a2de79d5742280aa614c218c7b950de67"><div class="ttname"><a href="class_redirector.html#a2de79d5742280aa614c218c7b950de67">Redirector::Behavior</a></div><div class="ttdeci">Behavior</div><div class="ttdoc">Controls signal propagation behavior. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00838">filters.h:838</a></div></div> <div class="ttc" id="cryptlib_8h_html_a04be65ada92ccb1e6aac0d94b4cc394b"><div class="ttname"><a href="cryptlib_8h.html#a04be65ada92ccb1e6aac0d94b4cc394b">g_nullNameValuePairs</a></div><div class="ttdeci">const NameValuePairs g_nullNameValuePairs</div><div class="ttdoc">An empty set of name-value pairs. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00494">cryptlib.h:494</a></div></div> <div class="ttc" id="class_buffered_transformation_html_a30b2076bce5fb29e992b6457485c67c2"><div class="ttname"><a href="class_buffered_transformation.html#a30b2076bce5fb29e992b6457485c67c2">BufferedTransformation::MaxRetrievable</a></div><div class="ttdeci">virtual lword MaxRetrievable() const</div><div class="ttdoc">Provides the number of bytes ready for retrieval. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8cpp_source.html#l00510">cryptlib.cpp:510</a></div></div> <div class="ttc" id="class_hash_filter_html_a5c2f3a90ced66c835969ce1aa235b63e"><div class="ttname"><a href="class_hash_filter.html#a5c2f3a90ced66c835969ce1aa235b63e">HashFilter::CreatePutSpace</a></div><div class="ttdeci">byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00567">filters.h:567</a></div></div> <div class="ttc" id="class_unflushable_html"><div class="ttname"><a href="class_unflushable.html">Unflushable</a></div><div class="ttdoc">Base class for unflushable filters. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00108">simple.h:108</a></div></div> <div class="ttc" id="class_p_k___verifier_html"><div class="ttname"><a href="class_p_k___verifier.html">PK_Verifier</a></div><div class="ttdoc">Interface for public-key signature verifiers. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l02769">cryptlib.h:2769</a></div></div> <div class="ttc" id="class_filter_html_a6e7251247b5c2cc3b0c15e861cc88e16"><div class="ttname"><a href="class_filter.html#a6e7251247b5c2cc3b0c15e861cc88e16">Filter::Attachable</a></div><div class="ttdeci">bool Attachable()</div><div class="ttdoc">Determine if attachable. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00051">filters.h:51</a></div></div> <div class="ttc" id="class_transparent_filter_html"><div class="ttname"><a href="class_transparent_filter.html">TransparentFilter</a></div><div class="ttdoc">A transparent MeterFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00287">filters.h:287</a></div></div> <div class="ttc" id="class_stream_transformation_filter_html_ace011a28ce65458013b722a005b909a4"><div class="ttname"><a href="class_stream_transformation_filter.html#ace011a28ce65458013b722a005b909a4">StreamTransformationFilter::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00516">filters.h:516</a></div></div> <div class="ttc" id="struct_filter_put_space_helper_html_ac50ca63d7b1a529a32e8596aa44df9c4"><div class="ttname"><a href="struct_filter_put_space_helper.html#ac50ca63d7b1a529a32e8596aa44df9c4">FilterPutSpaceHelper::m_tempSpace</a></div><div class="ttdeci">SecByteBlock m_tempSpace</div><div class="ttdoc">Temporay working space. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00211">filters.h:211</a></div></div> <div class="ttc" id="class_output_proxy_html_a997ff0e5b2ac162e96805f8753dfae40"><div class="ttname"><a href="class_output_proxy.html#a997ff0e5b2ac162e96805f8753dfae40">OutputProxy::SetPassSignal</a></div><div class="ttdeci">void SetPassSignal(bool passSignal)</div><div class="ttdoc">Set passSignal flag. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00943">filters.h:943</a></div></div> <div class="ttc" id="class_signer_filter_html_a1676894ce3df207b64b6041bc129133e"><div class="ttname"><a href="class_signer_filter.html#a1676894ce3df207b64b6041bc129133e">SignerFilter::SignerFilter</a></div><div class="ttdeci">SignerFilter(RandomNumberGenerator &rng, const PK_Signer &signer, BufferedTransformation *attachment=NULL, bool putMessage=false)</div><div class="ttdoc">Construct a SignerFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00753">filters.h:753</a></div></div> <div class="ttc" id="class_hash_transformation_html"><div class="ttname"><a href="class_hash_transformation.html">HashTransformation</a></div><div class="ttdoc">Interface for hash functions and data processing part of MACs. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01065">cryptlib.h:1065</a></div></div> <div class="ttc" id="class_buffered_transformation_html_af390325c959c3d6a2c03a447d6cd469d"><div class="ttname"><a href="class_buffered_transformation.html#af390325c959c3d6a2c03a447d6cd469d">BufferedTransformation::CreatePutSpace</a></div><div class="ttdeci">virtual byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l01606">cryptlib.h:1606</a></div></div> <div class="ttc" id="class_redirector_html_a9dde3ac97812d4ba31245f46192cb627"><div class="ttname"><a href="class_redirector.html#a9dde3ac97812d4ba31245f46192cb627">Redirector::ChannelFlush</a></div><div class="ttdeci">bool ChannelFlush(const std::string &channel, bool completeFlush, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Flush buffered input and/or output on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00910">filters.h:910</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979ae6ae59c8e974534a292a2f0b11131f08"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979ae6ae59c8e974534a292a2f0b11131f08">BlockPaddingSchemeDef::ZEROS_PADDING</a></div><div class="ttdoc">0&#39;s padding added to a block </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00476">filters.h:476</a></div></div> <div class="ttc" id="class_meter_filter_html_ad6f0f8c7bbc82fefb44c3c4747e3d3e9"><div class="ttname"><a href="class_meter_filter.html#ad6f0f8c7bbc82fefb44c3c4747e3d3e9">MeterFilter::SetTransparent</a></div><div class="ttdeci">void SetTransparent(bool transparent)</div><div class="ttdoc">Set or change the transparent mode of this object. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00234">filters.h:234</a></div></div> <div class="ttc" id="class_array_sink_html_a70d9e1c3231cb190831fd16e132ace2b"><div class="ttname"><a href="class_array_sink.html#a70d9e1c3231cb190831fd16e132ace2b">ArraySink::ArraySink</a></div><div class="ttdeci">ArraySink(const NameValuePairs &parameters=g_nullNameValuePairs)</div><div class="ttdoc">Construct an ArraySink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01140">filters.h:1140</a></div></div> <div class="ttc" id="class_filter_html"><div class="ttname"><a href="class_filter.html">Filter</a></div><div class="ttdoc">Implementation of BufferedTransformation&#39;s attachment interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00035">filters.h:35</a></div></div> <div class="ttc" id="class_get_block_html"><div class="ttname"><a href="class_get_block.html">GetBlock</a></div><div class="ttdoc">Access a block of memory. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l02324">misc.h:2324</a></div></div> <div class="ttc" id="class_meter_filter_html_a141a6f8b09072847dbdd6a3f0f33f865"><div class="ttname"><a href="class_meter_filter.html#a141a6f8b09072847dbdd6a3f0f33f865">MeterFilter::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="filters_8h_source.html#l00250">filters.h:250</a></div></div> <div class="ttc" id="class_meter_filter_html"><div class="ttname"><a href="class_meter_filter.html">MeterFilter</a></div><div class="ttdoc">Measure how many bytes and messages pass through the filter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00217">filters.h:217</a></div></div> <div class="ttc" id="class_redirector_html_ac0dc5f63f7a57af37f819aa9251a78bf"><div class="ttname"><a href="class_redirector.html#ac0dc5f63f7a57af37f819aa9251a78bf">Redirector::GetWaitObjects</a></div><div class="ttdeci">void GetWaitObjects(WaitObjectContainer &container, CallStack const &callStack)</div><div class="ttdoc">Retrieves waitable objects. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00917">filters.h:917</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979ad929ced62ab4871b2d9b87cab0b47887"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979ad929ced62ab4871b2d9b87cab0b47887">BlockPaddingSchemeDef::NO_PADDING</a></div><div class="ttdoc">No padding added to a block. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00473">filters.h:473</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_array_xor_sink_html_a2cb0d33318f1272826d235698191b68d"><div class="ttname"><a href="class_array_xor_sink.html#a2cb0d33318f1272826d235698191b68d">ArrayXorSink::ArrayXorSink</a></div><div class="ttdeci">ArrayXorSink(byte *buf, size_t size)</div><div class="ttdoc">Construct an ArrayXorSink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01182">filters.h:1182</a></div></div> <div class="ttc" id="class_string_store_html_acca5c45df0db23ac71fb363d7005743b"><div class="ttname"><a href="class_string_store.html#acca5c45df0db23ac71fb363d7005743b">StringStore::TransferTo2</a></div><div class="ttdeci">size_t TransferTo2(BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)</div><div class="ttdoc">Transfer bytes from this object to another BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l01195">filters.cpp:1195</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html_abea06c498771e8f0ad0fbbc19416a979a622df395c2f0edc35f722d938faaad1f"><div class="ttname"><a href="struct_block_padding_scheme_def.html#abea06c498771e8f0ad0fbbc19416a979a622df395c2f0edc35f722d938faaad1f">BlockPaddingSchemeDef::PKCS_PADDING</a></div><div class="ttdoc">PKCS #5 padding added to a block. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00479">filters.h:479</a></div></div> <div class="ttc" id="struct_block_padding_scheme_def_html"><div class="ttname"><a href="struct_block_padding_scheme_def.html">BlockPaddingSchemeDef</a></div><div class="ttdoc">Padding schemes used for block ciphers. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00460">filters.h:460</a></div></div> <div class="ttc" id="class_name_value_pairs_html_a5357c3a09602e44671d1e42cb9a9408d"><div class="ttname"><a href="class_name_value_pairs.html#a5357c3a09602e44671d1e42cb9a9408d">NameValuePairs::GetValue</a></div><div class="ttdeci">bool GetValue(const char *name, T &value) const</div><div class="ttdoc">Get a named value. </div><div class="ttdef"><b>Definition:</b> <a href="cryptlib_8h_source.html#l00347">cryptlib.h:347</a></div></div> <div class="ttc" id="class_p_k___encryptor_filter_html_aea9b12fbe885a3f5c7c9a1a048d1a8b8"><div class="ttname"><a href="class_p_k___encryptor_filter.html#aea9b12fbe885a3f5c7c9a1a048d1a8b8">PK_EncryptorFilter::PK_EncryptorFilter</a></div><div class="ttdeci">PK_EncryptorFilter(RandomNumberGenerator &rng, const PK_Encryptor &encryptor, BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a PK_EncryptorFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01039">filters.h:1039</a></div></div> <div class="ttc" id="class_array_sink_html_a2651a72ad26f0ced19013a425195e0e1"><div class="ttname"><a href="class_array_sink.html#a2651a72ad26f0ced19013a425195e0e1">ArraySink::ArraySink</a></div><div class="ttdeci">ArraySink(byte *buf, size_t size)</div><div class="ttdoc">Construct an ArraySink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01146">filters.h:1146</a></div></div> <div class="ttc" id="class_string_sink_template_html_a7f718529861bfc5c77e3f6f230026c07"><div class="ttname"><a href="class_string_sink_template.html#a7f718529861bfc5c77e3f6f230026c07">StringSinkTemplate::StringSinkTemplate</a></div><div class="ttdeci">StringSinkTemplate(T &output)</div><div class="ttdoc">Construct a StringSinkTemplate. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01070">filters.h:1070</a></div></div> <div class="ttc" id="class_random_number_source_html"><div class="ttname"><a href="class_random_number_source.html">RandomNumberSource</a></div><div class="ttdoc">RNG-based implementation of Source interface. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01419">filters.h:1419</a></div></div> <div class="ttc" id="class_redirector_html_a827e4af441934015de54ceb14334503d"><div class="ttname"><a href="class_redirector.html#a827e4af441934015de54ceb14334503d">Redirector::ChannelMessageSeriesEnd</a></div><div class="ttdeci">bool ChannelMessageSeriesEnd(const std::string &channel, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Marks the end of a series of messages on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00912">filters.h:912</a></div></div> <div class="ttc" id="class_filter_with_buffered_input_html_a4261e0491864a31738cf53b3f9343806"><div class="ttname"><a href="class_filter_with_buffered_input.html#a4261e0491864a31738cf53b3f9343806">FilterWithBufferedInput::IsolatedFlush</a></div><div class="ttdeci">bool IsolatedFlush(bool hardFlush, bool blocking)</div><div class="ttdoc">Flushes data buffered by this object, without signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8cpp_source.html#l00338">filters.cpp:338</a></div></div> <div class="ttc" id="class_output_proxy_html_a0b7247fde67865b260d55763e14fdfa5"><div class="ttname"><a href="class_output_proxy.html#a0b7247fde67865b260d55763e14fdfa5">OutputProxy::PutModifiable2</a></div><div class="ttdeci">size_t PutModifiable2(byte *begin, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes that may be modified by callee. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00949">filters.h:949</a></div></div> <div class="ttc" id="struct_filter_put_space_helper_html_a85fea9f0455741e4b340a3e035df9a39"><div class="ttname"><a href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39">FilterPutSpaceHelper::HelpCreatePutSpace</a></div><div class="ttdeci">byte * HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)</div><div class="ttdoc">Create a working space in a BufferedTransformation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00175">filters.h:175</a></div></div> <div class="ttc" id="class_call_stack_html"><div class="ttname"><a href="class_call_stack.html">CallStack</a></div><div class="ttdef"><b>Definition:</b> <a href="wait_8h_source.html#l00124">wait.h:124</a></div></div> <div class="ttc" id="class_filter_with_input_queue_html_a4cbafb997e9f2a310ed490eea49fb1ab"><div class="ttname"><a href="class_filter_with_input_queue.html#a4cbafb997e9f2a310ed490eea49fb1ab">FilterWithInputQueue::FilterWithInputQueue</a></div><div class="ttdeci">FilterWithInputQueue(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a FilterWithInputQueue. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00433">filters.h:433</a></div></div> <div class="ttc" id="class_opaque_filter_html_af1cce756d535a725ac0f490c48e6ab50"><div class="ttname"><a href="class_opaque_filter.html#af1cce756d535a725ac0f490c48e6ab50">OpaqueFilter::OpaqueFilter</a></div><div class="ttdeci">OpaqueFilter(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct an OpaqueFilter. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00302">filters.h:302</a></div></div> <div class="ttc" id="class_not_copyable_html"><div class="ttname"><a href="class_not_copyable.html">NotCopyable</a></div><div class="ttdoc">Ensures an object is not copyable. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l00228">misc.h:228</a></div></div> <div class="ttc" id="class_filter_with_buffered_input_html_a9885841f5ecee1403b57c5b1fc28a928"><div class="ttname"><a href="class_filter_with_buffered_input.html#a9885841f5ecee1403b57c5b1fc28a928">FilterWithBufferedInput::Put2</a></div><div class="ttdeci">size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes for processing. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00329">filters.h:329</a></div></div> <div class="ttc" id="class_redirector_html_a201243b803642ebfd392579953e75e92"><div class="ttname"><a href="class_redirector.html#a201243b803642ebfd392579953e75e92">Redirector::Flush</a></div><div class="ttdeci">bool Flush(bool hardFlush, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Flush buffered input and/or output, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00891">filters.h:891</a></div></div> <div class="ttc" id="class_array_xor_sink_html_a39567ce27137cc06ed9a2b0a1c834f01"><div class="ttname"><a href="class_array_xor_sink.html#a39567ce27137cc06ed9a2b0a1c834f01">ArrayXorSink::CreatePutSpace</a></div><div class="ttdeci">byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01186">filters.h:1186</a></div></div> <div class="ttc" id="class_string_store_html_aa35e0ca808e5b5c5f433e95fe3a9e371"><div class="ttname"><a href="class_string_store.html#aa35e0ca808e5b5c5f433e95fe3a9e371">StringStore::StringStore</a></div><div class="ttdeci">StringStore(const char *string=NULL)</div><div class="ttdoc">Construct a StringStore. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01196">filters.h:1196</a></div></div> <div class="ttc" id="class_custom_signal_propagation_html"><div class="ttname"><a href="class_custom_signal_propagation.html">CustomSignalPropagation</a></div><div class="ttdoc">Interface for custom flush signals. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00203">simple.h:203</a></div></div> <div class="ttc" id="class_output_proxy_html_aa6c68d78790266c60fa8b27176fbf969"><div class="ttname"><a href="class_output_proxy.html#aa6c68d78790266c60fa8b27176fbf969">OutputProxy::Flush</a></div><div class="ttdeci">bool Flush(bool hardFlush, int propagation=-1, bool blocking=true)</div><div class="ttdoc">Flush buffered input and/or output, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00953">filters.h:953</a></div></div> <div class="ttc" id="class_authenticated_decryption_filter_html_a1029fdc7cf2317fad80c71a6684b0638"><div class="ttname"><a href="class_authenticated_decryption_filter.html#a1029fdc7cf2317fad80c71a6684b0638">AuthenticatedDecryptionFilter::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00715">filters.h:715</a></div></div> <div class="ttc" id="class_redirector_html_aa39d3ce8654aede6c9473129125dffc7"><div class="ttname"><a href="class_redirector.html#aa39d3ce8654aede6c9473129125dffc7">Redirector::ChannelPutModifiable2</a></div><div class="ttdeci">size_t ChannelPutModifiable2(const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)</div><div class="ttdoc">Input multiple bytes that may be modified by callee on a channel. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00908">filters.h:908</a></div></div> <div class="ttc" id="class_array_sink_html_a36374569bfaf3711c3a7a306a46ea6d9"><div class="ttname"><a href="class_array_sink.html#a36374569bfaf3711c3a7a306a46ea6d9">ArraySink::TotalPutLength</a></div><div class="ttdeci">lword TotalPutLength()</div><div class="ttdoc">Provides the number of bytes written to the Sink. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01155">filters.h:1155</a></div></div> <div class="ttc" id="class_simple_proxy_filter_html_ac012ee6fab5a2a7de9071c61e0372123"><div class="ttname"><a href="class_simple_proxy_filter.html#ac012ee6fab5a2a7de9071c61e0372123">SimpleProxyFilter::LastPut</a></div><div class="ttdeci">void LastPut(const byte *inString, size_t length)</div><div class="ttdoc">Input the last block of data. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01024">filters.h:1024</a></div></div> <div class="ttc" id="class_signer_filter_html_a8f2ff110b58fdb2b9d629f12b9d166bb"><div class="ttname"><a href="class_signer_filter.html#a8f2ff110b58fdb2b9d629f12b9d166bb">SignerFilter::AlgorithmName</a></div><div class="ttdeci">std::string AlgorithmName() const</div><div class="ttdoc">Provides the name of this algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00756">filters.h:756</a></div></div> <div class="ttc" id="class_bufferless_html"><div class="ttname"><a href="class_bufferless.html">Bufferless</a></div><div class="ttdoc">Base class for bufferless filters. </div><div class="ttdef"><b>Definition:</b> <a href="simple_8h_source.html#l00098">simple.h:98</a></div></div> <div class="ttc" id="misc_8h_html_a3c75bb398badb69c7577b21486f9963f"><div class="ttname"><a href="misc_8h.html#a3c75bb398badb69c7577b21486f9963f">SIZE_MAX</a></div><div class="ttdeci">#define SIZE_MAX</div><div class="ttdoc">The maximum value of a machine word. </div><div class="ttdef"><b>Definition:</b> <a href="misc_8h_source.html#l00085">misc.h:85</a></div></div> <div class="ttc" id="class_output_proxy_html_ae0400c5e91f8d8c50e2b4da7d15bf646"><div class="ttname"><a href="class_output_proxy.html#ae0400c5e91f8d8c50e2b4da7d15bf646">OutputProxy::CreatePutSpace</a></div><div class="ttdeci">byte * CreatePutSpace(size_t &size)</div><div class="ttdoc">Request space which can be written into by the caller. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00945">filters.h:945</a></div></div> <div class="ttc" id="class_source_template_html_aeb0d3d0a6e3f56d88e9dabcec2e096f9"><div class="ttname"><a href="class_source_template.html#aeb0d3d0a6e3f56d88e9dabcec2e096f9">SourceTemplate::GetAutoSignalPropagation</a></div><div class="ttdeci">int GetAutoSignalPropagation() const</div><div class="ttdoc">Retrieve automatic signal propagation value. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01371">filters.h:1371</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 class="ttc" id="class_redirector_html_a34c42c1730d031f486e5d285c6dc3314"><div class="ttname"><a href="class_redirector.html#a34c42c1730d031f486e5d285c6dc3314">Redirector::MessageSeriesEnd</a></div><div class="ttdeci">bool MessageSeriesEnd(int propagation=-1, bool blocking=true)</div><div class="ttdoc">Marks the end of a series of messages, with signal propagation. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l00893">filters.h:893</a></div></div> <div class="ttc" id="class_source_html_a99d1d02e5d32ea8b21db7158f7cab2a9"><div class="ttname"><a href="class_source.html#a99d1d02e5d32ea8b21db7158f7cab2a9">Source::Source</a></div><div class="ttdeci">Source(BufferedTransformation *attachment=NULL)</div><div class="ttdoc">Construct a Source. </div><div class="ttdef"><b>Definition:</b> <a href="filters_8h_source.html#l01284">filters.h:1284</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:51 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>