blob: f8284bfd397d3df47482d69876d746ae9bcf398b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class SslStreamFactory
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SslStreamFactory
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items"></div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Client.SslStreamFactory">
<h1 id="Apache_Ignite_Core_Client_SslStreamFactory" data-uid="Apache.Ignite.Core.Client.SslStreamFactory" class="text-break">Class SslStreamFactory
</h1>
<div class="markdown level0 summary"><p>Predefined SSL stream factory, loads certificate from specified file.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">SslStreamFactory</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Apache.Ignite.Core.Client.ISslStreamFactory.html">ISslStreamFactory</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Client.html">Apache.Ignite.Core.Client</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Client_SslStreamFactory_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SslStreamFactory : ISslStreamFactory</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Client_SslStreamFactory__ctor_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory__ctor" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.#ctor">SslStreamFactory()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Client.SslStreamFactory.html">SslStreamFactory</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SslStreamFactory()</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_DefaultSslProtocols" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.DefaultSslProtocols">DefaultSslProtocols</h4>
<div class="markdown level1 summary"><p>Default SSL protocols.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const SslProtocols DefaultSslProtocols = SslProtocols.Tls</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Security.Authentication.SslProtocols</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Client_SslStreamFactory_CertificatePassword_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.CertificatePassword*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_CertificatePassword" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.CertificatePassword">CertificatePassword</h4>
<div class="markdown level1 summary"><p>Gets or sets the certificate file password.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string CertificatePassword { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_SslStreamFactory_CertificatePath_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.CertificatePath*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_CertificatePath" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.CertificatePath">CertificatePath</h4>
<div class="markdown level1 summary"><p>Gets or sets the certificate file (pfx) path.
<p>
Java certificates can be converted with <code>keytool</code>:
<code>keytool -importkeystore -srckeystore thekeystore.jks -srcstoretype JKS
-destkeystore thekeystore.pfx -deststoretype PKCS12</code></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string CertificatePath { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_SslStreamFactory_CheckCertificateRevocation_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.CheckCertificateRevocation*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_CheckCertificateRevocation" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.CheckCertificateRevocation">CheckCertificateRevocation</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the certificate revocation list is checked during authentication.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool CheckCertificateRevocation { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_SslStreamFactory_SkipServerCertificateValidation_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.SkipServerCertificateValidation*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_SkipServerCertificateValidation" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.SkipServerCertificateValidation">SkipServerCertificateValidation</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether to ignore invalid remote (server) certificates.
This may be useful for testing with self-signed certificates.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool SkipServerCertificateValidation { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_SslStreamFactory_SslProtocols_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.SslProtocols*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_SslProtocols" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.SslProtocols">SslProtocols</h4>
<div class="markdown level1 summary"><p>Gets or sets the SSL protocols.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SslProtocols SslProtocols { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Security.Authentication.SslProtocols</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Client_SslStreamFactory_Create_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.Create*"></a>
<h4 id="Apache_Ignite_Core_Client_SslStreamFactory_Create_System_IO_Stream_System_String_" data-uid="Apache.Ignite.Core.Client.SslStreamFactory.Create(System.IO.Stream,System.String)">Create(Stream, String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SslStream Create(Stream stream, string targetHost)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.Stream</span></td>
<td><span class="parametername">stream</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">targetHost</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Net.Security.SslStream</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Apache.Ignite.Core.Client.ISslStreamFactory.html">ISslStreamFactory</a>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2019 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>