Grpc.Core.SslServerCredentials.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  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 SslServerCredentials
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class SslServerCredentials
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.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" data-offset="120">
  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">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.SslServerCredentials">
  73. <h1 id="Grpc_Core_SslServerCredentials" data-uid="Grpc.Core.SslServerCredentials" class="text-break">Class SslServerCredentials
  74. </h1>
  75. <div class="markdown level0 summary"><p>Server-side SSL credentials.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><a class="xref" href="Grpc.Core.ServerCredentials.html">ServerCredentials</a></div>
  82. <div class="level2"><span class="xref">SslServerCredentials</span></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <a class="xref" href="Grpc.Core.ServerCredentials.html#Grpc_Core_ServerCredentials_Insecure">ServerCredentials.Insecure</a>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.Equals(System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetHashCode()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetType()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.MemberwiseClone()</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Object.ToString()</span>
  109. </div>
  110. </div>
  111. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  112. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  113. <h5 id="Grpc_Core_SslServerCredentials_syntax">Syntax</h5>
  114. <div class="codewrapper">
  115. <pre><code class="lang-csharp hljs">public class SslServerCredentials : ServerCredentials</code></pre>
  116. </div>
  117. <h3 id="constructors">Constructors
  118. </h3>
  119. <a id="Grpc_Core_SslServerCredentials__ctor_" data-uid="Grpc.Core.SslServerCredentials.#ctor*"></a>
  120. <h4 id="Grpc_Core_SslServerCredentials__ctor_System_Collections_Generic_IEnumerable_Grpc_Core_KeyCertificatePair__" data-uid="Grpc.Core.SslServerCredentials.#ctor(System.Collections.Generic.IEnumerable{Grpc.Core.KeyCertificatePair})">SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt;)</h4>
  121. <div class="markdown level1 summary"><p>Creates server-side SSL credentials.
  122. This constructor should be used if you do not wish to authenticate the client.
  123. (client certificate won&apos;t be requested and checked by the server at all).</p>
  124. </div>
  125. <div class="markdown level1 conceptual"></div>
  126. <h5 class="decalaration">Declaration</h5>
  127. <div class="codewrapper">
  128. <pre><code class="lang-csharp hljs">public SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt; keyCertificatePairs)</code></pre>
  129. </div>
  130. <h5 class="parameters">Parameters</h5>
  131. <table class="table table-bordered table-striped table-condensed">
  132. <thead>
  133. <tr>
  134. <th>Type</th>
  135. <th>Name</th>
  136. <th>Description</th>
  137. </tr>
  138. </thead>
  139. <tbody>
  140. <tr>
  141. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  142. <td><span class="parametername">keyCertificatePairs</span></td>
  143. <td><p>Key-certificates to use.</p>
  144. </td>
  145. </tr>
  146. </tbody>
  147. </table>
  148. <a id="Grpc_Core_SslServerCredentials__ctor_" data-uid="Grpc.Core.SslServerCredentials.#ctor*"></a>
  149. <h4 id="Grpc_Core_SslServerCredentials__ctor_System_Collections_Generic_IEnumerable_Grpc_Core_KeyCertificatePair__System_String_Grpc_Core_SslClientCertificateRequestType_" data-uid="Grpc.Core.SslServerCredentials.#ctor(System.Collections.Generic.IEnumerable{Grpc.Core.KeyCertificatePair},System.String,Grpc.Core.SslClientCertificateRequestType)">SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt;, String, SslClientCertificateRequestType)</h4>
  150. <div class="markdown level1 summary"><p>Creates server-side SSL credentials.</p>
  151. </div>
  152. <div class="markdown level1 conceptual"></div>
  153. <h5 class="decalaration">Declaration</h5>
  154. <div class="codewrapper">
  155. <pre><code class="lang-csharp hljs">public SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt; keyCertificatePairs, string rootCertificates, SslClientCertificateRequestType clientCertificateRequest)</code></pre>
  156. </div>
  157. <h5 class="parameters">Parameters</h5>
  158. <table class="table table-bordered table-striped table-condensed">
  159. <thead>
  160. <tr>
  161. <th>Type</th>
  162. <th>Name</th>
  163. <th>Description</th>
  164. </tr>
  165. </thead>
  166. <tbody>
  167. <tr>
  168. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  169. <td><span class="parametername">keyCertificatePairs</span></td>
  170. <td><p>Key-certificates to use.</p>
  171. </td>
  172. </tr>
  173. <tr>
  174. <td><span class="xref">System.String</span></td>
  175. <td><span class="parametername">rootCertificates</span></td>
  176. <td><p>PEM encoded client root certificates used to authenticate client.</p>
  177. </td>
  178. </tr>
  179. <tr>
  180. <td><a class="xref" href="Grpc.Core.SslClientCertificateRequestType.html">SslClientCertificateRequestType</a></td>
  181. <td><span class="parametername">clientCertificateRequest</span></td>
  182. <td><p>Options for requesting and verifying client certificate.</p>
  183. </td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. <a id="Grpc_Core_SslServerCredentials__ctor_" data-uid="Grpc.Core.SslServerCredentials.#ctor*"></a>
  188. <h4 id="Grpc_Core_SslServerCredentials__ctor_System_Collections_Generic_IEnumerable_Grpc_Core_KeyCertificatePair__System_String_System_Boolean_" data-uid="Grpc.Core.SslServerCredentials.#ctor(System.Collections.Generic.IEnumerable{Grpc.Core.KeyCertificatePair},System.String,System.Boolean)">SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt;, String, Boolean)</h4>
  189. <div class="markdown level1 summary"><p>Creates server-side SSL credentials.</p>
  190. </div>
  191. <div class="markdown level1 conceptual"></div>
  192. <h5 class="decalaration">Declaration</h5>
  193. <div class="codewrapper">
  194. <pre><code class="lang-csharp hljs">public SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt; keyCertificatePairs, string rootCertificates, bool forceClientAuth)</code></pre>
  195. </div>
  196. <h5 class="parameters">Parameters</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Name</th>
  202. <th>Description</th>
  203. </tr>
  204. </thead>
  205. <tbody>
  206. <tr>
  207. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  208. <td><span class="parametername">keyCertificatePairs</span></td>
  209. <td><p>Key-certificates to use.</p>
  210. </td>
  211. </tr>
  212. <tr>
  213. <td><span class="xref">System.String</span></td>
  214. <td><span class="parametername">rootCertificates</span></td>
  215. <td><p>PEM encoded client root certificates used to authenticate client.</p>
  216. </td>
  217. </tr>
  218. <tr>
  219. <td><span class="xref">System.Boolean</span></td>
  220. <td><span class="parametername">forceClientAuth</span></td>
  221. <td><p>Deprecated, use clientCertificateRequest overload instead.</p>
  222. </td>
  223. </tr>
  224. </tbody>
  225. </table>
  226. <h3 id="properties">Properties
  227. </h3>
  228. <a id="Grpc_Core_SslServerCredentials_ClientCertificateRequest_" data-uid="Grpc.Core.SslServerCredentials.ClientCertificateRequest*"></a>
  229. <h4 id="Grpc_Core_SslServerCredentials_ClientCertificateRequest" data-uid="Grpc.Core.SslServerCredentials.ClientCertificateRequest">ClientCertificateRequest</h4>
  230. <div class="markdown level1 summary"><p>Mode of requesting certificate from client by the server.</p>
  231. </div>
  232. <div class="markdown level1 conceptual"></div>
  233. <h5 class="decalaration">Declaration</h5>
  234. <div class="codewrapper">
  235. <pre><code class="lang-csharp hljs">public SslClientCertificateRequestType ClientCertificateRequest { get; }</code></pre>
  236. </div>
  237. <h5 class="propertyValue">Property Value</h5>
  238. <table class="table table-bordered table-striped table-condensed">
  239. <thead>
  240. <tr>
  241. <th>Type</th>
  242. <th>Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td><a class="xref" href="Grpc.Core.SslClientCertificateRequestType.html">SslClientCertificateRequestType</a></td>
  248. <td></td>
  249. </tr>
  250. </tbody>
  251. </table>
  252. <a id="Grpc_Core_SslServerCredentials_ForceClientAuthentication_" data-uid="Grpc.Core.SslServerCredentials.ForceClientAuthentication*"></a>
  253. <h4 id="Grpc_Core_SslServerCredentials_ForceClientAuthentication" data-uid="Grpc.Core.SslServerCredentials.ForceClientAuthentication">ForceClientAuthentication</h4>
  254. <div class="markdown level1 summary"><p>Deprecated. If true, the authenticity of client check will be enforced.</p>
  255. </div>
  256. <div class="markdown level1 conceptual"></div>
  257. <h5 class="decalaration">Declaration</h5>
  258. <div class="codewrapper">
  259. <pre><code class="lang-csharp hljs">public bool ForceClientAuthentication { get; }</code></pre>
  260. </div>
  261. <h5 class="propertyValue">Property Value</h5>
  262. <table class="table table-bordered table-striped table-condensed">
  263. <thead>
  264. <tr>
  265. <th>Type</th>
  266. <th>Description</th>
  267. </tr>
  268. </thead>
  269. <tbody>
  270. <tr>
  271. <td><span class="xref">System.Boolean</span></td>
  272. <td></td>
  273. </tr>
  274. </tbody>
  275. </table>
  276. <a id="Grpc_Core_SslServerCredentials_KeyCertificatePairs_" data-uid="Grpc.Core.SslServerCredentials.KeyCertificatePairs*"></a>
  277. <h4 id="Grpc_Core_SslServerCredentials_KeyCertificatePairs" data-uid="Grpc.Core.SslServerCredentials.KeyCertificatePairs">KeyCertificatePairs</h4>
  278. <div class="markdown level1 summary"><p>Key-certificate pairs.</p>
  279. </div>
  280. <div class="markdown level1 conceptual"></div>
  281. <h5 class="decalaration">Declaration</h5>
  282. <div class="codewrapper">
  283. <pre><code class="lang-csharp hljs">public IList&lt;KeyCertificatePair&gt; KeyCertificatePairs { get; }</code></pre>
  284. </div>
  285. <h5 class="propertyValue">Property Value</h5>
  286. <table class="table table-bordered table-striped table-condensed">
  287. <thead>
  288. <tr>
  289. <th>Type</th>
  290. <th>Description</th>
  291. </tr>
  292. </thead>
  293. <tbody>
  294. <tr>
  295. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  296. <td></td>
  297. </tr>
  298. </tbody>
  299. </table>
  300. <a id="Grpc_Core_SslServerCredentials_RootCertificates_" data-uid="Grpc.Core.SslServerCredentials.RootCertificates*"></a>
  301. <h4 id="Grpc_Core_SslServerCredentials_RootCertificates" data-uid="Grpc.Core.SslServerCredentials.RootCertificates">RootCertificates</h4>
  302. <div class="markdown level1 summary"><p>PEM encoded client root certificates.</p>
  303. </div>
  304. <div class="markdown level1 conceptual"></div>
  305. <h5 class="decalaration">Declaration</h5>
  306. <div class="codewrapper">
  307. <pre><code class="lang-csharp hljs">public string RootCertificates { get; }</code></pre>
  308. </div>
  309. <h5 class="propertyValue">Property Value</h5>
  310. <table class="table table-bordered table-striped table-condensed">
  311. <thead>
  312. <tr>
  313. <th>Type</th>
  314. <th>Description</th>
  315. </tr>
  316. </thead>
  317. <tbody>
  318. <tr>
  319. <td><span class="xref">System.String</span></td>
  320. <td></td>
  321. </tr>
  322. </tbody>
  323. </table>
  324. </article>
  325. </div>
  326. <div class="hidden-sm col-md-2" role="complementary">
  327. <div class="sideaffix">
  328. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  329. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  330. </nav>
  331. </div>
  332. </div>
  333. </div>
  334. </div>
  335. <footer>
  336. <div class="grad-bottom"></div>
  337. <div class="footer">
  338. <div class="container">
  339. <span class="pull-right">
  340. <a href="#top">Back to top</a>
  341. </span>
  342. <span>Generated by <strong>DocFX</strong></span>
  343. </div>
  344. </div>
  345. </footer>
  346. </div>
  347. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  348. <script type="text/javascript" src="../styles/docfx.js"></script>
  349. <script type="text/javascript" src="../styles/main.js"></script>
  350. </body>
  351. </html>