mcs/class/Mono.Posix/Documentation/en/Mono.Unix/PeerCred.xml

   1 <Type Name="PeerCred" FullName="Mono.Unix.PeerCred">
   2   <TypeSignature Language="C#" Value="public class PeerCred" />
   3   <AssemblyInfo>
   4     <AssemblyName>Mono.Posix</AssemblyName>
   5     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Object</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <summary>When using Unix domain sockets (via <see cref="T:Mono.Unix.UnixEndPoint" /> or <see cref="T:Mono.Unix.UnixClient" />, for example) most operating systems support the passing of credentials through the socket.  Generally, the process id (PID) of the application on the other side of the connection as well as the group ID (GID) and user ID (UID) of the executing user are available.  This is done via the kernel and cannot be spoofed, so this can be used to reliably authenticate a Unix socket connection.
  14 </summary>
  15     <remarks>Not all operating systems support this and the values of <see cref="P:Mono.Unix.PeerCred.GroupID" />, <see cref="P:Mono.Unix.PeerCred.ProcessID" />, and <see cref="P:Mono.Unix.PeerCred.UserID" /> may all be zero.</remarks>
  16   </Docs>
  17   <Members>
  18     <Member MemberName=".ctor">
  19       <MemberSignature Language="C#" Value="public PeerCred (System.Net.Sockets.Socket sock);" />
  20       <MemberType>Constructor</MemberType>
  21       <Parameters>
  22         <Parameter Name="sock" Type="System.Net.Sockets.Socket" />
  23       </Parameters>
  24       <Docs>
  25         <param name="sock">A <see cref="T:System.Net.Sockets.Socket" />, but this must be a Unix domain socket.</param>
  26         <summary>Reads the peer credentials from a Unix domain socket.</summary>
  27         <remarks>If the <see cref="T:System.Net.Sockets.Socket" /> passed in is not a Unix domain socket, <see cref="T:System.ArgumentException" /> is thrown.</remarks>
  28       </Docs>
  29       <AssemblyInfo>
  30         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  31         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  32       </AssemblyInfo>
  33     </Member>
  34     <Member MemberName="GroupID">
  35       <MemberSignature Language="C#" Value="public int GroupID { get; }" />
  36       <MemberType>Property</MemberType>
  37       <ReturnValue>
  38         <ReturnType>System.Int32</ReturnType>
  39       </ReturnValue>
  40       <Docs>
  41         <summary>The Unix group ID</summary>
  42         <value>The Unix group ID of the connection's peer.</value>
  43         <remarks />
  44       </Docs>
  45       <AssemblyInfo>
  46         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  47         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  48       </AssemblyInfo>
  49     </Member>
  50     <Member MemberName="ProcessID">
  51       <MemberSignature Language="C#" Value="public int ProcessID { get; }" />
  52       <MemberType>Property</MemberType>
  53       <ReturnValue>
  54         <ReturnType>System.Int32</ReturnType>
  55       </ReturnValue>
  56       <Docs>
  57         <summary>The process ID</summary>
  58         <value>The process ID of the connection's peer.</value>
  59         <remarks />
  60       </Docs>
  61       <AssemblyInfo>
  62         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  63         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  64       </AssemblyInfo>
  65     </Member>
  66     <Member MemberName="UserID">
  67       <MemberSignature Language="C#" Value="public int UserID { get; }" />
  68       <MemberType>Property</MemberType>
  69       <ReturnValue>
  70         <ReturnType>System.Int32</ReturnType>
  71       </ReturnValue>
  72       <Docs>
  73         <summary>The Unix user ID</summary>
  74         <value>The Unix user ID of the connection's peer.</value>
  75         <remarks />
  76       </Docs>
  77       <AssemblyInfo>
  78         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  79         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  80       </AssemblyInfo>
  81     </Member>
  82   </Members>
  83 </Type>