carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpcpp/security/credentials.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.13.0-dev</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<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>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">credentials.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;map&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2grpc__library_8h_source.html">grpcpp/impl/codegen/grpc_library.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="grpcpp_2security_2auth__context_8h_source.html">grpcpp/security/auth_context.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="grpcpp_2support_2status_8h_source.html">grpcpp/support/status.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="grpcpp_2support_2string__ref_8h_source.html">grpcpp/support/string_ref.h</a>&gt;</code><br />
</div>
<p><a href="grpcpp_2security_2credentials_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">User defined metadata credentials.  <a href="classgrpc_1_1_metadata_credentials_plugin.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_alts_credentials_options.html">grpc::experimental::AltsCredentialsOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options used to build AltsCredentials.  <a href="structgrpc_1_1experimental_1_1_alts_credentials_options.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<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>
<tr class="memdesc:namespacegrpc"><td class="mdescLeft">&#160;</td><td class="mdescRight">An <a class="el" href="classgrpc_1_1_alarm.html" title="A thin wrapper around grpc_alarm (see / / src/core/surface/alarm.h). ">Alarm</a> posts the user provided tag to its associated completion queue upon expiry or cancellation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacegrpc_1_1experimental"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html">grpc::experimental</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<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>
<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>
<tr class="separator:a6beb3ac70ff94bd2ebbd89b8f21d1f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a845b0382cdd2c71ba8ca715643c38b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ad9eda8fa85bd833730a40697278e9fe6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92a9f959d6102461f66ee973d8e9d3aa"><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#a92a9f959d6102461f66ee973d8e9d3aa">grpc::ServiceAccountJWTAccessCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;json_key, long token_lifetime_seconds=kMaxAuthTokenLifetimeSecs)</td></tr>
<tr class="memdesc:a92a9f959d6102461f66ee973d8e9d3aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds <a class="el" href="classgrpc_1_1_service.html" title="Desriptor of an RPC service and its various RPC methods. ">Service</a> Account JWT Access credentials.  <a href="namespacegrpc.html#a92a9f959d6102461f66ee973d8e9d3aa">More...</a><br /></td></tr>
<tr class="separator:a92a9f959d6102461f66ee973d8e9d3aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a96901c997b91bc6513b08491e0dca37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:ad3a80da696ffdaea943f0f858d7a360d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a9fc1fc101b41e680d47028166e76f9d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a15b2ab0930231bc9142a6e63a9cc8219"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:adc351fe5f823440fd2928a7dc65236f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a72a5e2e0be4aa041cb587bea339589d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb72a0af51f6a6a9aede5f7bb4ea4162"><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#abb72a0af51f6a6a9aede5f7bb4ea4162">grpc::CronetChannelCredentials</a> (void *engine)</td></tr>
<tr class="memdesc:abb72a0af51f6a6a9aede5f7bb4ea4162"><td class="mdescLeft">&#160;</td><td class="mdescRight">Credentials for a channel using Cronet.  <a href="namespacegrpc.html#abb72a0af51f6a6a9aede5f7bb4ea4162">More...</a><br /></td></tr>
<tr class="separator:abb72a0af51f6a6a9aede5f7bb4ea4162"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a823c6a4b19ffc71fb33e90154ee2ad07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad871e11876b9e9893ee4f57fc283abfb"><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_1_1experimental.html#ad871e11876b9e9893ee4f57fc283abfb">grpc::experimental::AltsCredentials</a> (const AltsCredentialsOptions &amp;options)</td></tr>
<tr class="memdesc:ad871e11876b9e9893ee4f57fc283abfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds ALTS Credentials given ALTS specific options.  <a href="namespacegrpc_1_1experimental.html#ad871e11876b9e9893ee4f57fc283abfb">More...</a><br /></td></tr>
<tr class="separator:ad871e11876b9e9893ee4f57fc283abfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a9b65a618d145857974b7defb40bed7a0"><td class="memItemLeft" align="right" valign="top">constexpr long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0">grpc::kMaxAuthTokenLifetimeSecs</a> = 3600</td></tr>
<tr class="memdesc:a9b65a618d145857974b7defb40bed7a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant for maximum auth token lifetime.  <a href="namespacegrpc.html#a9b65a618d145857974b7defb40bed7a0">More...</a><br /></td></tr>
<tr class="separator:a9b65a618d145857974b7defb40bed7a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>