📄 class_symmetric_cipher.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Crypto++: SymmetricCipher class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.2 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div><h1>SymmetricCipher Class Reference</h1><code>#include <<a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>></code><p><p>Inheritance diagram for SymmetricCipher:<p><center><img src="class_symmetric_cipher.png" usemap="#SymmetricCipher_map" border="0" alt=""></center><map name="SymmetricCipher_map"><area href="class_stream_transformation.html" alt="StreamTransformation" shape="rect" coords="282,112,649,136"><area href="class_simple_keying_interface.html" alt="SimpleKeyingInterface" shape="rect" coords="659,112,1026,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="282,56,649,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="282,0,649,24"><area href="class_a_r_c4___base.html" alt="ARC4_Base" shape="rect" coords="0,224,367,248"><area href="class_m_a_r_c4___base.html" alt="MARC4_Base" shape="rect" coords="0,280,367,304"></map><a href="class_symmetric_cipher-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>interface for stream ciphers <p><p>Definition at line <a class="el" href="cryptlib_8h-source.html#l00589">589</a> of file <a class="el" href="cryptlib_8h-source.html">cryptlib.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><b>IV_Requirement</b> { <br> <b>STRUCTURED_IV</b> = 0, <b>RANDOM_IV</b>, <b>UNPREDICTABLE_RANDOM_IV</b>, <b>INTERNALLY_GENERATED_IV</b>, <br> <b>NOT_RESYNCHRONIZABLE</b><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="el" href="class_stream_transformation.html">StreamTransformation</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera0">Ref</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to this object, </em> <a href="#_symmetric_ciphera0"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera1" doxytag="SymmetricCipher::MandatoryBlockSize"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera1">MandatoryBlockSize</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns block size, if input must be processed in blocks, otherwise 1 <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera2">OptimalBlockSize</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the input block size that is most efficient for this cipher </em> <a href="#_symmetric_ciphera2"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera3" doxytag="SymmetricCipher::GetOptimalBlockSizeUsed"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera3">GetOptimalBlockSizeUsed</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns how much of the current block is used up <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera4" doxytag="SymmetricCipher::OptimalDataAlignment"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera4">OptimalDataAlignment</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns how input should be aligned for optimal performance <br><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_symmetric_cipher.html#_symmetric_ciphera5">ProcessData</a> (byte *outString, const byte *inString, unsigned int length)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">encrypt or decrypt an array of bytes of specified length </em> <a href="#_symmetric_ciphera5"></a><em><br><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_symmetric_cipher.html#_symmetric_ciphera6">ProcessLastBlock</a> (byte *outString, const byte *inString, unsigned int length)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">for ciphers where the last block of data is special, encrypt or decrypt the last block of data </em> <a href="#_symmetric_ciphera6"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera7" doxytag="SymmetricCipher::MinLastBlockSize"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera7">MinLastBlockSize</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the minimum size of the last block, 0 indicating the last block is not special <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera8" doxytag="SymmetricCipher::ProcessString"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera8">ProcessString</a> (byte *inoutString, unsigned int length)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">same as ProcessData(inoutString, inoutString, length) <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera9" doxytag="SymmetricCipher::ProcessString"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera9">ProcessString</a> (byte *outString, const byte *inString, unsigned int length)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">same as ProcessData(outString, inString, length) <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera10" doxytag="SymmetricCipher::ProcessByte"></a>byte </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera10">ProcessByte</a> (byte input)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">implemented as {ProcessData(&input, &input, 1); return input;} <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera11" doxytag="SymmetricCipher::IsRandomAccess"></a>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera11">IsRandomAccess</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this cipher supports random access <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera12" doxytag="SymmetricCipher::Seek"></a>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera12">Seek</a> (dword n)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">for random access ciphers, seek to an absolute position <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera13" doxytag="SymmetricCipher::IsSelfInverting"></a>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera13">IsSelfInverting</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this transformation is self-inverting (e.g. xor with a keystream) <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_symmetric_ciphera14" doxytag="SymmetricCipher::IsForwardTransformation"></a>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_symmetric_ciphera14">IsForwardTransformation</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this is an encryption object <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora17" doxytag="SymmetricCipher::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_zlib_decompressora17">AlgorithmName</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora18" doxytag="SymmetricCipher::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_zlib_decompressora18">Clone</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea21" doxytag="SymmetricCipher::MinKeyLength"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea21">MinKeyLength</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns smallest valid key length in bytes */ <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea22" doxytag="SymmetricCipher::MaxKeyLength"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea22">MaxKeyLength</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns largest valid key length in bytes */ <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea23" doxytag="SymmetricCipher::DefaultKeyLength"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea23">DefaultKeyLength</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns default (recommended) key length in bytes */ <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea24" doxytag="SymmetricCipher::GetValidKeyLength"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea24">GetValidKeyLength</a> (unsigned int 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><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea25" doxytag="SymmetricCipher::IsValidKeyLength"></a>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea25">IsValidKeyLength</a> (unsigned int n) const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether n is a valid key length <br><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_symmetric_cipher.html#_x_m_a_c_c___basea26">SetKey</a> (const byte *key, unsigned int length, const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &params=<a class="el" href="cryptlib_8h.html#a3">g_nullNameValuePairs</a>)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">set or reset the key of this object </em> <a href="#_x_m_a_c_c___basea26"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea27" doxytag="SymmetricCipher::SetKeyWithRounds"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea27">SetKeyWithRounds</a> (const byte *key, unsigned int length, int rounds)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#_x_m_a_c_c___basea26">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> object that just specifies "Rounds" <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea28" doxytag="SymmetricCipher::SetKeyWithIV"></a>void </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea28">SetKeyWithIV</a> (const byte *key, unsigned int length, const byte *iv)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">calls <a class="el" href="class_simple_keying_interface.html#_x_m_a_c_c___basea26">SetKey()</a> with an <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> object that just specifies "IV" <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea29" doxytag="SymmetricCipher::IVRequirement"></a>virtual IV_Requirement </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea29">IVRequirement</a> () const=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the minimal requirement for secure IVs <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea30">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) </em> <a href="#_x_m_a_c_c___basea30"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea31" doxytag="SymmetricCipher::CanUseRandomIVs"></a>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea31">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><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea32" doxytag="SymmetricCipher::CanUsePredictableIVs"></a>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea32">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><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_c___basea33" doxytag="SymmetricCipher::CanUseStructuredIVs"></a>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_c___basea33">CanUseStructuredIVs</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object can use structured IVs, for example a counter (in addition to ones returned by GetNextIV) <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_x_m_a_c_ca32" doxytag="SymmetricCipher::IVSize"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_symmetric_cipher.html#_x_m_a_c_ca32">IVSize</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns size of IVs used by this object <br><br></td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -