cryptlib_8h-source.html

著名的密码库Crypto++的文档 C++语言的杰作。程序员必备。

<a name="l00074"></a>00074 <span class="comment">and getting me started with this manual.</span>
<a name="l00075"></a>00075 <span class="comment">*/</span>
<a name="l00076"></a>00076 
<a name="l00077"></a>00077 <span class="preprocessor">#ifndef CRYPTOPP_CRYPTLIB_H</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define CRYPTOPP_CRYPTLIB_H</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span>
<a name="l00080"></a>00080 <span class="preprocessor">#include "config.h"</span>
<a name="l00081"></a>00081 <span class="preprocessor">#include "stdcpp.h"</span>
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 NAMESPACE_BEGIN(CryptoPP)
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 <span class="comment">// forward declarations</span>
<a name="l00086"></a>00086 class <a class="code" href="class_integer.html" title="multiple precision integer and basic arithmetics">Integer</a>;
<a name="l00087"></a>00087 class <a class="code" href="class_random_number_generator.html" title="interface for random number generators">RandomNumberGenerator</a>;
<a name="l00088"></a>00088 class <a class="code" href="class_buffered_transformation.html" title="interface for buffered transformations">BufferedTransformation</a>;
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">//! used to specify a direction for a cipher to operate in (encrypt or decrypt)</span>
<a name="l00091"></a><a class="code" href="cryptlib_8h.html#353ccabf5ddc119a6a33e92f7b9961c7244e5e74f856cdd5aafc1005877a2f61">00091</a> <span class="comment"></span>enum <a class="code" href="cryptlib_8h.html#353ccabf5ddc119a6a33e92f7b9961c7" title="used to specify a direction for a cipher to operate in (encrypt or decrypt)">CipherDir</a> {<a class="code" href="cryptlib_8h.html#353ccabf5ddc119a6a33e92f7b9961c7244e5e74f856cdd5aafc1005877a2f61">ENCRYPTION</a>,     <a class="code" href="cryptlib_8h.html#353ccabf5ddc119a6a33e92f7b9961c7b5f88847da182e7a1a8af64f4e18f048">DECRYPTION</a>};
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">//! used to represent infinite time</span>
<a name="l00094"></a><a class="code" href="cryptlib_8h.html#5dc7a255dd813433eeee3152544c2f1d">00094</a> <span class="comment"></span><span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="cryptlib_8h.html#5dc7a255dd813433eeee3152544c2f1d" title="used to represent infinite time">INFINITE_TIME</a> = ULONG_MAX;
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="comment">// VC60 workaround: using enums as template parameters causes problems</span>
<a name="l00097"></a>00097 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ENUM_TYPE, <span class="keywordtype">int</span> VALUE&gt;
<a name="l00098"></a><a class="code" href="struct_enum_to_type.html">00098</a> <span class="keyword">struct </span><a class="code" href="struct_enum_to_type.html">EnumToType</a>
<a name="l00099"></a>00099 {
<a name="l00100"></a><a class="code" href="struct_enum_to_type.html#fe0316d264db930e7cd0c4b829599213">00100</a>         <span class="keyword">static</span> ENUM_TYPE <a class="code" href="struct_enum_to_type.html#fe0316d264db930e7cd0c4b829599213">ToEnum</a>() {<span class="keywordflow">return</span> (ENUM_TYPE)VALUE;}
<a name="l00101"></a>00101 };
<a name="l00102"></a>00102 
<a name="l00103"></a><a class="code" href="cryptlib_8h.html#aeb92d42f5a6e27b8ba19f18d69d142bccd5b3585bd07d6bdae383aa8271b9d2">00103</a> <span class="keyword">enum</span> <a class="code" href="cryptlib_8h.html#aeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> {<a class="code" href="cryptlib_8h.html#aeb92d42f5a6e27b8ba19f18d69d142bccd5b3585bd07d6bdae383aa8271b9d2">LITTLE_ENDIAN_ORDER</a> = 0, <a class="code" href="cryptlib_8h.html#aeb92d42f5a6e27b8ba19f18d69d142bf0c3bb6c718cc7ff0bffef4e8f178c57">BIG_ENDIAN_ORDER</a> = 1};
<a name="l00104"></a><a class="code" href="cryptlib_8h.html#d00625e1e5e96656feaf83fd53c1ab4e">00104</a> <span class="keyword">typedef</span> <a class="code" href="struct_enum_to_type.html">EnumToType&lt;ByteOrder, LITTLE_ENDIAN_ORDER&gt;</a> <a class="code" href="struct_enum_to_type.html">LittleEndian</a>;
<a name="l00105"></a><a class="code" href="cryptlib_8h.html#f2a408c806f842a5be8d06de7d6a1066">00105</a> <span class="keyword">typedef</span> <a class="code" href="struct_enum_to_type.html">EnumToType&lt;ByteOrder, BIG_ENDIAN_ORDER&gt;</a> <a class="code" href="struct_enum_to_type.html">BigEndian</a>;
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">//! base class for all exceptions thrown by Crypto++</span>
<a name="l00108"></a><a class="code" href="class_exception.html">00108</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a> : <span class="keyword">public</span> std::exception
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment">        //! error types</span>
<a name="l00112"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a">00112</a> <span class="comment"></span>        <span class="keyword">enum</span> <a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a" title="error types">ErrorType</a> {<span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">                //! a method is not implemented</span>
<a name="l00114"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a1323c0f32eac2f9502b99c5c899ce629">00114</a> <span class="comment"></span>                NOT_IMPLEMENTED,<span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">                //! invalid function argument</span>
<a name="l00116"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0ab018a535e00d226178a71d2c5fa800d1">00116</a> <span class="comment"></span>                INVALID_ARGUMENT,<span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment">                //! BufferedTransformation received a Flush(true) signal but can't flush buffers</span>
<a name="l00118"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a11a8912fe9ae87f7469705b6d5130a06">00118</a> <span class="comment"></span>                CANNOT_FLUSH,<span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment">                //! data integerity check (such as CRC or MAC) failed</span>
<a name="l00120"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a77a639a803cf53052f9c76a0354247e6">00120</a> <span class="comment"></span>                DATA_INTEGRITY_CHECK_FAILED,<span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">                //! received input data that doesn't conform to expected format</span>
<a name="l00122"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a3a0352964781e7712b21dbb70ffbe646">00122</a> <span class="comment"></span>                INVALID_DATA_FORMAT,<span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">                //! error reading from input device or writing to output device</span>
<a name="l00124"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0ad51c7d0e0156bc1794b3b7f99599aba8">00124</a> <span class="comment"></span>                IO_ERROR,<span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment">                //! some error not belong to any of the above categories</span>
<a name="l00126"></a><a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a27d9ee7704100a88e4ae4adcc4072015">00126</a> <span class="comment"></span>                OTHER_ERROR
<a name="l00127"></a>00127         };
<a name="l00128"></a>00128 
<a name="l00129"></a><a class="code" href="class_exception.html#30847048a4b7c9a7aae5e6178964dcfb">00129</a>         <span class="keyword">explicit</span> <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>(<a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a" title="error types">ErrorType</a> errorType, <span class="keyword">const</span> std::string &amp;s) : m_errorType(errorType), m_what(s) {}
<a name="l00130"></a><a class="code" href="class_exception.html#d1ba411de295ef2eeb02ba26284a829a">00130</a>         <span class="keyword">virtual</span> ~<a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>() throw() {}
<a name="l00131"></a><a class="code" href="class_exception.html#dd710fe2bae3ac497ed60393eea35c91">00131</a>         <span class="keyword">const</span> <span class="keywordtype">char</span> *what() <span class="keyword">const</span> throw() {<span class="keywordflow">return</span> (m_what.c_str());}
<a name="l00132"></a><a class="code" href="class_exception.html#e2d81c6f4f89015b9dcaa5ebfa47f3c4">00132</a>         <span class="keyword">const</span> std::string &amp;GetWhat()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_what;}
<a name="l00133"></a><a class="code" href="class_exception.html#15f2ad1081dbac6d3cd676a4baa9515d">00133</a>         <span class="keywordtype">void</span> SetWhat(<span class="keyword">const</span> std::string &amp;s) {m_what = s;}
<a name="l00134"></a><a class="code" href="class_exception.html#c2c2e8a3c1871c532660252cd1894b90">00134</a>         <a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a" title="error types">ErrorType</a> GetErrorType()<span class="keyword"> const </span>{<span class="keywordflow">return</span> m_errorType;}
<a name="l00135"></a><a class="code" href="class_exception.html#0e1d8806d64e54e9584e9918462894bc">00135</a>         <span class="keywordtype">void</span> SetErrorType(<a class="code" href="class_exception.html#8e53909d979479380e0274807c074c0a" title="error types">ErrorType</a> errorType) {m_errorType = errorType;}
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="keyword">private</span>:
<a name="l00138"></a>00138         ErrorType m_errorType;
<a name="l00139"></a>00139         std::string m_what;
<a name="l00140"></a>00140 };
<a name="l00141"></a>00141 <span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment">//! exception thrown when an invalid argument is detected</span>
<a name="l00143"></a><a class="code" href="class_invalid_argument.html">00143</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL InvalidArgument : <span class="keyword">public</span> <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="keyword">public</span>:
<a name="l00146"></a><a class="code" href="class_invalid_argument.html#9fea12aad2d0a973c7a3f109202642ff">00146</a>         <span class="keyword">explicit</span> InvalidArgument(<span class="keyword">const</span> std::string &amp;s) : <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>(INVALID_ARGUMENT, s) {}
<a name="l00147"></a>00147 };
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">//! exception thrown when input data is received that doesn't conform to expected format</span>
<a name="l00150"></a><a class="code" href="class_invalid_data_format.html">00150</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL InvalidDataFormat : <span class="keyword">public</span> <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>
<a name="l00151"></a>00151 {
<a name="l00152"></a>00152 <span class="keyword">public</span>:
<a name="l00153"></a><a class="code" href="class_invalid_data_format.html#698d4d179bc8ffa1d16356fa4b3fa413">00153</a>         <span class="keyword">explicit</span> InvalidDataFormat(<span class="keyword">const</span> std::string &amp;s) : <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>(INVALID_DATA_FORMAT, s) {}
<a name="l00154"></a>00154 };
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment">//! exception thrown by decryption filters when trying to decrypt an invalid ciphertext</span>
<a name="l00157"></a><a class="code" href="class_invalid_ciphertext.html">00157</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL InvalidCiphertext : <span class="keyword">public</span> InvalidDataFormat
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 <span class="keyword">public</span>:
<a name="l00160"></a><a class="code" href="class_invalid_ciphertext.html#760adc619b8098721bf33d64f5b3eaa7">00160</a>         <span class="keyword">explicit</span> InvalidCiphertext(<span class="keyword">const</span> std::string &amp;s) : InvalidDataFormat(s) {}
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162 <span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">//! exception thrown by a class if a non-implemented method is called</span>
<a name="l00164"></a><a class="code" href="class_not_implemented.html">00164</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL NotImplemented : <span class="keyword">public</span> <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>
<a name="l00165"></a>00165 {
<a name="l00166"></a>00166 <span class="keyword">public</span>:
<a name="l00167"></a><a class="code" href="class_not_implemented.html#b360905d5b2d8f2b0b2024ceacec9819">00167</a>         <span class="keyword">explicit</span> NotImplemented(<span class="keyword">const</span> std::string &amp;s) : <a class="code" href="class_exception.html" title="base class for all exceptions thrown by Crypto++">Exception</a>(NOT_IMPLEMENTED, s) {}