如何从 C# 将用户名和密码传递给 Web 服务调用的 SOAP 标头？

Question

我想编写一个 C# 代码来调用另一台机器上的（远程）Web 服务。为此，我必须在调用的 SOAP 标头中传递用户名和密码。

我想知道一个用 C# 编写的代码示例。

生成的 XML 应该是这样的：

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

提前致谢 J.

Answer 1

有很多方法可以做到这一点。 CustomBinding 更灵活，因为它允许更多控制，为此我建议您这样做。将标头传递到端点是一种简单的方法：

// 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();

其中 MySecurityHeader 是 AddressHeader，例如：

    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

这是一个使用 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();

这是自定义行为定义

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"; }
    }
}

请注意，您可以在发送请求之前和收到回复之后进行控制。
我希望这能解决您的问题，如果您对此有任何问题可以问我。