mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
linux-packaging-mono/mcs/class/Mono.Security/Documentation/en/Mono.Security.Protocol.Tls/SslServerStream.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

512 lines
20 KiB
XML
Raw Blame History

<Type Name="SslServerStream" FullName="Mono.Security.Protocol.Tls.SslServerStream">
<TypeSignature Language="C#" Maintainer="auto" Value="public class SslServerStream : Mono.Security.Protocol.Tls.SslStreamBase" />
<AssemblyInfo>
<AssemblyName>Mono.Security</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 79 15 99 77 D2 D0 3A 8E 6B EA 7A 2E 74 E8 D1 AF CC 93 E8 85 19 74 95 2B B4 80 A1 2C 91 34 47 4D 04 06 24 47 C3 7E 0E 68 C0 80 53 6F CF 3C 3F BE 2F F9 C9 79 CE 99 84 75 E5 06 E8 CE 82 DD 5B 0F 35 0D C1 0E 93 BF 2E EE CF 87 4B 24 77 0C 50 81 DB EA 74 47 FD DA FA 27 7B 22 DE 47 D6 FF EA 44 96 74 A4 F9 FC CF 84 D1 50 69 08 93 80 28 4D BD D3 5F 46 CD FF 12 A1 BD 78 E4 EF 00 65 D0 16 DF]</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>Mono.Security.Protocol.Tls.SslStreamBase</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>Server-side SSL/TLS stream.</summary>
<remarks>
<example>
<code lang="C#">
using System;
using System.IO;
using System.Net;
using System.Net.Sockets;
using System.Text;
using Mono.Security.Authenticode;
using Mono.Security.Protocol.Tls;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
namespace SslHttpServer
{
class SslHttpServer
{
private static X509Certificate _certificate;
private static string certfile;
private static string keyfile;
static void Main (string [] args)
{
certfile = (args.Length &gt; 0) ? args [0] : "ssl.cer";
keyfile = (args.Length &gt; 0) ? args [0] : "ssl.pvk";
Socket listenSocket = new Socket (AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
IPEndPoint localEndPoint = new IPEndPoint (IPAddress.Any, 1888);
Socket requestSocket;
listenSocket.Bind (localEndPoint);
listenSocket.Listen (10);
while (true) {
try {
requestSocket = listenSocket.Accept ();
using (NetworkStream ns = new NetworkStream (requestSocket, FileAccess.ReadWrite, true)) {
using (SslServerStream s = new SslServerStream (ns, Certificate, false, false)) {
s.PrivateKeyCertSelectionDelegate += new PrivateKeySelectionCallback (GetPrivateKey);
StreamReader reader = new StreamReader (s);
StreamWriter writer = new StreamWriter (s, Encoding.ASCII);
string line;
string answer =
"HTTP/1.0 200\r\n" +
"Connection: close\r\n" +
"Content-Type: text/html\r\n" +
"Content-Encoding: " + Encoding.ASCII.WebName + "\r\n" +
"\r\n" +
"&lt;html&gt;&lt;body&gt;&lt;h1&gt;Hello World!&lt;/h1&gt;&lt;/body&gt;&lt;/html&gt;\r\n";
// Read request header
do {
line = reader.ReadLine ();
if (line != null)
Console.WriteLine (line);
}
while (line != null &amp;&amp; line.Length &gt; 0);
// Send response
writer.Write (answer);
writer.Flush ();
s.Flush ();
ns.Flush ();
}
}
}
catch (Exception ex) {
Console.WriteLine ("---------------------------------------------------------");
Console.WriteLine (ex.ToString ());
}
}
}
private static X509Certificate Certificate {
get {
if (_certificate == null)
_certificate = X509Certificate.CreateFromCertFile (certfile);
return _certificate;
}
}
// note: makecert creates the private key in the PVK format
private static AsymmetricAlgorithm GetPrivateKey (X509Certificate certificate, string targetHost)
{
PrivateKey key = PrivateKey.CreateFromFile (keyfile);
return key.RSA;
}
}
}
</code>
</example>
<para>
You can create a X.509 test certificate and it's private key with the following command:
<example><code>makecert -n "CN=localhost" -r -sv ssl.pvk ssl.cer
</code></example></para>
<para>Note: Thanks to Jörg Rosenkranz for the original code sample.</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SslServerStream (System.IO.Stream stream, System.Security.Cryptography.X509Certificates.X509Certificate serverCertificate);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="serverCertificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate" />
</Parameters>
<Docs>
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
<param name="serverCertificate">a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /></param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SslServerStream (System.IO.Stream stream, System.Security.Cryptography.X509Certificates.X509Certificate serverCertificate, bool clientCertificateRequired, bool ownsStream);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="serverCertificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate" />
<Parameter Name="clientCertificateRequired" Type="System.Boolean" />
<Parameter Name="ownsStream" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
<param name="serverCertificate">a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /></param>
<param name="clientCertificateRequired">a <see cref="T:System.Boolean" /></param>
<param name="ownsStream">a <see cref="T:System.Boolean" /></param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SslServerStream (System.IO.Stream stream, System.Security.Cryptography.X509Certificates.X509Certificate serverCertificate, bool clientCertificateRequired, bool ownsStream, Mono.Security.Protocol.Tls.SecurityProtocolType securityProtocolType);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
<Parameter Name="serverCertificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate" />
<Parameter Name="clientCertificateRequired" Type="System.Boolean" />
<Parameter Name="ownsStream" Type="System.Boolean" />
<Parameter Name="securityProtocolType" Type="Mono.Security.Protocol.Tls.SecurityProtocolType" />
</Parameters>
<Docs>
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
<param name="serverCertificate">a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /></param>
<param name="clientCertificateRequired">a <see cref="T:System.Boolean" /></param>
<param name="ownsStream">a <see cref="T:System.Boolean" /></param>
<param name="securityProtocolType">a <see cref="T:System.Int32" /></param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CanRead">
<MemberSignature Language="C#" Value="public override bool CanRead { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CanSeek">
<MemberSignature Language="C#" Value="public override bool CanSeek { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CanWrite">
<MemberSignature Language="C#" Value="public override bool CanWrite { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CheckCertRevocationStatus">
<MemberSignature Language="C#" Value="public bool CheckCertRevocationStatus { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CipherAlgorithm">
<MemberSignature Language="C#" Value="public Mono.Security.Protocol.Tls.CipherAlgorithmType CipherAlgorithm { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Mono.Security.Protocol.Tls.CipherAlgorithmType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Mono.Security.Protocol.Tls.CipherAlgorithmType" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CipherStrength">
<MemberSignature Language="C#" Value="public int CipherStrength { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ClientCertificate">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate ClientCertificate { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ClientCertValidationDelegate">
<MemberSignature Language="C#" Value="public Mono.Security.Protocol.Tls.CertificateValidationCallback ClientCertValidationDelegate { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Mono.Security.Protocol.Tls.CertificateValidationCallback</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Mono.Security.Protocol.Tls.CertificateValidationCallback" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">a <see cref="T:System.Boolean" /></param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~SslServerStream ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HashAlgorithm">
<MemberSignature Language="C#" Value="public Mono.Security.Protocol.Tls.HashAlgorithmType HashAlgorithm { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Mono.Security.Protocol.Tls.HashAlgorithmType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Mono.Security.Protocol.Tls.HashAlgorithmType" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="HashStrength">
<MemberSignature Language="C#" Value="public int HashStrength { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="KeyExchangeAlgorithm">
<MemberSignature Language="C#" Value="public Mono.Security.Protocol.Tls.ExchangeAlgorithmType KeyExchangeAlgorithm { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Mono.Security.Protocol.Tls.ExchangeAlgorithmType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Mono.Security.Protocol.Tls.ExchangeAlgorithmType" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="KeyExchangeStrength">
<MemberSignature Language="C#" Value="public int KeyExchangeStrength { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public override long Length { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int64" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Position">
<MemberSignature Language="C#" Value="public override long Position { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int64" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PrivateKeyCertSelectionDelegate">
<MemberSignature Language="C#" Value="public Mono.Security.Protocol.Tls.PrivateKeySelectionCallback PrivateKeyCertSelectionDelegate { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Mono.Security.Protocol.Tls.PrivateKeySelectionCallback</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Set the method that can find the private key associated with a specific X.509 certificate and a host name.</summary>
<value>a <see cref="T:Mono.Security.Protocol.Tls.PrivateKeySelectionCallback" /></value>
<remarks>See <see cref="T:Mono.Security.Protocol.Tls.PrivateKeySelectionCallback" /> for an example on how to use this delegate.</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SecurityProtocol">
<MemberSignature Language="C#" Value="public Mono.Security.Protocol.Tls.SecurityProtocolType SecurityProtocol { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Mono.Security.Protocol.Tls.SecurityProtocolType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Mono.Security.Protocol.Tls.SecurityProtocolType" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ServerCertificate">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate ServerCertificate { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /></value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
Reference in New Issue View Git Blame Copy Permalink