How to pass username and password to the SOAP header of a Web Service Call from C#?

Question

I want to write a C# code which calls a (remote) web service in another machine. For this I have to pass username and password in the SOAP header of the call.

I would like to know an example of code to make this in C#.

the produced XML should be like :

<env:Header>
    <ns1:Security>
        <ns1:UsernameToken>
            <ns1:Username>XXXXXXXXXXXXXXXX</ns1:Username>
            <ns1:Password>YYYYYYYYYYYYYYYY</ns1:Password>
        </ns1:UsernameToken>
    </ns1:Security>
</env:Header>

Thanks in advance J.

Answer 1

Are many ways to do that. The CustomBinding is more flexible because it allow more controll, for that i propose you with that. Pasing header to endpoint is a simple way:

// binding
var binding = new CustomBinding();
binding.Elements.Clear();
binding.Elements.Add(new TextMessageEncodingBindingElement{MessageVersion = MessageVersion.Soap12});
binding.Elements.Add(new HttpTransportBindingElement{MaxReceivedMessageSize = 20000000,});
// endpoint
var endpoint = new EndpointAddress(new Uri(listeningUri), new MySecurityHeader())
var client = new Client(binding, endpoint);
client.SomeMethod();

where MySecurityHeader is an AddressHeader, for example:

    public class MySecurityHeader : AddressHeader
    {
        public override string Name
        {
            get { return "Security"; }
        }

        public override string Namespace
        {
            get { return "<provide the appropiate namespace>"; }
        }

        protected override void OnWriteAddressHeaderContents(System.Xml.XmlDictionaryWriter writer)
        {
            // here you do what you want
            writer.WriteRaw(String.Format(@"
             <UsernameToken xmlns=""http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"">
             <Username>user</Username>
             <Password Type=""http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"">pass</Password>
             </UsernameToken>").Trim());
        }
    }

Answer 2

this is an example using an IEndpointAdress

    var customBinding = new CustomBinding();
    customBinding.Elements.Add(new TextMessageEncodingBindingElement { MessageVersion = MessageVersion.Soap12, });
    customBinding.Elements.Add(new HttpTransportBindingElement { MaxReceivedMessageSize = 20000000, });

    var endpointAddres = new EndpointAddress(listeningUri);

    var client = new Client(customBinding, endpointAddres);
    // add my own IEndpointBehavior
    client.ChannelFactory.Endpoint.Behaviors.Add(new CustomBehavior());
    client.SomeMethod();

and this is the CustomBehavior definition

public class CustomBehavior : IEndpointBehavior
{
    public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters)
    {}

    public void ApplyClientBehavior(ServiceEndpoint endpoint, System.ServiceModel.Dispatcher.ClientRuntime clientRuntime)
    {
        var inspector = new CustomMessageInspector();
        clientRuntime.MessageInspectors.Add(inspector);
    }

    public void ApplyDispatchBehavior(ServiceEndpoint endpoint, System.ServiceModel.Dispatcher.EndpointDispatcher endpointDispatcher)
    {}

    public void Validate(ServiceEndpoint endpoint)
    {}
}

public class CustomMessageInspector : IClientMessageInspector
{
    public void AfterReceiveReply(ref Message reply, object correlationState)
    {}

    public object BeforeSendRequest(ref Message request, IClientChannel channel)
    {
        request.Headers.Add(new MyMessageHeader());
        return null;
    }
}

public class MyMessageHeader : MessageHeader
{

    protected override void OnWriteHeaderContents(XmlDictionaryWriter writer, MessageVersion messageVersion)
    {
        writer.WriteRaw(String.Format(@"
        <UsernameToken xmlns=""http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"">
        <Username>user</Username>
        <Password Type=""http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"">pass</Password>
        </UsernameToken>").Trim());
    }

    public override string Name
    {
        get { return "MyHeaderName"; }
    }

    public override string Namespace
    {
        get { return "MyHeaderNamespace"; }
    }
}

Note you have control before send the request and after receive your reply.
I hope this resolve your issue, if you have some problems with this yust ask me.