This documentation is archived and is not being maintained.

ClientCredentials Class

Enables the user to configure client and service credentials as well as service credential authentication settings for use on the client side of communication.


Namespace:  System.ServiceModel.Description
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

Public Class ClientCredentials _
	Inherits SecurityCredentialsManager _
	Implements IEndpointBehavior

The ClientCredentials type exposes the following members.

Public methodSupported by Portable Class LibraryClientCredentialsInitializes a new instance of the ClientCredentials class.
Protected methodSupported by Portable Class LibraryClientCredentials(ClientCredentials)This is a copy constructor.

Public propertyClientCertificateGets an object that you can use to provide the X.509 certificate that the client uses to authenticate to the service.
Public propertyHttpDigestGets the current HTTP Digest credential.
Public propertyIssuedTokenUse this property to specify the endpoint address and binding to use when contacting your local Security Token Service. This information is used when a service requires authentication using an issued token, but the policy of the service (represented as a binding on the client) does not explicitly specify how and where to obtain the issued token.
Public propertyPeerControls the credentials that a peer node uses to authenticate itself to other nodes in the mesh, as well as authentication settings that a peer node uses to authenticate other peer nodes.
Public propertyServiceCertificateGets an object used to specify a service's X.509 certificate.
Public propertySupportInteractiveGets or sets a value that indicates whether the system is allowed to interactively prompt the user for credentials when necessary. For example, setting it to false might be desired in middle-tier scenarios.
Public propertySupported by Portable Class LibraryUserNameGets a credential object that you can use to set the user name and password that the client uses to authenticate itself to the service.
Public propertyWindowsGets an object used to control the Windows credential that the client uses to authenticate itself to the service.

Public methodApplyClientBehaviorApplies the specified client behavior to the endpoint.
Public methodSupported by Portable Class LibraryCloneCreates a new copy of this ClientCredentials instance.
Protected methodSupported by Portable Class LibraryCloneCoreCreates a new copy of this ClientCredentials instance.
Public methodCreateSecurityTokenManagerCreates a security token manager for this instance. This method is rarely called explicitly; it is primarily used in extensibility scenarios and is called by the system itself. (Overrides SecurityCredentialsManager.CreateSecurityTokenManager.)
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetInfoCardSecurityTokenGenerates and returns a security token using the system and the specified policy chain and token serializer.
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)

Explicit interface implemetationPrivate methodIEndpointBehavior.AddBindingParametersAdds this instance of this class to a binding parameter collection.
Explicit interface implemetationPrivate methodIEndpointBehavior.ApplyDispatchBehaviorImplements a modification or extension of the service across an endpoint.
Explicit interface implemetationPrivate methodIEndpointBehavior.ValidateReserved for future use.

The ClientCredentials is accessed through the ClientCredentials property of the ClientBase(Of TChannel) class.

A ClientCredentials object is added to the Behaviors collection. The ClientCredentials property is a Façade (a well-known design pattern) over an entry in that collection. Many properties in this class return objects that consist mainly of properties. These objects can be used for configuration: once you get the object, you can use it to set properties by calling its members.

The following code sample shows how to override this class and implement your own custom client credentials that includes a custom security token manager.

Important noteImportant

It is important to note that the CreateSecurityTokenManager method is overridden to create a custom security token manager. The security token manager, derived from ClientCredentialsSecurityTokenManager. must return a custom security token provider, derived from [System.IdentityModel.Selectors.SecurityTokenProvider], to create the actual security token. If you do not follow this pattern for creating security tokens, your application will be at risk for security attacks, specifically elevation of privileges. This coding pattern ensures that the correct credentials are used when channel factories are cached.

Public Class MyClientCredentials
    Inherits ClientCredentials
    Private creditCardNumberValue As String

    Public Sub New() 

    End Sub 'New

    ' Perform client credentials initialization.    
    Protected Sub New(ByVal other As MyClientCredentials) 
        ' Clone fields defined in this class.
        Me.creditCardNumberValue = other.creditCardNumberValue

    End Sub

    Public Property CreditCardNumber() As String 
            Return Me.creditCardNumberValue
        End Get
            If value Is Nothing Then
                Throw New ArgumentNullException("value")
            End If
            Me.creditCardNumberValue = value
        End Set
    End Property

    Public Overrides Function CreateSecurityTokenManager() As SecurityTokenManager 
        ' Return your implementation of the SecurityTokenManager.
        Return New MyClientCredentialsSecurityTokenManager(Me)

    End Function

    Protected Overrides Function CloneCore() As ClientCredentials 
        ' Implement the cloning functionality.
        Return New MyClientCredentials(Me)

    End Function
End Class

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.