cryptlib_8h-source.html

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

<a name="l00262"></a>00262                 <span class="keywordflow">return</span> GetVoidValue(name, <span class="keyword">typeid</span>(T), &amp;value);
<a name="l00263"></a>00263         }
<a name="l00264"></a>00264 <span class="comment"></span>
<a name="l00265"></a>00265 <span class="comment">        //! get a named value, returns the default if the name doesn't exist</span>
<a name="l00266"></a>00266 <span class="comment"></span>        <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;
<a name="l00267"></a><a class="code" href="class_name_value_pairs.html#943b2009297783f1c35bae46efc3b5f7">00267</a>         T GetValueWithDefault(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, T defaultValue)<span class="keyword"> const</span>
<a name="l00268"></a>00268 <span class="keyword">        </span>{
<a name="l00269"></a>00269                 GetValue(name, defaultValue);
<a name="l00270"></a>00270                 <span class="keywordflow">return</span> defaultValue;
<a name="l00271"></a>00271         }
<a name="l00272"></a>00272 <span class="comment"></span>
<a name="l00273"></a>00273 <span class="comment">        //! get a list of value names that can be retrieved</span>
<a name="l00274"></a><a class="code" href="class_name_value_pairs.html#13faea827ee047cd58557282806ed2e1">00274</a> <span class="comment"></span>        CRYPTOPP_DLL std::string GetValueNames()<span class="keyword"> const</span>
<a name="l00275"></a>00275 <span class="keyword">                </span>{std::string result; GetValue(<span class="stringliteral">"ValueNames"</span>, result); <span class="keywordflow">return</span> result;}
<a name="l00276"></a>00276 <span class="comment"></span>
<a name="l00277"></a>00277 <span class="comment">        //! get a named value with type int</span>
<a name="l00278"></a>00278 <span class="comment"></span><span class="comment">        /*! used to ensure we don't accidentally try to get an unsigned int</span>
<a name="l00279"></a>00279 <span class="comment">                or some other type when we mean int (which is the most common case) */</span>
<a name="l00280"></a><a class="code" href="class_name_value_pairs.html#39b6daefcabcdd07f5ae482a075e1728">00280</a>         CRYPTOPP_DLL <span class="keywordtype">bool</span> GetIntValue(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> &amp;value)<span class="keyword"> const</span>
<a name="l00281"></a>00281 <span class="keyword">                </span>{<span class="keywordflow">return</span> GetValue(name, value);}
<a name="l00282"></a>00282 <span class="comment"></span>
<a name="l00283"></a>00283 <span class="comment">        //! get a named value with type int, with default</span>
<a name="l00284"></a><a class="code" href="class_name_value_pairs.html#7ddb654b7afcd1a04422a7b4b01366d9">00284</a> <span class="comment"></span>        CRYPTOPP_DLL <span class="keywordtype">int</span> GetIntValueWithDefault(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> defaultValue)<span class="keyword"> const</span>
<a name="l00285"></a>00285 <span class="keyword">                </span>{<span class="keywordflow">return</span> GetValueWithDefault(name, defaultValue);}
<a name="l00286"></a>00286 <span class="comment"></span>
<a name="l00287"></a>00287 <span class="comment">        //! used by derived classes to check for type mismatch</span>
<a name="l00288"></a><a class="code" href="class_name_value_pairs.html#a50a73b1705adb00ace9463b59696fb7">00288</a> <span class="comment"></span>        CRYPTOPP_DLL <span class="keyword">static</span> <span class="keywordtype">void</span> CRYPTOPP_API ThrowIfTypeMismatch(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> std::type_info &amp;stored, <span class="keyword">const</span> std::type_info &amp;retrieving)
<a name="l00289"></a>00289                 {<span class="keywordflow">if</span> (stored != retrieving) <span class="keywordflow">throw</span> ValueTypeMismatch(name, stored, retrieving);}
<a name="l00290"></a>00290 
<a name="l00291"></a>00291         <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;
<a name="l00292"></a><a class="code" href="class_name_value_pairs.html#c66048d3bc2a741712486d02e1f75d78">00292</a>         <span class="keywordtype">void</span> GetRequiredParameter(<span class="keyword">const</span> <span class="keywordtype">char</span> *className, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, T &amp;value)<span class="keyword"> const</span>
<a name="l00293"></a>00293 <span class="keyword">        </span>{
<a name="l00294"></a>00294                 <span class="keywordflow">if</span> (!GetValue(name, value))
<a name="l00295"></a>00295                         <span class="keywordflow">throw</span> InvalidArgument(std::string(className) + <span class="stringliteral">": missing required parameter '"</span> + name + <span class="stringliteral">"'"</span>);
<a name="l00296"></a>00296         }
<a name="l00297"></a>00297 
<a name="l00298"></a><a class="code" href="class_name_value_pairs.html#1e6596c87ad9c2bb7f2a4d7b2194b949">00298</a>         CRYPTOPP_DLL <span class="keywordtype">void</span> GetRequiredIntParameter(<span class="keyword">const</span> <span class="keywordtype">char</span> *className, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> &amp;value)<span class="keyword"> const</span>
<a name="l00299"></a>00299 <span class="keyword">        </span>{
<a name="l00300"></a>00300                 <span class="keywordflow">if</span> (!GetIntValue(name, value))
<a name="l00301"></a>00301                         <span class="keywordflow">throw</span> InvalidArgument(std::string(className) + <span class="stringliteral">": missing required parameter '"</span> + name + <span class="stringliteral">"'"</span>);
<a name="l00302"></a>00302         }
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment">        //! to be implemented by derived classes, users should use one of the above functions instead</span>
<a name="l00305"></a>00305 <span class="comment"></span>        CRYPTOPP_DLL <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetVoidValue(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> std::type_info &amp;valueType, <span class="keywordtype">void</span> *pValue) <span class="keyword">const</span> =0;
<a name="l00306"></a>00306 };
<a name="l00307"></a>00307 <span class="comment"></span>
<a name="l00308"></a>00308 <span class="comment">//! namespace containing value name definitions</span>
<a name="l00309"></a>00309 <span class="comment"></span><span class="comment">/*!     value names, types and semantics:</span>
<a name="l00310"></a>00310 <span class="comment"></span>
<a name="l00311"></a>00311 <span class="comment">        ThisObject:ClassName (ClassName, copy of this object or a subobject)</span>
<a name="l00312"></a>00312 <span class="comment">        ThisPointer:ClassName (const ClassName *, pointer to this object or a subobject)</span>
<a name="l00313"></a>00313 <span class="comment">*/</span>
<a name="l00314"></a>00314 DOCUMENTED_NAMESPACE_BEGIN(Name)
<a name="l00315"></a>00315 <span class="comment">// more names defined in argnames.h</span>
<a name="l00316"></a>00316 DOCUMENTED_NAMESPACE_END
<a name="l00317"></a>00317 <span class="comment"></span>
<a name="l00318"></a>00318 <span class="comment">//! empty set of name-value pairs</span>
<a name="l00319"></a><a class="code" href="class_null_name_value_pairs.html">00319</a> <span class="comment"></span>class CRYPTOPP_DLL <a class="code" href="class_null_name_value_pairs.html" title="empty set of name-value pairs">NullNameValuePairs</a> : public <a class="code" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a>
<a name="l00320"></a>00320 {
<a name="l00321"></a>00321 <span class="keyword">public</span>:
<a name="l00322"></a><a class="code" href="class_null_name_value_pairs.html#cf9413816ce2ada3ec085c2e30dfac2d">00322</a>         <span class="keywordtype">bool</span> GetVoidValue(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> std::type_info &amp;valueType, <span class="keywordtype">void</span> *pValue)<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00323"></a>00323 };
<a name="l00324"></a>00324 <span class="comment"></span>
<a name="l00325"></a>00325 <span class="comment">//! _</span>
<a name="l00326"></a>00326 <span class="comment"></span><span class="keyword">extern</span> CRYPTOPP_DLL <span class="keyword">const</span> <a class="code" href="class_null_name_value_pairs.html" title="empty set of name-value pairs">NullNameValuePairs</a> g_nullNameValuePairs;
<a name="l00327"></a>00327 
<a name="l00328"></a>00328 <span class="comment">// ********************************************************</span>
<a name="l00329"></a>00329 <span class="comment"></span>
<a name="l00330"></a>00330 <span class="comment">//! interface for cloning objects, this is not implemented by most classes yet</span>
<a name="l00331"></a><a class="code" href="class_clonable.html">00331</a> <span class="comment"></span><span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Clonable
<a name="l00332"></a>00332 {
<a name="l00333"></a>00333 <span class="keyword">public</span>:
<a name="l00334"></a><a class="code" href="class_clonable.html#2b9c911b4a49b532da3dea9951cf5fac">00334</a>         <span class="keyword">virtual</span> ~Clonable() {}<span class="comment"></span>
<a name="l00335"></a>00335 <span class="comment">        //! this is not implemented by most classes yet</span>
<a name="l00336"></a><a class="code" href="class_clonable.html#d0016ba2d505c23aa85aad49e6c19bb7">00336</a> <span class="comment"></span>        <span class="keyword">virtual</span> Clonable* Clone()<span class="keyword"> const </span>{<span class="keywordflow">throw</span> NotImplemented(<span class="stringliteral">"Clone() is not implemented yet."</span>);}      <span class="comment">// TODO: make this =0</span>
<a name="l00337"></a>00337 };
<a name="l00338"></a>00338 <span class="comment"></span>
<a name="l00339"></a>00339 <span class="comment">//! interface for all crypto algorithms</span>
<a name="l00340"></a>00340 <span class="comment"></span>
<a name="l00341"></a><a class="code" href="class_algorithm.html">00341</a> <span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Algorithm : <span class="keyword">public</span> Clonable
<a name="l00342"></a>00342 {
<a name="l00343"></a>00343 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00344"></a>00344 <span class="comment">        /*! When FIPS 140-2 compliance is enabled and checkSelfTestStatus == true,</span>
<a name="l00345"></a>00345 <span class="comment">                this constructor throws SelfTestFailure if the self test hasn't been run or fails. */</span>
<a name="l00346"></a>00346         Algorithm(<span class="keywordtype">bool</span> checkSelfTestStatus = <span class="keyword">true</span>);<span class="comment"></span>
<a name="l00347"></a>00347 <span class="comment">        //! returns name of this algorithm, not universally implemented yet</span>
<a name="l00348"></a><a class="code" href="class_algorithm.html#4f31510a192d1121856efe8ad0a9b844">00348</a> <span class="comment"></span>        <span class="keyword">virtual</span> std::string AlgorithmName()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <span class="stringliteral">"unknown"</span>;}
<a name="l00349"></a>00349 };
<a name="l00350"></a>00350 <span class="comment"></span>
<a name="l00351"></a>00351 <span class="comment">//! keying interface for crypto algorithms that take byte strings as keys</span>
<a name="l00352"></a>00352 <span class="comment"></span>
<a name="l00353"></a><a class="code" href="class_simple_keying_interface.html">00353</a> <span class="keyword">class </span>CRYPTOPP_DLL CRYPTOPP_NO_VTABLE SimpleKeyingInterface
<a name="l00354"></a>00354 {
<a name="l00355"></a>00355 <span class="keyword">public</span>: