SafeHandle Classe

Definizione

Rappresenta una classe wrapper per gli handle del sistema operativo. La classe deve essere ereditata.

public ref class SafeHandle abstract : IDisposable
public ref class SafeHandle abstract : System::Runtime::ConstrainedExecution::CriticalFinalizerObject, IDisposable
[System.Security.SecurityCritical]
public abstract class SafeHandle : IDisposable
public abstract class SafeHandle : System.Runtime.ConstrainedExecution.CriticalFinalizerObject, IDisposable
[System.Security.SecurityCritical]
public abstract class SafeHandle : System.Runtime.ConstrainedExecution.CriticalFinalizerObject, IDisposable
[<System.Security.SecurityCritical>]
type SafeHandle = class
    interface IDisposable
type SafeHandle = class
    inherit CriticalFinalizerObject
    interface IDisposable
[<System.Security.SecurityCritical>]
type SafeHandle = class
    inherit CriticalFinalizerObject
    interface IDisposable
Public MustInherit Class SafeHandle
Implements IDisposable
Public MustInherit Class SafeHandle
Inherits CriticalFinalizerObject
Implements IDisposable
Ereditarietà
SafeHandle
Ereditarietà
Derivato
Attributi
Implementazioni

Esempio

Nell'esempio di codice seguente viene creato un handle sicuro personalizzato per un handle di file del sistema operativo, derivando da SafeHandleZeroOrMinusOneIsInvalid . Legge i byte da un file e visualizza i relativi valori esadecimali. Contiene anche un harness di test degli errori che causa l'interruzione del thread, ma il valore dell'handle viene liberato. Quando si usa un IntPtr oggetto per rappresentare handle, l'handle viene occasionalmente persa a causa dell'interruzione asincrona del thread.

Sarà necessario un file di testo nella stessa cartella dell'applicazione compilata. Supponendo di assegnare all'applicazione il nome "HexViewer", l'utilizzo della riga di comando è:

HexViewer <filename> -Fault

Facoltativamente, -Fault specificare per tentare intenzionalmente di perdere l'handle interrompendo il thread in una determinata finestra. Usare lo Windows Perfmon.exe per monitorare i conteggi degli handle durante l'inserimento degli errori.

using System;
using System.Runtime.InteropServices;
using System.IO;
using System.ComponentModel;
using System.Security.Permissions;
using System.Security;
using System.Threading;
using Microsoft.Win32.SafeHandles;
using System.Runtime.ConstrainedExecution;

namespace SafeHandleDemo
{
    [SecurityPermission(SecurityAction.InheritanceDemand, UnmanagedCode = true)]
    [SecurityPermission(SecurityAction.Demand, UnmanagedCode = true)]
    internal class MySafeFileHandle : SafeHandleZeroOrMinusOneIsInvalid
    {
        // Create a SafeHandle, informing the base class
        // that this SafeHandle instance "owns" the handle,
        // and therefore SafeHandle should call
        // our ReleaseHandle method when the SafeHandle
        // is no longer in use.
        private MySafeFileHandle()
            : base(true)
        {
        }
        [ReliabilityContract(Consistency.WillNotCorruptState, Cer.MayFail)]
        override protected bool ReleaseHandle()
        {
            // Here, we must obey all rules for constrained execution regions.
            return NativeMethods.CloseHandle(handle);
            // If ReleaseHandle failed, it can be reported via the
            // "releaseHandleFailed" managed debugging assistant (MDA).  This
            // MDA is disabled by default, but can be enabled in a debugger
            // or during testing to diagnose handle corruption problems.
            // We do not throw an exception because most code could not recover
            // from the problem.
        }
    }

    [SuppressUnmanagedCodeSecurity()]
    internal static class NativeMethods
    {
        // Win32 constants for accessing files.
        internal const int GENERIC_READ = unchecked((int)0x80000000);

        // Allocate a file object in the kernel, then return a handle to it.
        [DllImport("kernel32", SetLastError = true, CharSet = CharSet.Unicode)]
        internal extern static MySafeFileHandle CreateFile(String fileName,
           int dwDesiredAccess, System.IO.FileShare dwShareMode,
           IntPtr securityAttrs_MustBeZero, System.IO.FileMode dwCreationDisposition,
           int dwFlagsAndAttributes, IntPtr hTemplateFile_MustBeZero);

        // Use the file handle.
        [DllImport("kernel32", SetLastError = true)]
        internal extern static int ReadFile(MySafeFileHandle handle, byte[] bytes,
           int numBytesToRead, out int numBytesRead, IntPtr overlapped_MustBeZero);

        // Free the kernel's file object (close the file).
        [DllImport("kernel32", SetLastError = true)]
        [ReliabilityContract(Consistency.WillNotCorruptState, Cer.MayFail)]
        internal extern static bool CloseHandle(IntPtr handle);
    }

    // The MyFileReader class is a sample class that accesses an operating system
    // resource and implements IDisposable. This is useful to show the types of
    // transformation required to make your resource wrapping classes
    // more resilient. Note the Dispose and Finalize implementations.
    // Consider this a simulation of System.IO.FileStream.
    public class MyFileReader : IDisposable
    {
        // _handle is set to null to indicate disposal of this instance.
        private MySafeFileHandle _handle;

        public MyFileReader(String fileName)
        {
            // Security permission check.
            String fullPath = Path.GetFullPath(fileName);
            new FileIOPermission(FileIOPermissionAccess.Read, fullPath).Demand();

            // Open a file, and save its handle in _handle.
            // Note that the most optimized code turns into two processor
            // instructions: 1) a call, and 2) moving the return value into
            // the _handle field.  With SafeHandle, the CLR's platform invoke
            // marshaling layer will store the handle into the SafeHandle
            // object in an atomic fashion. There is still the problem
            // that the SafeHandle object may not be stored in _handle, but
            // the real operating system handle value has been safely stored
            // in a critical finalizable object, ensuring against leaking
            // the handle even if there is an asynchronous exception.

            MySafeFileHandle tmpHandle;
            tmpHandle = NativeMethods.CreateFile(fileName, NativeMethods.GENERIC_READ,
                FileShare.Read, IntPtr.Zero, FileMode.Open, 0, IntPtr.Zero);

            // An async exception here will cause us to run our finalizer with
            // a null _handle, but MySafeFileHandle's ReleaseHandle code will
            // be invoked to free the handle.

            // This call to Sleep, run from the fault injection code in Main,
            // will help trigger a race. But it will not cause a handle leak
            // because the handle is already stored in a SafeHandle instance.
            // Critical finalization then guarantees that freeing the handle,
            // even during an unexpected AppDomain unload.
            Thread.Sleep(500);
            _handle = tmpHandle;  // Makes _handle point to a critical finalizable object.

            // Determine if file is opened successfully.
            if (_handle.IsInvalid)
                throw new Win32Exception(Marshal.GetLastWin32Error(), fileName);
        }

        public void Dispose()  // Follow the Dispose pattern - public nonvirtual.
        {
            Dispose(disposing: true);
            GC.SuppressFinalize(this);
        }

        // No finalizer is needed. The finalizer on SafeHandle
        // will clean up the MySafeFileHandle instance,
        // if it hasn't already been disposed.
        // However, there may be a need for a subclass to
        // introduce a finalizer, so Dispose is properly implemented here.
        [SecurityPermission(SecurityAction.Demand, UnmanagedCode = true)]
        protected virtual void Dispose(bool disposing)
        {
            // Note there are three interesting states here:
            // 1) CreateFile failed, _handle contains an invalid handle
            // 2) We called Dispose already, _handle is closed.
            // 3) _handle is null, due to an async exception before
            //    calling CreateFile. Note that the finalizer runs
            //    if the constructor fails.
            if (_handle != null && !_handle.IsInvalid)
            {
                // Free the handle
                _handle.Dispose();
            }
            // SafeHandle records the fact that we've called Dispose.
        }

        [SecurityPermission(SecurityAction.Demand, UnmanagedCode = true)]
        public byte[] ReadContents(int length)
        {
            if (_handle.IsInvalid)  // Is the handle disposed?
                throw new ObjectDisposedException("FileReader is closed");

            // This sample code will not work for all files.
            byte[] bytes = new byte[length];
            int numRead = 0;
            int r = NativeMethods.ReadFile(_handle, bytes, length, out numRead, IntPtr.Zero);
            // Since we removed MyFileReader's finalizer, we no longer need to
            // call GC.KeepAlive here.  Platform invoke will keep the SafeHandle
            // instance alive for the duration of the call.
            if (r == 0)
                throw new Win32Exception(Marshal.GetLastWin32Error());
            if (numRead < length)
            {
                byte[] newBytes = new byte[numRead];
                Array.Copy(bytes, newBytes, numRead);
                bytes = newBytes;
            }
            return bytes;
        }
    }

    static class Program
    {
        // Testing harness that injects faults.
        private static bool _printToConsole = false;
        private static bool _workerStarted = false;

        private static void Usage()
        {
            Console.WriteLine("Usage:");
            // Assumes that application is named HexViewer"
            Console.WriteLine("HexViewer <fileName> [-fault]");
            Console.WriteLine(" -fault Runs hex viewer repeatedly, injecting faults.");
        }

        private static void ViewInHex(Object fileName)
        {
            _workerStarted = true;
            byte[] bytes;
            using (MyFileReader reader = new MyFileReader((String)fileName))
            {
                bytes = reader.ReadContents(20);
            }  // Using block calls Dispose() for us here.

            if (_printToConsole)
            {
                // Print up to 20 bytes.
                int printNBytes = Math.Min(20, bytes.Length);
                Console.WriteLine("First {0} bytes of {1} in hex", printNBytes, fileName);
                for (int i = 0; i < printNBytes; i++)
                    Console.Write("{0:x} ", bytes[i]);
                Console.WriteLine();
            }
        }

        static void Main(string[] args)
        {
            if (args.Length == 0 || args.Length > 2 ||
                args[0] == "-?" || args[0] == "/?")
            {
                Usage();
                return;
            }

            String fileName = args[0];
            bool injectFaultMode = args.Length > 1;
            if (!injectFaultMode)
            {
                _printToConsole = true;
                ViewInHex(fileName);
            }
            else
            {
                Console.WriteLine("Injecting faults - watch handle count in perfmon (press Ctrl-C when done)");
                int numIterations = 0;
                while (true)
                {
                    _workerStarted = false;
                    Thread t = new Thread(new ParameterizedThreadStart(ViewInHex));
                    t.Start(fileName);
                    Thread.Sleep(1);
                    while (!_workerStarted)
                    {
                        Thread.Sleep(0);
                    }
                    t.Abort();  // Normal applications should not do this.
                    numIterations++;
                    if (numIterations % 10 == 0)
                        GC.Collect();
                    if (numIterations % 10000 == 0)
                        Console.WriteLine(numIterations);
                }
            }
        }
    }
}

Commenti

La classe fornisce la finalizzazione critica delle risorse di handle, impedendo il recupero prematura degli handle da parte di Garbage Collection e il riciclo da parte di Windows per fare riferimento a oggetti non gestiti non SafeHandle intenzionali.

Questo argomento include le sezioni seguenti:

Perché SafeHandle?
Funzione di SafeHandle
Classi derivate da SafeHandle

Perché SafeHandle?

Prima della .NET Framework versione 2.0, tutti gli handle del sistema operativo potevano essere incapsulati solo IntPtr nell'oggetto wrapper gestito. Sebbene si tratta di un modo pratico per interagire con il codice nativo, gli handle potrebbero essere persi da eccezioni asincrone, ad esempio un'interruzione imprevista di un thread o un overflow dello stack. Queste eccezioni asincrone sono un ostacolo alla pulizia delle risorse del sistema operativo e possono verificarsi quasi ovunque nell'app.

Anche se gli override del metodo consentono la pulizia delle risorse non gestite quando un oggetto viene sottoposto a Garbage Collection, in alcune circostanze gli oggetti finalizzabili possono essere recuperati da Garbage Collection durante l'esecuzione di un metodo all'interno di una Object.Finalize chiamata platform invoke. Se un finalizzatore libera l'handle passato a tale platform invoke chiamata, potrebbe causare il danneggiamento della gestione. L'handle può anche essere recuperato mentre il metodo è bloccato durante una chiamata platform invoke, ad esempio durante la lettura di un file.

In modo più critico, poiché Windows ricicla in modo aggressivo gli handle, è possibile riciclare un handle e puntare a un'altra risorsa che potrebbe contenere dati sensibili. Questo è noto come attacco di riciclo e può potenzialmente danneggiare i dati e essere una minaccia per la sicurezza.

Funzione di SafeHandle

La classe semplifica diversi di questi problemi di durata degli oggetti ed è integrata con platform invoke in modo che le risorse SafeHandle del sistema operativo non siano perse. La SafeHandle classe risolve i problemi di durata degli oggetti assegnando e rilasciando handle senza interruzioni. Contiene un finalizzatore critico che garantisce che l'handle sia chiuso e che l'esecuzione sia garantita durante scaricamenti imprevisti, anche nei casi in cui si presuppone che la chiamata platform invoke sia AppDomain danneggiata.

Poiché eredita da , tutti i finalizzatori non critici vengono SafeHandle chiamati prima di uno qualsiasi dei CriticalFinalizerObject finalizzatori critici. I finalizzatori vengono chiamati su oggetti che non sono più in tempo reale durante lo stesso passaggio di Garbage Collection. Ad esempio, un oggetto può eseguire un finalizzatore normale per scaricare i dati memorizzati nel buffer esistenti senza il rischio di perdita o riciclo FileStream dell'handle. Questo ordinamento molto debole tra finalizzatori critici e non critici non è destinato all'uso generale. Esiste principalmente per facilitare la migrazione delle librerie esistenti, consentendo l'uso di tali librerie SafeHandle senza modificarne la semantica. Inoltre, il finalizzatore critico e qualsiasi elemento che chiama, ad esempio il metodo SafeHandle.ReleaseHandle() , devono essere in un'area a esecuzione vincolata. Questo impone vincoli sul codice che può essere scritto all'interno del grafico delle chiamate del finalizzatore.

Le operazioni platform invoke incrementano automaticamente il conteggio dei riferimenti degli handle incapsulati da un oggetto e SafeHandle li decrementano al completamento. Ciò garantisce che l'handle non verrà riciclato o chiuso in modo imprevisto.

È possibile specificare la proprietà dell'handle sottostante durante la costruzione di oggetti fornendo un SafeHandle valore ownsHandle all'argomento nel SafeHandle costruttore della classe. Controlla se SafeHandle l'oggetto rilascerà l'handle dopo che l'oggetto è stato eliminato. Ciò è utile per gli handle con requisiti di durata particolari o per l'utilizzo di un handle la cui durata è controllata da un altro utente.

Classi derivate da SafeHandle

SafeHandle è una classe wrapper astratta per gli handle del sistema operativo. La derivazione da questa classe è difficile. Utilizzare invece le classi derivate nello spazio dei nomi Microsoft.Win32.SafeHandles che forniscono handle sicuri per gli elementi seguenti:

Note per gli implementatori

Per creare una classe derivata da , è necessario sapere come creare e SafeHandle liberare un handle del sistema operativo. Questo processo è diverso per i diversi tipi di handle perché alcuni usano la funzione CloseHandle, mentre altri usano funzioni più specifiche, ad esempio UnmapViewOfFile o FindClose. Per questo motivo, è necessario creare una classe derivata di per ogni tipo di handle del sistema operativo di cui si vuole eseguire SafeHandle il wrapping in un handle sicuro.

Quando si eredita da SafeHandle, è necessario eseguire l'override dei seguenti membri: IsInvalid e ReleaseHandle().

È inoltre necessario fornire un costruttore pubblico senza parametri che chiama il costruttore di base con un valore che rappresenta un valore di handle non valido e un valore che indica se l'handle nativo è di proprietà di e, di conseguenza, deve essere liberato quando è stato Boolean SafeHandle SafeHandle eliminato.

Costruttori

SafeHandle()
SafeHandle(IntPtr, Boolean)

Inizializza una nuova istanza della classe SafeHandle con il valore di handle non valido specificato.

Campi

handle

Specifica l'handle di cui eseguire il wrapping.

Proprietà

IsClosed

Ottiene un valore che indica se l'handle è chiuso.

IsInvalid

Quando ne viene eseguito l'override in una classe derivata, consente di ottenere un valore che indica se il valore dell'handle non è valido.

Metodi

Close()

Contrassegna l'handle per il rilascio delle risorse.

DangerousAddRef(Boolean)

Incrementa manualmente il numero di riferimenti nelle istanze di SafeHandle.

DangerousGetHandle()

Restituisce il valore del campo handle.

DangerousRelease()

Decrementa manualmente il numero di riferimenti in un'istanza di SafeHandle.

Dispose()

Rilascia tutte le risorse usate dalla classe SafeHandle.

Dispose(Boolean)

Rilascia le risorse non gestite usate dalla classe SafeHandle specificando se eseguire una normale operazione di eliminazione.

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
Finalize()

Libera tutte le risorse associate all'handle.

GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
ReleaseHandle()

Quando ne viene eseguito l'override in una classe derivata, esegue il codice necessario per liberare l'handle.

SetHandle(IntPtr)

Imposta l'handle sull'handle preesistente specificato.

SetHandleAsInvalid()

Contrassegna un handle come non più usato.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Si applica a

Vedi anche