📄 class_s_a_f_e_r_1_1_base.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>Crypto++: SAFER::Base Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><div class="nav"><a class="el" href="class_s_a_f_e_r.html">SAFER</a>::<a class="el" href="class_s_a_f_e_r_1_1_base.html">Base</a></div><h1>SAFER::Base Class Reference</h1><!-- doxytag: class="SAFER::Base" --><!-- doxytag: inherits="BlockCipher" --><p>Inheritance diagram for SAFER::Base:<p><center><img src="class_s_a_f_e_r_1_1_base.png" usemap="#SAFER::Base_map" border="0" alt=""></center><map name="SAFER::Base_map"><area href="class_block_cipher.html" alt="BlockCipher" shape="rect" coords="74,168,212,192"><area href="class_block_transformation.html" alt="BlockTransformation" shape="rect" coords="0,112,138,136"><area href="class_simple_keying_interface.html" alt="SimpleKeyingInterface" shape="rect" coords="148,112,286,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,138,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,138,24"><area href="class_s_a_f_e_r_1_1_dec.html" alt="SAFER::Dec" shape="rect" coords="0,280,138,304"><area href="class_s_a_f_e_r_1_1_enc.html" alt="SAFER::Enc" shape="rect" coords="148,280,286,304"></map><a href="class_s_a_f_e_r_1_1_base-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><p><p>Definition at line <a class="el" href="safer_8h-source.html#l00016">16</a> of file <a class="el" href="safer_8h-source.html">safer.h</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Types</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6e">IV_Requirement</a> { <br> <a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6e1cc32e69fe4f385e54d9d482a2ab5a56">UNIQUE_IV</a> = 0, <a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6e4520c4379ee3a1aed95a36e2235ba338">RANDOM_IV</a>, <a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6eceff3ad4b12bcb6d7b61a5bd543a815c">UNPREDICTABLE_RANDOM_IV</a>, <a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6eb659bf6d2c470c50c14bfbab5b2d45ab">INTERNALLY_GENERATED_IV</a>, <br> <a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6ec1d24de3dedd05c28516f452d3ace417">NOT_RESYNCHRONIZABLE</a><br> }</td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d00d16d1a495ffe932e3ba7cbee2c31"></a><!-- doxytag: member="SAFER::Base::GetAlignment" ref="0d00d16d1a495ffe932e3ba7cbee2c31" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_a_f_e_r_1_1_base.html#0d00d16d1a495ffe932e3ba7cbee2c31">GetAlignment</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d403227c3c5f82315dbb3f13dd2ec868"></a><!-- doxytag: member="SAFER::Base::UncheckedSetKey" ref="d403227c3c5f82315dbb3f13dd2ec868" args="(const byte *userkey, unsigned int length, const NameValuePairs &params)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_a_f_e_r_1_1_base.html#d403227c3c5f82315dbb3f13dd2ec868">UncheckedSetKey</a> (const byte *userkey, unsigned int length, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1904cf145e4c5c650dd7aff32f54e153"></a><!-- doxytag: member="SAFER::Base::ProcessAndXorBlock" ref="1904cf145e4c5c650dd7aff32f54e153" args="(const byte *inBlock, const byte *xorBlock, byte *outBlock) const =0" -->virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#1904cf145e4c5c650dd7aff32f54e153">ProcessAndXorBlock</a> (const byte *inBlock, const byte *xorBlock, byte *outBlock) const =0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">encrypt or decrypt inBlock, xor with xorBlock, and write to outBlock <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#2fefb3f4c6c6297c0c91fcbba9e4f4f3">ProcessBlock</a> (const byte *inBlock, byte *outBlock) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">encrypt or decrypt one block <a href="#2fefb3f4c6c6297c0c91fcbba9e4f4f3"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12cc1846de571557be0f82471e8904bf"></a><!-- doxytag: member="SAFER::Base::ProcessBlock" ref="12cc1846de571557be0f82471e8904bf" args="(byte *inoutBlock) const " -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#12cc1846de571557be0f82471e8904bf">ProcessBlock</a> (byte *inoutBlock) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">encrypt or decrypt one block in place <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4936bef4368804cf5cadab9eb6eb37e4"></a><!-- doxytag: member="SAFER::Base::BlockSize" ref="4936bef4368804cf5cadab9eb6eb37e4" args="() const=0" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#4936bef4368804cf5cadab9eb6eb37e4">BlockSize</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">block size of the cipher in bytes <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2da7e22f6b6ddda72bc7db2aceaa67a"></a><!-- doxytag: member="SAFER::Base::BlockAlignment" ref="f2da7e22f6b6ddda72bc7db2aceaa67a" args="() const" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#f2da7e22f6b6ddda72bc7db2aceaa67a">BlockAlignment</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">block pointers must be divisible by this <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4118be8bfaf6772a9a8e03dd450614b"></a><!-- doxytag: member="SAFER::Base::IsPermutation" ref="a4118be8bfaf6772a9a8e03dd450614b" args="() const" -->virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#a4118be8bfaf6772a9a8e03dd450614b">IsPermutation</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if this is a permutation (i.e. there is an inverse transformation) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="924da616b7ba966704fb67e2b852fd2e"></a><!-- doxytag: member="SAFER::Base::IsForwardTransformation" ref="924da616b7ba966704fb67e2b852fd2e" args="() const=0" -->virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#924da616b7ba966704fb67e2b852fd2e">IsForwardTransformation</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if this is an encryption object <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ee1da34a4c957d4be87d2b0469806b0"></a><!-- doxytag: member="SAFER::Base::OptimalNumberOfParallelBlocks" ref="9ee1da34a4c957d4be87d2b0469806b0" args="() const" -->virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#9ee1da34a4c957d4be87d2b0469806b0">OptimalNumberOfParallelBlocks</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">return number of blocks that can be processed in parallel, for bit-slicing implementations <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9efa0ea24795a19d15c9aa0d7f134562"></a><!-- doxytag: member="SAFER::Base::ProcessAndXorMultipleBlocks" ref="9efa0ea24795a19d15c9aa0d7f134562" args="(const byte *inBlocks, const byte *xorBlocks, byte *outBlocks, size_t numberOfBlocks) const" -->virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#9efa0ea24795a19d15c9aa0d7f134562">ProcessAndXorMultipleBlocks</a> (const byte *inBlocks, const byte *xorBlocks, byte *outBlocks, size_t numberOfBlocks) const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">encrypt or decrypt multiple blocks, for bit-slicing implementations <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91b351e01288f31eccb3b42bc096c2ba"></a><!-- doxytag: member="SAFER::Base::GetCipherDirection" ref="91b351e01288f31eccb3b42bc096c2ba" args="() const" --><a class="el" href="cryptlib_8h.html#353ccabf5ddc119a6a33e92f7b9961c7">CipherDir</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_block_transformation.html#91b351e01288f31eccb3b42bc096c2ba">GetCipherDirection</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31510a192d1121856efe8ad0a9b844"></a><!-- doxytag: member="SAFER::Base::AlgorithmName" ref="4f31510a192d1121856efe8ad0a9b844" args="() const" -->virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#4f31510a192d1121856efe8ad0a9b844">AlgorithmName</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0016ba2d505c23aa85aad49e6c19bb7"></a><!-- doxytag: member="SAFER::Base::Clone" ref="d0016ba2d505c23aa85aad49e6c19bb7" args="() const" -->virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#d0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9e027a141d40929fef51343064d1a69"></a><!-- doxytag: member="SAFER::Base::MinKeyLength" ref="b9e027a141d40929fef51343064d1a69" args="() const=0" -->virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#b9e027a141d40929fef51343064d1a69">MinKeyLength</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns smallest valid key length in bytes */ <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99ebc91e778d51d8481c4c4e8403508b"></a><!-- doxytag: member="SAFER::Base::MaxKeyLength" ref="99ebc91e778d51d8481c4c4e8403508b" args="() const=0" -->virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#99ebc91e778d51d8481c4c4e8403508b">MaxKeyLength</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns largest valid key length in bytes */ <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f900bd0bce7f925cfe8c6002b828d810"></a><!-- doxytag: member="SAFER::Base::DefaultKeyLength" ref="f900bd0bce7f925cfe8c6002b828d810" args="() const=0" -->virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#f900bd0bce7f925cfe8c6002b828d810">DefaultKeyLength</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns default (recommended) key length in bytes */ <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4fb24fe36b6396c361d83dcc8c647f0"></a><!-- doxytag: member="SAFER::Base::GetValidKeyLength" ref="d4fb24fe36b6396c361d83dcc8c647f0" args="(size_t n) const=0" -->virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#d4fb24fe36b6396c361d83dcc8c647f0">GetValidKeyLength</a> (size_t n) const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the smallest valid key length in bytes that is >= min(n, GetMaxKeyLength()) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2229cdb9d7ac7e2cf3b02b39ae59ad77"></a><!-- doxytag: member="SAFER::Base::IsValidKeyLength" ref="2229cdb9d7ac7e2cf3b02b39ae59ad77" args="(size_t n) const" -->virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#2229cdb9d7ac7e2cf3b02b39ae59ad77">IsValidKeyLength</a> (size_t n) const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether n is a valid key length <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#df3c29b3ef3af74788a58c7c49887fd7">SetKey</a> (const byte *key, size_t length, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params=<a class="el" href="cryptlib_8h.html#d3205973dd1afa14090a683154c1109c">g_nullNameValuePairs</a>)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">set or reset the key of this object <a href="#df3c29b3ef3af74788a58c7c49887fd7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0401f9c67930805180964bc02ae0ac1c"></a><!-- doxytag: member="SAFER::Base::SetKeyWithRounds" ref="0401f9c67930805180964bc02ae0ac1c" args="(const byte *key, size_t length, int rounds)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#0401f9c67930805180964bc02ae0ac1c">SetKeyWithRounds</a> (const byte *key, size_t length, int rounds)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#df3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a> object that just specifies "Rounds" <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c25e27eaeae2e909741c07de93caef49"></a><!-- doxytag: member="SAFER::Base::SetKeyWithIV" ref="c25e27eaeae2e909741c07de93caef49" args="(const byte *key, size_t length, const byte *iv)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#c25e27eaeae2e909741c07de93caef49">SetKeyWithIV</a> (const byte *key, size_t length, const byte *iv)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#df3c29b3ef3af74788a58c7c49887fd7" title="set or reset the key of this object">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html" title="interface for retrieving values given their names">NameValuePairs</a> object that just specifies "IV" <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22087180aa396209403b0852e9efc431"></a><!-- doxytag: member="SAFER::Base::IVRequirement" ref="22087180aa396209403b0852e9efc431" args="() const=0" -->virtual <a class="el" href="class_simple_keying_interface.html#88201c180fbfaa9fef2715252546ad6e">IV_Requirement</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#22087180aa396209403b0852e9efc431">IVRequirement</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the minimal requirement for secure IVs <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#71039112353cc70e9859ebd95037cc1a">IsResynchronizable</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can be resynchronized (i.e. supports initialization vectors) <a href="#71039112353cc70e9859ebd95037cc1a"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a09fd0893ac8c6068e07ce30bb55c1d9"></a><!-- doxytag: member="SAFER::Base::CanUseRandomIVs" ref="a09fd0893ac8c6068e07ce30bb55c1d9" args="() const" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#a09fd0893ac8c6068e07ce30bb55c1d9">CanUseRandomIVs</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can use random IVs (in addition to ones returned by GetNextIV) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b98803e8744b73663e7e9c872eef822b"></a><!-- doxytag: member="SAFER::Base::CanUsePredictableIVs" ref="b98803e8744b73663e7e9c872eef822b" args="() const" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_simple_keying_interface.html#b98803e8744b73663e7e9c872eef822b">CanUsePredictableIVs</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can use random but possibly predictable IVs (in addition to ones returned by GetNextIV) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbf7065f7db5439d471d1bcc260d3bd5"></a><!-- doxytag: member="SAFER::Base::CanUseStructuredIVs" ref="fbf7065f7db5439d471d1bcc260d3bd5" args="() const" -->⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -