EndpointIdentity.CreateSpnIdentity(String) Method

Definition

Namespace:

System.ServiceModel

Assembly:

System.ServiceModel.dll

Creates a server principal name (SPN) identity with a specified name.

public:
 static System::ServiceModel::EndpointIdentity ^ CreateSpnIdentity(System::String ^ spnName);

public static System.ServiceModel.EndpointIdentity CreateSpnIdentity (string spnName);

static member CreateSpnIdentity : string -> System.ServiceModel.EndpointIdentity

Public Shared Function CreateSpnIdentity (spnName As String) As EndpointIdentity

Parameters

spnName

String

The name for the SPN identity.

Returns

EndpointIdentity

An SPN EndpointIdentity associated with the specified spnName.

Exceptions

ArgumentNullException

spnName is null.

Examples

The following code shows how to call this method.

// Create the service host.
ServiceHost myServiceHost = new ServiceHost(typeof(Calculator));

// Create the binding.
WSHttpBinding binding = new WSHttpBinding();
binding.Security.Mode = SecurityMode.Message;
binding.Security.Message.ClientCredentialType =
     MessageCredentialType.Windows;

// Disable credential negotiation and establishment of the
// security context.
binding.Security.Message.NegotiateServiceCredential = false;
binding.Security.Message.EstablishSecurityContext = false;

// Create a URI for the endpoint address.
Uri httpUri = new Uri("http://localhost/Calculator");

// Create the EndpointAddress with the SPN for the Identity.
EndpointAddress ea = new EndpointAddress(httpUri,
    EndpointIdentity.CreateSpnIdentity("service_spn_name"));

// Get the contract from the ICalculator interface (not shown here).
// See the sample applications for an example of the ICalculator.
ContractDescription contract = ContractDescription.GetContract(
    typeof(ICalculator));

// Create a new ServiceEndpoint.
ServiceEndpoint se = new ServiceEndpoint(contract, binding, ea);

// Add the service endpoint to the service.
myServiceHost.Description.Endpoints.Add(se);

// Open the service.
myServiceHost.Open();
Console.WriteLine("Listening...");
Console.ReadLine();

// Close the service.
myServiceHost.Close();

Remarks

A secure WCF client that connects to an endpoint with this identity uses the SPN when performing SSPI authentication with the endpoint.

This static method creates an instance of SpnEndpointIdentity by calling its constructor, SpnEndpointIdentity, using spnName as the input parameter.

If spnName is specified with an empty string, authentication falls back from Kerberos to NTLM if possible. If AllowNtlm is false, authentication fails.