grpcpp_2security_2server__credentials_8h_source.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: include/grpcpp/security/server_credentials.h Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_121096a639b520446ccef04f840b5644.html">security</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">server_credentials.h</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="grpcpp_2security_2server__credentials_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  72. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  73. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015 gRPC authors.</span></div>
  74. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  75. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
  76. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
  77. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
  78. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  79. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
  80. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
  81. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
  82. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
  83. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
  84. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
  85. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
  86. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div>
  87. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  88. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
  89. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_SECURITY_SERVER_CREDENTIALS_H</span></div>
  90. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GRPCPP_SECURITY_SERVER_CREDENTIALS_H</span></div>
  91. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  92. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
  93. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
  94. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
  95. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc__security__constants_8h.html">grpc/grpc_security_constants.h</a>&gt;</span></div>
  96. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2security_2auth__metadata__processor_8h.html">grpcpp/security/auth_metadata_processor.h</a>&gt;</span></div>
  97. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="tls__credentials__options_8h.html">grpcpp/security/tls_credentials_options.h</a>&gt;</span></div>
  98. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2config_8h.html">grpcpp/support/config.h</a>&gt;</span></div>
  99. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
  100. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">struct </span><a class="code" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a>;</div>
  101. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
  102. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
  103. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
  104. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">class </span>Server;</div>
  105. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">class </span>ServerCredentials;</div>
  106. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">class </span>SecureServerCredentials;</div>
  107. <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html"> 38</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html">SslServerCredentialsOptions</a> {</div>
  108. <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html#ae85661f17b0dd9f4fc27275203e5f105"> 40</a></span>&#160; <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#ae85661f17b0dd9f4fc27275203e5f105">SslServerCredentialsOptions</a>()</div>
  109. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; : <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#aa563c0e5a34e389dbc2f4dfa3c097e3e">force_client_auth</a>(false),</div>
  110. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#a646486fd3adbacf5805ff013f5362f5c">client_certificate_request</a>(<a class="code" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f">GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE</a>) {}</div>
  111. <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html#a00650afd8a132f271b068d17da446679"> 43</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#a00650afd8a132f271b068d17da446679">SslServerCredentialsOptions</a>(</div>
  112. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> request_type)</div>
  113. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; : <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#aa563c0e5a34e389dbc2f4dfa3c097e3e">force_client_auth</a>(false), <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#a646486fd3adbacf5805ff013f5362f5c">client_certificate_request</a>(request_type) {}</div>
  114. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
  115. <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html"> 47</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html">PemKeyCertPair</a> {</div>
  116. <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html#adc70dbf7748845465cd6a19386f9b88c"> 48</a></span>&#160; std::string <a class="code" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html#adc70dbf7748845465cd6a19386f9b88c">private_key</a>;</div>
  117. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html#a0d0c8e159020e872e2bfeecab675f4f9"> 49</a></span>&#160; std::string <a class="code" href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html#a0d0c8e159020e872e2bfeecab675f4f9">cert_chain</a>;</div>
  118. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; };</div>
  119. <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html#ac2385fa44cffc5e671611645828736bd"> 51</a></span>&#160; std::string <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#ac2385fa44cffc5e671611645828736bd">pem_root_certs</a>;</div>
  120. <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html#a3a042e846edd3d1e2f24e846e36c694d"> 52</a></span>&#160; std::vector&lt;PemKeyCertPair&gt; <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#a3a042e846edd3d1e2f24e846e36c694d">pem_key_cert_pairs</a>;</div>
  121. <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html#aa563c0e5a34e389dbc2f4dfa3c097e3e"> 54</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#aa563c0e5a34e389dbc2f4dfa3c097e3e">force_client_auth</a>;</div>
  122. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
  123. <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_server_credentials_options.html#a646486fd3adbacf5805ff013f5362f5c"> 60</a></span>&#160; <a class="code" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html#a646486fd3adbacf5805ff013f5362f5c">client_certificate_request</a>;</div>
  124. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;};</div>
  125. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
  126. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="keyword">namespace </span>experimental {</div>
  127. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc_1_1experimental.html#a7317b5a2aba8ba9b1126d39609e7da58">XdsServerCredentials</a>(</div>
  128. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;ServerCredentials&gt;&amp; fallback_credentials);</div>
  129. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;} <span class="comment">// namespace experimental</span></div>
  130. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
  131. <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_credentials.html"> 70</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> : <span class="keyword">private</span> <a class="code" href="classgrpc_1_1_grpc_library_codegen.html">grpc::GrpcLibraryCodegen</a> {</div>
  132. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">public</span>:</div>
  133. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="classgrpc_1_1_server_credentials.html#ae4271df98b9da8ac4fada0c147e1674a">ServerCredentials</a>();</div>
  134. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classgrpc_1_1_server_credentials.html#a2b25359ccca36f025fc82327c5aad0f8">~ServerCredentials</a>() <span class="keyword">override</span>;</div>
  135. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
  136. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_server_credentials.html#aac2d5861ec4c0534c3eaa7b36f5cc6fa">SetAuthMetadataProcessor</a>(</div>
  137. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;grpc::AuthMetadataProcessor&gt;&amp; processor) = 0;</div>
  138. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
  139. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">private</span>:</div>
  140. <div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classgrpc_1_1_server_credentials.html#ac2055578ac48afabe5af487878450f68"> 81</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_server.html">Server</a>;</div>
  141. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
  142. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// We need this friend declaration for access to Insecure() and</span></div>
  143. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">// AsSecureServerCredentials(). When these two functions are no longer</span></div>
  144. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// necessary, this friend declaration can be removed too.</span></div>
  145. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">friend</span> std::shared_ptr&lt;ServerCredentials&gt;</div>
  146. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="namespacegrpc_1_1experimental.html#a7317b5a2aba8ba9b1126d39609e7da58">grpc::experimental::XdsServerCredentials</a>(</div>
  147. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;ServerCredentials&gt;&amp; fallback_credentials);</div>
  148. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
  149. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="comment">// TODO(dgq): the &quot;port&quot; part seems to be a misnomer.</span></div>
  150. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> AddPortToServer(<span class="keyword">const</span> std::string&amp; addr, <a class="code" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a>* server) = 0;</div>
  151. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
  152. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="comment">// TODO(yashykt): This is a hack since InsecureServerCredentials() cannot use</span></div>
  153. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="comment">// grpc_insecure_server_credentials_create() and should be removed after</span></div>
  154. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="comment">// insecure builds are removed from gRPC.</span></div>
  155. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsInsecure()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div>
  156. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
  157. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="comment">// TODO(yashkt): This is a hack that should be removed once we remove insecure</span></div>
  158. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="comment">// builds and the indirect method of adding ports to a server.</span></div>
  159. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">virtual</span> SecureServerCredentials* AsSecureServerCredentials() {</div>
  160. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
  161. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div>
  162. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;};</div>
  163. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
  164. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc.html#a58c19329766a61e325450888aacef0ad">SslServerCredentials</a>(</div>
  165. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc_1_1_ssl_server_credentials_options.html">grpc::SslServerCredentialsOptions</a>&amp; options);</div>
  166. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
  167. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc.html#aa8c26768567516f22852d7ccc09c7940">InsecureServerCredentials</a>();</div>
  168. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
  169. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="keyword">namespace </span>experimental {</div>
  170. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
  171. <div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html"> 118</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> {</div>
  172. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;};</div>
  173. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
  174. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc_1_1experimental.html#ad18c246d1f0dfe0c6670daade5518111">AltsServerCredentials</a>(</div>
  175. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a>&amp; options);</div>
  176. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
  177. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc_1_1experimental.html#ad18c246d1f0dfe0c6670daade5518111">AltsServerCredentials</a>(</div>
  178. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a>&amp; options);</div>
  179. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
  180. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc_1_1experimental.html#a6076d466bcfdcb7d7678c2dcafe01f5f">LocalServerCredentials</a>(</div>
  181. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <a class="code" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type);</div>
  182. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
  183. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;std::shared_ptr&lt;ServerCredentials&gt; <a class="code" href="namespacegrpc_1_1experimental.html#ae38e21893afedf68729867eb397b33c3">TlsServerCredentials</a>(</div>
  184. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">const</span> <a class="code" href="classgrpc_1_1experimental_1_1_tls_server_credentials_options.html">experimental::TlsServerCredentialsOptions</a>&amp; options);</div>
  185. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
  186. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;} <span class="comment">// namespace experimental</span></div>
  187. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;} <span class="comment">// namespace grpc</span></div>
  188. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div>
  189. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="preprocessor">#endif // GRPCPP_SECURITY_SERVER_CREDENTIALS_H</span></div>
  190. </div><!-- fragment --></div><!-- contents -->
  191. <div class="ttc" id="anamespacegrpc_html_aa8c26768567516f22852d7ccc09c7940"><div class="ttname"><a href="namespacegrpc.html#aa8c26768567516f22852d7ccc09c7940">grpc::InsecureServerCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; ServerCredentials &gt; InsecureServerCredentials()</div></div>
  192. <div class="ttc" id="aclassgrpc_1_1_grpc_library_codegen_html"><div class="ttname"><a href="classgrpc_1_1_grpc_library_codegen.html">grpc::GrpcLibraryCodegen</a></div><div class="ttdoc">Classes that require gRPC to be initialized should inherit from this class.</div><div class="ttdef"><b>Definition:</b> grpc_library.h:38</div></div>
  193. <div class="ttc" id="atls__credentials__options_8h_html"><div class="ttname"><a href="tls__credentials__options_8h.html">tls_credentials_options.h</a></div></div>
  194. <div class="ttc" id="anamespacegrpc_html_a58c19329766a61e325450888aacef0ad"><div class="ttname"><a href="namespacegrpc.html#a58c19329766a61e325450888aacef0ad">grpc::SslServerCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; ServerCredentials &gt; SslServerCredentials(const grpc::SslServerCredentialsOptions &amp;options)</div><div class="ttdoc">Builds SSL ServerCredentials given SSL specific options.</div></div>
  195. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair_html"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html">grpc::SslServerCredentialsOptions::PemKeyCertPair</a></div><div class="ttdef"><b>Definition:</b> server_credentials.h:47</div></div>
  196. <div class="ttc" id="aclassgrpc_1_1_server_html"><div class="ttname"><a href="classgrpc_1_1_server.html">grpc::Server</a></div><div class="ttdoc">Represents a gRPC server.</div><div class="ttdef"><b>Definition:</b> server.h:59</div></div>
  197. <div class="ttc" id="anamespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm.h:33</div></div>
  198. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html_aa563c0e5a34e389dbc2f4dfa3c097e3e"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html#aa563c0e5a34e389dbc2f4dfa3c097e3e">grpc::SslServerCredentialsOptions::force_client_auth</a></div><div class="ttdeci">bool force_client_auth</div><div class="ttdef"><b>Definition:</b> server_credentials.h:54</div></div>
  199. <div class="ttc" id="aclassgrpc_1_1_server_credentials_html"><div class="ttname"><a href="classgrpc_1_1_server_credentials.html">grpc::ServerCredentials</a></div><div class="ttdoc">Wrapper around grpc_server_credentials, a way to authenticate a server.</div><div class="ttdef"><b>Definition:</b> server_credentials.h:70</div></div>
  200. <div class="ttc" id="anamespacegrpc_1_1experimental_html_a7317b5a2aba8ba9b1126d39609e7da58"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a7317b5a2aba8ba9b1126d39609e7da58">grpc::experimental::XdsServerCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; ServerCredentials &gt; XdsServerCredentials(const std::shared_ptr&lt; ServerCredentials &gt; &amp;fallback_credentials)</div><div class="ttdoc">Builds Xds ServerCredentials given fallback credentials.</div></div>
  201. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair_html_adc70dbf7748845465cd6a19386f9b88c"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html#adc70dbf7748845465cd6a19386f9b88c">grpc::SslServerCredentialsOptions::PemKeyCertPair::private_key</a></div><div class="ttdeci">std::string private_key</div><div class="ttdef"><b>Definition:</b> server_credentials.h:48</div></div>
  202. <div class="ttc" id="anamespacegrpc_1_1experimental_html_a6076d466bcfdcb7d7678c2dcafe01f5f"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#a6076d466bcfdcb7d7678c2dcafe01f5f">grpc::experimental::LocalServerCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; ServerCredentials &gt; LocalServerCredentials(grpc_local_connect_type type)</div></div>
  203. <div class="ttc" id="aclassgrpc_1_1_server_credentials_html_aac2d5861ec4c0534c3eaa7b36f5cc6fa"><div class="ttname"><a href="classgrpc_1_1_server_credentials.html#aac2d5861ec4c0534c3eaa7b36f5cc6fa">grpc::ServerCredentials::SetAuthMetadataProcessor</a></div><div class="ttdeci">virtual void SetAuthMetadataProcessor(const std::shared_ptr&lt; grpc::AuthMetadataProcessor &gt; &amp;processor)=0</div><div class="ttdoc">This method is not thread-safe and has to be called before the server is started.</div></div>
  204. <div class="ttc" id="agrpcpp_2security_2auth__metadata__processor_8h_html"><div class="ttname"><a href="grpcpp_2security_2auth__metadata__processor_8h.html">auth_metadata_processor.h</a></div></div>
  205. <div class="ttc" id="agrpc__types_8h_html_a2bbbaad8f7a806f6c834b68c5dd916d8"><div class="ttname"><a href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a></div><div class="ttdeci">struct grpc_server grpc_server</div><div class="ttdoc">A server listens to some port and responds to request calls.</div><div class="ttdef"><b>Definition:</b> grpc_types.h:65</div></div>
  206. <div class="ttc" id="agrpc__security__constants_8h_html_a29ffe63a8bb3b4945ecab42d82758f09"><div class="ttname"><a href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a></div><div class="ttdeci">grpc_ssl_client_certificate_request_type</div><div class="ttdef"><b>Definition:</b> grpc_security_constants.h:62</div></div>
  207. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html_ae85661f17b0dd9f4fc27275203e5f105"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html#ae85661f17b0dd9f4fc27275203e5f105">grpc::SslServerCredentialsOptions::SslServerCredentialsOptions</a></div><div class="ttdeci">SslServerCredentialsOptions()</div><div class="ttdef"><b>Definition:</b> server_credentials.h:40</div></div>
  208. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html">grpc::SslServerCredentialsOptions</a></div><div class="ttdoc">Options to create ServerCredentials with SSL.</div><div class="ttdef"><b>Definition:</b> server_credentials.h:38</div></div>
  209. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair_html_a0d0c8e159020e872e2bfeecab675f4f9"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options_1_1_pem_key_cert_pair.html#a0d0c8e159020e872e2bfeecab675f4f9">grpc::SslServerCredentialsOptions::PemKeyCertPair::cert_chain</a></div><div class="ttdeci">std::string cert_chain</div><div class="ttdef"><b>Definition:</b> server_credentials.h:49</div></div>
  210. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html_a00650afd8a132f271b068d17da446679"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html#a00650afd8a132f271b068d17da446679">grpc::SslServerCredentialsOptions::SslServerCredentialsOptions</a></div><div class="ttdeci">SslServerCredentialsOptions(grpc_ssl_client_certificate_request_type request_type)</div><div class="ttdef"><b>Definition:</b> server_credentials.h:43</div></div>
  211. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html_ac2385fa44cffc5e671611645828736bd"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html#ac2385fa44cffc5e671611645828736bd">grpc::SslServerCredentialsOptions::pem_root_certs</a></div><div class="ttdeci">std::string pem_root_certs</div><div class="ttdef"><b>Definition:</b> server_credentials.h:51</div></div>
  212. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_tls_server_credentials_options_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_tls_server_credentials_options.html">grpc::experimental::TlsServerCredentialsOptions</a></div><div class="ttdef"><b>Definition:</b> tls_credentials_options.h:224</div></div>
  213. <div class="ttc" id="agrpcpp_2support_2config_8h_html"><div class="ttname"><a href="grpcpp_2support_2config_8h.html">config.h</a></div></div>
  214. <div class="ttc" id="agrpc__security__constants_8h_html_a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f"><div class="ttname"><a href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f">GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE</a></div><div class="ttdeci">@ GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE</div><div class="ttdoc">Server does not request client certificate.</div><div class="ttdef"><b>Definition:</b> grpc_security_constants.h:67</div></div>
  215. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html_a3a042e846edd3d1e2f24e846e36c694d"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html#a3a042e846edd3d1e2f24e846e36c694d">grpc::SslServerCredentialsOptions::pem_key_cert_pairs</a></div><div class="ttdeci">std::vector&lt; PemKeyCertPair &gt; pem_key_cert_pairs</div><div class="ttdef"><b>Definition:</b> server_credentials.h:52</div></div>
  216. <div class="ttc" id="agrpc__security__constants_8h_html"><div class="ttname"><a href="grpc__security__constants_8h.html">grpc_security_constants.h</a></div></div>
  217. <div class="ttc" id="astructgrpc_1_1_ssl_server_credentials_options_html_a646486fd3adbacf5805ff013f5362f5c"><div class="ttname"><a href="structgrpc_1_1_ssl_server_credentials_options.html#a646486fd3adbacf5805ff013f5362f5c">grpc::SslServerCredentialsOptions::client_certificate_request</a></div><div class="ttdeci">grpc_ssl_client_certificate_request_type client_certificate_request</div><div class="ttdoc">If both force_client_auth and client_certificate_request fields are set, force_client_auth takes effe...</div><div class="ttdef"><b>Definition:</b> server_credentials.h:60</div></div>
  218. <div class="ttc" id="anamespacegrpc_1_1experimental_html_ad18c246d1f0dfe0c6670daade5518111"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#ad18c246d1f0dfe0c6670daade5518111">grpc::experimental::AltsServerCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; ServerCredentials &gt; AltsServerCredentials(const AltsServerCredentialsOptions &amp;options)</div><div class="ttdoc">Builds ALTS ServerCredentials given ALTS specific options.</div></div>
  219. <div class="ttc" id="aclassgrpc_1_1_server_credentials_html_ae4271df98b9da8ac4fada0c147e1674a"><div class="ttname"><a href="classgrpc_1_1_server_credentials.html#ae4271df98b9da8ac4fada0c147e1674a">grpc::ServerCredentials::ServerCredentials</a></div><div class="ttdeci">ServerCredentials()</div></div>
  220. <div class="ttc" id="astructgrpc_1_1experimental_1_1_alts_server_credentials_options_html"><div class="ttname"><a href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">grpc::experimental::AltsServerCredentialsOptions</a></div><div class="ttdoc">Options to create ServerCredentials with ALTS.</div><div class="ttdef"><b>Definition:</b> server_credentials.h:118</div></div>
  221. <div class="ttc" id="agrpc__security__constants_8h_html_a31d00ce5c064e1fff4261a6d6298dc11"><div class="ttname"><a href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a></div><div class="ttdeci">grpc_local_connect_type</div><div class="ttdoc">Type of local connections for which local channel/server credentials will be applied.</div><div class="ttdef"><b>Definition:</b> grpc_security_constants.h:140</div></div>
  222. <div class="ttc" id="aclassgrpc_1_1_server_credentials_html_a2b25359ccca36f025fc82327c5aad0f8"><div class="ttname"><a href="classgrpc_1_1_server_credentials.html#a2b25359ccca36f025fc82327c5aad0f8">grpc::ServerCredentials::~ServerCredentials</a></div><div class="ttdeci">~ServerCredentials() override</div></div>
  223. <div class="ttc" id="anamespacegrpc_1_1experimental_html_ae38e21893afedf68729867eb397b33c3"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#ae38e21893afedf68729867eb397b33c3">grpc::experimental::TlsServerCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; ServerCredentials &gt; TlsServerCredentials(const experimental::TlsServerCredentialsOptions &amp;options)</div><div class="ttdoc">Builds TLS ServerCredentials given TLS options.</div></div>
  224. <!-- start footer part -->
  225. <hr class="footer"/><address class="footer"><small>
  226. Generated on Wed Mar 3 2021 19:17:19 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  227. <img class="footer" src="doxygen.png" alt="doxygen"/>
  228. </a> 1.8.17
  229. </small></address>
  230. </body>
  231. </html>