This topic has not yet been rated - Rate this topic

SymmetricAlgorithm Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Represents the abstract base class from which all implementations of symmetric algorithms must inherit.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)
[ComVisibleAttribute(true)]
public abstract class SymmetricAlgorithm : IDisposable

The SymmetricAlgorithm type exposes the following members.

  Name Description
Protected method SymmetricAlgorithm Initializes a new instance of the SymmetricAlgorithm class.
Top
  Name Description
Public property BlockSize Gets or sets the block size, in bits, of the cryptographic operation.
Public property FeedbackSize Gets or sets the feedback size, in bits, of the cryptographic operation.
Public property IV Gets or sets the initialization vector (IV) for the symmetric algorithm.
Public property Key Gets or sets the secret key for the symmetric algorithm.
Public property KeySize Gets or sets the size, in bits, of the secret key used by the symmetric algorithm.
Public property LegalBlockSizes Gets the block sizes, in bits, that are supported by the symmetric algorithm.
Public property LegalKeySizes Gets the key sizes, in bits, that are supported by the symmetric algorithm.
Public property Mode Gets or sets the mode for operation of the symmetric algorithm.
Public property Padding Gets or sets the padding mode used in the symmetric algorithm.
Top
  Name Description
Public method Clear Releases all resources used by the SymmetricAlgorithm class.
Public method Static member Create() Creates a default cryptographic object used to perform the symmetric algorithm.
Public method Static member Create(String) Creates the specified cryptographic object used to perform the symmetric algorithm.
Public method CreateDecryptor() Creates a symmetric decryptor object with the current Key property and initialization vector (IV).
Public method CreateDecryptor(Byte[], Byte[]) When overridden in a derived class, creates a symmetric decryptor object with the specified Key property and initialization vector (IV).
Public method CreateEncryptor() Creates a symmetric encryptor object with the current Key property and initialization vector (IV).
Public method CreateEncryptor(Byte[], Byte[]) When overridden in a derived class, creates a symmetric encryptor object with the specified Key property and initialization vector (IV).
Public method Dispose() Releases all resources used by the current instance of the SymmetricAlgorithm class.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the SymmetricAlgorithm and optionally releases the managed resources.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GenerateIV When overridden in a derived class, generates a random initialization vector (IV) to use for the algorithm.
Public method GenerateKey When overridden in a derived class, generates a random key (Key) to use for the algorithm.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method ValidKeySize Determines whether the specified key size is valid for the current algorithm.
Top
  Name Description
Protected field BlockSizeValue Represents the block size, in bits, of the cryptographic operation.
Protected field FeedbackSizeValue Represents the feedback size, in bits, of the cryptographic operation.
Protected field IVValue Represents the initialization vector (IV) for the symmetric algorithm.
Protected field KeySizeValue Represents the size, in bits, of the secret key used by the symmetric algorithm.
Protected field KeyValue Represents the secret key for the symmetric algorithm.
Protected field LegalBlockSizesValue Specifies the block sizes, in bits, that are supported by the symmetric algorithm.
Protected field LegalKeySizesValue Specifies the key sizes, in bits, that are supported by the symmetric algorithm.
Protected field ModeValue Represents the cipher mode used in the symmetric algorithm.
Protected field PaddingValue Represents the padding mode used in the symmetric algorithm.
Top

The classes that derive from the SymmetricAlgorithm class use a chaining mode called cipher block chaining (CBC), which requires a key (Key) and an initialization vector (IV) to perform cryptographic transformations on data. To decrypt data that was encrypted using one of the SymmetricAlgorithm classes, you must set the Key property and the IV property to the same values that were used for encryption. For a symmetric algorithm to be useful, the secret key must be known only to the sender and the receiver.

RijndaelManaged , DESCryptoServiceProvider, RC2CryptoServiceProvider, and TripleDESCryptoServiceProvider are implementations of symmetric algorithms.

Note that when using derived classes, it is not enough, from a security perspective, to simply force a garbage collection after you have finished using the object. You must explicitly call the Clear method on the object to zero out any sensitive data within the object before it is released. Note that garbage collection does not zero out the contents of collected objects but simply marks the memory as available for reallocation. Thus the data contained within a garbage collected object may still be present in the memory heap in unallocated memory. In the case of cryptographic objects, this data could contain sensitive information such as key data or a block of plain text.

All cryptographic classes in the .NET Framework that hold sensitive data implement a Clear method. When called, the Clear method overwrites all sensitive data within the object with zeros and then releases the object so that it can be safely garbage collected. When the object has been zeroed and released, you should then call the Dispose method with the disposing parameter set to True to dispose of all managed and unmanaged resources associated with the object.

Notes to Inheritors

When you inherit from the SymmetricAlgorithm class, you must override the following members: CreateDecryptor, CreateEncryptor, GenerateIV, and GenerateKey.

The following code example uses the RijndaelManaged class with the specified Key property and initialization vector (IV) to encrypt a file specified by inName, and outputs the encrypted result to the file specified by outName. The desKey and desIV parameters to the method are 8-byte arrays. You must have the high encryption pack installed to run this example.


private static void EncryptData(String inName, String outName, byte[] rijnKey, byte[] rijnIV)
 {    
     //Create the file streams to handle the input and output files.
     FileStream fin = new FileStream(inName, FileMode.Open, FileAccess.Read);
     FileStream fout = new FileStream(outName, FileMode.OpenOrCreate, FileAccess.Write);
     fout.SetLength(0);

     //Create variables to help with read and write.
     byte[] bin = new byte[100]; //This is intermediate storage for the encryption.
     long rdlen = 0;              //This is the total number of bytes written.
     long totlen = fin.Length;    //This is the total length of the input file.
     int len;                     //This is the number of bytes to be written at a time.

     SymmetricAlgorithm rijn = SymmetricAlgorithm.Create(); //Creates the default implementation, which is RijndaelManaged.         
     CryptoStream encStream = new CryptoStream(fout, rijn.CreateEncryptor(rijnKey, rijnIV), CryptoStreamMode.Write);

     Console.WriteLine("Encrypting...");

     //Read from the input file, then encrypt and write to the output file.
     while(rdlen < totlen)
     {
         len = fin.Read(bin, 0, 100);
         encStream.Write(bin, 0, len);
         rdlen = rdlen + len;
         Console.WriteLine("{0} bytes processed", rdlen);
     }

     encStream.Close();  
     fout.Close();
     fin.Close();                   
 }


.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)