Trang chủ Khám phá Trợ giúp
Đăng nhập
carto
/
grpc
2
0
Fork 0
Các tập tin Các vấn đề 0 Yêu cầu kéo về 0 Wiki
Branch: gh-pages
Branches Tags
grpc
/
cpp
/
tls__certificate__provider_8h_source.html

tls__certificate__provider_8h_source.html 37 KB
Permalink Lịch sử Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.17"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>GRPC C++: include/grpcpp/security/tls_certificate_provider.h Source File</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="search/searchdata.js"></script>
    14. 

  14. <script type="text/javascript" src="search/search.js"></script>
    15. 

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    16. 

  16. </head>
    17. 

  17. <body>
    18. 

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    19. 

  19. <div id="titlearea">
    20. 

  20. <table cellspacing="0" cellpadding="0">
    21. 

  21.  <tbody>
    22. 

  22.  <tr style="height: 56px;">
    23. 

  23.   <td id="projectalign" style="padding-left: 0.5em;">
    24. 

  24.    <div id="projectname">GRPC C++
    25. 

  25.    &#160;<span id="projectnumber">1.36.1</span>
    26. 

  26.    </div>
    27. 

  27.   </td>
    28. 

  28.  </tr>
    29. 

  29.  </tbody>
    30. 

  30. </table>
    31. 

  31. </div>
    32. 

  32. <!-- end header part -->
    33. 

  33. <!-- Generated by Doxygen 1.8.17 -->
    34. 

  34. <script type="text/javascript">
    35. 

  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    36. 

  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    37. 

  37. /* @license-end */
    38. 

  38. </script>
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    43. 

  43. $(function() {
    44. 

  44.   initMenu('',true,false,'search.php','Search');
    45. 

  45.   $(document).ready(function() { init_search(); });
    46. 

  46. });
    47. 

  47. /* @license-end */</script>
    48. 

  48. <div id="main-nav"></div>
    49. 

  49. <!-- window showing the filter options -->
    50. 

  50. <div id="MSearchSelectWindow"
    51. 

  51.      onmouseover="return searchBox.OnSearchSelectShow()"
    52. 

  52.      onmouseout="return searchBox.OnSearchSelectHide()"
    53. 

  53.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    54. 

  54. </div>
    55. 

  55. 

  56. <!-- iframe showing the search results (closed by default) -->
    57. 

  57. <div id="MSearchResultsWindow">
    58. 

  58. <iframe src="javascript:void(0)" frameborder="0" 
    59. 

  59.         name="MSearchResults" id="MSearchResults">
    60. 

  60. </iframe>
    61. 

  61. </div>
    62. 

  62. 

  63. <div id="nav-path" class="navpath">
    64. 

  64.   <ul>
    65. 

  65. <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>
    66. 

  66. </div>
    67. 

  67. </div><!-- top -->
    68. 

  68. <div class="header">
    69. 

  69.   <div class="headertitle">
    70. 

  70. <div class="title">tls_certificate_provider.h</div>  </div>
    71. 

  71. </div><!--header-->
    72. 

  72. <div class="contents">
    73. 

  73. <a href="tls__certificate__provider_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>
    74. 

  74. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// Copyright 2020 gRPC authors.</span></div>
    75. 

  75. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//</span></div>
    76. 

  76. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
    77. 

  77. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
    78. 

  78. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
    79. 

  79. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div>
    80. 

  80. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//     http://www.apache.org/licenses/LICENSE-2.0</span></div>
    81. 

  81. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//</span></div>
    82. 

  82. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
    83. 

  83. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
    84. 

  84. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
    85. 

  85. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
    86. 

  86. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">// limitations under the License.</span></div>
    87. 

  87. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//</span></div>
    88. 

  88. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160; </div>
    89. 

  89. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef GRPCPP_SECURITY_TLS_CERTIFICATE_PROVIDER_H</span></div>
    90. 

  90. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define GRPCPP_SECURITY_TLS_CERTIFICATE_PROVIDER_H</span></div>
    91. 

  91. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160; </div>
    92. 

  92. <div class="line"><a name="l00020"></a><span class="lineno">   20</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>
    93. 

  93. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc_2status_8h.html">grpc/status.h</a>&gt;</span></div>
    94. 

  94. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="support_2log_8h.html">grpc/support/log.h</a>&gt;</span></div>
    95. 

  95. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2impl_2codegen_2grpc__library_8h.html">grpcpp/impl/codegen/grpc_library.h</a>&gt;</span></div>
    96. 

  96. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2config_8h.html">grpcpp/support/config.h</a>&gt;</span></div>
    97. 

  97. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160; </div>
    98. 

  98. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
    99. 

  99. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
    100. 

  100. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160; </div>
    101. 

  101. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">// TODO(yihuazhang): remove the forward declaration here and include</span></div>
    102. 

  102. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">// &lt;grpc/grpc_security.h&gt; directly once the insecure builds are cleaned up.</span></div>
    103. 

  103. <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="tls__certificate__provider_8h.html#ab7eb1d297905525b6c1f0508de55c028">   31</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a> <a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>;</div>
    104. 

  104. <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
    105. 

  105. <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
    106. 

  106. <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">namespace </span>experimental {</div>
    107. 

  107. <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
    108. 

  108. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">// Interface for a class that handles the process to fetch credential data.</span></div>
    109. 

  109. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">// Implementations should be a wrapper class of an internal provider</span></div>
    110. 

  110. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">// implementation.</span></div>
    111. 

  111. <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">   39</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">CertificateProviderInterface</a> {</div>
    112. 

  112. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160; <span class="keyword">public</span>:</div>
    113. 

  113. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html#afe79d717cfed70937978dfd030da57fb">~CertificateProviderInterface</a>() = <span class="keywordflow">default</span>;</div>
    114. 

  114. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;  <span class="keyword">virtual</span> <a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>* <a class="code" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html#a3f293b3dedea1935a82e3a3bb779e949">c_provider</a>() = 0;</div>
    115. 

  115. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;};</div>
    116. 

  116. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160; </div>
    117. 

  117. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">// A struct that stores the credential data presented to the peer in handshake</span></div>
    118. 

  118. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">// to show local identity. The private_key and certificate_chain should always</span></div>
    119. 

  119. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">// match.</span></div>
    120. 

  120. <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html">   48</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html">IdentityKeyCertPair</a> {</div>
    121. 

  121. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html#ab31899f5f54f8ab9c035c89a041f8701">   49</a></span>&#160;  std::string <a class="code" href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html#ab31899f5f54f8ab9c035c89a041f8701">private_key</a>;</div>
    122. 

  122. <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html#aadb18afc3c4e56dd1147333694d02e58">   50</a></span>&#160;  std::string <a class="code" href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html#aadb18afc3c4e56dd1147333694d02e58">certificate_chain</a>;</div>
    123. 

  123. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;};</div>
    124. 

  124. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
    125. 

  125. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment">// A basic CertificateProviderInterface implementation that will load credential</span></div>
    126. 

  126. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">// data from static string during initialization. This provider will always</span></div>
    127. 

  127. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">// return the same cert data for all cert names, and reloading is not supported.</span></div>
    128. 

  128. <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html">   56</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html">StaticDataCertificateProvider</a> : <span class="keyword">public</span> <a class="code" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">CertificateProviderInterface</a> {</div>
    129. 

  129. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160; <span class="keyword">public</span>:</div>
    130. 

  130. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a0b72dc0d81b33ecb4cc1812ee7b0d5f4">StaticDataCertificateProvider</a>(</div>
    131. 

  131. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;      <span class="keyword">const</span> std::string&amp; root_certificate,</div>
    132. 

  132. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;      <span class="keyword">const</span> std::vector&lt;IdentityKeyCertPair&gt;&amp; identity_key_cert_pairs);</div>
    133. 

  133. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
    134. 

  134. <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a4dffc04c8a03bb3062488ec3de50a452">   62</a></span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a4dffc04c8a03bb3062488ec3de50a452">StaticDataCertificateProvider</a>(<span class="keyword">const</span> std::string&amp; root_certificate)</div>
    135. 

  135. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;      : <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html">StaticDataCertificateProvider</a>(root_certificate, {}) {}</div>
    136. 

  136. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160; </div>
    137. 

  137. <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#ab51acb420cf14f1d55f544f2aa62b3cf">   65</a></span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#ab51acb420cf14f1d55f544f2aa62b3cf">StaticDataCertificateProvider</a>(</div>
    138. 

  138. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;      <span class="keyword">const</span> std::vector&lt;IdentityKeyCertPair&gt;&amp; identity_key_cert_pairs)</div>
    139. 

  139. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;      : <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html">StaticDataCertificateProvider</a>(<span class="stringliteral">&quot;&quot;</span>, identity_key_cert_pairs) {}</div>
    140. 

  140. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
    141. 

  141. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#ae48eb2f5b69084db3a4d9a4aa787b574">~StaticDataCertificateProvider</a>() <span class="keyword">override</span>;</div>
    142. 

  142. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160; </div>
    143. 

  143. <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a1439dedd4a6879c3ff6d0802d991a22d">   71</a></span>&#160;  <a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>* <a class="code" href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a1439dedd4a6879c3ff6d0802d991a22d">c_provider</a>()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> c_provider_; }</div>
    144. 

  144. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160; </div>
    145. 

  145. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160; <span class="keyword">private</span>:</div>
    146. 

  146. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  <a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>* c_provider_ = <span class="keyword">nullptr</span>;</div>
    147. 

  147. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;};</div>
    148. 

  148. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160; </div>
    149. 

  149. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment">// A CertificateProviderInterface implementation that will watch the credential</span></div>
    150. 

  150. <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment">// changes on the file system. This provider will always return the up-to-date</span></div>
    151. 

  151. <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment">// cert data for all the cert names callers set through |TlsCredentialsOptions|.</span></div>
    152. 

  152. <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">// Several things to note:</span></div>
    153. 

  153. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">// 1. This API only supports one key-cert file and hence one set of identity</span></div>
    154. 

  154. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">// key-cert pair, so SNI(Server Name Indication) is not supported.</span></div>
    155. 

  155. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">// 2. The private key and identity certificate should always match. This API</span></div>
    156. 

  156. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">// guarantees atomic read, and it is the callers&#39; responsibility to do atomic</span></div>
    157. 

  157. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">// updates. There are many ways to atomically update the key and certs in the</span></div>
    158. 

  158. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">// file system. To name a few:</span></div>
    159. 

  159. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment">//   1)  creating a new directory, renaming the old directory to a new name, and</span></div>
    160. 

  160. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">//   then renaming the new directory to the original name of the old directory.</span></div>
    161. 

  161. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">//   2)  using a symlink for the directory. When need to change, put new</span></div>
    162. 

  162. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">//   credential data in a new directory, and change symlink.</span></div>
    163. 

  163. <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html">   91</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html">FileWatcherCertificateProvider</a> final</div>
    164. 

  164. <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    : <span class="keyword">public</span> <a class="code" href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">CertificateProviderInterface</a> {</div>
    165. 

  165. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160; <span class="keyword">public</span>:</div>
    166. 

  166. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  <span class="comment">// Constructor to get credential updates from root and identity file paths.</span></div>
    167. 

  167. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  <span class="comment">//</span></div>
    168. 

  168. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  <span class="comment">// @param private_key_path is the file path of the private key.</span></div>
    169. 

  169. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;  <span class="comment">// @param identity_certificate_path is the file path of the identity</span></div>
    170. 

  170. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  <span class="comment">// certificate chain.</span></div>
    171. 

  171. <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <span class="comment">// @param root_cert_path is the file path to the root certificate bundle.</span></div>
    172. 

  172. <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  <span class="comment">// @param refresh_interval_sec is the refreshing interval that we will check</span></div>
    173. 

  173. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  <span class="comment">// the files for updates.</span></div>
    174. 

  174. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a796ef530e5ff982a060413684830ce31">FileWatcherCertificateProvider</a>(<span class="keyword">const</span> std::string&amp; private_key_path,</div>
    175. 

  175. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;                                 <span class="keyword">const</span> std::string&amp; identity_certificate_path,</div>
    176. 

  176. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;                                 <span class="keyword">const</span> std::string&amp; root_cert_path,</div>
    177. 

  177. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;                                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> refresh_interval_sec);</div>
    178. 

  178. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;  <span class="comment">// Constructor to get credential updates from identity file paths only.</span></div>
    179. 

  179. <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#ac7afc32d97f7459e79d7de3176387865">  107</a></span>&#160;  <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#ac7afc32d97f7459e79d7de3176387865">FileWatcherCertificateProvider</a>(<span class="keyword">const</span> std::string&amp; private_key_path,</div>
    180. 

  180. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;                                 <span class="keyword">const</span> std::string&amp; identity_certificate_path,</div>
    181. 

  181. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;                                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> refresh_interval_sec)</div>
    182. 

  182. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;      : <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html">FileWatcherCertificateProvider</a>(private_key_path,</div>
    183. 

  183. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;                                       identity_certificate_path, <span class="stringliteral">&quot;&quot;</span>,</div>
    184. 

  184. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;                                       refresh_interval_sec) {}</div>
    185. 

  185. <div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  <span class="comment">// Constructor to get credential updates from root file path only.</span></div>
    186. 

  186. <div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#af3edde419c3b8aad5e4a6f286c4c0369">  114</a></span>&#160;  <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#af3edde419c3b8aad5e4a6f286c4c0369">FileWatcherCertificateProvider</a>(<span class="keyword">const</span> std::string&amp; root_cert_path,</div>
    187. 

  187. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;                                 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> refresh_interval_sec)</div>
    188. 

  188. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;      : <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html">FileWatcherCertificateProvider</a>(<span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, root_cert_path,</div>
    189. 

  189. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;                                       refresh_interval_sec) {}</div>
    190. 

  190. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160; </div>
    191. 

  191. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a74b0da79f08e7d99612784b284c4535f">~FileWatcherCertificateProvider</a>() <span class="keyword">override</span>;</div>
    192. 

  192. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160; </div>
    193. 

  193. <div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a52c6245b084bc0a811177b28fc023d2a">  121</a></span>&#160;  <a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>* <a class="code" href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a52c6245b084bc0a811177b28fc023d2a">c_provider</a>()<span class="keyword"> override </span>{ <span class="keywordflow">return</span> c_provider_; }</div>
    194. 

  194. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160; </div>
    195. 

  195. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160; <span class="keyword">private</span>:</div>
    196. 

  196. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;  <a class="code" href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a>* c_provider_ = <span class="keyword">nullptr</span>;</div>
    197. 

  197. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;};</div>
    198. 

  198. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160; </div>
    199. 

  199. <div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;}  <span class="comment">// namespace experimental</span></div>
    200. 

  200. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;}  <span class="comment">// namespace grpc</span></div>
    201. 

  201. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160; </div>
    202. 

  202. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#endif  // GRPCPP_SECURITY_TLS_CERTIFICATE_PROVIDER_H</span></div>
    203. 

  203. </div><!-- fragment --></div><!-- contents -->
    204. 

  204. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_file_watcher_certificate_provider_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html">grpc::experimental::FileWatcherCertificateProvider</a></div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:91</div></div>
    205. 

  205. <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>
    206. 

  206. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_file_watcher_certificate_provider_html_ac7afc32d97f7459e79d7de3176387865"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#ac7afc32d97f7459e79d7de3176387865">grpc::experimental::FileWatcherCertificateProvider::FileWatcherCertificateProvider</a></div><div class="ttdeci">FileWatcherCertificateProvider(const std::string &amp;private_key_path, const std::string &amp;identity_certificate_path, unsigned int refresh_interval_sec)</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:107</div></div>
    207. 

  207. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_static_data_certificate_provider_html_ae48eb2f5b69084db3a4d9a4aa787b574"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#ae48eb2f5b69084db3a4d9a4aa787b574">grpc::experimental::StaticDataCertificateProvider::~StaticDataCertificateProvider</a></div><div class="ttdeci">~StaticDataCertificateProvider() override</div></div>
    208. 

  208. <div class="ttc" id="agrpc_2status_8h_html"><div class="ttname"><a href="grpc_2status_8h.html">status.h</a></div></div>
    209. 

  209. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_static_data_certificate_provider_html_ab51acb420cf14f1d55f544f2aa62b3cf"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#ab51acb420cf14f1d55f544f2aa62b3cf">grpc::experimental::StaticDataCertificateProvider::StaticDataCertificateProvider</a></div><div class="ttdeci">StaticDataCertificateProvider(const std::vector&lt; IdentityKeyCertPair &gt; &amp;identity_key_cert_pairs)</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:65</div></div>
    210. 

  210. <div class="ttc" id="agrpc__security_8h_html_ab7eb1d297905525b6c1f0508de55c028"><div class="ttname"><a href="grpc__security_8h.html#ab7eb1d297905525b6c1f0508de55c028">grpc_tls_certificate_provider</a></div><div class="ttdeci">struct grpc_tls_certificate_provider grpc_tls_certificate_provider</div><div class="ttdoc">A struct provides ways to gain credential data that will be used in the TLS handshake.</div><div class="ttdef"><b>Definition:</b> grpc_security.h:769</div></div>
    211. 

  211. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_file_watcher_certificate_provider_html_af3edde419c3b8aad5e4a6f286c4c0369"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#af3edde419c3b8aad5e4a6f286c4c0369">grpc::experimental::FileWatcherCertificateProvider::FileWatcherCertificateProvider</a></div><div class="ttdeci">FileWatcherCertificateProvider(const std::string &amp;root_cert_path, unsigned int refresh_interval_sec)</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:114</div></div>
    212. 

  212. <div class="ttc" id="asupport_2log_8h_html"><div class="ttname"><a href="support_2log_8h.html">log.h</a></div></div>
    213. 

  213. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_static_data_certificate_provider_html_a0b72dc0d81b33ecb4cc1812ee7b0d5f4"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a0b72dc0d81b33ecb4cc1812ee7b0d5f4">grpc::experimental::StaticDataCertificateProvider::StaticDataCertificateProvider</a></div><div class="ttdeci">StaticDataCertificateProvider(const std::string &amp;root_certificate, const std::vector&lt; IdentityKeyCertPair &gt; &amp;identity_key_cert_pairs)</div></div>
    214. 

  214. <div class="ttc" id="astructgrpc_1_1experimental_1_1_identity_key_cert_pair_html_aadb18afc3c4e56dd1147333694d02e58"><div class="ttname"><a href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html#aadb18afc3c4e56dd1147333694d02e58">grpc::experimental::IdentityKeyCertPair::certificate_chain</a></div><div class="ttdeci">std::string certificate_chain</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:50</div></div>
    215. 

  215. <div class="ttc" id="agrpcpp_2impl_2codegen_2grpc__library_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2grpc__library_8h.html">grpc_library.h</a></div></div>
    216. 

  216. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_static_data_certificate_provider_html_a1439dedd4a6879c3ff6d0802d991a22d"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a1439dedd4a6879c3ff6d0802d991a22d">grpc::experimental::StaticDataCertificateProvider::c_provider</a></div><div class="ttdeci">grpc_tls_certificate_provider * c_provider() override</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:71</div></div>
    217. 

  217. <div class="ttc" id="astructgrpc_1_1experimental_1_1_identity_key_cert_pair_html"><div class="ttname"><a href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html">grpc::experimental::IdentityKeyCertPair</a></div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:48</div></div>
    218. 

  218. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_certificate_provider_interface_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html">grpc::experimental::CertificateProviderInterface</a></div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:39</div></div>
    219. 

  219. <div class="ttc" id="astructgrpc_1_1experimental_1_1_identity_key_cert_pair_html_ab31899f5f54f8ab9c035c89a041f8701"><div class="ttname"><a href="structgrpc_1_1experimental_1_1_identity_key_cert_pair.html#ab31899f5f54f8ab9c035c89a041f8701">grpc::experimental::IdentityKeyCertPair::private_key</a></div><div class="ttdeci">std::string private_key</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:49</div></div>
    220. 

  220. <div class="ttc" id="agrpcpp_2support_2config_8h_html"><div class="ttname"><a href="grpcpp_2support_2config_8h.html">config.h</a></div></div>
    221. 

  221. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_file_watcher_certificate_provider_html_a52c6245b084bc0a811177b28fc023d2a"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a52c6245b084bc0a811177b28fc023d2a">grpc::experimental::FileWatcherCertificateProvider::c_provider</a></div><div class="ttdeci">grpc_tls_certificate_provider * c_provider() override</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:121</div></div>
    222. 

  222. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_certificate_provider_interface_html_afe79d717cfed70937978dfd030da57fb"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html#afe79d717cfed70937978dfd030da57fb">grpc::experimental::CertificateProviderInterface::~CertificateProviderInterface</a></div><div class="ttdeci">virtual ~CertificateProviderInterface()=default</div></div>
    223. 

  223. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_certificate_provider_interface_html_a3f293b3dedea1935a82e3a3bb779e949"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_certificate_provider_interface.html#a3f293b3dedea1935a82e3a3bb779e949">grpc::experimental::CertificateProviderInterface::c_provider</a></div><div class="ttdeci">virtual grpc_tls_certificate_provider * c_provider()=0</div></div>
    224. 

  224. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_static_data_certificate_provider_html"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html">grpc::experimental::StaticDataCertificateProvider</a></div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:56</div></div>
    225. 

  225. <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>
    226. 

  226. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_file_watcher_certificate_provider_html_a796ef530e5ff982a060413684830ce31"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a796ef530e5ff982a060413684830ce31">grpc::experimental::FileWatcherCertificateProvider::FileWatcherCertificateProvider</a></div><div class="ttdeci">FileWatcherCertificateProvider(const std::string &amp;private_key_path, const std::string &amp;identity_certificate_path, const std::string &amp;root_cert_path, unsigned int refresh_interval_sec)</div></div>
    227. 

  227. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_static_data_certificate_provider_html_a4dffc04c8a03bb3062488ec3de50a452"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_static_data_certificate_provider.html#a4dffc04c8a03bb3062488ec3de50a452">grpc::experimental::StaticDataCertificateProvider::StaticDataCertificateProvider</a></div><div class="ttdeci">StaticDataCertificateProvider(const std::string &amp;root_certificate)</div><div class="ttdef"><b>Definition:</b> tls_certificate_provider.h:62</div></div>
    228. 

  228. <div class="ttc" id="aclassgrpc_1_1experimental_1_1_file_watcher_certificate_provider_html_a74b0da79f08e7d99612784b284c4535f"><div class="ttname"><a href="classgrpc_1_1experimental_1_1_file_watcher_certificate_provider.html#a74b0da79f08e7d99612784b284c4535f">grpc::experimental::FileWatcherCertificateProvider::~FileWatcherCertificateProvider</a></div><div class="ttdeci">~FileWatcherCertificateProvider() override</div></div>
    229. 

  229. <!-- start footer part -->
    230. 

  230. <hr class="footer"/><address class="footer"><small>
    231. 

  231. Generated on Wed Mar 3 2021 19:17:20 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
    232. 

  232. <img class="footer" src="doxygen.png" alt="doxygen"/>
    233. 

  233. </a> 1.8.17
    234. 

  234. </small></address>
    235. 

  235. </body>
    236. 

  236. </html>
    237.