CryptoStream Klasa

Definicja

Przestrzeń nazw:

System.Security.Cryptography

Zestaw:

System.Security.Cryptography.dll

Źródło:

CryptoStream.cs

Definiuje strumień, który łączy strumienie danych z przekształceniami kryptograficznymi.

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

Dziedziczenie

Object

MarshalByRefObject

Stream

CryptoStream

Implementuje

IDisposable

Przykłady

W poniższym przykładzie pokazano, jak za pomocą CryptoStream zaszyfrować ciąg. Ta metoda używa klasy Aes z określonym wektorem Key i inicjalizacji (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

Uwagi

Środowisko uruchomieniowe języka wspólnego używa projektu zorientowanego na strumień na potrzeby kryptografii. Podstawą tego projektu jest CryptoStream. Wszystkie obiekty kryptograficzne, które implementują CryptoStream, można połączyć ze sobą wszystkie obiekty implementujące Stream, dzięki czemu przesyłane strumieniowo dane wyjściowe z jednego obiektu mogą być przekazywane do danych wejściowych innego obiektu. Wynik pośredni (dane wyjściowe z pierwszego obiektu) nie musi być przechowywany oddzielnie.

Ważny

W wersji .NET 6 i nowszych, gdy Stream.Read lub Stream.ReadAsync jest wywoływana z buforem długości N, operacja kończy się, gdy co najmniej 1 bajt został odczytany ze strumienia lub źródłowy strumień, który opakowuje, zwraca 0 z wywołania do Read, co oznacza, że nie są dostępne żadne więcej danych. Przed platformą .NET 6 Stream.Read i Stream.ReadAsync nie zostały zwrócone, dopóki wszystkie N bajty nie zostaną odczytane ze strumienia lub strumień źródłowy zwrócił 0 z wywołania do Read. Jeśli kod zakłada, że metody Read nie zostaną zwrócone, dopóki wszystkie N bajty nie zostaną odczytane, może nie odczytać całej zawartości. Aby uzyskać więcej informacji, zobacz odczyty częściowe i zerowe w strumieniach.

Zawsze należy jawnie zamknąć obiekt CryptoStream po zakończeniu korzystania z niego, wywołując metodę Clear. Spowoduje to opróżnienie bazowego strumienia i spowoduje przetworzenie wszystkich pozostałych bloków danych przez obiekt CryptoStream. Jeśli jednak wystąpi wyjątek przed wywołaniem metody Close, obiekt CryptoStream może nie zostać zamknięty. Aby upewnić się, że metoda Close zawsze jest wywoływana, umieść wywołanie metody Clear w bloku finally instrukcji try/catch.

Ten typ implementuje interfejs IDisposable. Po zakończeniu używania typu należy go usunąć bezpośrednio lub pośrednio przez wywołanie metody Clear, która z kolei wywołuje implementację IDisposable. Aby usunąć typ bezpośrednio, wywołaj metodę Clear w bloku try/catch. Aby usunąć go pośrednio, należy użyć konstrukcji języka, takiej jak using (w języku C#) lub Using (w Visual Basic).

Konstruktory

CryptoStream(Stream, ICryptoTransform, CryptoStreamMode)	Inicjuje nowe wystąpienie klasy CryptoStream z docelowym strumieniem danych, transformacją do użycia i trybem strumienia.
CryptoStream(Stream, ICryptoTransform, CryptoStreamMode, Boolean)	Inicjuje nowe wystąpienie klasy CryptoStream.

Właściwości

CanRead	Pobiera wartość wskazującą, czy bieżąca CryptoStream jest czytelna.
CanSeek	Pobiera wartość wskazującą, czy można wyszukiwać w bieżącym CryptoStream.
CanTimeout	Pobiera wartość określającą, czy bieżący strumień może upłynął limit czasu. (Odziedziczone po Stream)
CanWrite	Pobiera wartość wskazującą, czy bieżący CryptoStream jest zapisywalny.
HasFlushedFinalBlock	Pobiera wartość wskazującą, czy ostatni blok buforu został zapisany w strumieniu bazowym.
Length	Pobiera długość w bajtach strumienia.
Position	Pobiera lub ustawia położenie w bieżącym strumieniu.
ReadTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował odczytać przed upływem limitu czasu. (Odziedziczone po Stream)
WriteTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował zapisać przed upływem limitu czasu. (Odziedziczone po Stream)

Metody

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna operację odczytu asynchronicznego. (Rozważ użycie ReadAsync zamiast tego).
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna asynchroniczną operację zapisu. (Rozważ użycie WriteAsync zamiast tego).
Clear()	Zwalnia wszystkie zasoby używane przez CryptoStream.
Close()	Zamyka bieżący strumień i zwalnia wszystkie zasoby (takie jak gniazda i dojścia plików) skojarzone z bieżącym strumieniem. Zamiast wywoływać tę metodę, upewnij się, że strumień jest prawidłowo usuwany. (Odziedziczone po Stream)
CopyTo(Stream)	Odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyTo(Stream, Int32)	Odczytuje bajty ze strumienia bazowego, stosuje odpowiednie przekształcenia kryptograficzne i zapisuje wynik w strumieniu docelowym.
CopyToAsync(Stream)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego tokenu anulowania. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronicznie odczytuje bajty ze strumienia bazowego, stosuje odpowiednie przekształcenia kryptograficzne i zapisuje wynik w strumieniu docelowym.
CreateObjRef(Type)	Tworzy obiekt zawierający wszystkie istotne informacje wymagane do wygenerowania serwera proxy używanego do komunikowania się z obiektem zdalnym. (Odziedziczone po MarshalByRefObject)
CreateWaitHandle()	Przestarzałe. Przydziela obiekt WaitHandle. (Odziedziczone po Stream)
Dispose()	Zwalnia wszystkie zasoby używane przez Stream. (Odziedziczone po Stream)
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez CryptoStream i opcjonalnie zwalnia zarządzane zasoby.
DisposeAsync()	Asynchronicznie zwalnia niezarządzane zasoby używane przez CryptoStream.
EndRead(IAsyncResult)	Czeka na ukończenie oczekującego odczytu asynchronicznego. (Rozważ użycie ReadAsync zamiast tego).
EndWrite(IAsyncResult)	Kończy asynchroniczną operację zapisu. (Rozważ użycie WriteAsync zamiast tego).
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
Flush()	Czyści wszystkie dla bieżącego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu źródłowym.
FlushAsync()	Asynchronicznie czyści wszystkie dla tego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym. (Odziedziczone po Stream)
FlushAsync(CancellationToken)	Czyści wszystkie dla bieżącego strumienia asynchronicznie, powoduje zapisanie wszystkich buforowanych danych na urządzeniu źródłowym i monitorowanie żądań anulowania.
FlushFinalBlock()	Aktualizuje bazowe źródło danych lub repozytorium przy użyciu bieżącego stanu buforu, a następnie czyści bufor.
FlushFinalBlockAsync(CancellationToken)	Asynchronicznie aktualizuje bazowe źródło danych lub repozytorium przy użyciu bieżącego stanu buforu, a następnie czyści bufor.
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetLifetimeService()	Przestarzałe. Pobiera bieżący obiekt usługi okresu istnienia, który kontroluje zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
InitializeLifetimeService()	Przestarzałe. Uzyskuje obiekt usługi okresu istnienia w celu kontrolowania zasad okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
MemberwiseClone(Boolean)	Tworzy płytkią kopię bieżącego obiektu MarshalByRefObject. (Odziedziczone po MarshalByRefObject)
ObjectInvariant()	Przestarzałe. Zapewnia obsługę Contract. (Odziedziczone po Stream)
Read(Byte[], Int32, Int32)	Odczytuje sekwencję bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów.
Read(Span<Byte>)	Gdy przesłonięta w klasie pochodnej, odczytuje sekwencję bajtów z bieżącego strumienia i przechodzi pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAsync(Byte[], Int32, Int32)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Odczytuje sekwencję bajtów z bieżącego strumienia asynchronicznie, rozwija pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia, rozwija pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronicznie odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu przez liczbę odczytanych bajtów i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadByte()	Odczytuje bajt ze strumienia i rozwija pozycję w strumieniu według jednego bajtu lub zwraca -1, jeśli na końcu strumienia.
ReadExactly(Byte[], Int32, Int32)	Odczytuje count liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu. (Odziedziczone po Stream)
ReadExactly(Span<Byte>)	Odczytuje bajty z bieżącego strumienia i przesuwa pozycję w strumieniu do momentu wypełnienia buffer. (Odziedziczone po Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje count liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia, przechodzi pozycję w strumieniu do momentu wypełnienia buffer i monitoruje żądania anulowania. (Odziedziczone po Stream)
Seek(Int64, SeekOrigin)	Ustawia położenie w bieżącym strumieniu.
SetLength(Int64)	Ustawia długość bieżącego strumienia.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
Write(Byte[], Int32, Int32)	Zapisuje sekwencję bajtów do bieżącej CryptoStream i przechodzi bieżącą pozycję w strumieniu według liczby zapisanych bajtów.
Write(ReadOnlySpan<Byte>)	Po zastąpieniu w klasie pochodnej zapisuje sekwencję bajtów do bieżącego strumienia i przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów. (Odziedziczone po Stream)
WriteAsync(Byte[], Int32, Int32)	Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów. (Odziedziczone po Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Zapisuje sekwencję bajtów do bieżącego strumienia asynchronicznie, przechodzi bieżącą pozycję w strumieniu według liczby zapisanych bajtów i monitoruje żądania anulowania.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronicznie zapisuje sekwencję bajtów w bieżącym strumieniu, przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów i monitoruje żądania anulowania.
WriteByte(Byte)	Zapisuje bajt do bieżącej pozycji w strumieniu i rozwija pozycję w strumieniu według jednego bajtu.

Metody rozszerzania

CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronicznie odczytuje bajty z Stream i zapisuje je w określonym PipeWriterprzy użyciu tokenu anulowania.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, w jaki sposób będą wykonywane oczekiwania na zadania zwrócone z asynchronicznego jednorazowego użytku.

Zobacz też

• usług kryptograficznych
• odczyty częściowe i zerowe w DeflateStream, GZipStream i CryptoStream