559 lines
36 KiB
HTML
559 lines
36 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++: include/grpc/grpc_security_constants.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++
|
|
 <span id="projectnumber">1.58.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&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 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="#define-members">Macros</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">grpc_security_constants.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a href="grpc__security__constants_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="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:aff82fdff9e7c40c4dd4bdc650e38e25a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#aff82fdff9e7c40c4dd4bdc650e38e25a">GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME</a>   "transport_security_type"</td></tr>
|
|
<tr class="separator:aff82fdff9e7c40c4dd4bdc650e38e25a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35a35c597b7090b8ac7e2d854c9bcc7a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a35a35c597b7090b8ac7e2d854c9bcc7a">GRPC_SSL_TRANSPORT_SECURITY_TYPE</a>   "ssl"</td></tr>
|
|
<tr class="separator:a35a35c597b7090b8ac7e2d854c9bcc7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f689af6e31c98c996522441cf069da3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a9f689af6e31c98c996522441cf069da3">GRPC_TLS_TRANSPORT_SECURITY_TYPE</a>   "tls"</td></tr>
|
|
<tr class="separator:a9f689af6e31c98c996522441cf069da3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afee5e0fade6e0af1954529f1f08afe0c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#afee5e0fade6e0af1954529f1f08afe0c">GRPC_X509_CN_PROPERTY_NAME</a>   "x509_common_name"</td></tr>
|
|
<tr class="separator:afee5e0fade6e0af1954529f1f08afe0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a982fc088817a32a03fbc9b27bc514629"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a982fc088817a32a03fbc9b27bc514629">GRPC_X509_SUBJECT_PROPERTY_NAME</a>   "x509_subject"</td></tr>
|
|
<tr class="separator:a982fc088817a32a03fbc9b27bc514629"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1412421653b7999544296f56025a0f36"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a1412421653b7999544296f56025a0f36">GRPC_X509_SAN_PROPERTY_NAME</a>   "x509_subject_alternative_name"</td></tr>
|
|
<tr class="separator:a1412421653b7999544296f56025a0f36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad46c3fd565d6a24eeb25d1fdc342cb28"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#ad46c3fd565d6a24eeb25d1fdc342cb28">GRPC_X509_PEM_CERT_PROPERTY_NAME</a>   "x509_pem_cert"</td></tr>
|
|
<tr class="separator:ad46c3fd565d6a24eeb25d1fdc342cb28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ea60d47d799302dc1b760bcfa78e5a1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a4ea60d47d799302dc1b760bcfa78e5a1">GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME</a>   "x509_pem_cert_chain"</td></tr>
|
|
<tr class="separator:a4ea60d47d799302dc1b760bcfa78e5a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacbb09bfff7ebda81d9d3d89f0597312"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#aacbb09bfff7ebda81d9d3d89f0597312">GRPC_SSL_SESSION_REUSED_PROPERTY</a>   "ssl_session_reused"</td></tr>
|
|
<tr class="separator:aacbb09bfff7ebda81d9d3d89f0597312"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab19cdead9b37b4818118403d4d3b4ebb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#ab19cdead9b37b4818118403d4d3b4ebb">GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME</a>   "security_level"</td></tr>
|
|
<tr class="separator:ab19cdead9b37b4818118403d4d3b4ebb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f5d1fd6d796535d7ccef836c6a5208d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a2f5d1fd6d796535d7ccef836c6a5208d">GRPC_PEER_DNS_PROPERTY_NAME</a>   "peer_dns"</td></tr>
|
|
<tr class="separator:a2f5d1fd6d796535d7ccef836c6a5208d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb77790260f0d5b9ffb8d8095bbbe044"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#abb77790260f0d5b9ffb8d8095bbbe044">GRPC_PEER_SPIFFE_ID_PROPERTY_NAME</a>   "peer_spiffe_id"</td></tr>
|
|
<tr class="separator:abb77790260f0d5b9ffb8d8095bbbe044"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1cd49207ca7cd943fabc7ee334c0b599"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a1cd49207ca7cd943fabc7ee334c0b599">GRPC_PEER_URI_PROPERTY_NAME</a>   "peer_uri"</td></tr>
|
|
<tr class="separator:a1cd49207ca7cd943fabc7ee334c0b599"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f64629d47653ee491c99787ca620a33"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a9f64629d47653ee491c99787ca620a33">GRPC_PEER_EMAIL_PROPERTY_NAME</a>   "peer_email"</td></tr>
|
|
<tr class="separator:a9f64629d47653ee491c99787ca620a33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7ad4e75b69d08674bceca1187b90258"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#af7ad4e75b69d08674bceca1187b90258">GRPC_PEER_IP_PROPERTY_NAME</a>   "peer_ip"</td></tr>
|
|
<tr class="separator:af7ad4e75b69d08674bceca1187b90258"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48565da473b7c82fa2453798f620fd59"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a48565da473b7c82fa2453798f620fd59">GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR</a>   "GRPC_DEFAULT_SSL_ROOTS_FILE_PATH"</td></tr>
|
|
<tr class="memdesc:a48565da473b7c82fa2453798f620fd59"><td class="mdescLeft"> </td><td class="mdescRight">Environment variable that points to the default SSL roots file. <a href="grpc__security__constants_8h.html#a48565da473b7c82fa2453798f620fd59">More...</a><br /></td></tr>
|
|
<tr class="separator:a48565da473b7c82fa2453798f620fd59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3874f70577fc9fe15fd2c4ce68a36ecd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a3874f70577fc9fe15fd2c4ce68a36ecd">GRPC_GOOGLE_CREDENTIALS_ENV_VAR</a>   "GOOGLE_APPLICATION_CREDENTIALS"</td></tr>
|
|
<tr class="memdesc:a3874f70577fc9fe15fd2c4ce68a36ecd"><td class="mdescLeft"> </td><td class="mdescRight">Environment variable that points to the google default application credentials json key or refresh token. <a href="grpc__security__constants_8h.html#a3874f70577fc9fe15fd2c4ce68a36ecd">More...</a><br /></td></tr>
|
|
<tr class="separator:a3874f70577fc9fe15fd2c4ce68a36ecd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a90c47ae1d8c33145342170fe615fa68c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">grpc_ssl_roots_override_result</a> { <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68cadc1832235a9330a02cfa9a753eab70bc">GRPC_SSL_ROOTS_OVERRIDE_OK</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68caa0fdee0e3b14865c1ee4e7d89a46cc64">GRPC_SSL_ROOTS_OVERRIDE_FAIL_PERMANENTLY</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68ca0c132ade28f3f56729b82119fc9f8142">GRPC_SSL_ROOTS_OVERRIDE_FAIL</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a90c47ae1d8c33145342170fe615fa68c"><td class="mdescLeft"> </td><td class="mdescRight">Results for the SSL roots override callback. <a href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">More...</a><br /></td></tr>
|
|
<tr class="separator:a90c47ae1d8c33145342170fe615fa68c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f19e93998bbda68d9c24f27673ff627"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a> { <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627ac5460b1687280e87915d11adc507988d">GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_UNCHANGED</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627a00758a0455bc6cfbfe0e2af5f4f861cb">GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_NEW</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627a87b80abccb958ca6899bc7e965ed8855">GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_FAIL</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a4f19e93998bbda68d9c24f27673ff627"><td class="mdescLeft"> </td><td class="mdescRight">Callback results for dynamically loading a SSL certificate config. <a href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">More...</a><br /></td></tr>
|
|
<tr class="separator:a4f19e93998bbda68d9c24f27673ff627"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29ffe63a8bb3b4945ecab42d82758f09"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> { <br />
|
|
  <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f">GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09af7c66a36be648bf7e396a145654d79f1">GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a7390ee04c71c633589eefdad872c2048">GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a6522b7d489da328ef7c9745039a93f42">GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY</a>,
|
|
<br />
|
|
  <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a1041edab0ab12d270937f066f1e1ea0d">GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a29ffe63a8bb3b4945ecab42d82758f09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c3165c49cd7a359ddb8656aae7e9dd6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6">grpc_security_level</a> { <br />
|
|
  <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6a1cb478ac1535b61fdd1cb2c1e2062b3a">GRPC_SECURITY_MIN</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6abb83593125096051f1c26ffa8df813b1">GRPC_SECURITY_NONE</a> = GRPC_SECURITY_MIN,
|
|
<a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6ad9ad5579bef3a4b55e461f29c9fbd957">GRPC_INTEGRITY_ONLY</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6af27dbc67f757ccd2ff3537e053ad06c3">GRPC_PRIVACY_AND_INTEGRITY</a>,
|
|
<br />
|
|
  <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6a3dac3570a7b2f7189f426c0377bdb1e1">GRPC_SECURITY_MAX</a> = GRPC_PRIVACY_AND_INTEGRITY
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a3c3165c49cd7a359ddb8656aae7e9dd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31d00ce5c064e1fff4261a6d6298dc11"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> { <a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11a94e03cdcc2f95916c9eaf6ab486ed768">UDS</a> = 0,
|
|
<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11acb07333a9323d16e7e2258fe5bb4aed8">LOCAL_TCP</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:a31d00ce5c064e1fff4261a6d6298dc11"><td class="mdescLeft"> </td><td class="mdescRight">Type of local connections for which local channel/server credentials will be applied. <a href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">More...</a><br /></td></tr>
|
|
<tr class="separator:a31d00ce5c064e1fff4261a6d6298dc11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab7f46c1753e3601b1de9aa31958748dd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dd">grpc_tls_version</a> { <a class="el" href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dda05ba9c03f48f1d2ab9774e456d24522f">TLS1_2</a>,
|
|
<a class="el" href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dda900414265a7f4babe6386ce7356b5ebb">TLS1_3</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ab7f46c1753e3601b1de9aa31958748dd"><td class="mdescLeft"> </td><td class="mdescRight">The TLS versions that are supported by the SSL stack. <a href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dd">More...</a><br /></td></tr>
|
|
<tr class="separator:ab7f46c1753e3601b1de9aa31958748dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a48565da473b7c82fa2453798f620fd59"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48565da473b7c82fa2453798f620fd59">◆ </a></span>GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR   "GRPC_DEFAULT_SSL_ROOTS_FILE_PATH"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Environment variable that points to the default SSL roots file. </p>
|
|
<p>This file must be a PEM encoded file with all the roots such as the one that can be downloaded from <a href="https://pki.google.com/roots.pem">https://pki.google.com/roots.pem</a>. <br />
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3874f70577fc9fe15fd2c4ce68a36ecd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3874f70577fc9fe15fd2c4ce68a36ecd">◆ </a></span>GRPC_GOOGLE_CREDENTIALS_ENV_VAR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_GOOGLE_CREDENTIALS_ENV_VAR   "GOOGLE_APPLICATION_CREDENTIALS"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Environment variable that points to the google default application credentials json key or refresh token. </p>
|
|
<p>Used in the grpc_google_default_credentials_create function. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f5d1fd6d796535d7ccef836c6a5208d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f5d1fd6d796535d7ccef836c6a5208d">◆ </a></span>GRPC_PEER_DNS_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_PEER_DNS_PROPERTY_NAME   "peer_dns"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f64629d47653ee491c99787ca620a33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f64629d47653ee491c99787ca620a33">◆ </a></span>GRPC_PEER_EMAIL_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_PEER_EMAIL_PROPERTY_NAME   "peer_email"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7ad4e75b69d08674bceca1187b90258"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7ad4e75b69d08674bceca1187b90258">◆ </a></span>GRPC_PEER_IP_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_PEER_IP_PROPERTY_NAME   "peer_ip"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb77790260f0d5b9ffb8d8095bbbe044"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb77790260f0d5b9ffb8d8095bbbe044">◆ </a></span>GRPC_PEER_SPIFFE_ID_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_PEER_SPIFFE_ID_PROPERTY_NAME   "peer_spiffe_id"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1cd49207ca7cd943fabc7ee334c0b599"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1cd49207ca7cd943fabc7ee334c0b599">◆ </a></span>GRPC_PEER_URI_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_PEER_URI_PROPERTY_NAME   "peer_uri"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacbb09bfff7ebda81d9d3d89f0597312"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacbb09bfff7ebda81d9d3d89f0597312">◆ </a></span>GRPC_SSL_SESSION_REUSED_PROPERTY</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_SSL_SESSION_REUSED_PROPERTY   "ssl_session_reused"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a35a35c597b7090b8ac7e2d854c9bcc7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a35a35c597b7090b8ac7e2d854c9bcc7a">◆ </a></span>GRPC_SSL_TRANSPORT_SECURITY_TYPE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_SSL_TRANSPORT_SECURITY_TYPE   "ssl"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f689af6e31c98c996522441cf069da3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f689af6e31c98c996522441cf069da3">◆ </a></span>GRPC_TLS_TRANSPORT_SECURITY_TYPE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_TLS_TRANSPORT_SECURITY_TYPE   "tls"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab19cdead9b37b4818118403d4d3b4ebb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab19cdead9b37b4818118403d4d3b4ebb">◆ </a></span>GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME   "security_level"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff82fdff9e7c40c4dd4bdc650e38e25a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff82fdff9e7c40c4dd4bdc650e38e25a">◆ </a></span>GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME   "transport_security_type"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afee5e0fade6e0af1954529f1f08afe0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afee5e0fade6e0af1954529f1f08afe0c">◆ </a></span>GRPC_X509_CN_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_X509_CN_PROPERTY_NAME   "x509_common_name"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ea60d47d799302dc1b760bcfa78e5a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ea60d47d799302dc1b760bcfa78e5a1">◆ </a></span>GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME   "x509_pem_cert_chain"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad46c3fd565d6a24eeb25d1fdc342cb28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad46c3fd565d6a24eeb25d1fdc342cb28">◆ </a></span>GRPC_X509_PEM_CERT_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_X509_PEM_CERT_PROPERTY_NAME   "x509_pem_cert"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1412421653b7999544296f56025a0f36"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1412421653b7999544296f56025a0f36">◆ </a></span>GRPC_X509_SAN_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_X509_SAN_PROPERTY_NAME   "x509_subject_alternative_name"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a982fc088817a32a03fbc9b27bc514629"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a982fc088817a32a03fbc9b27bc514629">◆ </a></span>GRPC_X509_SUBJECT_PROPERTY_NAME</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define GRPC_X509_SUBJECT_PROPERTY_NAME   "x509_subject"</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a31d00ce5c064e1fff4261a6d6298dc11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a31d00ce5c064e1fff4261a6d6298dc11">◆ </a></span>grpc_local_connect_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type of local connections for which local channel/server credentials will be applied. </p>
|
|
<p>It supports UDS and local TCP connections. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a31d00ce5c064e1fff4261a6d6298dc11a94e03cdcc2f95916c9eaf6ab486ed768"></a>UDS </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a31d00ce5c064e1fff4261a6d6298dc11acb07333a9323d16e7e2258fe5bb4aed8"></a>LOCAL_TCP </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c3165c49cd7a359ddb8656aae7e9dd6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c3165c49cd7a359ddb8656aae7e9dd6">◆ </a></span>grpc_security_level</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6">grpc_security_level</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6a1cb478ac1535b61fdd1cb2c1e2062b3a"></a>GRPC_SECURITY_MIN </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6abb83593125096051f1c26ffa8df813b1"></a>GRPC_SECURITY_NONE </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6ad9ad5579bef3a4b55e461f29c9fbd957"></a>GRPC_INTEGRITY_ONLY </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6af27dbc67f757ccd2ff3537e053ad06c3"></a>GRPC_PRIVACY_AND_INTEGRITY </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6a3dac3570a7b2f7189f426c0377bdb1e1"></a>GRPC_SECURITY_MAX </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f19e93998bbda68d9c24f27673ff627"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f19e93998bbda68d9c24f27673ff627">◆ </a></span>grpc_ssl_certificate_config_reload_status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Callback results for dynamically loading a SSL certificate config. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627ac5460b1687280e87915d11adc507988d"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_UNCHANGED </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627a00758a0455bc6cfbfe0e2af5f4f861cb"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_NEW </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627a87b80abccb958ca6899bc7e965ed8855"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_FAIL </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a29ffe63a8bb3b4945ecab42d82758f09"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a29ffe63a8bb3b4945ecab42d82758f09">◆ </a></span>grpc_ssl_client_certificate_request_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f"></a>GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE </td><td class="fielddoc"><p>Server does not request client certificate. </p>
|
|
<p>The certificate presented by the client is not checked by the server at all. (A client may present a self signed or signed certificate or not present a certificate at all and any of those option would be accepted) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09af7c66a36be648bf7e396a145654d79f1"></a>GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY </td><td class="fielddoc"><p>Server requests client certificate but does not enforce that the client presents a certificate. </p>
|
|
<p>If the client presents a certificate, the client authentication is left to the application (the necessary metadata will be available to the application via authentication context properties, see grpc_auth_context).</p>
|
|
<p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a7390ee04c71c633589eefdad872c2048"></a>GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY </td><td class="fielddoc"><p>Server requests client certificate but does not enforce that the client presents a certificate. </p>
|
|
<p>If the client presents a certificate, the client authentication is done by the gRPC framework. (For a successful connection the client needs to either present a certificate that can be verified against the root certificate configured by the server or not present a certificate at all)</p>
|
|
<p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a6522b7d489da328ef7c9745039a93f42"></a>GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY </td><td class="fielddoc"><p>Server requests client certificate and enforces that the client presents a certificate. </p>
|
|
<p>If the client presents a certificate, the client authentication is left to the application (the necessary metadata will be available to the application via authentication context properties, see grpc_auth_context).</p>
|
|
<p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a1041edab0ab12d270937f066f1e1ea0d"></a>GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY </td><td class="fielddoc"><p>Server requests client certificate and enforces that the client presents a certificate. </p>
|
|
<p>The certificate presented by the client is verified by the gRPC framework. (For a successful connection the client needs to present a certificate that can be verified against the root certificate configured by the server)</p>
|
|
<p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90c47ae1d8c33145342170fe615fa68c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90c47ae1d8c33145342170fe615fa68c">◆ </a></span>grpc_ssl_roots_override_result</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">grpc_ssl_roots_override_result</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Results for the SSL roots override callback. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68cadc1832235a9330a02cfa9a753eab70bc"></a>GRPC_SSL_ROOTS_OVERRIDE_OK </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68caa0fdee0e3b14865c1ee4e7d89a46cc64"></a>GRPC_SSL_ROOTS_OVERRIDE_FAIL_PERMANENTLY </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68ca0c132ade28f3f56729b82119fc9f8142"></a>GRPC_SSL_ROOTS_OVERRIDE_FAIL </td><td class="fielddoc"><p>Do not try fallback options. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab7f46c1753e3601b1de9aa31958748dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab7f46c1753e3601b1de9aa31958748dd">◆ </a></span>grpc_tls_version</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dd">grpc_tls_version</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The TLS versions that are supported by the SSL stack. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab7f46c1753e3601b1de9aa31958748dda05ba9c03f48f1d2ab9774e456d24522f"></a>TLS1_2 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ab7f46c1753e3601b1de9aa31958748dda900414265a7f4babe6386ce7356b5ebb"></a>TLS1_3 </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Sep 6 2023 16:09:16 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>
|