SecurityBindingElement Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

SecurityBindingElement.cs

An abstract class that, when implemented, represents a binding element that supports channel SOAP message security.

public ref class SecurityBindingElement abstract : System::ServiceModel::Channels::BindingElement

public abstract class SecurityBindingElement : System.ServiceModel.Channels.BindingElement

type SecurityBindingElement = class
    inherit BindingElement

Public MustInherit Class SecurityBindingElement
Inherits BindingElement

Inheritance

Object

BindingElement

SecurityBindingElement

Derived

System.ServiceModel.Channels.AsymmetricSecurityBindingElement

System.ServiceModel.Channels.SymmetricSecurityBindingElement

System.ServiceModel.Channels.TransportSecurityBindingElement

Remarks

This class is the base class for the SOAP message security binding elements in WCF. There are three implementations of this abstract class: SymmetricSecurityBindingElement, AsymmetricSecurityBindingElement, and TransportSecurityBindingElement. These implementations model the bindings defined in the WS-Security Policy specification.

A custom binding contains a collection of binding elements arranged in a specific order: the element that represents the top of the binding stack is added first, the next element down in the binding stack is added second, and so on.

To add this class to a binding, do the following:

1. Create a BindingElementCollection.

2. Create a custom binding element that is above this binding element in the binding stack, such as the optional TransactionFlowBindingElement and ReliableSessionBindingElement.

3. Add these elements in the order previously described to the BindingElementCollection using the InsertItem method.

4. Create an instance of a security binding element derived from SecurityBindingElement, such as AsymmetricSecurityBindingElement, SymmetricSecurityBindingElement, or TransportSecurityBindingElement.

5. Add the derived security binding element to the collection.

6. Add any additional custom binding elements to the collection, such as TcpTransportBindingElement.

For more information about using a SecurityBindingElement, see SecurityBindingElement Authentication Modes and How to: Create a Custom Binding Using the SecurityBindingElement.

Note

Once a SecurityBindingElement object is created, you should treat its properties as immutable. Calling set on some properties may have unpredictable effects: the binding may behave as if the property retained its old value, with a runtime failure being the only indication of an issue. Two properties known to behave this way are KeyType and MessageSecurityVersion. There may be other properties of which this is also true.

Properties

DefaultAlgorithmSuite	Gets or sets the message encryption and key-wrap algorithms.
EnableUnsecuredResponse	Gets or sets a value that indicates whether WCF can send and receive unsecured responses to secured requests.
EndpointSupportingTokenParameters	Gets the endpoint that supports token parameters.
IncludeTimestamp	Gets or sets a value that indicates whether time stamps are included in each message.
KeyEntropyMode	Gets or sets the source of entropy used to create keys.
LocalClientSettings	Gets the binding properties specific to local security settings used by the client.
MessageSecurityVersion	Gets or sets the message security version.
SecurityHeaderLayout	Gets or sets the ordering of the elements in the security header for this binding.

Methods

BuildChannelFactory<TChannel>(BindingContext)	Creates a channel factory based on the SecurityBindingElement settings and the binding context passed in. The channel factory created is a SOAP message security channel factory, which internally has a reference to the channel factory that corresponds to the binding context, (which includes the transport channel factory).
BuildChannelFactoryCore<TChannel>(BindingContext)	When implemented, creates a channel factory of a specified type.
BuildChannelListener<TChannel>(BindingContext)	Initializes a channel listener to accept channels of a specified type from the binding context. (Inherited from BindingElement)
CanBuildChannelFactory<TChannel>(BindingContext)	Determines whether a channel factory of the specified type can be built.
CanBuildChannelListener<TChannel>(BindingContext)	Returns a value that indicates whether the binding element can build a listener for a specific type of channel. (Inherited from BindingElement)
Clone()	When overridden in a derived class, returns a copy of the binding element object. (Inherited from BindingElement)
CreateCertificateOverTransportBindingElement()	Creates a security binding element that expects clients to do certificate-based authentication using SOAP message security.
CreateCertificateOverTransportBindingElement(MessageSecurityVersion)	Creates a security binding element that expects clients to do certificate-based authentication using SOAP message security.
CreateIssuedTokenOverTransportBindingElement(IssuedSecurityTokenParameters)	Creates a security binding element configured to require SOAP security based client authentication using an issued token. This binding element requires the transport to provide server authentication and message protection (for example, HTTPS).
CreateSecureConversationBindingElement(SecurityBindingElement)	Creates a symmetric security binding element that is configured to establish a secure conversation between the client and service. The security context token issued at the end of the secure conversation handshake is used to secure the messages. The bootstrap security binding element specifies how the secure conversation handshake messages are secured.
CreateUserNameOverTransportBindingElement()	Creates a security binding element that is configured for client authentication based on a user name and password sent as part of the SOAP message. The binding element requires the transport to provide server authentication and message protection (for example, HTTPS).
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>(BindingContext)	Gets a specified object using the specified BindingContext.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a description of this class.

See also

• SecurityBindingElement Authentication Modes
• How To: Create a Custom Binding Using the SecurityBindingElement