282 lines
15 KiB
HTML
282 lines
15 KiB
HTML
<!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++: grpc_tls_server_authorization_check_arg Struct 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++
|
|
 <span id="projectnumber">1.31.1</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&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&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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">grpc_tls_server_authorization_check_arg Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A struct containing all information necessary to schedule/cancel a server authorization check request.
|
|
<a href="structgrpc__tls__server__authorization__check__arg.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a77029657f0b1b653fe3694a05b3272dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#ab72de5caa877bbfff84676b1cb024fb3">grpc_tls_on_server_authorization_check_done_cb</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a77029657f0b1b653fe3694a05b3272dc">cb</a></td></tr>
|
|
<tr class="separator:a77029657f0b1b653fe3694a05b3272dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49f838e2bc8533b18d77e9e31a34033b"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a49f838e2bc8533b18d77e9e31a34033b">cb_user_data</a></td></tr>
|
|
<tr class="separator:a49f838e2bc8533b18d77e9e31a34033b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b61309fca075f7d93d3a4325728bb7f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a4b61309fca075f7d93d3a4325728bb7f">success</a></td></tr>
|
|
<tr class="separator:a4b61309fca075f7d93d3a4325728bb7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ea427a08f7acada51d9ace358f8529b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a5ea427a08f7acada51d9ace358f8529b">target_name</a></td></tr>
|
|
<tr class="separator:a5ea427a08f7acada51d9ace358f8529b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa33742301cfcf0e968360da852d7bcc0"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#aa33742301cfcf0e968360da852d7bcc0">peer_cert</a></td></tr>
|
|
<tr class="separator:aa33742301cfcf0e968360da852d7bcc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a985f586cfc2ac1b2f262afa1f72b6f82"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a985f586cfc2ac1b2f262afa1f72b6f82">peer_cert_full_chain</a></td></tr>
|
|
<tr class="separator:a985f586cfc2ac1b2f262afa1f72b6f82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5947a871b4a54e5562d4419f7dafc56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc_2impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#ad5947a871b4a54e5562d4419f7dafc56">status</a></td></tr>
|
|
<tr class="separator:ad5947a871b4a54e5562d4419f7dafc56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e4543bc601b5ab3c8c856412870f950"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#aedcefc12b72d7ec5691ed39a0e9020c6">grpc_tls_error_details</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a3e4543bc601b5ab3c8c856412870f950">error_details</a></td></tr>
|
|
<tr class="separator:a3e4543bc601b5ab3c8c856412870f950"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a682bb119d97a1166dd50001c848f9b38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__security_8h.html#a0927fc30a7bd209877095da5a67ba22c">grpc_tls_server_authorization_check_config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a682bb119d97a1166dd50001c848f9b38">config</a></td></tr>
|
|
<tr class="separator:a682bb119d97a1166dd50001c848f9b38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a840309051d10d17392e977812f78254e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#a840309051d10d17392e977812f78254e">context</a></td></tr>
|
|
<tr class="separator:a840309051d10d17392e977812f78254e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3202abff43af16a7cc01d3d09845f1c"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__tls__server__authorization__check__arg.html#af3202abff43af16a7cc01d3d09845f1c">destroy_context</a> )(void *ctx)</td></tr>
|
|
<tr class="separator:af3202abff43af16a7cc01d3d09845f1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A struct containing all information necessary to schedule/cancel a server authorization check request. </p>
|
|
<ul>
|
|
<li>cb and cb_user_data represent a gRPC-provided callback and an argument passed to it.</li>
|
|
<li>success will store the result of server authorization check. That is, if success returns a non-zero value, it means the authorization check passes and if returning zero, it means the check fails.</li>
|
|
</ul>
|
|
<p>target_name is the name of an endpoint the channel is connecting to.</p><ul>
|
|
<li>peer_cert represents a complete certificate chain including both signing and leaf certificates.</li>
|
|
<li>status and error_details contain information about errors occurred when a server authorization check request is scheduled/cancelled.</li>
|
|
<li>config is a pointer to the unique grpc_tls_server_authorization_check_config instance that this argument corresponds to.</li>
|
|
<li>context is a pointer to a wrapped language implementation of this <a class="el" href="structgrpc__tls__server__authorization__check__arg.html" title="A struct containing all information necessary to schedule/cancel a server authorization check request...">grpc_tls_server_authorization_check_arg</a> instance.</li>
|
|
<li>destroy_context is a pointer to a caller-provided method that cleans up any data associated with the context pointer. It is used for experimental purpose for now and subject to change. </li>
|
|
</ul>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a77029657f0b1b653fe3694a05b3272dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77029657f0b1b653fe3694a05b3272dc">◆ </a></span>cb</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="grpc__security_8h.html#ab72de5caa877bbfff84676b1cb024fb3">grpc_tls_on_server_authorization_check_done_cb</a> grpc_tls_server_authorization_check_arg::cb</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49f838e2bc8533b18d77e9e31a34033b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49f838e2bc8533b18d77e9e31a34033b">◆ </a></span>cb_user_data</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* grpc_tls_server_authorization_check_arg::cb_user_data</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a682bb119d97a1166dd50001c848f9b38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a682bb119d97a1166dd50001c848f9b38">◆ </a></span>config</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="grpc__security_8h.html#a0927fc30a7bd209877095da5a67ba22c">grpc_tls_server_authorization_check_config</a>* grpc_tls_server_authorization_check_arg::config</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a840309051d10d17392e977812f78254e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a840309051d10d17392e977812f78254e">◆ </a></span>context</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* grpc_tls_server_authorization_check_arg::context</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3202abff43af16a7cc01d3d09845f1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3202abff43af16a7cc01d3d09845f1c">◆ </a></span>destroy_context</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void(* grpc_tls_server_authorization_check_arg::destroy_context) (void *ctx)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e4543bc601b5ab3c8c856412870f950"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e4543bc601b5ab3c8c856412870f950">◆ </a></span>error_details</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="grpc__security_8h.html#aedcefc12b72d7ec5691ed39a0e9020c6">grpc_tls_error_details</a>* grpc_tls_server_authorization_check_arg::error_details</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa33742301cfcf0e968360da852d7bcc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa33742301cfcf0e968360da852d7bcc0">◆ </a></span>peer_cert</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* grpc_tls_server_authorization_check_arg::peer_cert</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a985f586cfc2ac1b2f262afa1f72b6f82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a985f586cfc2ac1b2f262afa1f72b6f82">◆ </a></span>peer_cert_full_chain</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* grpc_tls_server_authorization_check_arg::peer_cert_full_chain</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5947a871b4a54e5562d4419f7dafc56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5947a871b4a54e5562d4419f7dafc56">◆ </a></span>status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="grpc_2impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> grpc_tls_server_authorization_check_arg::status</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b61309fca075f7d93d3a4325728bb7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b61309fca075f7d93d3a4325728bb7f">◆ </a></span>success</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int grpc_tls_server_authorization_check_arg::success</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ea427a08f7acada51d9ace358f8529b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ea427a08f7acada51d9ace358f8529b">◆ </a></span>target_name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* grpc_tls_server_authorization_check_arg::target_name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>include/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Aug 18 2020 16:24:48 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|