SocketTools .NET Edition

SocketWrench.CertificateName Property

Gets and sets a value that specifies the name of the security certificate.

[Visual Basic]
Public Property CertificateName As String
[C#]
public string CertificateName {get; set;}

Property Value

A string which specifies the certificate name.

Remarks

The CertificateName property sets the common name or friendly name of the certificate that should be used when establishing a secure client connection or accepting a secure connection from a remote host. This property is used in conjunction with the CertificateStore property to identify the client or server certificate.

For client applications, it is only required that you set this property value if the server requires a client certificate for authentication. If this property is not set, a client certificate will not be provided to the server. The certificate must be designated as a client certificate and have a private key associated with it, otherwise the connection attempt will fail.

For server applications, it is required that you specify a certificate name if security has been enabled by setting the Secure property to true. The certificate must be designated as a server certificate and have a private key associated with it, otherwise incoming client connections cannot be accepted.

When the certificate store is searched for a matching certificate, it will first search for any certificate with a friendly name that matches the property value. If no valid certificate is found, it will then search for a certificate with a matching common name.

Certificates may be installed and viewed on the local system using the Certificate Manager that is included with the Windows operating system. For more information, refer to the documentation for the Microsoft Management Console.

See Also

SocketWrench Class | SocketTools Namespace | CertificateStore Property | Secure Property