Export (0) Print
Expand All

AsymmetricSecurityBindingElement Class

Represents a custom binding element that supports channel security using asymmetric encryption. This binding element signs the message using the sender's authentication token and encrypts the message using the recipient's token.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

'Declaration
Public NotInheritable Class AsymmetricSecurityBindingElement _
	Inherits SecurityBindingElement _
	Implements IPolicyExportExtension

The AsymmetricSecurityBindingElement type exposes the following members.

  NameDescription
Public methodAsymmetricSecurityBindingElementCreates an instance of this class.
Public methodAsymmetricSecurityBindingElement(SecurityTokenParameters)Initializes a new instance of AsymmetricSecurityBindingElement with the specified recipient token parameters.
Public methodAsymmetricSecurityBindingElement(SecurityTokenParameters, SecurityTokenParameters)Initializes a new instance of AsymmetricSecurityBindingElement with the specified recipient and initiator token parameters.
Top

  NameDescription
Public propertyAllowInsecureTransportGets or sets a value that indicates whether mixed-mode secured messages can be sent over an unsecured transport such as HTTP. (Inherited from SecurityBindingElement.)
Public propertyAllowSerializedSigningTokenOnReplyGets or sets a value that indicates whether serializing a signing token on a reply message is allowed.
Public propertyDefaultAlgorithmSuiteGets or sets the message encryption and key-wrap algorithms. (Inherited from SecurityBindingElement.)
Public propertyEnableUnsecuredResponseGets or sets a value that indicates whether WCF can send and receive unsecured responses to secured requests. (Inherited from SecurityBindingElement.)
Public propertyEndpointSupportingTokenParametersGets the endpoint that supports token parameters. (Inherited from SecurityBindingElement.)
Public propertyIncludeTimestampGets or sets a value that indicates whether time stamps are included in each message. (Inherited from SecurityBindingElement.)
Public propertyInitiatorTokenParametersSpecifies the token definition for the initiator.
Public propertyKeyEntropyModeGets or sets the source of entropy used to create keys. (Inherited from SecurityBindingElement.)
Public propertyLocalClientSettingsGets the binding properties specific to local security settings used by the client. (Inherited from SecurityBindingElement.)
Public propertyLocalServiceSettingsGets the binding properties specific to local security settings used by the service. (Inherited from SecurityBindingElement.)
Public propertyMessageProtectionOrderGets or sets the order of message encryption and signing for this binding.
Public propertyMessageSecurityVersionGets or sets the message security version. (Inherited from SecurityBindingElement.)
Public propertyOperationSupportingTokenParametersGets the collection of operation supporting token parameters. (Inherited from SecurityBindingElement.)
Public propertyOptionalEndpointSupportingTokenParametersGets the optional supporting token parameters for the service endpoint. (Inherited from SecurityBindingElement.)
Public propertyOptionalOperationSupportingTokenParametersGets the collection of optional operation supporting token parameters. (Inherited from SecurityBindingElement.)
Public propertyProtectTokensGets or sets whether the security binding element protects tokens. (Inherited from SecurityBindingElement.)
Public propertyRecipientTokenParametersSpecifies the token definition for the recipient.
Public propertyRequireSignatureConfirmationGets or sets a value that indicates whether message signatures must be confirmed.
Public propertySecurityHeaderLayoutGets or sets the ordering of the elements in the security header for this binding. (Inherited from SecurityBindingElement.)
Top

  NameDescription
Public methodBuildChannelFactory(Of TChannel)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). (Inherited from SecurityBindingElement.)
Public methodBuildChannelListener(Of TChannel)Creates a channel listener based on the SecurityBindingElement settings and the binding context passed in. (Inherited from SecurityBindingElement.)
Public methodCanBuildChannelFactory(Of TChannel)Determines whether a channel factory of the specified type can be built. (Inherited from SecurityBindingElement.)
Public methodCanBuildChannelListener(Of TChannel)Determines whether a channel listener of the specified type can be built. (Inherited from SecurityBindingElement.)
Public methodCloneCreates a new instance of this class initialized from the current one. (Overrides BindingElement.Clone.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetProperty(Of T)Gets a specified object from the BindingContext. (Overrides SecurityBindingElement.GetProperty(Of T)(BindingContext).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSetKeyDerivationSets a value that indicates whether derived keys are required. (Overrides SecurityBindingElement.SetKeyDerivation(Boolean).)
Public methodToStringReturns a string that represents this AsymmetricSecurityBindingElement instance. (Overrides SecurityBindingElement.ToString.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIPolicyExportExtension.ExportPolicyExports a custom policy assertion about bindings, which is added to the Web Services Description Language (WSDL) information.
Top

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 forth.

To add this class to a binding

  1. Create a BindingElementCollection.

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

  3. Add the created elements in the preceding order to the BindingElementCollection using the InsertItem(Int32, BindingElement) method.

  4. Create an instance of AsymmetricSecurityBindingElement and add it to the collection.

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

Before using this class, you should determine if a standard binding meets your security requirements.

NoteNote

Once an instance of this object is created, you should treat the properties of its base class SecurityBindingElement 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 run-time failure being the only indication of an issue. Two properties known to behave this way are KeyType and MessageSecurityVersion. There may be other properties this is true of.

The following example shows how to use this class to create a custom binding that includes this class as a security binding element. For more information about the code in this example, see How to: Consistently Reference X.509 Certificates.

		Public Function CreateClientBinding() As Binding
			'<snippet2> 
			Dim abe As AsymmetricSecurityBindingElement = CType(SecurityBindingElement.CreateMutualCertificateBindingElement(MessageSecurityVersion.WSSecurity10WSTrustFebruary2005WSSecureConversationFebruary2005WSSecurityPolicy11BasicSecurityProfile10), AsymmetricSecurityBindingElement)

			abe.SetKeyDerivation(False)

			Dim istp As X509SecurityTokenParameters = TryCast(abe.InitiatorTokenParameters, X509SecurityTokenParameters)
			If istp IsNot Nothing Then
				istp.X509ReferenceStyle = X509KeyIdentifierClauseType.IssuerSerial
			End If 
			Dim rstp As X509SecurityTokenParameters = TryCast(abe.RecipientTokenParameters, X509SecurityTokenParameters)
			If rstp IsNot Nothing Then
				rstp.X509ReferenceStyle = X509KeyIdentifierClauseType.IssuerSerial
			End If 

			Dim transport As New HttpTransportBindingElement()

			Return New CustomBinding(abe, transport)
		End Function

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft