SslStream.IsAuthenticated Property

Reference

Definition

Namespace:: System.Net.Security

Assemblies:: netstandard.dll, System.Net.Security.dll

Assembly:: System.Net.Security.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: SslStream.cs

Source:: SslStream.cs

Source:: SslStream.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a Boolean value that indicates whether authentication was successful.

public:
 virtual property bool IsAuthenticated { bool get(); };

public override bool IsAuthenticated { get; }

member this.IsAuthenticated : bool

Public Overrides ReadOnly Property IsAuthenticated As Boolean

Property Value

Boolean

true if successful authentication occurred; otherwise, false.

Examples

The following code example demonstrates displaying the value of this property.

static void DisplaySecurityServices( SslStream^ stream )
{
   Console::WriteLine( L"Is authenticated: {0} as server? {1}", stream->IsAuthenticated, stream->IsServer );
   Console::WriteLine( L"IsSigned: {0}", stream->IsSigned );
   Console::WriteLine( L"Is Encrypted: {0}", stream->IsEncrypted );
   Console::WriteLine( L"Is mutually authenticated: {0}", stream->IsMutuallyAuthenticated );
}

static void DisplaySecurityServices(SslStream stream)
{
   Console.WriteLine("Is authenticated: {0} as server? {1}", stream.IsAuthenticated, stream.IsServer);
   Console.WriteLine("IsSigned: {0}", stream.IsSigned);
   Console.WriteLine("Is Encrypted: {0}", stream.IsEncrypted);
   Console.WriteLine("Is mutually authenticated: {0}", stream.IsMutuallyAuthenticated);
}

Private Shared Sub DisplaySecurityServices(stream As SslStream)
    Console.WriteLine("Is authenticated: {0} as server? {1}", stream.IsAuthenticated, stream.IsServer)
    Console.WriteLine("IsSigned: {0}", stream.IsSigned)
    Console.WriteLine("Is Encrypted: {0}", stream.IsEncrypted)
    Console.WriteLine("Is mutually authenticated: {0}", stream.IsMutuallyAuthenticated)
End Sub

Remarks

Clients authenticate by calling the AuthenticateAsClient or BeginAuthenticateAsClient methods. Servers authenticate by calling the AuthenticateAsServer or BeginAuthenticateAsServer methods.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via