Search code examples
c#ws-securitysoapheader

Unable to add WS-Security header to request built from web reference


I've consumed a WebReference and the receiving server requires a WS-Security header:

<wsse:UsernameToken wsu:Id="Example"> 
    <wsse:Username> ... </wsse:Username>
    <wsse:Password Type="..."> ... </wsse:Password>
    <wsse:Nonce EncodingType="..."> ... </wsse:Nonce>
    <wsu:Created> ... </wsu:Created>
</wsse:UsernameToken>

I'd assumed this would be included in the WSDL however after reading this post I understand that the logic should be separated.

The client class I use to perform the request contains a Proxy property IWebProxy:HttpWebClientProtocol. I believe this is where I should provide the header/override information. Please could someone confirm this?

I also have some code that I know generates the correct headers. However I'm unsure how to specify these headers/elements without modifying the WebReference.

public static Tuple<EndpointAddress, BindingElementCollection, string, string> PrepareGlowsAuth(string endpoint)
{
    EndpointAddress soapEndpoint = new EndpointAddress(string.Format("{0}/{1}", (IsProduction ? productionBaseUrl : testingBaseUrl), endpoint));
    BasicHttpsBinding binding = new BasicHttpsBinding();
    binding.Security.Mode = BasicHttpsSecurityMode.TransportWithMessageCredential;
    binding.Security.Message.ClientCredentialType = BasicHttpMessageCredentialType.UserName;

    BindingElementCollection elements = binding.CreateBindingElements();
    elements.Find<SecurityBindingElement>().EnableUnsecuredResponse = true;

    return new Tuple<EndpointAddress, BindingElementCollection, string, string>(soapEndpoint, elements, "username", "password");
}

Would appreciate it if someone could point me in the right direction!

Update: After following advice I cant see the Client or Response classes.

Image to show the classes arent defined


Solution

  • The way you would go about injecting the credentials into the request without altering the client class is as follows:

    // Assume that you named your "Connected Service" com.example.foo
    
    foo.bar requestObj= new foo.bar();
    
    // Fill in your request object
    bar.FirstName = "Someone";
    // etc.
    
    // Set up the authentication using the function you provided
    var glowsAuthData = PrepareGlowsAuth("expressRateBook");
    
    // foo.<object name>Client is automatically created, this is the generated
    //   proxy class for communicating with the intended web service
    foo.barClient client = new foo.barClient(new CustomBinding(glowsAuthData.Item2)
                                             , glowsAuthData.Item1);
    client.ClientCredentials.UserName.UserName = glowsAuthData.Item3;
    client.ClientCredentials.UserName.Password = glowsAuthData.Item4;
    
    // Use the client to send the request object and populate the response object
    // foo.<object name>Response is automatically generated when VS generates 
    //   the code for "Connected Service". It also makes it the return type 
    //   for foo.barClient.barResponse(foo.bar);
    foo.barResponse responseObj = client.barResponse(requestObj);
    

    Assuming no exceptions, responseObj will contain the response from the server. No direct modification to the generated client created using the WSDL required.