Grpc.Core.SslCredentials.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class SslCredentials
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class SslCredentials
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.23.1.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items"></div>
  58. <ul id="pagination"></ul>
  59. </div>
  60. </div>
  61. <div role="main" class="container body-content hide-when-search">
  62. <div class="sidenav hide-when-search">
  63. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  64. <div class="sidetoggle collapse" id="sidetoggle">
  65. <div id="sidetoc"></div>
  66. </div>
  67. </div>
  68. <div class="article row grid-right">
  69. <div class="col-md-10">
  70. <article class="content wrap" id="_content" data-uid="Grpc.Core.SslCredentials">
  71. <h1 id="Grpc_Core_SslCredentials" data-uid="Grpc.Core.SslCredentials" class="text-break">Class SslCredentials
  72. </h1>
  73. <div class="markdown level0 summary"><p>Client-side SSL credentials.</p>
  74. </div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><span class="xref">System.Object</span></div>
  79. <div class="level1"><a class="xref" href="Grpc.Core.ChannelCredentials.html">ChannelCredentials</a></div>
  80. <div class="level2"><span class="xref">SslCredentials</span></div>
  81. </div>
  82. <div class="inheritedMembers">
  83. <h5>Inherited Members</h5>
  84. <div>
  85. <a class="xref" href="Grpc.Core.ChannelCredentials.html#Grpc_Core_ChannelCredentials_Insecure">ChannelCredentials.Insecure</a>
  86. </div>
  87. <div>
  88. <a class="xref" href="Grpc.Core.ChannelCredentials.html#Grpc_Core_ChannelCredentials_Create_Grpc_Core_ChannelCredentials_Grpc_Core_CallCredentials_">ChannelCredentials.Create(ChannelCredentials, CallCredentials)</a>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.ToString()</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.GetHashCode()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.GetType()</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Object.MemberwiseClone()</span>
  110. </div>
  111. </div>
  112. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  113. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  114. <h5 id="Grpc_Core_SslCredentials_syntax">Syntax</h5>
  115. <div class="codewrapper">
  116. <pre><code class="lang-csharp hljs">public sealed class SslCredentials : ChannelCredentials</code></pre>
  117. </div>
  118. <h3 id="constructors">Constructors
  119. </h3>
  120. <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  121. <h4 id="Grpc_Core_SslCredentials__ctor" data-uid="Grpc.Core.SslCredentials.#ctor">SslCredentials()</h4>
  122. <div class="markdown level1 summary"><p>Creates client-side SSL credentials loaded from
  123. disk file pointed to by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable.
  124. If that fails, gets the roots certificates from a well known place on disk.</p>
  125. </div>
  126. <div class="markdown level1 conceptual"></div>
  127. <h5 class="decalaration">Declaration</h5>
  128. <div class="codewrapper">
  129. <pre><code class="lang-csharp hljs">public SslCredentials()</code></pre>
  130. </div>
  131. <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  132. <h4 id="Grpc_Core_SslCredentials__ctor_System_String_" data-uid="Grpc.Core.SslCredentials.#ctor(System.String)">SslCredentials(String)</h4>
  133. <div class="markdown level1 summary"><p>Creates client-side SSL credentials from
  134. a string containing PEM encoded root certificates.</p>
  135. </div>
  136. <div class="markdown level1 conceptual"></div>
  137. <h5 class="decalaration">Declaration</h5>
  138. <div class="codewrapper">
  139. <pre><code class="lang-csharp hljs">public SslCredentials(string rootCertificates)</code></pre>
  140. </div>
  141. <h5 class="parameters">Parameters</h5>
  142. <table class="table table-bordered table-striped table-condensed">
  143. <thead>
  144. <tr>
  145. <th>Type</th>
  146. <th>Name</th>
  147. <th>Description</th>
  148. </tr>
  149. </thead>
  150. <tbody>
  151. <tr>
  152. <td><span class="xref">System.String</span></td>
  153. <td><span class="parametername">rootCertificates</span></td>
  154. <td></td>
  155. </tr>
  156. </tbody>
  157. </table>
  158. <a id="Grpc_Core_SslCredentials__ctor_" data-uid="Grpc.Core.SslCredentials.#ctor*"></a>
  159. <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>
  160. <div class="markdown level1 summary"><p>Creates client-side SSL credentials.</p>
  161. </div>
  162. <div class="markdown level1 conceptual"></div>
  163. <h5 class="decalaration">Declaration</h5>
  164. <div class="codewrapper">
  165. <pre><code class="lang-csharp hljs">public SslCredentials(string rootCertificates, KeyCertificatePair keyCertificatePair)</code></pre>
  166. </div>
  167. <h5 class="parameters">Parameters</h5>
  168. <table class="table table-bordered table-striped table-condensed">
  169. <thead>
  170. <tr>
  171. <th>Type</th>
  172. <th>Name</th>
  173. <th>Description</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. <tr>
  178. <td><span class="xref">System.String</span></td>
  179. <td><span class="parametername">rootCertificates</span></td>
  180. <td><p>string containing PEM encoded server root certificates.</p>
  181. </td>
  182. </tr>
  183. <tr>
  184. <td><a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a></td>
  185. <td><span class="parametername">keyCertificatePair</span></td>
  186. <td><p>a key certificate pair.</p>
  187. </td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <h3 id="properties">Properties
  192. </h3>
  193. <a id="Grpc_Core_SslCredentials_KeyCertificatePair_" data-uid="Grpc.Core.SslCredentials.KeyCertificatePair*"></a>
  194. <h4 id="Grpc_Core_SslCredentials_KeyCertificatePair" data-uid="Grpc.Core.SslCredentials.KeyCertificatePair">KeyCertificatePair</h4>
  195. <div class="markdown level1 summary"><p>Client side key and certificate pair.
  196. If null, client will not use key and certificate pair.</p>
  197. </div>
  198. <div class="markdown level1 conceptual"></div>
  199. <h5 class="decalaration">Declaration</h5>
  200. <div class="codewrapper">
  201. <pre><code class="lang-csharp hljs">public KeyCertificatePair KeyCertificatePair { get; }</code></pre>
  202. </div>
  203. <h5 class="propertyValue">Property Value</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Description</th>
  209. </tr>
  210. </thead>
  211. <tbody>
  212. <tr>
  213. <td><a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a></td>
  214. <td></td>
  215. </tr>
  216. </tbody>
  217. </table>
  218. <a id="Grpc_Core_SslCredentials_RootCertificates_" data-uid="Grpc.Core.SslCredentials.RootCertificates*"></a>
  219. <h4 id="Grpc_Core_SslCredentials_RootCertificates" data-uid="Grpc.Core.SslCredentials.RootCertificates">RootCertificates</h4>
  220. <div class="markdown level1 summary"><p>PEM encoding of the server root certificates.</p>
  221. </div>
  222. <div class="markdown level1 conceptual"></div>
  223. <h5 class="decalaration">Declaration</h5>
  224. <div class="codewrapper">
  225. <pre><code class="lang-csharp hljs">public string RootCertificates { get; }</code></pre>
  226. </div>
  227. <h5 class="propertyValue">Property Value</h5>
  228. <table class="table table-bordered table-striped table-condensed">
  229. <thead>
  230. <tr>
  231. <th>Type</th>
  232. <th>Description</th>
  233. </tr>
  234. </thead>
  235. <tbody>
  236. <tr>
  237. <td><span class="xref">System.String</span></td>
  238. <td></td>
  239. </tr>
  240. </tbody>
  241. </table>
  242. </article>
  243. </div>
  244. <div class="hidden-sm col-md-2" role="complementary">
  245. <div class="sideaffix">
  246. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  247. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  248. </nav>
  249. </div>
  250. </div>
  251. </div>
  252. </div>
  253. <footer>
  254. <div class="grad-bottom"></div>
  255. <div class="footer">
  256. <div class="container">
  257. <span class="pull-right">
  258. <a href="#top">Back to top</a>
  259. </span>
  260. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  261. </div>
  262. </div>
  263. </footer>
  264. </div>
  265. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  266. <script type="text/javascript" src="../styles/docfx.js"></script>
  267. <script type="text/javascript" src="../styles/main.js"></script>
  268. </body>
  269. </html>