CryptoStream Класс

Определение

Пространство имен:

System.Security.Cryptography

Сборка:

System.Security.Cryptography.dll

Исходный код:

CryptoStream.cs

Определяет поток, который связывает потоки данных с криптографическими преобразованиями.

public ref class CryptoStream : System::IO::Stream

public class CryptoStream : System.IO.Stream

type CryptoStream = class
    inherit Stream
    interface IDisposable

Public Class CryptoStream
Inherits Stream

Наследование

Object

MarshalByRefObject

Stream

CryptoStream

Реализации

IDisposable

Примеры

В следующем примере показано, как использовать CryptoStream для шифрования строки. Этот метод использует класс Aes с указанным Key и вектором инициализации (IV).

using System;
using System.IO;
using System.Security.Cryptography;

class AesExample
{
    public static void Main()
    {
        try
        {
            string original = "Here is some data to encrypt!";

            // Create a new instance of the Aes class.
            // This generates a new key and initialization vector (IV).
            using (Aes myAes = Aes.Create())
            {
                // Encrypt the string to an array of bytes.
                byte[] encrypted = EncryptStringToBytes(original, myAes.Key, myAes.IV);

                // Decrypt the bytes to a string.
                string roundtrip = DecryptStringFromBytes(encrypted, myAes.Key, myAes.IV);

                // Display the original data and the decrypted data.
                Console.WriteLine("Original:   {0}", original);
                Console.WriteLine("Round trip: {0}", roundtrip);
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("Error: {0}", e.Message);
        }
    }

    static byte[] EncryptStringToBytes(string plainText, byte[] Key, byte[] IV)
    {
        // Check arguments.
        if (plainText == null || plainText.Length <= 0)
            throw new ArgumentNullException(nameof(plainText));
        if (Key == null || Key.Length <= 0)
            throw new ArgumentNullException(nameof(Key));
        if (IV == null || IV.Length <= 0)
            throw new ArgumentNullException(nameof(IV));
        byte[] encrypted;

        // Create a Aes object with the specified key and IV.
        using (Aes aesAlg = Aes.Create())
        {
            aesAlg.Key = Key;
            aesAlg.IV = IV;

            // Create an encryptor to perform the stream transform.
            ICryptoTransform encryptor = aesAlg.CreateEncryptor(aesAlg.Key, aesAlg.IV);

            // Create the streams used for encryption.
            using (MemoryStream msEncrypt = new())
            {
                using (CryptoStream csEncrypt = new(msEncrypt, encryptor, CryptoStreamMode.Write))
                {
                    using (StreamWriter swEncrypt = new(csEncrypt))
                    {
                        // Write all data to the stream.
                        swEncrypt.Write(plainText);
                    }
                    encrypted = msEncrypt.ToArray();
                }
            }
        }

        // Return the encrypted bytes from the memory stream.
        return encrypted;
    }

    static string DecryptStringFromBytes(byte[] cipherText, byte[] Key, byte[] IV)
    {
        // Check arguments.
        if (cipherText == null || cipherText.Length <= 0)
            throw new ArgumentNullException(nameof(cipherText));
        if (Key == null || Key.Length <= 0)
            throw new ArgumentNullException(nameof(Key));
        if (IV == null || IV.Length <= 0)
            throw new ArgumentNullException(nameof(IV));

        // Declare the string used to hold the decrypted text.
        string plaintext = null;

        // Create a Aes object with the specified key and IV.
        using (Aes aesAlg = Aes.Create())
        {
            aesAlg.Key = Key;
            aesAlg.IV = IV;

            // Create a decryptor to perform the stream transform.
            ICryptoTransform decryptor = aesAlg.CreateDecryptor(aesAlg.Key, aesAlg.IV);

            // Create the streams used for decryption.
            using (MemoryStream msDecrypt = new(cipherText))
            {
                using (CryptoStream csDecrypt = new(msDecrypt, decryptor, CryptoStreamMode.Read))
                {
                    using (StreamReader srDecrypt = new(csDecrypt))
                    {

                        // Read the decrypted bytes from the decrypting stream
                        // and place them in a string.
                        plaintext = srDecrypt.ReadToEnd();
                    }
                }
            }
        }

        return plaintext;
    }
}

Imports System.IO
Imports System.Security.Cryptography

Class AesExample

    Public Shared Sub Main()
        Try
            Dim original As String = "Here is some data to encrypt!"

            ' Create a new instance of the Aes class.
            ' This generates a new key and initialization vector (IV).
            Using myAes = Aes.Create()

                ' Encrypt the string to an array of bytes.
                Dim encrypted As Byte() = EncryptStringToBytes(original, myAes.Key, myAes.IV)

                ' Decrypt the bytes to a string.
                Dim roundtrip As String = DecryptStringFromBytes(encrypted, myAes.Key, myAes.IV)

                'Display the original data and the decrypted data.
                Console.WriteLine("Original:   {0}", original)
                Console.WriteLine("Round Trip: {0}", roundtrip)
            End Using
        Catch e As Exception
            Console.WriteLine("Error: {0}", e.Message)
        End Try
    End Sub

    Shared Function EncryptStringToBytes(ByVal plainText As String, ByVal Key() As Byte, ByVal IV() As Byte) As Byte()
        ' Check arguments.
        If plainText Is Nothing OrElse plainText.Length <= 0 Then
            Throw New ArgumentNullException(NameOf(plainText))
        End If
        If Key Is Nothing OrElse Key.Length <= 0 Then
            Throw New ArgumentNullException(NameOf(Key))
        End If
        If IV Is Nothing OrElse IV.Length <= 0 Then
            Throw New ArgumentNullException(NameOf(IV))
        End If
        Dim encrypted() As Byte

        ' Create an Aes object with the specified key and IV.
        Using aesAlg = Aes.Create()

            aesAlg.Key = Key
            aesAlg.IV = IV

            ' Create an encryptor to perform the stream transform.
            Dim encryptor As ICryptoTransform = aesAlg.CreateEncryptor(aesAlg.Key, aesAlg.IV)
            ' Create the streams used for encryption.
            Using msEncrypt As New MemoryStream()
                Using csEncrypt As New CryptoStream(msEncrypt, encryptor, CryptoStreamMode.Write)
                    Using swEncrypt As New StreamWriter(csEncrypt)

                        ' Write all data to the stream.
                        swEncrypt.Write(plainText)
                    End Using
                    encrypted = msEncrypt.ToArray()
                End Using
            End Using
        End Using

        ' Return the encrypted bytes from the memory stream.
        Return encrypted

    End Function 'EncryptStringToBytes

    Shared Function DecryptStringFromBytes(
        ByVal cipherText() As Byte,
        ByVal Key() As Byte,
        ByVal IV() As Byte) As String
        ' Check arguments.
        If cipherText Is Nothing OrElse cipherText.Length <= 0 Then
            Throw New ArgumentNullException(NameOf(cipherText))
        End If
        If Key Is Nothing OrElse Key.Length <= 0 Then
            Throw New ArgumentNullException(NameOf(Key))
        End If
        If IV Is Nothing OrElse IV.Length <= 0 Then
            Throw New ArgumentNullException(NameOf(IV))
        End If

        ' Declare the string used to hold the decrypted text.
        Dim plaintext As String = Nothing

        ' Create an Aes object with the specified key and IV.
        Using aesAlg = Aes.Create()
            aesAlg.Key = Key
            aesAlg.IV = IV

            ' Create a decryptor to perform the stream transform.
            Dim decryptor As ICryptoTransform = aesAlg.CreateDecryptor(aesAlg.Key, aesAlg.IV)

            ' Create the streams used for decryption.
            Using msDecrypt As New MemoryStream(cipherText)
                Using csDecrypt As New CryptoStream(msDecrypt, decryptor, CryptoStreamMode.Read)
                    Using srDecrypt As New StreamReader(csDecrypt)
                        ' Read the decrypted bytes from the decrypting stream
                        ' and place them in a string.
                        plaintext = srDecrypt.ReadToEnd()
                    End Using
                End Using
            End Using
        End Using

        Return plaintext

    End Function 'DecryptStringFromBytes 
End Class

Комментарии

Среда CLR использует потоковую структуру для шифрования. Основной частью этого дизайна является CryptoStream. Любые криптографические объекты, реализующие CryptoStream, можно объединить с любыми объектами, реализующими Stream, поэтому потоковые выходные данные одного объекта можно передать в входные данные другого объекта. Промежуточный результат (выходные данные первого объекта) не требуется хранить отдельно.

Важный

В .NET 6 и более поздних версиях, когда Stream.Read или Stream.ReadAsync вызывается с буфером длины N, операция завершается, когда не менее 1 байта считывается из потока, или базовый поток, который он выполняет оболочку, возвращает 0 из вызова Read, указывая, что больше данных не доступно. До .NET 6 Stream.Read и Stream.ReadAsync не возвращались до тех пор, пока все N байты не были прочитаны из потока или базовый поток вернул 0 из вызова Read. Если в коде предполагается, что методы Read не возвращаются до тех пор, пока не будут прочитаны все N байты, это может не считывать все содержимое. Дополнительные сведения см. в разделе Частичное и нулевое число операций чтения в потоках.

Вы всегда должны явно закрыть объект CryptoStream после завершения работы с ним, вызвав метод Clear. Это приводит к очистке базового потока и приводит к обработке всех оставшихся блоков данных объектом CryptoStream. Однако если исключение возникает перед вызовом метода Close, объект CryptoStream может не быть закрыт. Чтобы убедиться, что метод Close всегда вызывается, поместите вызов к методу Clear в блоке finally оператора try/catch.

Этот тип реализует интерфейс IDisposable. Завершив использование типа, его следует удалить напрямую или косвенно путем вызова метода Clear, который, в свою очередь, вызывает свою реализацию IDisposable. Чтобы удалить тип напрямую, вызовите метод Clear в блоке try/catch. Чтобы удалить его косвенно, используйте конструкцию языка, например using (в C#) или Using (в Visual Basic).

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

CryptoStream(Stream, ICryptoTransform, CryptoStreamMode)	Инициализирует новый экземпляр класса CryptoStream с целевым потоком данных, преобразованием для использования и режимом потока.
CryptoStream(Stream, ICryptoTransform, CryptoStreamMode, Boolean)	Инициализирует новый экземпляр класса CryptoStream.

Свойства

CanRead	Возвращает значение, указывающее, доступен ли текущий CryptoStream.
CanSeek	Возвращает значение, указывающее, можно ли искать в текущем CryptoStream.
CanTimeout	Возвращает значение, определяющее, может ли текущий поток истекает время ожидания. (Унаследовано от Stream)
CanWrite	Возвращает значение, указывающее, является ли текущий CryptoStream записываемым.
HasFlushedFinalBlock	Возвращает значение, указывающее, записан ли окончательный блок буфера в базовый поток.
Length	Возвращает длину в байтах потока.
Position	Возвращает или задает позицию в текущем потоке.
ReadTimeout	Возвращает или задает значение в миллисекундах, которое определяет, сколько времени поток попытается прочитать до истечения времени ожидания. (Унаследовано от Stream)
WriteTimeout	Возвращает или задает значение в миллисекундах, определяющее, сколько времени поток попытается записать до истечения времени ожидания. (Унаследовано от Stream)

Методы

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Начинает асинхронную операцию чтения. (Вместо этого рекомендуется использовать ReadAsync.)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Начинает асинхронную операцию записи. (Вместо этого рекомендуется использовать WriteAsync.)
Clear()	Освобождает все ресурсы, используемые CryptoStream.
Close()	Закрывает текущий поток и освобождает все ресурсы (например, сокеты и дескрипторы файлов), связанные с текущим потоком. Вместо вызова этого метода убедитесь, что поток правильно удален. (Унаследовано от Stream)
CopyTo(Stream)	Считывает байты из текущего потока и записывает их в другой поток. Обе позиции потоков расширены по количеству скопированных байтов. (Унаследовано от Stream)
CopyTo(Stream, Int32)	Считывает байты из базового потока, применяет соответствующие криптографические преобразования и записывает результат в целевой поток.
CopyToAsync(Stream)	Асинхронно считывает байты из текущего потока и записывает их в другой поток. Обе позиции потоков расширены по количеству скопированных байтов. (Унаследовано от Stream)
CopyToAsync(Stream, CancellationToken)	Асинхронно считывает байты из текущего потока и записывает их в другой поток с помощью указанного маркера отмены. Обе позиции потоков расширены по количеству скопированных байтов. (Унаследовано от Stream)
CopyToAsync(Stream, Int32)	Асинхронно считывает байты из текущего потока и записывает их в другой поток, используя указанный размер буфера. Обе позиции потоков расширены по количеству скопированных байтов. (Унаследовано от Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Асинхронно считывает байты из базового потока, применяет соответствующие криптографические преобразования и записывает результат в целевой поток.
CreateObjRef(Type)	Создает объект, содержащий все соответствующие сведения, необходимые для создания прокси-сервера, используемого для взаимодействия с удаленным объектом. (Унаследовано от MarshalByRefObject)
CreateWaitHandle()	Устаревшие.. Выделяет объект WaitHandle. (Унаследовано от Stream)
Dispose()	Освобождает все ресурсы, используемые Stream. (Унаследовано от Stream)
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые CryptoStream, и при необходимости освобождает управляемые ресурсы.
DisposeAsync()	Асинхронно освобождает неуправляемые ресурсы, используемые CryptoStream.
EndRead(IAsyncResult)	Ожидает завершения ожидающего асинхронного чтения. (Вместо этого рекомендуется использовать ReadAsync.)
EndWrite(IAsyncResult)	Завершает асинхронную операцию записи. (Вместо этого рекомендуется использовать WriteAsync.)
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Flush()	Очищает все буферы для текущего потока и приводит к записи буферных данных на базовое устройство.
FlushAsync()	Асинхронно очищает все буферы для этого потока и приводит к записи всех буферных данных на базовое устройство. (Унаследовано от Stream)
FlushAsync(CancellationToken)	Очищает все буферы для текущего потока асинхронно, приводит к записи всех буферных данных на базовое устройство и отслеживает запросы на отмену.
FlushFinalBlock()	Обновляет базовый источник данных или репозиторий с текущим состоянием буфера, а затем очищает буфер.
FlushFinalBlockAsync(CancellationToken)	Асинхронно обновляет базовый источник данных или репозиторий с текущим состоянием буфера, а затем очищает буфер.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetLifetimeService()	Устаревшие.. Извлекает текущий объект службы времени существования, который управляет политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
InitializeLifetimeService()	Устаревшие.. Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
MemberwiseClone(Boolean)	Создает неглубокую копию текущего объекта MarshalByRefObject. (Унаследовано от MarshalByRefObject)
ObjectInvariant()	Устаревшие.. Предоставляет поддержку Contract. (Унаследовано от Stream)
Read(Byte[], Int32, Int32)	Считывает последовательность байтов из текущего потока и перемещает позицию в потоке по числу байтов.
Read(Span<Byte>)	При переопределении в производном классе считывает последовательность байтов из текущего потока и перемещает положение в потоке по количеству байтов, считываемых. (Унаследовано от Stream)
ReadAsync(Byte[], Int32, Int32)	Асинхронно считывает последовательность байтов из текущего потока и перемещает позицию в потоке по числу байтов. (Унаследовано от Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Считывает последовательность байтов из текущего потока асинхронно, перемещает положение в потоке по количеству операций чтения байтов и отслеживает запросы на отмену.
ReadAsync(Memory<Byte>, CancellationToken)	Асинхронно считывает последовательность байтов из текущего потока, перемещает положение в потоке по количеству операций чтения байтов и отслеживает запросы на отмену.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Считывает по крайней мере минимальное количество байтов из текущего потока и перемещает положение в потоке по количеству байтов, считываемых. (Унаследовано от Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Асинхронно считывает по крайней мере минимальное количество байтов из текущего потока, перемещает положение в потоке по количеству операций чтения байтов и отслеживает запросы на отмену. (Унаследовано от Stream)
ReadByte()	Считывает байт из потока и перемещает позицию в потоке по одному байту или возвращает -1, если в конце потока.
ReadExactly(Byte[], Int32, Int32)	Считывает count число байтов из текущего потока и перемещает положение в потоке. (Унаследовано от Stream)
ReadExactly(Span<Byte>)	Считывает байты из текущего потока и перемещает позицию в потоке до заполнения buffer. (Унаследовано от Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Асинхронно считывает count число байтов из текущего потока, перемещает положение в потоке и отслеживает запросы на отмену. (Унаследовано от Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Асинхронно считывает байты из текущего потока, перемещает положение в потоке до заполнения buffer и отслеживает запросы на отмену. (Унаследовано от Stream)
Seek(Int64, SeekOrigin)	Задает позицию в текущем потоке.
SetLength(Int64)	Задает длину текущего потока.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Write(Byte[], Int32, Int32)	Записывает последовательность байтов в текущую CryptoStream и перемещает текущую позицию в потоке по количеству записанных байтов.
Write(ReadOnlySpan<Byte>)	При переопределении в производном классе записывает последовательность байтов в текущий поток и перемещает текущую позицию в этом потоке по количеству записанных байтов. (Унаследовано от Stream)
WriteAsync(Byte[], Int32, Int32)	Асинхронно записывает последовательность байтов в текущий поток и перемещает текущую позицию в этом потоке по количеству записанных байтов. (Унаследовано от Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Записывает последовательность байтов в текущий поток асинхронно, перемещает текущую позицию в потоке по количеству записанных байтов и отслеживает запросы на отмену.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Асинхронно записывает последовательность байтов в текущий поток, перемещает текущую позицию в этом потоке по количеству записанных байтов и отслеживает запросы на отмену.
WriteByte(Byte)	Записывает байт в текущую позицию в потоке и перемещает позицию в потоке по одному байту.

Методы расширения

CopyToAsync(Stream, PipeWriter, CancellationToken)	Асинхронно считывает байты из Stream и записывает их в указанный PipeWriterс помощью маркера отмены.
ConfigureAwait(IAsyncDisposable, Boolean)	Настраивает способ ожидания задач, возвращаемых из асинхронного удаления.

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

• служб шифрования
• частичное и нулевое число операций чтения в DeflateStream, GZipStream и CryptoStream