SymmetricAlgorithm Класс

Определение

Представляет абстрактный базовый класс, от которого наследуются все реализации алгоритмов симметричного шифрования.Represents the abstract base class from which all implementations of symmetric algorithms must inherit.

public ref class SymmetricAlgorithm abstract : IDisposable
public abstract class SymmetricAlgorithm : IDisposable
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class SymmetricAlgorithm : IDisposable
type SymmetricAlgorithm = class
    interface IDisposable
[<System.Runtime.InteropServices.ComVisible(true)>]
type SymmetricAlgorithm = class
    interface IDisposable
Public MustInherit Class SymmetricAlgorithm
Implements IDisposable
Наследование
SymmetricAlgorithm
Производный
Атрибуты
Реализации

Примеры

В следующем примере кода используется Aes класс с указанным Key свойством и вектором инициализации ( IV ) для шифрования файла, заданного параметром inName , и выводит зашифрованный результат в файл, указанный параметром outName .The following code example uses the Aes 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. desKeyПараметры и desIV для метода представляют собой 8-байтовые массивы.The desKey and desIV parameters to the method are 8-byte arrays. Для выполнения этого примера необходимо, чтобы был установлен пакет стойкого шифрования.You must have the high encryption pack installed to run this example.

void EncryptData( String^ inName, String^ outName, array<Byte>^aesKey, array<Byte>^aesIV )
{
   
   //Create the file streams to handle the input and output files.
   FileStream^ fin = gcnew FileStream( inName,FileMode::Open,FileAccess::Read );
   FileStream^ fout = gcnew FileStream( outName,FileMode::OpenOrCreate,FileAccess::Write );
   fout->SetLength( 0 );
   
   //Create variables to help with read and write.
   array<Byte>^bin = gcnew array<Byte>(100);
   long rdlen = 0; //This is the total number of bytes written.

   long totlen = (long)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.

   Aes^ aes = Aes::Create();

   CryptoStream^ encStream = gcnew CryptoStream( fout,aes->CreateEncryptor( aesKey, aesIV ),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();
}

private static void EncryptData(String inName, String outName, byte[] aesKey, byte[] aesIV)
 {
     //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.

     Aes aes = Aes.Create();
     CryptoStream encStream = new CryptoStream(fout, aes.CreateEncryptor(aesKey, aesIV), 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();
 }
Private Shared Sub EncryptData(inName As String, outName As String, _
rijnKey() As Byte, rijnIV() As Byte)

    'Create the file streams to handle the input and output files.
    Dim fin As New FileStream(inName, FileMode.Open, FileAccess.Read)
    Dim fout As New FileStream(outName, FileMode.OpenOrCreate, _
       FileAccess.Write)
    fout.SetLength(0)
    
    'Create variables to help with read and write.
    Dim bin(100) As Byte 'This is intermediate storage for the encryption.
    Dim rdlen As Long = 0 'This is the total number of bytes written.
    Dim totlen As Long = fin.Length 'Total length of the input file.
    Dim len As Integer 'This is the number of bytes to be written at a time.
    'Creates the default implementation, which is RijndaelManaged.
    Dim rijn As SymmetricAlgorithm = SymmetricAlgorithm.Create()
    Dim encStream As 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 = Convert.ToInt32(rdlen + len)
        Console.WriteLine("{0} bytes processed", rdlen)
    End While
    
    encStream.Close()
fout.Close()
fin.Close()
End Sub

Комментарии

Классы, производные от класса, SymmetricAlgorithm используют режим цепочки, именуемый сцеплением блоков шифра (CBC), Key IV для выполнения криптографических преобразований данных требуется ключ () и вектор инициализации ().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. Для расшифровки данных, зашифрованных с помощью одного из SymmetricAlgorithm классов, необходимо задать Key для свойства и IV Свойства те же значения, которые использовались для шифрования.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.

Aes, DES , RC2 и TripleDES являются реализациями симметричных алгоритмов.Aes, DES, RC2, and TripleDES 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. Необходимо явно вызвать метод для Clear объекта, чтобы обнулить все конфиденциальные данные в объекте до его освобождения.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.

Все классы шифрования в платформа .NET Framework, содержащие конфиденциальные данные, реализуют Clear метод.All cryptographic classes in the .NET Framework that hold sensitive data implement a Clear method. При вызове Clear метод перезаписывает все конфиденциальные данные в объекте с нулями, а затем освобождает объект, чтобы его можно было безопасно собрать сборщиком мусора.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. Когда объект был обнулен и освобожден, следует вызвать Dispose метод с disposing параметром, имеющим значение, True чтобы удалить все управляемые и неуправляемые ресурсы, связанные с объектом.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.

Примечания для тех, кто реализует этот метод

При наследовании от SymmetricAlgorithm класса необходимо переопределить следующие члены: CreateDecryptor(Byte[], Byte[]) , CreateEncryptor(Byte[], Byte[]) , GenerateIV() и GenerateKey() .When you inherit from the SymmetricAlgorithm class, you must override the following members: CreateDecryptor(Byte[], Byte[]), CreateEncryptor(Byte[], Byte[]), GenerateIV(), and GenerateKey().

Конструкторы

SymmetricAlgorithm()

Инициализирует новый экземпляр класса SymmetricAlgorithm.Initializes a new instance of the SymmetricAlgorithm class.

Поля

BlockSizeValue

Представляет размер блока криптографической операции (в битах).Represents the block size, in bits, of the cryptographic operation.

FeedbackSizeValue

Представляет размер порции данных обратной связи для криптографической операции (в битах).Represents the feedback size, in bits, of the cryptographic operation.

IVValue

Представляет вектор инициализации (IV) для алгоритма симметричного шифрования.Represents the initialization vector (IV) for the symmetric algorithm.

KeySizeValue

Представляет размер секретного ключа (в битах), используемого алгоритмом симметричного шифрования.Represents the size, in bits, of the secret key used by the symmetric algorithm.

KeyValue

Представляет секретный ключ для алгоритма симметричного шифрования.Represents the secret key for the symmetric algorithm.

LegalBlockSizesValue

Задает размеры блоков (в битах), которые поддерживаются алгоритмом симметричного шифрования.Specifies the block sizes, in bits, that are supported by the symmetric algorithm.

LegalKeySizesValue

Задает размеры ключа (в битах), которые поддерживаются алгоритмом симметричного шифрования.Specifies the key sizes, in bits, that are supported by the symmetric algorithm.

ModeValue

Представляет режим шифрования, используемый в алгоритме симметричного шифрования.Represents the cipher mode used in the symmetric algorithm.

PaddingValue

Представляет режим заполнения, используемый в алгоритме симметричного шифрования.Represents the padding mode used in the symmetric algorithm.

Свойства

BlockSize

Возвращает или задает размер блока криптографической операции (в битах).Gets or sets the block size, in bits, of the cryptographic operation.

FeedbackSize

Возвращает или задает размер ответа криптографической операции (в битах) для режимов шифрования "Обратная связь по шифру" (CFB) и "Выходная обратная связь" (OFB).Gets or sets the feedback size, in bits, of the cryptographic operation for the Cipher Feedback (CFB) and Output Feedback (OFB) cipher modes.

IV

Получает или задает вектор инициализации (IV) для алгоритма симметричного шифрования.Gets or sets the initialization vector (IV) for the symmetric algorithm.

Key

Получает или задает секретный ключ для алгоритма симметричного шифрования.Gets or sets the secret key for the symmetric algorithm.

KeySize

Получает или задает размер секретного ключа (в битах), используемого алгоритмом симметричного шифрования.Gets or sets the size, in bits, of the secret key used by the symmetric algorithm.

LegalBlockSizes

Получает размеры блоков (в битах), которые поддерживаются алгоритмом симметричного шифрования.Gets the block sizes, in bits, that are supported by the symmetric algorithm.

LegalKeySizes

Возвращает размеры ключа (в битах), которые поддерживаются симметричным алгоритмом.Gets the key sizes, in bits, that are supported by the symmetric algorithm.

Mode

Возвращает или задает режим функционирования симметричного алгоритма.Gets or sets the mode for operation of the symmetric algorithm.

Padding

Возвращает или задает режим заполнения, используемый в симметричном алгоритме.Gets or sets the padding mode used in the symmetric algorithm.

Методы

Clear()

Освобождает все ресурсы, используемые классом SymmetricAlgorithm.Releases all resources used by the SymmetricAlgorithm class.

Create()
Является устаревшей.

Создает криптографический объект по умолчанию, используемый для выполнения алгоритма симметричного шифрования.Creates a default cryptographic object used to perform the symmetric algorithm.

Create(String)

Создает заданный криптографический объект, используемый для выполнения алгоритма симметричного шифрования.Creates the specified cryptographic object used to perform the symmetric algorithm.

CreateDecryptor()

Создает симметричный объект-дешифратор с текущим свойством Key и вектором инициализации (IV).Creates a symmetric decryptor object with the current Key property and initialization vector (IV).

CreateDecryptor(Byte[], Byte[])

При переопределении в производном классе создает объект-дешифратор для алгоритма симметричного шифрования с заданным свойством Key и вектором инициализации (IV).When overridden in a derived class, creates a symmetric decryptor object with the specified Key property and initialization vector (IV).

CreateEncryptor()

Создает симметричный объект-шифратор с текущим свойством Key и вектором инициализации (IV).Creates a symmetric encryptor object with the current Key property and initialization vector (IV).

CreateEncryptor(Byte[], Byte[])

При переопределении в производном классе создает объект-шифратор для алгоритма симметричного шифрования с заданным свойством Key и вектором инициализации (IV).When overridden in a derived class, creates a symmetric encryptor object with the specified Key property and initialization vector (IV).

Dispose()

Освобождает все ресурсы, используемые текущим экземпляром класса SymmetricAlgorithm.Releases all resources used by the current instance of the SymmetricAlgorithm class.

Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые объектом SymmetricAlgorithm, а при необходимости освобождает также управляемые ресурсы.Releases the unmanaged resources used by the SymmetricAlgorithm and optionally releases the managed resources.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Finalize()

Этот член переопределяет Finalize(); по данной теме может быть доступна более полная документация.This member overrides Finalize(), and more complete documentation might be available in that topic.

Позволяет объекту Object попытаться освободить ресурсы и выполнить другие операции очистки, перед тем как объект Object будет утилизирован в процессе сборки мусора.Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

GenerateIV()

При переопределении в производном классе генерирует случайный вектор инициализации (IV), используемый для алгоритма.When overridden in a derived class, generates a random initialization vector (IV) to use for the algorithm.

GenerateKey()

При переопределении в производном классе генерирует случайный ключ (Key), используемый для алгоритма.When overridden in a derived class, generates a random key (Key) to use for the algorithm.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)
ValidKeySize(Int32)

Определяет, является ли заданный размер ключа допустимым для текущего алгоритма.Determines whether the specified key size is valid for the current algorithm.

Явные реализации интерфейса

IDisposable.Dispose()

Этот API поддерживает инфраструктуру продукта и не предназначен для использования непосредственно из программного кода.

Освобождает неуправляемые ресурсы, используемые объектом SymmetricAlgorithm, а при необходимости освобождает также управляемые ресурсы.Releases the unmanaged resources used by the SymmetricAlgorithm and optionally releases the managed resources.

Применяется к

См. также раздел