ClientCertificateError Property

HttpListenerRequest.ClientCertificateError Property

Gets an error code that identifies a problem with the X509Certificate provided by the client.

Namespace:  System.Net
Assembly:  System (in System.dll)

'Declaration
Public ReadOnly Property ClientCertificateError As Integer
'Usage
Dim instance As HttpListenerRequest 
Dim value As Integer 

value = instance.ClientCertificateError

Property Value

Type: System.Int32
An Int32 value that contains a Windows error code.

This property contains a Windows error code returned by the Secure Channel (Schannel) Security Support Provider Interface (SSPI), which is used to validate the certificate. For more information about SSPI support for Schannel, see "Creating a Secure Connection Using Schannel" in the Security documentation at http://msdn.microsoft.com/library.

The following code example checks this property to determine whether the request includes a valid client certificate.

Console.WriteLine("Listening for {0} prefixes...", listener.Prefixes.Count)
Dim context As HttpListenerContext = listener.GetContext()
Dim request As HttpListenerRequest = context.Request
Console.WriteLine("Received a request.")
' This server requires a valid client certificate 
' for requests that are not sent from the local computer. 

' Did the client omit the certificate or send an invalid certificate? 
If request.IsAuthenticated AndAlso request.GetClientCertificate() Is Nothing OrElse request.ClientCertificateError <> 0 Then 
    ' Send a 403 response. 
    Dim badCertificateResponse As HttpListenerResponse = context.Response
    SendBadCertificateResponse(badCertificateResponse)
    Console.WriteLine("Client has invalid certificate.")
    Continue Do
End If

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2016 Microsoft