Grpc.Core.SslServerCredentials.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  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.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.SslServerCredentials">
  71. <h1 id="Grpc_Core_SslServerCredentials" data-uid="Grpc.Core.SslServerCredentials" class="text-break">Class SslServerCredentials
  72. </h1>
  73. <div class="markdown level0 summary"><p>Server-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.ServerCredentials.html">ServerCredentials</a></div>
  80. <div class="level2"><span class="xref">SslServerCredentials</span></div>
  81. </div>
  82. <div class="inheritedMembers">
  83. <h5>Inherited Members</h5>
  84. <div>
  85. <a class="xref" href="Grpc.Core.ServerCredentials.html#Grpc_Core_ServerCredentials_Insecure">ServerCredentials.Insecure</a>
  86. </div>
  87. <div>
  88. <span class="xref">System.Object.ToString()</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetHashCode()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.GetType()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.MemberwiseClone()</span>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  110. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  111. <h5 id="Grpc_Core_SslServerCredentials_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class SslServerCredentials : ServerCredentials</code></pre>
  114. </div>
  115. <h3 id="constructors">Constructors
  116. </h3>
  117. <a id="Grpc_Core_SslServerCredentials__ctor_" data-uid="Grpc.Core.SslServerCredentials.#ctor*"></a>
  118. <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>
  119. <div class="markdown level1 summary"><p>Creates server-side SSL credentials.
  120. This constructor should be use if you do not wish to autheticate client
  121. using client root certificates.</p>
  122. </div>
  123. <div class="markdown level1 conceptual"></div>
  124. <h5 class="decalaration">Declaration</h5>
  125. <div class="codewrapper">
  126. <pre><code class="lang-csharp hljs">public SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt; keyCertificatePairs)</code></pre>
  127. </div>
  128. <h5 class="parameters">Parameters</h5>
  129. <table class="table table-bordered table-striped table-condensed">
  130. <thead>
  131. <tr>
  132. <th>Type</th>
  133. <th>Name</th>
  134. <th>Description</th>
  135. </tr>
  136. </thead>
  137. <tbody>
  138. <tr>
  139. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  140. <td><span class="parametername">keyCertificatePairs</span></td>
  141. <td><p>Key-certificates to use.</p>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <a id="Grpc_Core_SslServerCredentials__ctor_" data-uid="Grpc.Core.SslServerCredentials.#ctor*"></a>
  147. <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>
  148. <div class="markdown level1 summary"><p>Creates server-side SSL credentials.</p>
  149. </div>
  150. <div class="markdown level1 conceptual"></div>
  151. <h5 class="decalaration">Declaration</h5>
  152. <div class="codewrapper">
  153. <pre><code class="lang-csharp hljs">public SslServerCredentials(IEnumerable&lt;KeyCertificatePair&gt; keyCertificatePairs, string rootCertificates, bool forceClientAuth)</code></pre>
  154. </div>
  155. <h5 class="parameters">Parameters</h5>
  156. <table class="table table-bordered table-striped table-condensed">
  157. <thead>
  158. <tr>
  159. <th>Type</th>
  160. <th>Name</th>
  161. <th>Description</th>
  162. </tr>
  163. </thead>
  164. <tbody>
  165. <tr>
  166. <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  167. <td><span class="parametername">keyCertificatePairs</span></td>
  168. <td><p>Key-certificates to use.</p>
  169. </td>
  170. </tr>
  171. <tr>
  172. <td><span class="xref">System.String</span></td>
  173. <td><span class="parametername">rootCertificates</span></td>
  174. <td><p>PEM encoded client root certificates used to authenticate client.</p>
  175. </td>
  176. </tr>
  177. <tr>
  178. <td><span class="xref">System.Boolean</span></td>
  179. <td><span class="parametername">forceClientAuth</span></td>
  180. <td><p>If true, client will be rejected unless it proves its unthenticity using against rootCertificates.</p>
  181. </td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <h3 id="properties">Properties
  186. </h3>
  187. <a id="Grpc_Core_SslServerCredentials_ForceClientAuthentication_" data-uid="Grpc.Core.SslServerCredentials.ForceClientAuthentication*"></a>
  188. <h4 id="Grpc_Core_SslServerCredentials_ForceClientAuthentication" data-uid="Grpc.Core.SslServerCredentials.ForceClientAuthentication">ForceClientAuthentication</h4>
  189. <div class="markdown level1 summary"><p>If true, the authenticity of client check will be enforced.</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 bool ForceClientAuthentication { get; }</code></pre>
  195. </div>
  196. <h5 class="propertyValue">Property Value</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">System.Boolean</span></td>
  207. <td></td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <a id="Grpc_Core_SslServerCredentials_KeyCertificatePairs_" data-uid="Grpc.Core.SslServerCredentials.KeyCertificatePairs*"></a>
  212. <h4 id="Grpc_Core_SslServerCredentials_KeyCertificatePairs" data-uid="Grpc.Core.SslServerCredentials.KeyCertificatePairs">KeyCertificatePairs</h4>
  213. <div class="markdown level1 summary"><p>Key-certificate pairs.</p>
  214. </div>
  215. <div class="markdown level1 conceptual"></div>
  216. <h5 class="decalaration">Declaration</h5>
  217. <div class="codewrapper">
  218. <pre><code class="lang-csharp hljs">public IList&lt;KeyCertificatePair&gt; KeyCertificatePairs { get; }</code></pre>
  219. </div>
  220. <h5 class="propertyValue">Property Value</h5>
  221. <table class="table table-bordered table-striped table-condensed">
  222. <thead>
  223. <tr>
  224. <th>Type</th>
  225. <th>Description</th>
  226. </tr>
  227. </thead>
  228. <tbody>
  229. <tr>
  230. <td><span class="xref">System.Collections.Generic.IList</span>&lt;<a class="xref" href="Grpc.Core.KeyCertificatePair.html">KeyCertificatePair</a>&gt;</td>
  231. <td></td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. <a id="Grpc_Core_SslServerCredentials_RootCertificates_" data-uid="Grpc.Core.SslServerCredentials.RootCertificates*"></a>
  236. <h4 id="Grpc_Core_SslServerCredentials_RootCertificates" data-uid="Grpc.Core.SslServerCredentials.RootCertificates">RootCertificates</h4>
  237. <div class="markdown level1 summary"><p>PEM encoded client root certificates.</p>
  238. </div>
  239. <div class="markdown level1 conceptual"></div>
  240. <h5 class="decalaration">Declaration</h5>
  241. <div class="codewrapper">
  242. <pre><code class="lang-csharp hljs">public string RootCertificates { get; }</code></pre>
  243. </div>
  244. <h5 class="propertyValue">Property Value</h5>
  245. <table class="table table-bordered table-striped table-condensed">
  246. <thead>
  247. <tr>
  248. <th>Type</th>
  249. <th>Description</th>
  250. </tr>
  251. </thead>
  252. <tbody>
  253. <tr>
  254. <td><span class="xref">System.String</span></td>
  255. <td></td>
  256. </tr>
  257. </tbody>
  258. </table>
  259. </article>
  260. </div>
  261. <div class="hidden-sm col-md-2" role="complementary">
  262. <div class="sideaffix">
  263. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  264. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  265. </nav>
  266. </div>
  267. </div>
  268. </div>
  269. </div>
  270. <footer>
  271. <div class="grad-bottom"></div>
  272. <div class="footer">
  273. <div class="container">
  274. <span class="pull-right">
  275. <a href="#top">Back to top</a>
  276. </span>
  277. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  278. </div>
  279. </div>
  280. </footer>
  281. </div>
  282. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  283. <script type="text/javascript" src="../styles/docfx.js"></script>
  284. <script type="text/javascript" src="../styles/main.js"></script>
  285. </body>
  286. </html>