SecurityContext Class

Definition

Caution

Code Access Security is not supported or honored by the runtime.

Encapsulates and propagates all security-related data for execution contexts transferred across threads. This class cannot be inherited.

public ref class SecurityContext sealed : IDisposable
public ref class SecurityContext sealed
public sealed class SecurityContext : IDisposable
[System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
public sealed class SecurityContext : IDisposable
public sealed class SecurityContext
type SecurityContext = class
    interface IDisposable
[<System.Obsolete("Code Access Security is not supported or honored by the runtime.", DiagnosticId="SYSLIB0003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
type SecurityContext = class
    interface IDisposable
type SecurityContext = class
Public NotInheritable Class SecurityContext
Implements IDisposable
Public NotInheritable Class SecurityContext
Inheritance
SecurityContext
Attributes
Implements

Remarks

Caution

Code Access Security (CAS) has been deprecated across all versions of .NET Framework and .NET. Recent versions of .NET do not honor CAS annotations and produce errors if CAS-related APIs are used. Developers should seek alternative means of accomplishing security tasks.

Note

This type is marked obsolete starting in .NET 6.

A SecurityContext object captures all security-related information for a logical thread, including the information contained in the WindowsIdentity and CompressedStack objects. This configuration allows the Windows identity and the security elements on the stack to be propagated automatically when the SecurityContext is copied and transferred across asynchronous threads.

Note

The common language runtime (CLR) is aware of impersonation operations performed using only managed code, not of impersonation performed outside of managed code, such as through platform invoke to unmanaged code or through direct calls to Win32 functions. Only managed WindowsIdentity objects can flow across asynchronous points, unless the alwaysFlowImpersonationPolicy element has been set to true (<alwaysFlowImpersonationPolicy enabled="true"/>). Setting the alwaysFlowImpersonationPolicy element to true specifies that the Windows identity always flows across asynchronous points, regardless of how impersonation was performed. For more information about flowing unmanaged impersonation across asynchronous points, see <alwaysFlowImpersonationPolicy> Element.

The SecurityContext is part of the larger ExecutionContext and flows or migrates when the ExecutionContext flows or migrates.

Important

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Methods

Capture()

Captures the security context for the current thread.

CreateCopy()

Creates a copy of the current security context.

Dispose()

Releases all resources used by the current instance of the SecurityContext class.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsFlowSuppressed()

Determines whether the flow of the security context has been suppressed.

IsWindowsIdentityFlowSuppressed()

Determines whether the flow of the Windows identity portion of the current security context has been suppressed.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
RestoreFlow()

Restores the flow of the security context across asynchronous threads.

Run(SecurityContext, ContextCallback, Object)

Runs the specified method in the specified security context on the current thread.

SuppressFlow()

Suppresses the flow of the security context across asynchronous threads.

SuppressFlowWindowsIdentity()

Suppresses the flow of the Windows identity portion of the current security context across asynchronous threads.

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to