grpcpp_2security_2credentials_8h_source.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: include/grpcpp/security/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.30.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.16 -->
  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">credentials.h</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="grpcpp_2security_2credentials_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_CREDENTIALS_H</span></div>
  90. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define GRPCPP_SECURITY_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;<a class="code" href="credentials__impl_8h.html">grpcpp/security/credentials_impl.h</a>&gt;</span></div>
  93. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
  94. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
  95. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
  96. <div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de"> 26</a></span>&#160;<a class="code" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">typedef ::grpc_impl::ChannelCredentials</a> <a class="code" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">ChannelCredentials</a>;</div>
  97. <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a342736b8414b0f55bf7154e0ddfaddd2"> 27</a></span>&#160;<a class="code" href="namespacegrpc.html#a342736b8414b0f55bf7154e0ddfaddd2">typedef ::grpc_impl::CallCredentials</a> <a class="code" href="namespacegrpc.html#a342736b8414b0f55bf7154e0ddfaddd2">CallCredentials</a>;</div>
  98. <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespacegrpc.html#ab5168b14aecc6de83c874a72b16d073e"> 28</a></span>&#160;<a class="code" href="namespacegrpc.html#ab5168b14aecc6de83c874a72b16d073e">typedef ::grpc_impl::SslCredentialsOptions</a> <a class="code" href="namespacegrpc.html#ab5168b14aecc6de83c874a72b16d073e">SslCredentialsOptions</a>;</div>
  99. <div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacegrpc.html#ac98f7fcdb6e918b043433c20197c20b6"> 29</a></span>&#160;<a class="code" href="namespacegrpc.html#ac98f7fcdb6e918b043433c20197c20b6">typedef ::grpc_impl::SecureCallCredentials</a> <a class="code" href="namespacegrpc.html#ac98f7fcdb6e918b043433c20197c20b6">SecureCallCredentials</a>;</div>
  100. <div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a1870277cca7ed6ebac824ea43d6da689"> 30</a></span>&#160;<a class="code" href="namespacegrpc.html#a1870277cca7ed6ebac824ea43d6da689">typedef ::grpc_impl::SecureChannelCredentials</a> <a class="code" href="namespacegrpc.html#a1870277cca7ed6ebac824ea43d6da689">SecureChannelCredentials</a>;</div>
  101. <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a9db94ddbe0252efe09ab45f0de8abba8"> 31</a></span>&#160;<a class="code" href="namespacegrpc.html#a9db94ddbe0252efe09ab45f0de8abba8">typedef ::grpc_impl::MetadataCredentialsPlugin</a> <a class="code" href="namespacegrpc.html#a9db94ddbe0252efe09ab45f0de8abba8">MetadataCredentialsPlugin</a>;</div>
  102. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
  103. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::ChannelCredentials&gt;</div>
  104. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;GoogleDefaultCredentials() {</div>
  105. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; return ::grpc_impl::GoogleDefaultCredentials();</div>
  106. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div>
  107. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
  108. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;ChannelCredentials&gt; SslCredentials(</div>
  109. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab5168b14aecc6de83c874a72b16d073e">SslCredentialsOptions</a>&amp; options) {</div>
  110. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; return ::grpc_impl::SslCredentials(options);</div>
  111. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div>
  112. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
  113. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt;</div>
  114. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;GoogleComputeEngineCredentials() {</div>
  115. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; return ::grpc_impl::GoogleComputeEngineCredentials();</div>
  116. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div>
  117. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
  118. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0"> 49</a></span>&#160;constexpr <span class="keywordtype">long</span> <a class="code" href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0">kMaxAuthTokenLifetimeSecs</a> =</div>
  119. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0">::grpc_impl::kMaxAuthTokenLifetimeSecs</a>;</div>
  120. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
  121. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt;</div>
  122. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;ServiceAccountJWTAccessCredentials(</div>
  123. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; json_key,</div>
  124. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">long</span> token_lifetime_seconds = <a class="code" href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0">grpc::kMaxAuthTokenLifetimeSecs</a>) {</div>
  125. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; return ::grpc_impl::ServiceAccountJWTAccessCredentials(</div>
  126. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; json_key, token_lifetime_seconds);</div>
  127. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div>
  128. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
  129. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt;</div>
  130. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;GoogleRefreshTokenCredentials(<span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; json_refresh_token) {</div>
  131. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; return ::grpc_impl::GoogleRefreshTokenCredentials(json_refresh_token);</div>
  132. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;}</div>
  133. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
  134. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt;</div>
  135. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;AccessTokenCredentials(<span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; access_token) {</div>
  136. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; return ::grpc_impl::AccessTokenCredentials(access_token);</div>
  137. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
  138. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
  139. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt; GoogleIAMCredentials(</div>
  140. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; authorization_token,</div>
  141. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; authority_selector) {</div>
  142. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; return ::grpc_impl::GoogleIAMCredentials(authorization_token,</div>
  143. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; authority_selector);</div>
  144. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
  145. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
  146. <div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="namespacegrpc__impl.html#a59409a2853f39bd444964a886a836e17"> 77</a></span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;ChannelCredentials&gt; CompositeChannelCredentials(</div>
  147. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;ChannelCredentials&gt;&amp; channel_creds,</div>
  148. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;CallCredentials&gt;&amp; call_creds) {</div>
  149. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; return ::grpc_impl::CompositeChannelCredentials(channel_creds, call_creds);</div>
  150. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
  151. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
  152. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt;</div>
  153. <div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="namespacegrpc__impl.html#a326eea880361ad2aa40dd87af6d64812"> 84</a></span>&#160;CompositeCallCredentials(<span class="keyword">const</span> std::shared_ptr&lt;CallCredentials&gt;&amp; creds1,</div>
  154. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">const</span> std::shared_ptr&lt;CallCredentials&gt;&amp; creds2) {</div>
  155. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; return ::grpc_impl::CompositeCallCredentials(creds1, creds2);</div>
  156. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div>
  157. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
  158. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::ChannelCredentials&gt;</div>
  159. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;InsecureChannelCredentials() {</div>
  160. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; return ::grpc_impl::InsecureChannelCredentials();</div>
  161. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;}</div>
  162. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
  163. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<a class="code" href="namespacegrpc.html#a9db94ddbe0252efe09ab45f0de8abba8">typedef ::grpc_impl::MetadataCredentialsPlugin</a> <a class="code" href="namespacegrpc.html#a9db94ddbe0252efe09ab45f0de8abba8">MetadataCredentialsPlugin</a>;</div>
  164. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
  165. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt;</div>
  166. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;MetadataCredentialsFromPlugin(</div>
  167. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; std::unique_ptr&lt;MetadataCredentialsPlugin&gt; plugin) {</div>
  168. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; return ::grpc_impl::MetadataCredentialsFromPlugin(std::move(plugin));</div>
  169. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;}</div>
  170. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
  171. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="keyword">namespace </span>experimental {</div>
  172. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
  173. <div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1experimental.html#ac4837b9e8b9108310ba8cbc65e52e7c4"> 104</a></span>&#160;<a class="code" href="namespacegrpc_1_1experimental.html#ac4837b9e8b9108310ba8cbc65e52e7c4">typedef ::grpc_impl::experimental::StsCredentialsOptions</a> <a class="code" href="namespacegrpc_1_1experimental.html#ac4837b9e8b9108310ba8cbc65e52e7c4">StsCredentialsOptions</a>;</div>
  174. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
  175. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="classgrpc_1_1_status.html">grpc::Status</a> StsCredentialsOptionsFromJson(</div>
  176. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&amp; json_string, <a class="code" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a>* options) {</div>
  177. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; return ::grpc_impl::experimental::StsCredentialsOptionsFromJson(json_string,</div>
  178. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; options);</div>
  179. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;}</div>
  180. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
  181. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="classgrpc_1_1_status.html">grpc::Status</a> StsCredentialsOptionsFromEnv(</div>
  182. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <a class="code" href="namespacegrpc_1_1experimental.html#ac4837b9e8b9108310ba8cbc65e52e7c4">StsCredentialsOptions</a>* options) {</div>
  183. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespacegrpc__impl_1_1experimental.html#aede3f7e0584dea73197d2913b0a4defe">grpc_impl::experimental::StsCredentialsOptionsFromEnv</a>(options);</div>
  184. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;}</div>
  185. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
  186. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::CallCredentials&gt; StsCredentials(</div>
  187. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacegrpc_1_1experimental.html#ac4837b9e8b9108310ba8cbc65e52e7c4">StsCredentialsOptions</a>&amp; options) {</div>
  188. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespacegrpc__impl_1_1experimental.html#a0438f46fa3968eb6e904005356b8c531">grpc_impl::experimental::StsCredentials</a>(options);</div>
  189. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;}</div>
  190. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
  191. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<a class="code" href="namespacegrpc_1_1experimental.html#ab381bbcb87e572c667736fb1b8dd39ff">typedef ::grpc_impl::experimental::AltsCredentialsOptions</a></div>
  192. <div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="namespacegrpc_1_1experimental.html#ab381bbcb87e572c667736fb1b8dd39ff"> 123</a></span>&#160; <a class="code" href="namespacegrpc_1_1experimental.html#ab381bbcb87e572c667736fb1b8dd39ff">AltsCredentialsOptions</a>;</div>
  193. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
  194. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::ChannelCredentials&gt; AltsCredentials(</div>
  195. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a>&amp; options) {</div>
  196. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; return ::grpc_impl::experimental::AltsCredentials(options);</div>
  197. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;}</div>
  198. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
  199. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::ChannelCredentials&gt; LocalCredentials(</div>
  200. <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>
  201. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; return ::grpc_impl::experimental::LocalCredentials(type);</div>
  202. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;}</div>
  203. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
  204. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;grpc_impl::ChannelCredentials&gt; TlsCredentials(</div>
  205. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; const ::grpc_impl::experimental::TlsCredentialsOptions&amp; options) {</div>
  206. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; return ::grpc_impl::experimental::TlsCredentials(options);</div>
  207. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;}</div>
  208. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div>
  209. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;} <span class="comment">// namespace experimental</span></div>
  210. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;} <span class="comment">// namespace grpc</span></div>
  211. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
  212. <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="preprocessor">#endif // GRPCPP_SECURITY_CREDENTIALS_H</span></div>
  213. </div><!-- fragment --></div><!-- contents -->
  214. <div class="ttc" id="anamespacegrpc__impl_1_1experimental_html_a0438f46fa3968eb6e904005356b8c531"><div class="ttname"><a href="namespacegrpc__impl_1_1experimental.html#a0438f46fa3968eb6e904005356b8c531">grpc_impl::experimental::StsCredentials</a></div><div class="ttdeci">std::shared_ptr&lt; CallCredentials &gt; StsCredentials(const StsCredentialsOptions &amp;options)</div></div>
  215. <div class="ttc" id="anamespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...</div><div class="ttdef"><b>Definition:</b> alarm.h:24</div></div>
  216. <div class="ttc" id="anamespacegrpc_html_a9db94ddbe0252efe09ab45f0de8abba8"><div class="ttname"><a href="namespacegrpc.html#a9db94ddbe0252efe09ab45f0de8abba8">grpc::MetadataCredentialsPlugin</a></div><div class="ttdeci">::grpc_impl::MetadataCredentialsPlugin MetadataCredentialsPlugin</div><div class="ttdef"><b>Definition:</b> credentials.h:31</div></div>
  217. <div class="ttc" id="anamespacegrpc_html_aaf2939b1b4a48aa00606f8e986bf21de"><div class="ttname"><a href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a></div><div class="ttdeci">::grpc_impl::ChannelCredentials ChannelCredentials</div><div class="ttdef"><b>Definition:</b> credentials.h:26</div></div>
  218. <div class="ttc" id="anamespacegrpc_html_ac98f7fcdb6e918b043433c20197c20b6"><div class="ttname"><a href="namespacegrpc.html#ac98f7fcdb6e918b043433c20197c20b6">grpc::SecureCallCredentials</a></div><div class="ttdeci">::grpc_impl::SecureCallCredentials SecureCallCredentials</div><div class="ttdef"><b>Definition:</b> credentials.h:29</div></div>
  219. <div class="ttc" id="aclassgrpc_1_1_status_html"><div class="ttname"><a href="classgrpc_1_1_status.html">grpc::Status</a></div><div class="ttdoc">Did it work? If it didn't, why?</div><div class="ttdef"><b>Definition:</b> status.h:31</div></div>
  220. <div class="ttc" id="anamespacegrpc__impl_1_1experimental_html_aede3f7e0584dea73197d2913b0a4defe"><div class="ttname"><a href="namespacegrpc__impl_1_1experimental.html#aede3f7e0584dea73197d2913b0a4defe">grpc_impl::experimental::StsCredentialsOptionsFromEnv</a></div><div class="ttdeci">grpc::Status StsCredentialsOptionsFromEnv(StsCredentialsOptions *options)</div><div class="ttdoc">Creates STS credentials options from the $STS_CREDENTIALS environment variable.</div></div>
  221. <div class="ttc" id="astructgrpc__impl_1_1experimental_1_1_sts_credentials_options_html"><div class="ttname"><a href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">grpc_impl::experimental::StsCredentialsOptions</a></div><div class="ttdoc">Options for creating STS Oauth Token Exchange credentials following the IETF draft https://tools....</div><div class="ttdef"><b>Definition:</b> credentials_impl.h:272</div></div>
  222. <div class="ttc" id="anamespacegrpc_1_1experimental_html_ab381bbcb87e572c667736fb1b8dd39ff"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#ab381bbcb87e572c667736fb1b8dd39ff">grpc::experimental::AltsCredentialsOptions</a></div><div class="ttdeci">::grpc_impl::experimental::AltsCredentialsOptions AltsCredentialsOptions</div><div class="ttdef"><b>Definition:</b> credentials.h:123</div></div>
  223. <div class="ttc" id="anamespacegrpc_1_1experimental_html_ac4837b9e8b9108310ba8cbc65e52e7c4"><div class="ttname"><a href="namespacegrpc_1_1experimental.html#ac4837b9e8b9108310ba8cbc65e52e7c4">grpc::experimental::StsCredentialsOptions</a></div><div class="ttdeci">::grpc_impl::experimental::StsCredentialsOptions StsCredentialsOptions</div><div class="ttdef"><b>Definition:</b> credentials.h:104</div></div>
  224. <div class="ttc" id="astructgrpc__impl_1_1experimental_1_1_alts_credentials_options_html"><div class="ttname"><a href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">grpc_impl::experimental::AltsCredentialsOptions</a></div><div class="ttdoc">Options used to build AltsCredentials.</div><div class="ttdef"><b>Definition:</b> credentials_impl.h:336</div></div>
  225. <div class="ttc" id="anamespacegrpc_html_a1870277cca7ed6ebac824ea43d6da689"><div class="ttname"><a href="namespacegrpc.html#a1870277cca7ed6ebac824ea43d6da689">grpc::SecureChannelCredentials</a></div><div class="ttdeci">::grpc_impl::SecureChannelCredentials SecureChannelCredentials</div><div class="ttdef"><b>Definition:</b> credentials.h:30</div></div>
  226. <div class="ttc" id="acredentials__impl_8h_html"><div class="ttname"><a href="credentials__impl_8h.html">credentials_impl.h</a></div></div>
  227. <div class="ttc" id="anamespacegrpc_html_a342736b8414b0f55bf7154e0ddfaddd2"><div class="ttname"><a href="namespacegrpc.html#a342736b8414b0f55bf7154e0ddfaddd2">grpc::CallCredentials</a></div><div class="ttdeci">::grpc_impl::CallCredentials CallCredentials</div><div class="ttdef"><b>Definition:</b> credentials.h:27</div></div>
  228. <div class="ttc" id="anamespacegrpc_html_ab04a87625da3bf85cdaf5e7856b00203"><div class="ttname"><a href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a></div><div class="ttdeci">std::string string</div><div class="ttdef"><b>Definition:</b> config.h:35</div></div>
  229. <div class="ttc" id="anamespacegrpc_html_a9b65a618d145857974b7defb40bed7a0"><div class="ttname"><a href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0">grpc::kMaxAuthTokenLifetimeSecs</a></div><div class="ttdeci">constexpr long kMaxAuthTokenLifetimeSecs</div><div class="ttdoc">Constant for maximum auth token lifetime.</div><div class="ttdef"><b>Definition:</b> credentials.h:49</div></div>
  230. <div class="ttc" id="anamespacegrpc_html_ab5168b14aecc6de83c874a72b16d073e"><div class="ttname"><a href="namespacegrpc.html#ab5168b14aecc6de83c874a72b16d073e">grpc::SslCredentialsOptions</a></div><div class="ttdeci">::grpc_impl::SslCredentialsOptions SslCredentialsOptions</div><div class="ttdef"><b>Definition:</b> credentials.h:28</div></div>
  231. <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>
  232. <!-- start footer part -->
  233. <hr class="footer"/><address class="footer"><small>
  234. Generated on Tue Jun 30 2020 18:16:56 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  235. <img class="footer" src="doxygen.png" alt="doxygen"/>
  236. </a> 1.8.16
  237. </small></address>
  238. </body>
  239. </html>