credentials_8h.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
  7. <title>GRPC C++: include/grpc++/security/credentials.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li class="current"><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="files.html"><span>File&#160;List</span></a></li>
  67. <li><a href="globals.html"><span>Globals</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f1b2ab2a88927c1e950e43c1cf4b634b.html">grpc++</a></li><li class="navelem"><a class="el" href="dir_7d74774c8f3e0db94d40932630f431b6.html">security</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#nested-classes">Data Structures</a> &#124;
  90. <a href="#namespaces">Namespaces</a> &#124;
  91. <a href="#func-members">Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">credentials.h File Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <div class="textblock"><code>#include &lt;map&gt;</code><br />
  97. <code>#include &lt;memory&gt;</code><br />
  98. <code>#include &lt;<a class="el" href="codegen_2grpc__library_8h_source.html">grpc++/impl/codegen/grpc_library.h</a>&gt;</code><br />
  99. <code>#include &lt;<a class="el" href="security_2auth__context_8h_source.html">grpc++/security/auth_context.h</a>&gt;</code><br />
  100. <code>#include &lt;<a class="el" href="grpc_09_09_2support_2status_8h_source.html">grpc++/support/status.h</a>&gt;</code><br />
  101. <code>#include &lt;<a class="el" href="support_2string__ref_8h_source.html">grpc++/support/string_ref.h</a>&gt;</code><br />
  102. </div>
  103. <p><a href="credentials_8h_source.html">Go to the source code of this file.</a></p>
  104. <table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  106. Data Structures</h2></td></tr>
  107. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_credentials.html">grpc::ChannelCredentials</a></td></tr>
  108. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A channel credentials object encapsulates all the state needed by a client to authenticate with a server for a given channel. <a href="classgrpc_1_1_channel_credentials.html#details">More...</a><br /></td></tr>
  109. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_call_credentials.html">grpc::CallCredentials</a></td></tr>
  111. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A call credentials object encapsulates the state needed by a client to authenticate with a server for a given call on a channel. <a href="classgrpc_1_1_call_credentials.html#details">More...</a><br /></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html">grpc::SslCredentialsOptions</a></td></tr>
  114. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options used to build SslCredentials. <a href="structgrpc_1_1_ssl_credentials_options.html#details">More...</a><br /></td></tr>
  115. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_metadata_credentials_plugin.html">grpc::MetadataCredentialsPlugin</a></td></tr>
  117. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
  120. Namespaces</h2></td></tr>
  121. <tr class="memitem:namespacegrpc"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html">grpc</a></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table><table class="memberdecls">
  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  125. Functions</h2></td></tr>
  126. <tr class="memitem:a6beb3ac70ff94bd2ebbd89b8f21d1f61"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; ChannelCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a6beb3ac70ff94bd2ebbd89b8f21d1f61">grpc::GoogleDefaultCredentials</a> ()</td></tr>
  127. <tr class="memdesc:a6beb3ac70ff94bd2ebbd89b8f21d1f61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds credentials with reasonable defaults. <a href="namespacegrpc.html#a6beb3ac70ff94bd2ebbd89b8f21d1f61">More...</a><br /></td></tr>
  128. <tr class="separator:a6beb3ac70ff94bd2ebbd89b8f21d1f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a845b0382cdd2c71ba8ca715643c38b94"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; ChannelCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a845b0382cdd2c71ba8ca715643c38b94">grpc::SslCredentials</a> (const SslCredentialsOptions &amp;options)</td></tr>
  130. <tr class="memdesc:a845b0382cdd2c71ba8ca715643c38b94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds SSL Credentials given SSL specific options. <a href="namespacegrpc.html#a845b0382cdd2c71ba8ca715643c38b94">More...</a><br /></td></tr>
  131. <tr class="separator:a845b0382cdd2c71ba8ca715643c38b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ad9eda8fa85bd833730a40697278e9fe6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#ad9eda8fa85bd833730a40697278e9fe6">grpc::GoogleComputeEngineCredentials</a> ()</td></tr>
  133. <tr class="memdesc:ad9eda8fa85bd833730a40697278e9fe6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds credentials for use when running in GCE. <a href="namespacegrpc.html#ad9eda8fa85bd833730a40697278e9fe6">More...</a><br /></td></tr>
  134. <tr class="separator:ad9eda8fa85bd833730a40697278e9fe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ae61aff892e1d17234d2d2367a5bc72a1"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#ae61aff892e1d17234d2d2367a5bc72a1">grpc::ServiceAccountJWTAccessCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;json_key, long token_lifetime_seconds)</td></tr>
  136. <tr class="memdesc:ae61aff892e1d17234d2d2367a5bc72a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds <a class="el" href="classgrpc_1_1_service.html">Service</a> Account JWT Access credentials. <a href="namespacegrpc.html#ae61aff892e1d17234d2d2367a5bc72a1">More...</a><br /></td></tr>
  137. <tr class="separator:ae61aff892e1d17234d2d2367a5bc72a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a96901c997b91bc6513b08491e0dca37c"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a96901c997b91bc6513b08491e0dca37c">grpc::GoogleRefreshTokenCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;json_refresh_token)</td></tr>
  139. <tr class="memdesc:a96901c997b91bc6513b08491e0dca37c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds refresh token credentials. <a href="namespacegrpc.html#a96901c997b91bc6513b08491e0dca37c">More...</a><br /></td></tr>
  140. <tr class="separator:a96901c997b91bc6513b08491e0dca37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ad3a80da696ffdaea943f0f858d7a360d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#ad3a80da696ffdaea943f0f858d7a360d">grpc::AccessTokenCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;access_token)</td></tr>
  142. <tr class="memdesc:ad3a80da696ffdaea943f0f858d7a360d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds access token credentials. <a href="namespacegrpc.html#ad3a80da696ffdaea943f0f858d7a360d">More...</a><br /></td></tr>
  143. <tr class="separator:ad3a80da696ffdaea943f0f858d7a360d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a9fc1fc101b41e680d47028166e76f9d0"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a9fc1fc101b41e680d47028166e76f9d0">grpc::GoogleIAMCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;authorization_token, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;authority_selector)</td></tr>
  145. <tr class="memdesc:a9fc1fc101b41e680d47028166e76f9d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds IAM credentials. <a href="namespacegrpc.html#a9fc1fc101b41e680d47028166e76f9d0">More...</a><br /></td></tr>
  146. <tr class="separator:a9fc1fc101b41e680d47028166e76f9d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a15b2ab0930231bc9142a6e63a9cc8219"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; ChannelCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a15b2ab0930231bc9142a6e63a9cc8219">grpc::CompositeChannelCredentials</a> (const std::shared_ptr&lt; ChannelCredentials &gt; &amp;channel_creds, const std::shared_ptr&lt; CallCredentials &gt; &amp;call_creds)</td></tr>
  148. <tr class="memdesc:a15b2ab0930231bc9142a6e63a9cc8219"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines a channel credentials and a call credentials into a composite channel credentials. <a href="namespacegrpc.html#a15b2ab0930231bc9142a6e63a9cc8219">More...</a><br /></td></tr>
  149. <tr class="separator:a15b2ab0930231bc9142a6e63a9cc8219"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:adc351fe5f823440fd2928a7dc65236f4"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#adc351fe5f823440fd2928a7dc65236f4">grpc::CompositeCallCredentials</a> (const std::shared_ptr&lt; CallCredentials &gt; &amp;creds1, const std::shared_ptr&lt; CallCredentials &gt; &amp;creds2)</td></tr>
  151. <tr class="memdesc:adc351fe5f823440fd2928a7dc65236f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines two call credentials objects into a composite call credentials. <a href="namespacegrpc.html#adc351fe5f823440fd2928a7dc65236f4">More...</a><br /></td></tr>
  152. <tr class="separator:adc351fe5f823440fd2928a7dc65236f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a72a5e2e0be4aa041cb587bea339589d7"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; ChannelCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a72a5e2e0be4aa041cb587bea339589d7">grpc::InsecureChannelCredentials</a> ()</td></tr>
  154. <tr class="memdesc:a72a5e2e0be4aa041cb587bea339589d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Credentials for an unencrypted, unauthenticated channel. <a href="namespacegrpc.html#a72a5e2e0be4aa041cb587bea339589d7">More...</a><br /></td></tr>
  155. <tr class="separator:a72a5e2e0be4aa041cb587bea339589d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a823c6a4b19ffc71fb33e90154ee2ad07"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; CallCredentials &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a823c6a4b19ffc71fb33e90154ee2ad07">grpc::MetadataCredentialsFromPlugin</a> (std::unique_ptr&lt; MetadataCredentialsPlugin &gt; plugin)</td></tr>
  157. <tr class="separator:a823c6a4b19ffc71fb33e90154ee2ad07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table>
  159. </div><!-- contents -->
  160. <!-- start footer part -->
  161. <hr class="footer"/><address class="footer"><small>
  162. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  163. <img class="footer" src="doxygen.png" alt="doxygen"/>
  164. </a> 1.8.11
  165. </small></address>
  166. </body>
  167. </html>