natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
grpc/cpp/grpc__security_8h.html

623 lines
40 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpc/grpc_security.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" />
</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.64.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">grpc_security.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &lt;<a class="el" href="grpc_8h_source.html">grpc/grpc.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="grpc__security__constants_8h_source.html">grpc/grpc_security_constants.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="grpc_2status_8h_source.html">grpc/status.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="support_2port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br />
</div>
<p><a href="grpc__security_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a></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__auth__property.html">grpc_auth_property</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">value, if not NULL, is guaranteed to be NULL terminated. <a href="structgrpc__auth__property.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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa13f0724cb7ff99995d7f0881c01d553"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a></td></tr>
<tr class="memdesc:aa13f0724cb7ff99995d7f0881c01d553"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Authentication Context. <a href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">More...</a><br /></td></tr>
<tr class="separator:aa13f0724cb7ff99995d7f0881c01d553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecf098f41bfd613c4c62ea2a963a7a23"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aecf098f41bfd613c4c62ea2a963a7a23">grpc_auth_property_iterator</a></td></tr>
<tr class="separator:aecf098f41bfd613c4c62ea2a963a7a23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ddc1f2acf756950cc6c697c99f3e048"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a7ddc1f2acf756950cc6c697c99f3e048">grpc_auth_property</a></td></tr>
<tr class="memdesc:a7ddc1f2acf756950cc6c697c99f3e048"><td class="mdescLeft">&#160;</td><td class="mdescRight">value, if not NULL, is guaranteed to be NULL terminated. <a href="grpc__security_8h.html#a7ddc1f2acf756950cc6c697c99f3e048">More...</a><br /></td></tr>
<tr class="separator:a7ddc1f2acf756950cc6c697c99f3e048"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a971586c2e177c739bfe180ef440d21"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a></td></tr>
<tr class="memdesc:a0a971586c2e177c739bfe180ef440d21"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERIMENTAL - Subject to change. <a href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">More...</a><br /></td></tr>
<tr class="separator:a0a971586c2e177c739bfe180ef440d21"><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:ab10bd417749a79405d601516fbf5e5f4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#ab10bd417749a79405d601516fbf5e5f4">grpc_auth_property_iterator_next</a> (<a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> *it)</td></tr>
<tr class="memdesc:ab10bd417749a79405d601516fbf5e5f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns NULL when the iterator is at the end. <a href="grpc__security_8h.html#ab10bd417749a79405d601516fbf5e5f4">More...</a><br /></td></tr>
<tr class="separator:ab10bd417749a79405d601516fbf5e5f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedee02a7f6ed58e9bd41b00a518350c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aedee02a7f6ed58e9bd41b00a518350c2">grpc_auth_context_property_iterator</a> (const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
<tr class="memdesc:aedee02a7f6ed58e9bd41b00a518350c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates over the auth context. <a href="grpc__security_8h.html#aedee02a7f6ed58e9bd41b00a518350c2">More...</a><br /></td></tr>
<tr class="separator:aedee02a7f6ed58e9bd41b00a518350c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d6409cf4a261297cd327bd49e72fcea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a4d6409cf4a261297cd327bd49e72fcea">grpc_auth_context_peer_identity</a> (const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
<tr class="memdesc:a4d6409cf4a261297cd327bd49e72fcea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the peer identity. <a href="grpc__security_8h.html#a4d6409cf4a261297cd327bd49e72fcea">More...</a><br /></td></tr>
<tr class="separator:a4d6409cf4a261297cd327bd49e72fcea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d3ce2db2aa6fb1c21dd2789ee7c2d18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a9d3ce2db2aa6fb1c21dd2789ee7c2d18">grpc_auth_context_find_properties_by_name</a> (const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name)</td></tr>
<tr class="memdesc:a9d3ce2db2aa6fb1c21dd2789ee7c2d18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a property in the context. <a href="grpc__security_8h.html#a9d3ce2db2aa6fb1c21dd2789ee7c2d18">More...</a><br /></td></tr>
<tr class="separator:a9d3ce2db2aa6fb1c21dd2789ee7c2d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf812326f742584f336b3777dba08f11"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#acf812326f742584f336b3777dba08f11">grpc_auth_context_peer_identity_property_name</a> (const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
<tr class="memdesc:acf812326f742584f336b3777dba08f11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the property that indicates the peer identity. <a href="grpc__security_8h.html#acf812326f742584f336b3777dba08f11">More...</a><br /></td></tr>
<tr class="separator:acf812326f742584f336b3777dba08f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bb56dbcba0b0c54e3c6da0635391959"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5bb56dbcba0b0c54e3c6da0635391959">grpc_auth_context_peer_is_authenticated</a> (const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
<tr class="memdesc:a5bb56dbcba0b0c54e3c6da0635391959"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns 1 if the peer is authenticated, 0 otherwise. <a href="grpc__security_8h.html#a5bb56dbcba0b0c54e3c6da0635391959">More...</a><br /></td></tr>
<tr class="separator:a5bb56dbcba0b0c54e3c6da0635391959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c1860cddc9edaa7f657a98a35b77e80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a3c1860cddc9edaa7f657a98a35b77e80">grpc_call_auth_context</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call)</td></tr>
<tr class="memdesc:a3c1860cddc9edaa7f657a98a35b77e80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the auth context from the call. <a href="grpc__security_8h.html#a3c1860cddc9edaa7f657a98a35b77e80">More...</a><br /></td></tr>
<tr class="separator:a3c1860cddc9edaa7f657a98a35b77e80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9dbfdabaca2ab86c9d7e71cbc81d3d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa9dbfdabaca2ab86c9d7e71cbc81d3d4">grpc_auth_context_release</a> (<a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *context)</td></tr>
<tr class="memdesc:aa9dbfdabaca2ab86c9d7e71cbc81d3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the auth context returned from grpc_call_auth_context. <a href="grpc__security_8h.html#aa9dbfdabaca2ab86c9d7e71cbc81d3d4">More...</a><br /></td></tr>
<tr class="separator:aa9dbfdabaca2ab86c9d7e71cbc81d3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93f543166de70abb3a725bdca1d79996"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a93f543166de70abb3a725bdca1d79996">grpc_auth_context_add_property</a> (<a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name, const char *value, size_t value_length)</td></tr>
<tr class="memdesc:a93f543166de70abb3a725bdca1d79996"><td class="mdescLeft">&#160;</td><td class="mdescRight">&ndash; The following auth context methods should only be called by a server metadata <a href="grpc__security_8h.html#a93f543166de70abb3a725bdca1d79996">More...</a><br /></td></tr>
<tr class="separator:a93f543166de70abb3a725bdca1d79996"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73068ca89b430bb9004f8c3e86a2886a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a73068ca89b430bb9004f8c3e86a2886a">grpc_auth_context_add_cstring_property</a> (<a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name, const char *value)</td></tr>
<tr class="memdesc:a73068ca89b430bb9004f8c3e86a2886a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a C string property. <a href="grpc__security_8h.html#a73068ca89b430bb9004f8c3e86a2886a">More...</a><br /></td></tr>
<tr class="separator:a73068ca89b430bb9004f8c3e86a2886a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cff913051370085b7cc58aa3ccbd4a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a9cff913051370085b7cc58aa3ccbd4a4">grpc_auth_context_set_peer_identity_property_name</a> (<a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name)</td></tr>
<tr class="memdesc:a9cff913051370085b7cc58aa3ccbd4a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the property name. <a href="grpc__security_8h.html#a9cff913051370085b7cc58aa3ccbd4a4">More...</a><br /></td></tr>
<tr class="separator:a9cff913051370085b7cc58aa3ccbd4a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7baf4df54030f3d5c7afb562e6cecf4d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a7baf4df54030f3d5c7afb562e6cecf4d">grpc_authorization_policy_provider_static_data_create</a> (const char *authz_policy, <a class="el" href="grpc_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> *code, const char **error_details)</td></tr>
<tr class="memdesc:a7baf4df54030f3d5c7afb562e6cecf4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERIMENTAL - Subject to change. <a href="grpc__security_8h.html#a7baf4df54030f3d5c7afb562e6cecf4d">More...</a><br /></td></tr>
<tr class="separator:a7baf4df54030f3d5c7afb562e6cecf4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1af848db3753b7bd14aaf3565d3c4102"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a1af848db3753b7bd14aaf3565d3c4102">grpc_authorization_policy_provider_file_watcher_create</a> (const char *authz_policy_path, unsigned int refresh_interval_sec, <a class="el" href="grpc_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> *code, const char **error_details)</td></tr>
<tr class="memdesc:a1af848db3753b7bd14aaf3565d3c4102"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERIMENTAL - Subject to change. <a href="grpc__security_8h.html#a1af848db3753b7bd14aaf3565d3c4102">More...</a><br /></td></tr>
<tr class="separator:a1af848db3753b7bd14aaf3565d3c4102"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5367215eba06ef320f4999abc378e663"><td class="memItemLeft" align="right" valign="top"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5367215eba06ef320f4999abc378e663">grpc_authorization_policy_provider_release</a> (<a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a> *provider)</td></tr>
<tr class="memdesc:a5367215eba06ef320f4999abc378e663"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERIMENTAL - Subject to change. <a href="grpc__security_8h.html#a5367215eba06ef320f4999abc378e663">More...</a><br /></td></tr>
<tr class="separator:a5367215eba06ef320f4999abc378e663"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aa13f0724cb7ff99995d7f0881c01d553"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa13f0724cb7ff99995d7f0881c01d553">&#9670;&nbsp;</a></span>grpc_auth_context</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>&mdash; Authentication Context. </p>
<p>&mdash; </p>
</div>
</div>
<a id="a7ddc1f2acf756950cc6c697c99f3e048"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ddc1f2acf756950cc6c697c99f3e048">&#9670;&nbsp;</a></span>grpc_auth_property</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a> <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>value, if not NULL, is guaranteed to be NULL terminated. </p>
</div>
</div>
<a id="aecf098f41bfd613c4c62ea2a963a7a23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecf098f41bfd613c4c62ea2a963a7a23">&#9670;&nbsp;</a></span>grpc_auth_property_iterator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0a971586c2e177c739bfe180ef440d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a971586c2e177c739bfe180ef440d21">&#9670;&nbsp;</a></span>grpc_authorization_policy_provider</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a> <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>EXPERIMENTAL - Subject to change. </p>
<p>An opaque type that is responsible for providing authorization policies to gRPC. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a73068ca89b430bb9004f8c3e86a2886a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73068ca89b430bb9004f8c3e86a2886a">&#9670;&nbsp;</a></span>grpc_auth_context_add_cstring_property()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_auth_context_add_cstring_property </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a C string property. </p>
</div>
</div>
<a id="a93f543166de70abb3a725bdca1d79996"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93f543166de70abb3a725bdca1d79996">&#9670;&nbsp;</a></span>grpc_auth_context_add_property()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_auth_context_add_property </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>value_length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>&ndash; The following auth context methods should only be called by a server metadata </p>
<h2><a class="anchor" id="autotoc_md271"></a>
processor to set properties extracted from auth metadata.</h2>
<p>Add a property. </p>
</div>
</div>
<a id="a9d3ce2db2aa6fb1c21dd2789ee7c2d18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d3ce2db2aa6fb1c21dd2789ee7c2d18">&#9670;&nbsp;</a></span>grpc_auth_context_find_properties_by_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> grpc_auth_context_find_properties_by_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds a property in the context. </p>
<p>May return an empty iterator (first _next will return NULL) if no property with this name was found in the context. </p>
</div>
</div>
<a id="a4d6409cf4a261297cd327bd49e72fcea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d6409cf4a261297cd327bd49e72fcea">&#9670;&nbsp;</a></span>grpc_auth_context_peer_identity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> grpc_auth_context_peer_identity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the peer identity. </p>
<p>Returns an empty iterator (first _next will return NULL) if the peer is not authenticated. </p>
</div>
</div>
<a id="acf812326f742584f336b3777dba08f11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf812326f742584f336b3777dba08f11">&#9670;&nbsp;</a></span>grpc_auth_context_peer_identity_property_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> char* grpc_auth_context_peer_identity_property_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name of the property that indicates the peer identity. </p>
<p>Will return NULL if the peer is not authenticated. </p>
</div>
</div>
<a id="a5bb56dbcba0b0c54e3c6da0635391959"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bb56dbcba0b0c54e3c6da0635391959">&#9670;&nbsp;</a></span>grpc_auth_context_peer_is_authenticated()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_auth_context_peer_is_authenticated </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns 1 if the peer is authenticated, 0 otherwise. </p>
</div>
</div>
<a id="aedee02a7f6ed58e9bd41b00a518350c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedee02a7f6ed58e9bd41b00a518350c2">&#9670;&nbsp;</a></span>grpc_auth_context_property_iterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> grpc_auth_context_property_iterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over the auth context. </p>
</div>
</div>
<a id="aa9dbfdabaca2ab86c9d7e71cbc81d3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9dbfdabaca2ab86c9d7e71cbc81d3d4">&#9670;&nbsp;</a></span>grpc_auth_context_release()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_auth_context_release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the auth context returned from grpc_call_auth_context. </p>
</div>
</div>
<a id="a9cff913051370085b7cc58aa3ccbd4a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cff913051370085b7cc58aa3ccbd4a4">&#9670;&nbsp;</a></span>grpc_auth_context_set_peer_identity_property_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_auth_context_set_peer_identity_property_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the property name. </p>
<p>Returns 1 if successful or 0 in case of failure (which means that no property with this name exists). </p>
</div>
</div>
<a id="ab10bd417749a79405d601516fbf5e5f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab10bd417749a79405d601516fbf5e5f4">&#9670;&nbsp;</a></span>grpc_auth_property_iterator_next()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a>* grpc_auth_property_iterator_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> *&#160;</td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns NULL when the iterator is at the end. </p>
</div>
</div>
<a id="a1af848db3753b7bd14aaf3565d3c4102"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1af848db3753b7bd14aaf3565d3c4102">&#9670;&nbsp;</a></span>grpc_authorization_policy_provider_file_watcher_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a>* grpc_authorization_policy_provider_file_watcher_create </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>authz_policy_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>refresh_interval_sec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="grpc_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> *&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **&#160;</td>
<td class="paramname"><em>error_details</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>EXPERIMENTAL - Subject to change. </p>
<p>Creates a grpc_authorization_policy_provider by watching for gRPC authorization policy changes in filesystem.</p><ul>
<li>authz_policy is the file path of gRPC authorization policy.</li>
<li>refresh_interval_sec is the amount of time the internal thread would wait before checking for file updates.</li>
<li>code is the error status code on failure. On success, it equals GRPC_STATUS_OK.</li>
<li>error_details contains details about the error if any. If the initialization is successful, it will be null. Caller must use gpr_free to destroy this string. </li>
</ul>
</div>
</div>
<a id="a5367215eba06ef320f4999abc378e663"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5367215eba06ef320f4999abc378e663">&#9670;&nbsp;</a></span>grpc_authorization_policy_provider_release()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_authorization_policy_provider_release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a> *&#160;</td>
<td class="paramname"><em>provider</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>EXPERIMENTAL - Subject to change. </p>
<p>Releases grpc_authorization_policy_provider object. The creator of grpc_authorization_policy_provider is responsible for its release. </p>
</div>
</div>
<a id="a7baf4df54030f3d5c7afb562e6cecf4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7baf4df54030f3d5c7afb562e6cecf4d">&#9670;&nbsp;</a></span>grpc_authorization_policy_provider_static_data_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a0a971586c2e177c739bfe180ef440d21">grpc_authorization_policy_provider</a>* grpc_authorization_policy_provider_static_data_create </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>authz_policy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="grpc_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> *&#160;</td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **&#160;</td>
<td class="paramname"><em>error_details</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>EXPERIMENTAL - Subject to change. </p>
<p>Creates a grpc_authorization_policy_provider using gRPC authorization policy from static string.</p><ul>
<li>authz_policy is the input gRPC authorization policy.</li>
<li>code is the error status code on failure. On success, it equals GRPC_STATUS_OK.</li>
<li>error_details contains details about the error if any. If the initialization is successful, it will be null. Caller must use gpr_free to destroy this string. </li>
</ul>
</div>
</div>
<a id="a3c1860cddc9edaa7f657a98a35b77e80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c1860cddc9edaa7f657a98a35b77e80">&#9670;&nbsp;</a></span>grpc_call_auth_context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="support_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc_2credentials_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a>* grpc_call_auth_context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
<td class="paramname"><em>call</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the auth context from the call. </p>
<p>Caller needs to call grpc_auth_context_release on the returned context. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 17 2024 01:17:16 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink