Click here to Skip to main content
12,549,003 members (47,576 online)
Click here to Skip to main content
Add your own
alternative version


159 bookmarked

WCF Service with custom username password authentication

, 25 Jul 2010 CPOL
Rate this:
Please Sign up or sign in to vote.
This article describes custom username password authentication without the need of certificate installation on the client side.

Tools used

  1. Pluralsight Self-Cert Tool. This tool is provided by Pluralsight to create and install certificates.
  2. WinHttpCertCfg.exe. Windows HTTP Services Certificate Configuration Tool is a command line tool to grant specific users read right access on a certificate's private key file.
  3. Environment: Visual Studio 2010, and IIS7 or above.


  1. Introduction
  2. Creating the service
  3. Configuring the service
  4. Configuring IIS and publishing the website
  5. Installing the server side certificate
  6. Setting up the client


Windows Communication Foundation comes with a rich set of security features such as transport level message and transport with message; each security type has its own advantages and overheads as well. My application has lots of diverse clients used to connect with the service, and they have to be authenticated from the database, so the best possible solution is message level security using custom username - password authentication. After digging in to the net, I found pieces of information, and with some effort, I implemented a concrete solution which I am hoping is helpful for others.

Creating the service

The solution is created using VS2010, and contains three projects: the WCF Service, the website, and the desktop application which is the client application.


The WCF Service just contains a function GetServertime():

public interface IService1
    string GetServertime();

[ServiceBehavior(IncludeExceptionDetailInFaults = true)]
public class Service1 : IService1
    public string GetServertime()
        return DateTime.Now.ToString();

We create a class and name it UserNamePassValidator. We the implement this code in it:

using System;
using System.ServiceModel;

namespace CustomUsernamePasswordAuth.Service
    class UserNamePassValidator : 
        public override void Validate(string userName, string password)
            if(  userName==null ||  password==null)
                throw new ArgumentNullException();

            if (!(userName == "fayaz" && password == "soomro") )
                throw new FaultException("Incorrect Username or Password");

This class must be derived from System.IdentityModel.Selectors.UserNamePasswordValidator and override the Validate method. And to validate the user, use any data source; in this example, we will use a hard coded value.

Creating the web application

Add a reference to the service in the web application. Add a text file and rename it to UserNamePassService.svc, and add the following line of code:

<%@ ServiceHost Language="C#" Debug="true" 
    Service="CustomUsernamePasswordAuth.Service.Service1" %>

Configuring the Web Service

Modify the web.config and add following lines in it.

Add a service behavior and name it Behavior1. Enable the service meta data by adding <serviceMetadata httpGetEnabled="true"/> so that when we add a service reference into the client application, it fetched the information and creates the proxy classes for us. And the essential part is the service certificate. Certificate creation will be covered in a later section, but now, we have to remember the certificate settings. FindValye="MyWebSite" will be the subject for the certificate CN=MyWebSite, and you can change this value to your domain name or project name.

Set the usernamepasswordvalidation mode to custom, and customUsernameapsswordValidator has to be specify the custom validation class and namespace.

            <behavior name="Behavior1">
                <serviceMetadata httpGetEnabled="true" />
                <serviceDebug includeExceptionDetailInFaults="true" />
                    <serviceCertificate findValue="MyWebSite" 
                          x509FindType="FindBySubjectName" />
                    <userNameAuthentication userNamePasswordValidationMode="Custom"
                        Service.UserNamePassValidator, CustomUsernamePasswordAuth.Service" />

Set up the binding configuration as shown below. Name it Binding1 and set the security mode as Message and clientCredentialType as "username".

        <binding name="Binding1">
            <security mode="Message">
                <message clientCredentialType="UserName"/>

Now we will set up the service endpoint. There are two endpoints: wsHttp endpoint, and Mex end point for metadata exchange. The base address is http://localhost/. The fully qualified service address will be http://localhost/UserNamePassService.svc.

    <service behaviorConfiguration="Behavior1" 
    <endpoint address="" binding="wsHttpBinding"    
              contract="CustomUsernamePasswordAuth.Service.IService1" />
     <endpoint address="mex" binding="mexHttpBinding" 
        contract="IMetadataExchange" />
                    <add baseAddress="http://localhost/" />

Note: if the website is going to be hosted on a specific port in IIS, as in this example, we have hosted the website in IIS on port 83, http://localhost:83/UserNamePassService.svc, we don't need to change the port in the configuration file and leave the baseAddress as "http://localhost/".

Creating the site in IIS 7

Open IIS Manager. Right click Sites and Add Website. Name it as WebSite, set Application pool to DeafaultAppPool, and select the physical path and set port to 83. As shown below:


Set the DefaultAppPool Framework version to 4.0.


Publish Site to IIS

Right click the website project in Solution Explorer and publish it. Select Publish method as File system, and Target location as http://localhost:83, as shown in the figure below:


Browse the site. Open Internet Explorer and type http://localhost:83/UserNamePassService.svc. You will see the error that X.509 could not be found.


Installing the certificate

Download the Pluralsight SelfCert from the link given at the beginning of the article. Run the tool as Administrator; otherwise, it will crash.

Configure the settings to install the certificate; refer the screen below.


After making the required changes, click the Save button and then you will see the screen below:


After the installation of the certificate, browse the site again, but this time, you should see a different error as shown in the screen below:


This error means that the default application pool does not have access rights to the certificate's private key, so now, we have to give read access to the default application pool to do this.

Download WinHttpCertCfg.exe from the link given at the beginning of the article. This tool is a command line tool. After installing the tool, run the following command on the command prompt as Administrator.

C:\Program Files (x86)\Windows Resource Kits\Tools>winhttpcertcfg 
             -g -c LOCAL_MACHINE\My -s MyWebSite -a DefaultAppPool

After running the command, you will see the screen like this:


Now browse the site again. And verify the service, it should be up.


The final step is to create a client to consume the service

The client application is the desktop application, and just contains the address textbox and the button to get the server time.


Now add the service reference to the project:


Add the code to the Button_click event:

private void button1_Click(object sender, EventArgs e)
    string time = "";
    // Method 1: Create the client using the configuration file

    Service1Client c = new Service1Client();
    c.ClientCredentials.UserName.UserName = "fayaz";
    c.ClientCredentials.UserName.Password = "soomro";
    c.ClientCredentials.ServiceCertificate.Authentication.CertificateValidationMode = 
    time = c.GetServertime();

    // Method 2: Creating the client by creating endpoint and binding through coding
    var ServiceendPoint = new EndpointAddress(new Uri(txtServiceAddress.Text), 
    var binding = new WSHttpBinding();
    binding.Security.Mode = SecurityMode.Message;
    binding.Security.Message.ClientCredentialType = MessageCredentialType.UserName;

    var result = new Service1Client(binding, ServiceendPoint);
    result.ClientCredentials.ServiceCertificate.Authentication.CertificateValidationMode = 
    result.ClientCredentials.UserName.UserName = "fayaz";            
    result.ClientCredentials.UserName.Password = "soomro";
    time = result.GetServertime();

Run the application:


Running the client from another PC to make sure everything works fine:



I 'm sure this project will be useful for developers who want to implement custom security. I tried my best to describe each step with a screenshot. I hope you've enjoyed this article. If you like this article, please let me know :). If you have any questions, please feel free to contact me at


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

Fayaz Soomro
Software Developer Macmillan Publishing
United States United States
No Biography provided

You may also be interested in...


Comments and Discussions

GeneralMy vote of 5 Pin
Omar Gameel Salem18-Feb-13 3:15
memberOmar Gameel Salem18-Feb-13 3:15 
QuestionCan't see UserNamePassService Pin
Noe Garcia15-Feb-13 9:44
memberNoe Garcia15-Feb-13 9:44 
Questioncertificate encodedValue Pin
jason724-Jan-13 3:15
memberjason724-Jan-13 3:15 
QuestionHow to use same security implementation in HttpWebRequest? Pin
Umais ASGHAR15-Jan-13 22:34
memberUmais ASGHAR15-Jan-13 22:34 
Hi, I'm using the this WCF custom username password authentication and it's working as I need it to. Thank you for the article, it solved my issue. But, I'm having another issue, I need to call this secured-service through HTTP POST request, in XML format. Everywhere I look at, people are using RESTful service and it's not what I need. I need to use HttpWebRequest and get HttpWebResponse by using the same WCF service. I tried things like...
[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Xml, ResponseFormat = WebMessageFormat.Xml)]
and called the service like...
HttpWebRequest request = WebRequest.Create("http://localhost:56779/BeSTService.svc/Knock") as HttpWebRequest;
            request.Credentials = new NetworkCredential("umais", "asghar");
            XElement root;
            using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
                StreamReader reader = new StreamReader(response.GetResponseStream());
                root = XElement.Parse(reader.ReadToEnd());
HttpWebRequest req = (HttpWebRequest)WebRequest.Create("http://localhost:56779/BeSTService.svc/Knock");
req.Method = "POST";
req.ContentLength = 0;
req.ContentType = "application/soap+xml; charset=utf-8";
HttpWebResponse response = (HttpWebResponse)req.GetResponse();
but failed. "Bad request".
my service...
public interface IService
   string Knock();
public class Service : IService
   public string Knock()
      return "Come in Umais!";
Pleaser help me out here!
QuestionImplement WCF Service available both in POX and JSON with custom authentication Pin
hamba _hamba5-Dec-12 4:03
memberhamba _hamba5-Dec-12 4:03 
GeneralMy vote of 5 Pin
Keizer61912-Sep-12 20:43
memberKeizer61912-Sep-12 20:43 
GeneralThank you very much Pin
rdkleine12-Jun-12 4:29
memberrdkleine12-Jun-12 4:29 
QuestionCan we Call it Direct Authentication Pin
Kunal Uppal5-Apr-12 8:30
memberKunal Uppal5-Apr-12 8:30 
QuestionCustom validation is not firing Pin
tejas Deodhar4-Apr-12 23:32
membertejas Deodhar4-Apr-12 23:32 
BugHTTP-Fehler 404.3 - Not Found Pin
Member 87799554-Apr-12 2:41
memberMember 87799554-Apr-12 2:41 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.161021.1 | Last Updated 25 Jul 2010
Article Copyright 2010 by Fayaz Soomro
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid