CryptoStream Třída

Definice

Obor názvů:

System.Security.Cryptography

Sestavení:

System.Security.Cryptography.dll

Zdroj:

CryptoStream.cs

Definuje datový proud, který propojuje datové proudy s kryptografickými transformacemi.

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

Dědičnost

Object

MarshalByRefObject

Stream

CryptoStream

Implementuje

IDisposable

Příklady

Následující příklad ukazuje, jak použít k CryptoStream šifrování řetězce. Tato metoda používá Aes třídu se zadaným Key a inicializačním vektorem (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

Poznámky

Modul CLR (Common Language Runtime) používá pro kryptografii návrh orientovaný na datový proud. Jádrem tohoto návrhu je CryptoStream. Všechny kryptografické objekty, které implementují CryptoStream , mohou být zřetězený společně s libovolnými objekty, které implementují Stream, takže streamovaný výstup z jednoho objektu může být předán do vstupu jiného objektu. Průběžný výsledek (výstup z prvního objektu) nemusí být uložen samostatně.

Důležité

V .NET 6 a novějších verzích, když Stream.Read nebo Stream.ReadAsync je volána s vyrovnávací pamětí o délce N, operace se dokončí, když buď byl ze streamu načten alespoň 1 bajt, nebo pokud podkladový datový proud, který zabalí, vrátí 0 z volání , Readcož znamená, že nejsou k dispozici žádná další data. Před rozhraním .NET 6 se a Stream.ReadAsync nevrátil, Stream.Read dokud nebyly všechny N bajty přečteny z datového proudu nebo dokud podkladový datový proud nevrátil hodnotu 0 z volání .Read Pokud váš kód předpokládá Read , že metody se nevrátí, dokud nebudou přečteny všechny N bajty, může selhat čtení veškerého obsahu. Další informace najdete v tématu Částečná a nulová čtení v datových proudech.

Po dokončení používání objektu byste vždy měli explicitně zavřít CryptoStream voláním Clear metody . Tím se vyprázdní podkladový datový proud a objekt zpracuje všechny zbývající bloky dat CryptoStream . Pokud však před voláním metody dojde k výjimce CloseCryptoStream , nemusí být objekt uzavřen. Pokud chcete zajistit, aby se Close metoda vždy volala, umístěte volání Clear metody do finally bloku try/catch příkazu.

Tento typ implementuje IDisposable rozhraní. Po dokončení používání typu byste ho měli odstranit přímo nebo nepřímo voláním jeho Clear metody, která následně volá jeho IDisposable implementaci. Pokud chcete odstranit typ přímo, zavolejte jeho Clear metodu try/catch v bloku. Pokud ho chcete odstranit nepřímo, použijte konstruktor jazyka, například using (v jazyce C#) nebo Using (v jazyce Visual Basic).

Konstruktory

CryptoStream(Stream, ICryptoTransform, CryptoStreamMode)	Inicializuje novou instanci CryptoStream třídy s cílovým datovým proudem, transformace, která se má použít, a režim datového proudu.
CryptoStream(Stream, ICryptoTransform, CryptoStreamMode, Boolean)	Inicializuje novou instanci CryptoStream třídy.

Vlastnosti

CanRead	Získá hodnotu označující, zda je aktuální CryptoStream čitelný.
CanSeek	Získá hodnotu označující, zda můžete hledat v rámci aktuálního CryptoStreamobjektu .
CanTimeout	Získá hodnotu, která určuje, zda aktuální datový proud může vypršení časového limitu. (Zděděno od Stream)
CanWrite	Získá hodnotu označující, zda je aktuální CryptoStream zapisovatelný.
HasFlushedFinalBlock	Získá hodnotu označující, zda byl poslední blok vyrovnávací paměti zapsán do podkladového datového proudu.
Length	Získá délku v bajtech datového proudu.
Position	Získá nebo nastaví pozici v aktuálním datovém proudu.
ReadTimeout	Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí číst před vypršením časového limitu. (Zděděno od Stream)
WriteTimeout	Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí zapisovat před vypršením časového limitu. (Zděděno od Stream)

Metody

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Spustí asynchronní operaci čtení. (Zvažte místo toho použití ReadAsync .)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Spustí asynchronní operaci zápisu. (Zvažte místo toho použití WriteAsync .)
Clear()	Uvolní všechny prostředky používané nástrojem CryptoStream.
Close()	Zavře aktuální datový proud a uvolní všechny prostředky (například sokety a popisovače souborů) přidružené k aktuálnímu datovému proudu. Místo volání této metody se ujistěte, že je datový proud správně odstraněn. (Zděděno od Stream)
CopyTo(Stream)	Přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyTo(Stream, Int32)	Načte bajty z podkladového datového proudu, použije relevantní kryptografické transformace a zapíše výsledek do cílového datového proudu.
CopyToAsync(Stream)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadaného tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, Int32)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronně přečte bajty z podkladového datového proudu, použije relevantní kryptografické transformace a zapíše výsledek do cílového datového proudu.
CreateObjRef(Type)	Vytvoří objekt, který obsahuje všechny relevantní informace potřebné k vygenerování proxy používaného ke komunikaci se vzdáleným objektem. (Zděděno od MarshalByRefObject)
CreateWaitHandle()	Zastaralé. Přidělí WaitHandle objekt. (Zděděno od Stream)
Dispose()	Uvolní všechny prostředky používané nástrojem Stream. (Zděděno od Stream)
Dispose(Boolean)	Uvolní nespravované prostředky používané CryptoStream nástrojem a volitelně uvolní spravované prostředky.
DisposeAsync()	Asynchronně uvolní nespravované prostředky používané CryptoStreamnástrojem .
EndRead(IAsyncResult)	Čeká na dokončení čekajícího asynchronního čtení. (Zvažte místo toho použití ReadAsync .)
EndWrite(IAsyncResult)	Ukončí operaci asynchronního zápisu. (Zvažte místo toho použití WriteAsync .)
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
Flush()	Vymaže všechny vyrovnávací paměti pro aktuální datový proud a způsobí zápis všech dat do vyrovnávací paměti do příslušného zařízení.
FlushAsync()	Asynchronně vymaže všechny vyrovnávací paměti pro tento datový proud a způsobí zápis všech dat do vyrovnávací paměti do základního zařízení. (Zděděno od Stream)
FlushAsync(CancellationToken)	Vymaže asynchronně všechny vyrovnávací paměti pro aktuální datový proud, způsobí zápis všech dat do vyrovnávací paměti do příslušného zařízení a monitoruje žádosti o zrušení.
FlushFinalBlock()	Aktualizace podkladového zdroje dat nebo úložiště s aktuálním stavem vyrovnávací paměti, vymaže vyrovnávací paměť.
FlushFinalBlockAsync(CancellationToken)	Asynchronně aktualizuje podkladový zdroj dat nebo úložiště o aktuální stav vyrovnávací paměti a pak vyrovnávací paměť vymaže.
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetLifetimeService()	Zastaralé. Načte objekt služby aktuální životnosti, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject)
GetType()	Získá aktuální Type instanci. (Zděděno od Object)
InitializeLifetimeService()	Zastaralé. Získá objekt služby životnosti, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
MemberwiseClone(Boolean)	Vytvoří mělkou kopii aktuálního MarshalByRefObject objektu. (Zděděno od MarshalByRefObject)
ObjectInvariant()	Zastaralé. Poskytuje podporu pro Contract. (Zděděno od Stream)
Read(Byte[], Int32, Int32)	Přečte posloupnost bajtů z aktuálního datového proudu a posune pozici v rámci streamu o počet přečtených bajtů.
Read(Span<Byte>)	Při přepsání v odvozené třídě přečte posloupnost bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od Stream)
ReadAsync(Byte[], Int32, Int32)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Načte posloupnost bajtů z aktuálního datového proudu asynchronně, posune pozici v rámci streamu o počet přečtených bajtů a monitoruje požadavky na zrušení.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu, posune pozici v rámci streamu o počet přečtených bajtů a monitoruje žádosti o zrušení.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Přečte alespoň minimální počet bajtů z aktuálního datového proudu a posune pozici v rámci streamu o počet přečtených bajtů. (Zděděno od Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronně přečte alespoň minimální počet bajtů z aktuálního datového proudu, posune pozici v rámci streamu o počet přečtených bajtů a monitoruje žádosti o zrušení. (Zděděno od Stream)
ReadByte()	Načte bajt z datového proudu a posune pozici v rámci streamu o jeden bajt, nebo vrátí hodnotu -1, pokud je na konci streamu.
ReadExactly(Byte[], Int32, Int32)	count Přečte počet bajtů z aktuálního datového proudu a posune pozici v rámci streamu. (Zděděno od Stream)
ReadExactly(Span<Byte>)	Přečte bajty z aktuálního datového proudu a posune pozici v rámci streamu, dokud buffer se nenaplní. (Zděděno od Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně přečte count počet bajtů z aktuálního datového proudu, posune pozici v rámci streamu a monitoruje žádosti o zrušení. (Zděděno od Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronně čte bajty z aktuálního datového proudu, posune pozici v rámci streamu, dokud buffer se nenaplní, a monitoruje žádosti o zrušení. (Zděděno od Stream)
Seek(Int64, SeekOrigin)	Nastaví pozici v aktuálním datovém proudu.
SetLength(Int64)	Nastaví délku aktuálního datového proudu.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)
Write(Byte[], Int32, Int32)	Zapíše posloupnost bajtů do proudu CryptoStream a posune aktuální pozici v rámci streamu o počet zapsaných bajtů.
Write(ReadOnlySpan<Byte>)	Při přepsání v odvozené třídě zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů. (Zděděno od Stream)
WriteAsync(Byte[], Int32, Int32)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů. (Zděděno od Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Zapíše posloupnost bajtů do aktuálního datového proudu asynchronně, posune aktuální pozici v rámci streamu o počet zapsaných bajtů a monitoruje požadavky na zrušení.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto streamu o počet zapsaných bajtů a monitoruje žádosti o zrušení.
WriteByte(Byte)	Zapíše bajt na aktuální pozici v datovém proudu a posune pozici v rámci streamu o jeden bajt.

Metody rozšíření

CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronně přečte bajty z objektu Stream a zapíše je do zadaného PipeWriterobjektu pomocí tokenu zrušení.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, jak se provádí čekání na úlohy vrácené z asynchronního jednorázového použití.

Viz také

• Šifrovací služby
• Částečná a nulová čtení v DeflateStream, GZipStream a CryptoStream