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)

Public ReadOnly Property ClientCertificateError As Integer

Property Value

Type: System.Int32

An Int32 value that contains a Windows error code.

Exception Condition
InvalidOperationException

The client certificate has not been initialized yet by a call to the BeginGetClientCertificate or GetClientCertificate methods

-or -

The operation is still in progress.

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

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft