366 lines
20 KiB
XML
366 lines
20 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="LocalClientSecuritySettings" FullName="System.ServiceModel.Channels.LocalClientSecuritySettings">
|
|
<TypeSignature Language="C#" Value="public sealed class LocalClientSecuritySettings" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit LocalClientSecuritySettings extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.ServiceModel</AssemblyName>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This class contains the local security settings used by the <see cref="T:System.ServiceModel.Channels.SecurityBindingElement" /> (and classes derived from it) to build the security channel. These settings are local to the client and are not determined from the service's security policy.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specifies local client security settings.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public LocalClientSecuritySettings ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.LocalClientSecuritySettings" /> class. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CacheCookies">
|
|
<MemberSignature Language="C#" Value="public bool CacheCookies { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool CacheCookies" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether secure conversation cookies are cached. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Clone">
|
|
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.LocalClientSecuritySettings Clone ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ServiceModel.Channels.LocalClientSecuritySettings Clone() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ServiceModel.Channels.LocalClientSecuritySettings</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Creates a new instance of this class, which is a copy or clone of the current instance.</para>
|
|
</summary>
|
|
<returns>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A new instance of <see cref="T:System.ServiceModel.Channels.LocalClientSecuritySettings" />.</para>
|
|
</returns>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CookieRenewalThresholdPercentage">
|
|
<MemberSignature Language="C#" Value="public int CookieRenewalThresholdPercentage { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 CookieRenewalThresholdPercentage" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The client caches secure conversation cookies and when a cached cookie is going to expire in the near future, the client automatically gets a new cookie from the service. The value of this property determines what percentage of the cached cookie's validity period must be over before getting a new cookie. For example, if the value of this property is 60, and the client has a secure conversation cookie that is valid for 100 minutes, it reuses the cached cookie for 60 minutes, after which it gets a new cookie from the service.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the threshold percentage for renewal of secure conversation cookies.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="DetectReplays">
|
|
<MemberSignature Language="C#" Value="public bool DetectReplays { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool DetectReplays" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether replay detection is enabled on messages the client receives from the service.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IdentityVerifier">
|
|
<MemberSignature Language="C#" Value="public System.ServiceModel.Security.IdentityVerifier IdentityVerifier { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Security.IdentityVerifier IdentityVerifier" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.ServiceModel.Security.IdentityVerifier</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>This property is used to verify that the remote endpoint that the client channel is communicating with matches the identity specified in the <see cref="T:System.ServiceModel.EndpointAddress" /> that the channel is targeted for.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the identity verifier.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxClockSkew">
|
|
<MemberSignature Language="C#" Value="public TimeSpan MaxClockSkew { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxClockSkew" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Messages between systems whose clocks' difference exceeds the value specified in this property are rejected.</para>
|
|
<para>This property is used in conjunction with the message time stamp verification and the <see cref="P:System.ServiceModel.Channels.LocalClientSecuritySettings.ReplayWindow" /> property.</para>
|
|
<para>crdefault <format type="text/html"><a href="491d1705-eb29-43c2-a44c-c0cf996f74eb">How To: Set a Max Clock Skew</a></format>.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum allowable time difference between the system clocks of the two parties that are communicating. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MaxCookieCachingTime">
|
|
<MemberSignature Language="C#" Value="public TimeSpan MaxCookieCachingTime { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MaxCookieCachingTime" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum caching time for secure conversation cookies. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReconnectTransportOnFailure">
|
|
<MemberSignature Language="C#" Value="public bool ReconnectTransportOnFailure { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool ReconnectTransportOnFailure" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If this flag is set to true, the client tries to send messages that correspond to a single security session over multiple transport connections. It establishes a new transport connection if the previous connection fails. This is useful in the case of secure WS-ReliableMessaging because the client requires the session to tolerate transient transport failures.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value that indicates whether security sessions attempt to reconnect after transport failures.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReplayCacheSize">
|
|
<MemberSignature Language="C#" Value="public int ReplayCacheSize { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 ReplayCacheSize" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <newTerm>nonce</newTerm> is a "number used once", often a random number used in an authentication protocol to ensure that old communications cannot be used in an attack by using replays.</para>
|
|
<para>If the nonce count is exceeded, the incoming message is rejected and a <see cref="T:System.ServiceModel.Security.MessageSecurityException" /> is thrown. Old nonces are removed in a timely manner.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the number of cached nonces used for replay detection. </para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ReplayWindow">
|
|
<MemberSignature Language="C#" Value="public TimeSpan ReplayWindow { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan ReplayWindow" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>A <newTerm>nonce</newTerm> is a "number used once", often a random number used in an authentication protocol to ensure that old communications cannot be used in an attack by using replays.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum time that a message nonce is valid.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SessionKeyRenewalInterval">
|
|
<MemberSignature Language="C#" Value="public TimeSpan SessionKeyRenewalInterval { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan SessionKeyRenewalInterval" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Session settings such as this one are applicable under any of the following conditions:</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>All client credential types for <see cref="T:System.ServiceModel.WSDualHttpBinding" /> and <see cref="T:System.ServiceModel.NetTcpBinding" />.</para>
|
|
</item>
|
|
<item>
|
|
<para>If <format type="text/html"><a href="9c93818a-7dfa-43d5-b3a1-1aafccf3a00b"><reliableSession> element</a></format> is enabled.</para>
|
|
</item>
|
|
<item>
|
|
<para>If <format type="text/html"><a href="9c93818a-7dfa-43d5-b3a1-1aafccf3a00b"><reliableSession> element</a></format> is not enabled, on <see cref="T:System.ServiceModel.WSHttpBinding" /> with <see cref="P:System.ServiceModel.Description.ClientCredentials.UserName" /> = true or <see cref="P:System.ServiceModel.Description.ClientCredentials.Windows" /> = true.</para>
|
|
</item>
|
|
</list>
|
|
<para>Session settings such as this one are not applicable under any of the following conditions:</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>For <see cref="T:System.ServiceModel.BasicHttpBinding" />.</para>
|
|
</item>
|
|
<item>
|
|
<para>For <see cref="T:System.ServiceModel.NetNamedPipeBinding" />.</para>
|
|
</item>
|
|
<item>
|
|
<para>If <format type="text/html"><a href="9c93818a-7dfa-43d5-b3a1-1aafccf3a00b"><reliableSession> element</a></format> is not enabled, on <see cref="T:System.ServiceModel.WSHttpBinding" /> with <see cref="P:System.ServiceModel.Description.ClientCredentials.ClientCertificate" /> = true or with none of the <see cref="T:System.ServiceModel.Description.ClientCredentials" /> properties set to true.</para>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the time span after which the initiator renews the key for the security session.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SessionKeyRolloverInterval">
|
|
<MemberSignature Language="C#" Value="public TimeSpan SessionKeyRolloverInterval { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan SessionKeyRolloverInterval" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>After key renewal, the client and the server should always send messages using the most current available key. Both parties can accept incoming messages secured with the previous session key until the rollover time expires.</para>
|
|
<para>Session settings such as this one are applicable under any of the following conditions:</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>All client credential types for <see cref="T:System.ServiceModel.WSDualHttpBinding" /> and <see cref="T:System.ServiceModel.NetTcpBinding" />.</para>
|
|
</item>
|
|
<item>
|
|
<para>If <format type="text/html"><a href="9c93818a-7dfa-43d5-b3a1-1aafccf3a00b"><reliableSession> element</a></format> is enabled.</para>
|
|
</item>
|
|
<item>
|
|
<para>If <format type="text/html"><a href="9c93818a-7dfa-43d5-b3a1-1aafccf3a00b"><reliableSession> element</a></format> is not enabled, on <see cref="T:System.ServiceModel.WSHttpBinding" /> with <see cref="P:System.ServiceModel.Description.ClientCredentials.UserName" /> = true or <see cref="P:System.ServiceModel.Description.ClientCredentials.windows" /> = true.</para>
|
|
</item>
|
|
</list>
|
|
<para>Session settings such as this one are not applicable under any of the following conditions:</para>
|
|
<list type="bullet">
|
|
<item>
|
|
<para>For <see cref="T:System.ServiceModel.BasicHttpBinding" />.</para>
|
|
</item>
|
|
<item>
|
|
<para>For <see cref="T:System.ServiceModel.NetNamedPipeBinding" />.</para>
|
|
</item>
|
|
<item>
|
|
<para>If <format type="text/html"><a href="9c93818a-7dfa-43d5-b3a1-1aafccf3a00b"><reliableSession> element</a></format> is not enabled, on <see cref="T:System.ServiceModel.WSHttpBinding" /> with <see cref="P:System.ServiceModel.Description.ClientCredentials.ClientCertificate" /> = true or with none of the <see cref="T:System.ServiceModel.Description.ClientCredentials" /> properties set to true.</para>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the time interval for which the previous session key is valid on incoming messages during a key renewal.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TimestampValidityDuration">
|
|
<MemberSignature Language="C#" Value="public TimeSpan TimestampValidityDuration { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan TimestampValidityDuration" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets the maximum duration that the messages are valid when sent by the client. If a message is received by the service after this duration, it should discard the message.</para>
|
|
</summary>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type> |