blob: 7c75ae37f04d971a15298eb7e3c45afdaf1ca72a [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 SslContextFactory
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SslContextFactory
| 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.Ssl.SslContextFactory">
<h1 id="Apache_Ignite_Core_Ssl_SslContextFactory" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory" class="text-break">Class SslContextFactory
</h1>
<div class="markdown level0 summary"><p>This SSL context factory that provides ssl context configuration with specified key and trust stores.</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">SslContextFactory</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Apache.Ignite.Core.Ssl.ISslContextFactory.html">ISslContextFactory</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.Ssl.html">Apache.Ignite.Core.Ssl</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Ssl_SslContextFactory_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Serializable]
public class SslContextFactory : ISslContextFactory</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Ssl_SslContextFactory__ctor_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory__ctor" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.#ctor">SslContextFactory()</h4>
<div class="markdown level1 summary"><p>Default constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SslContextFactory()</code></pre>
</div>
<a id="Apache_Ignite_Core_Ssl_SslContextFactory__ctor_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory__ctor_System_String_System_String_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.#ctor(System.String,System.String)">SslContextFactory(String, String)</h4>
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html">SslContextFactory</a> class.
Trust store file is not set that results in accepting any SSL Certificate.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SslContextFactory(string keyStoreFilePath, string keyStorePassword)</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.String</span></td>
<td><span class="parametername">keyStoreFilePath</span></td>
<td><p>Path to key store file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">keyStorePassword</span></td>
<td><p>Key store password.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Ssl_SslContextFactory__ctor_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory__ctor_System_String_System_String_System_String_System_String_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.#ctor(System.String,System.String,System.String,System.String)">SslContextFactory(String, String, String, String)</h4>
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html">SslContextFactory</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 SslContextFactory(string keyStoreFilePath, string keyStorePassword, string trustStoreFilePath, string trustStorePassword)</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.String</span></td>
<td><span class="parametername">keyStoreFilePath</span></td>
<td><p>Path to key store file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">keyStorePassword</span></td>
<td><p>Key store password.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">trustStoreFilePath</span></td>
<td><p>Path to trust store file.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">trustStorePassword</span></td>
<td><p>Trust store password.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_DefaultKeyAlgorithm" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.DefaultKeyAlgorithm">DefaultKeyAlgorithm</h4>
<div class="markdown level1 summary"><p>Default value for <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_KeyAlgorithm">KeyAlgorithm</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string DefaultKeyAlgorithm = &quot;SunX509&quot;</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_DefaultSslProtocol" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.DefaultSslProtocol">DefaultSslProtocol</h4>
<div class="markdown level1 summary"><p>Default value for <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_Protocol">Protocol</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string DefaultSslProtocol = &quot;TLS&quot;</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_DefaultStoreType" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.DefaultStoreType">DefaultStoreType</h4>
<div class="markdown level1 summary"><p>Default value for <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_KeyStoreType">KeyStoreType</a> and <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_TrustStoreType">TrustStoreType</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string DefaultStoreType = &quot;JKS&quot;</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Ssl_SslContextFactory_KeyAlgorithm_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyAlgorithm*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_KeyAlgorithm" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyAlgorithm">KeyAlgorithm</h4>
<div class="markdown level1 summary"><p>Key manager algorithm that will be used to create a key manager. Notice that in most cased default value
<a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_DefaultKeyAlgorithm">DefaultKeyAlgorithm</a> suites well, however, on Android platform this value need to be set
to X509.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyAlgorithm { 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_Ssl_SslContextFactory_KeyStoreFilePath_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyStoreFilePath*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_KeyStoreFilePath" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyStoreFilePath">KeyStoreFilePath</h4>
<div class="markdown level1 summary"><p>Key store file path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyStoreFilePath { 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_Ssl_SslContextFactory_KeyStorePassword_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyStorePassword*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_KeyStorePassword" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyStorePassword">KeyStorePassword</h4>
<div class="markdown level1 summary"><p>Key store 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 KeyStorePassword { 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_Ssl_SslContextFactory_KeyStoreType_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyStoreType*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_KeyStoreType" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.KeyStoreType">KeyStoreType</h4>
<div class="markdown level1 summary"><p>Key store type used for context creation. <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_DefaultStoreType">DefaultStoreType</a> by default.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string KeyStoreType { 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_Ssl_SslContextFactory_Protocol_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.Protocol*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_Protocol" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.Protocol">Protocol</h4>
<div class="markdown level1 summary"><p>Protocol for secure transport. <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_DefaultSslProtocol">DefaultSslProtocol</a> by default.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Protocol { 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_Ssl_SslContextFactory_TrustStoreFilePath_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.TrustStoreFilePath*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_TrustStoreFilePath" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.TrustStoreFilePath">TrustStoreFilePath</h4>
<div class="markdown level1 summary"><p>Path to trust store file. Could be null if any SSL Certificate should be accepted/succeed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TrustStoreFilePath { 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_Ssl_SslContextFactory_TrustStorePassword_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.TrustStorePassword*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_TrustStorePassword" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.TrustStorePassword">TrustStorePassword</h4>
<div class="markdown level1 summary"><p>Trust store 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 TrustStorePassword { 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_Ssl_SslContextFactory_TrustStoreType_" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.TrustStoreType*"></a>
<h4 id="Apache_Ignite_Core_Ssl_SslContextFactory_TrustStoreType" data-uid="Apache.Ignite.Core.Ssl.SslContextFactory.TrustStoreType">TrustStoreType</h4>
<div class="markdown level1 summary"><p>Trust store type used for context creation. <a class="xref" href="Apache.Ignite.Core.Ssl.SslContextFactory.html#Apache_Ignite_Core_Ssl_SslContextFactory_DefaultStoreType">DefaultStoreType</a> by default.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TrustStoreType { 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>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Apache.Ignite.Core.Ssl.ISslContextFactory.html">ISslContextFactory</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>