carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class SslCredentials
   | gRPC for .NET </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class SslCredentials
   | gRPC for .NET ">
    <meta name="generator" content="docfx 2.36.0.0">
    
    <link rel="shortcut icon" href="../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" data-offset="120">
    <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="../logo.svg" 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">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </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="Grpc.Core.SslCredentials">
  
  
  <h1 id="Grpc_Core_SslCredentials" data-uid="Grpc.Core.SslCredentials" class="text-break">Class SslCredentials
  </h1>
  <div class="markdown level0 summary"><p>Client-side SSL credentials.</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"><a class="xref" href="Grpc.Core.ChannelCredentials.html">ChannelCredentials</a></div>
    <div class="level2"><span class="xref">SslCredentials</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="Grpc.Core.ChannelCredentials.html#Grpc_Core_ChannelCredentials_Insecure">ChannelCredentials.Insecure</a>
    </div>
    <div>
      <a class="xref" href="Grpc.Core.ChannelCredentials.html#Grpc_Core_ChannelCredentials_Create_Grpc_Core_ChannelCredentials_Grpc_Core_CallCredentials_">ChannelCredentials.Create(ChannelCredentials, CallCredentials)</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  <h5 id="Grpc_Core_SslCredentials_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public sealed class SslCredentials : ChannelCredentials</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  <h4 id="Grpc_Core_SslCredentials__ctor" data-uid="Grpc.Core.SslCredentials.#ctor">SslCredentials()</h4>
  <div class="markdown level1 summary"><p>Creates client-side SSL credentials loaded from
disk file pointed to by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable.
If that fails, gets the roots certificates from a well known place on disk.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SslCredentials()</code></pre>
  </div>
  <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  <h4 id="Grpc_Core_SslCredentials__ctor_System_String_" data-uid="Grpc.Core.SslCredentials.#ctor(System.String)">SslCredentials(String)</h4>
  <div class="markdown level1 summary"><p>Creates client-side SSL credentials from
a string containing PEM encoded root certificates.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SslCredentials(string rootCertificates)</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">rootCertificates</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  <h4 id="Grpc_Core_SslCredentials__ctor_System_String_Grpc_Core_KeyCertificatePair_" data-uid="Grpc.Core.SslCredentials.#ctor(System.String,Grpc.Core.KeyCertificatePair)">SslCredentials(String, KeyCertificatePair)</h4>
  <div class="markdown level1 summary"><p>Creates client-side SSL credentials.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SslCredentials(string rootCertificates, KeyCertificatePair keyCertificatePair)</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">rootCertificates</span></td>
        <td><p>string containing PEM encoded server root certificates.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a></td>
        <td><span class="parametername">keyCertificatePair</span></td>
        <td><p>a key certificate pair.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  <h4 id="Grpc_Core_SslCredentials__ctor_System_String_Grpc_Core_KeyCertificatePair_Grpc_Core_VerifyPeerCallback_" data-uid="Grpc.Core.SslCredentials.#ctor(System.String,Grpc.Core.KeyCertificatePair,Grpc.Core.VerifyPeerCallback)">SslCredentials(String, KeyCertificatePair, VerifyPeerCallback)</h4>
  <div class="markdown level1 summary"><p>Creates client-side SSL credentials.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SslCredentials(string rootCertificates, KeyCertificatePair keyCertificatePair, VerifyPeerCallback verifyPeerCallback)</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">rootCertificates</span></td>
        <td><p>string containing PEM encoded server root certificates.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a></td>
        <td><span class="parametername">keyCertificatePair</span></td>
        <td><p>a key certificate pair.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="Grpc.Core.VerifyPeerCallback.html">VerifyPeerCallback</a></td>
        <td><span class="parametername">verifyPeerCallback</span></td>
        <td><p>a callback to verify peer&apos;s target name and certificate.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <a id="Grpc_Core_SslCredentials_KeyCertificatePair_" data-uid="Grpc.Core.SslCredentials.KeyCertificatePair*"></a>
  <h4 id="Grpc_Core_SslCredentials_KeyCertificatePair" data-uid="Grpc.Core.SslCredentials.KeyCertificatePair">KeyCertificatePair</h4>
  <div class="markdown level1 summary"><p>Client side key and certificate pair.
If null, client will not use key and certificate pair.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public KeyCertificatePair KeyCertificatePair { get; }</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><a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="Grpc_Core_SslCredentials_RootCertificates_" data-uid="Grpc.Core.SslCredentials.RootCertificates*"></a>
  <h4 id="Grpc_Core_SslCredentials_RootCertificates" data-uid="Grpc.Core.SslCredentials.RootCertificates">RootCertificates</h4>
  <div class="markdown level1 summary"><p>PEM encoding of the server root certificates.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string RootCertificates { get; }</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="methods">Methods
  </h3>
  <a id="Grpc_Core_SslCredentials_InternalPopulateConfiguration_" data-uid="Grpc.Core.SslCredentials.InternalPopulateConfiguration*"></a>
  <h4 id="Grpc_Core_SslCredentials_InternalPopulateConfiguration_Grpc_Core_ChannelCredentialsConfiguratorBase_System_Object_" data-uid="Grpc.Core.SslCredentials.InternalPopulateConfiguration(Grpc.Core.ChannelCredentialsConfiguratorBase,System.Object)">InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase, Object)</h4>
  <div class="markdown level1 summary"><p>Populates channel credentials configurator with this instance&apos;s configuration.
End users never need to invoke this method as it is part of internal implementation.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override void InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase configurator, object state)</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><a class="xref" href="Grpc.Core.ChannelCredentialsConfiguratorBase.html">ChannelCredentialsConfiguratorBase</a></td>
        <td><span class="parametername">configurator</span></td>
        <td></td>
      </tr>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><span class="parametername">state</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="Grpc.Core.ChannelCredentials.html#Grpc_Core_ChannelCredentials_InternalPopulateConfiguration_Grpc_Core_ChannelCredentialsConfiguratorBase_System_Object_">ChannelCredentials.InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase, Object)</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>
            
            <span>Generated by <strong>DocFX</strong></span>
          </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>