PeerCredential.xml

<Type Name="PeerCredential" FullName="System.ServiceModel.Security.PeerCredential">
  <TypeSignature Language="C#" Value="public class PeerCredential" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PeerCredential extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.ServiceModel.Security.PeerCredential" />
  <TypeSignature Language="VB.NET" Value="Public Class PeerCredential" />
  <TypeSignature Language="F#" Value="type PeerCredential = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class PeerCredential" />
  <AssemblyInfo>
    <AssemblyName>System.ServiceModel</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Contains the credentials used when authenticating a peer node within a peer mesh.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Instances of this class are used to specify the credentials needed for the particular security mode of a peer mesh. An instance of this type can be accessed using <xref:System.ServiceModel.ChannelFactory.Credentials%2A> or <xref:System.ServiceModel.ServiceHostBase.Credentials%2A>.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Certificate">
      <MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.Security.PeerCredential.Certificate" />
      <MemberSignature Language="VB.NET" Value="Public Property Certificate As X509Certificate2" />
      <MemberSignature Language="F#" Value="member this.Certificate : System.Security.Cryptography.X509Certificates.X509Certificate2 with get, set" Usage="System.ServiceModel.Security.PeerCredential.Certificate" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Security::Cryptography::X509Certificates::X509Certificate2 ^ Certificate { System::Security::Cryptography::X509Certificates::X509Certificate2 ^ get(); void set(System::Security::Cryptography::X509Certificates::X509Certificate2 ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets an X509 certificate for the peer.</summary>
        <value>The X509 certificate for the peer.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This property contains a <xref:System.Security.Cryptography.X509Certificates.X509Certificate2> instance used when authenticating neighbors in the peer mesh. An instance must be specified if the credential type chosen is PeerTransportCredentialType.<xref:System.ServiceModel.Security.PeerCredential.Certificate%2A>. If PeerTransportCredentialType.<xref:System.ServiceModel.PeerTransportCredentialType.Password> is chosen, this property is optional.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="MeshPassword">
      <MemberSignature Language="C#" Value="public string MeshPassword { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string MeshPassword" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.Security.PeerCredential.MeshPassword" />
      <MemberSignature Language="VB.NET" Value="Public Property MeshPassword As String" />
      <MemberSignature Language="F#" Value="member this.MeshPassword : string with get, set" Usage="System.ServiceModel.Security.PeerCredential.MeshPassword" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ MeshPassword { System::String ^ get(); void set(System::String ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the password used by the peer to authenticate with the peer mesh.</summary>
        <value>The password used by the peer to authenticate with the peer mesh.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MessageSenderAuthentication">
      <MemberSignature Language="C#" Value="public System.ServiceModel.Security.X509PeerCertificateAuthentication MessageSenderAuthentication { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Security.X509PeerCertificateAuthentication MessageSenderAuthentication" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.Security.PeerCredential.MessageSenderAuthentication" />
      <MemberSignature Language="VB.NET" Value="Public Property MessageSenderAuthentication As X509PeerCertificateAuthentication" />
      <MemberSignature Language="F#" Value="member this.MessageSenderAuthentication : System.ServiceModel.Security.X509PeerCertificateAuthentication with get, set" Usage="System.ServiceModel.Security.PeerCredential.MessageSenderAuthentication" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::ServiceModel::Security::X509PeerCertificateAuthentication ^ MessageSenderAuthentication { System::ServiceModel::Security::X509PeerCertificateAuthentication ^ get(); void set(System::ServiceModel::Security::X509PeerCertificateAuthentication ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.ServiceModel.Security.X509PeerCertificateAuthentication</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the message sender authentication validator.</summary>
        <value>The message sender authentication validator.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This property must be populated if message authentication is chosen. This property specifies a validator, which will be invoked during message security verification. The credential specified in the message is passed to the validator specified in this property. The validator can either accept or reject the credential.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="PeerAuthentication">
      <MemberSignature Language="C#" Value="public System.ServiceModel.Security.X509PeerCertificateAuthentication PeerAuthentication { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.Security.X509PeerCertificateAuthentication PeerAuthentication" />
      <MemberSignature Language="DocId" Value="P:System.ServiceModel.Security.PeerCredential.PeerAuthentication" />
      <MemberSignature Language="VB.NET" Value="Public Property PeerAuthentication As X509PeerCertificateAuthentication" />
      <MemberSignature Language="F#" Value="member this.PeerAuthentication : System.ServiceModel.Security.X509PeerCertificateAuthentication with get, set" Usage="System.ServiceModel.Security.PeerCredential.PeerAuthentication" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::ServiceModel::Security::X509PeerCertificateAuthentication ^ PeerAuthentication { System::ServiceModel::Security::X509PeerCertificateAuthentication ^ get(); void set(System::ServiceModel::Security::X509PeerCertificateAuthentication ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.ServiceModel.Security.X509PeerCertificateAuthentication</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the peer authentication object.</summary>
        <value>The peer authentication object.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This property specifies a validator, which is invoked during neighbor-to-neighbor authentication in the mesh. When a new peer tries to establish a neighbor connection, it passes its own credential to the responding peer. The validator of the responder is invoked to verify the credential of the remote party. Whenever a peer connection is established in the mesh, both peers are mutually authenticated, meaning validators on both ends are invoked.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <MemberGroup MemberName="SetCertificate">
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Sets the certificate.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName="SetCertificate">
      <MemberSignature Language="C#" Value="public void SetCertificate (string subjectName, System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, System.Security.Cryptography.X509Certificates.StoreName storeName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCertificate(string subjectName, valuetype System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, valuetype System.Security.Cryptography.X509Certificates.StoreName storeName) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Security.PeerCredential.SetCertificate(System.String,System.Security.Cryptography.X509Certificates.StoreLocation,System.Security.Cryptography.X509Certificates.StoreName)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetCertificate (subjectName As String, storeLocation As StoreLocation, storeName As StoreName)" />
      <MemberSignature Language="F#" Value="member this.SetCertificate : string * System.Security.Cryptography.X509Certificates.StoreLocation * System.Security.Cryptography.X509Certificates.StoreName -&gt; unit" Usage="peerCredential.SetCertificate (subjectName, storeLocation, storeName)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void SetCertificate(System::String ^ subjectName, System::Security::Cryptography::X509Certificates::StoreLocation storeLocation, System::Security::Cryptography::X509Certificates::StoreName storeName);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="subjectName" Type="System.String" />
        <Parameter Name="storeLocation" Type="System.Security.Cryptography.X509Certificates.StoreLocation" />
        <Parameter Name="storeName" Type="System.Security.Cryptography.X509Certificates.StoreName" />
      </Parameters>
      <Docs>
        <param name="subjectName">The subject name of the certificate.</param>
        <param name="storeLocation">The location of the certificate store.</param>
        <param name="storeName">The certificate store name.</param>
        <summary>Sets the certificate.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This overload is used to specify a certificate credential of the peer. It is provided as a shortcut to load the certificate from one of the available certificate stores that the user has access to.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SetCertificate">
      <MemberSignature Language="C#" Value="public void SetCertificate (System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, System.Security.Cryptography.X509Certificates.StoreName storeName, System.Security.Cryptography.X509Certificates.X509FindType findType, object findValue);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetCertificate(valuetype System.Security.Cryptography.X509Certificates.StoreLocation storeLocation, valuetype System.Security.Cryptography.X509Certificates.StoreName storeName, valuetype System.Security.Cryptography.X509Certificates.X509FindType findType, object findValue) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ServiceModel.Security.PeerCredential.SetCertificate(System.Security.Cryptography.X509Certificates.StoreLocation,System.Security.Cryptography.X509Certificates.StoreName,System.Security.Cryptography.X509Certificates.X509FindType,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetCertificate (storeLocation As StoreLocation, storeName As StoreName, findType As X509FindType, findValue As Object)" />
      <MemberSignature Language="F#" Value="member this.SetCertificate : System.Security.Cryptography.X509Certificates.StoreLocation * System.Security.Cryptography.X509Certificates.StoreName * System.Security.Cryptography.X509Certificates.X509FindType * obj -&gt; unit" Usage="peerCredential.SetCertificate (storeLocation, storeName, findType, findValue)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void SetCertificate(System::Security::Cryptography::X509Certificates::StoreLocation storeLocation, System::Security::Cryptography::X509Certificates::StoreName storeName, System::Security::Cryptography::X509Certificates::X509FindType findType, System::Object ^ findValue);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ServiceModel</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="storeLocation" Type="System.Security.Cryptography.X509Certificates.StoreLocation" />
        <Parameter Name="storeName" Type="System.Security.Cryptography.X509Certificates.StoreName" />
        <Parameter Name="findType" Type="System.Security.Cryptography.X509Certificates.X509FindType" />
        <Parameter Name="findValue" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="storeLocation">The location of the certificate store.</param>
        <param name="storeName">The certificate store name.</param>
        <param name="findType">The search criteria.</param>
        <param name="findValue">The value to search on.</param>
        <summary>Sets the certificate with the specified search criteria.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>