grpc__security__constants_8h.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: include/grpc/grpc_security_constants.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#define-members">Macros</a> &#124;
  69. <a href="#enum-members">Enumerations</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc_security_constants.h File Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><a href="grpc__security__constants_8h_source.html">Go to the source code of this file.</a></p>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  77. Macros</h2></td></tr>
  78. <tr class="memitem:aff82fdff9e7c40c4dd4bdc650e38e25a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#aff82fdff9e7c40c4dd4bdc650e38e25a">GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;transport_security_type&quot;</td></tr>
  79. <tr class="separator:aff82fdff9e7c40c4dd4bdc650e38e25a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a35a35c597b7090b8ac7e2d854c9bcc7a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a35a35c597b7090b8ac7e2d854c9bcc7a">GRPC_SSL_TRANSPORT_SECURITY_TYPE</a>&#160;&#160;&#160;&quot;ssl&quot;</td></tr>
  81. <tr class="separator:a35a35c597b7090b8ac7e2d854c9bcc7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:afee5e0fade6e0af1954529f1f08afe0c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#afee5e0fade6e0af1954529f1f08afe0c">GRPC_X509_CN_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;x509_common_name&quot;</td></tr>
  83. <tr class="separator:afee5e0fade6e0af1954529f1f08afe0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a1412421653b7999544296f56025a0f36"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a1412421653b7999544296f56025a0f36">GRPC_X509_SAN_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;x509_subject_alternative_name&quot;</td></tr>
  85. <tr class="separator:a1412421653b7999544296f56025a0f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ad46c3fd565d6a24eeb25d1fdc342cb28"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#ad46c3fd565d6a24eeb25d1fdc342cb28">GRPC_X509_PEM_CERT_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;x509_pem_cert&quot;</td></tr>
  87. <tr class="separator:ad46c3fd565d6a24eeb25d1fdc342cb28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a4ea60d47d799302dc1b760bcfa78e5a1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a4ea60d47d799302dc1b760bcfa78e5a1">GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;x509_pem_cert_chain&quot;</td></tr>
  89. <tr class="separator:a4ea60d47d799302dc1b760bcfa78e5a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:aacbb09bfff7ebda81d9d3d89f0597312"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#aacbb09bfff7ebda81d9d3d89f0597312">GRPC_SSL_SESSION_REUSED_PROPERTY</a>&#160;&#160;&#160;&quot;ssl_session_reused&quot;</td></tr>
  91. <tr class="separator:aacbb09bfff7ebda81d9d3d89f0597312"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ab19cdead9b37b4818118403d4d3b4ebb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#ab19cdead9b37b4818118403d4d3b4ebb">GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;security_level&quot;</td></tr>
  93. <tr class="separator:ab19cdead9b37b4818118403d4d3b4ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:abb77790260f0d5b9ffb8d8095bbbe044"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#abb77790260f0d5b9ffb8d8095bbbe044">GRPC_PEER_SPIFFE_ID_PROPERTY_NAME</a>&#160;&#160;&#160;&quot;peer_spiffe_id&quot;</td></tr>
  95. <tr class="separator:abb77790260f0d5b9ffb8d8095bbbe044"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a48565da473b7c82fa2453798f620fd59"><td class="memItemLeft" align="right" valign="top">#define&#160;</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>&#160;&#160;&#160;&quot;GRPC_DEFAULT_SSL_ROOTS_FILE_PATH&quot;</td></tr>
  97. <tr class="memdesc:a48565da473b7c82fa2453798f620fd59"><td class="mdescLeft">&#160;</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>
  98. <tr class="separator:a48565da473b7c82fa2453798f620fd59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a3874f70577fc9fe15fd2c4ce68a36ecd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a3874f70577fc9fe15fd2c4ce68a36ecd">GRPC_GOOGLE_CREDENTIALS_ENV_VAR</a>&#160;&#160;&#160;&quot;GOOGLE_APPLICATION_CREDENTIALS&quot;</td></tr>
  100. <tr class="memdesc:a3874f70577fc9fe15fd2c4ce68a36ecd"><td class="mdescLeft">&#160;</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>
  101. <tr class="separator:a3874f70577fc9fe15fd2c4ce68a36ecd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  104. Enumerations</h2></td></tr>
  105. <tr class="memitem:a90c47ae1d8c33145342170fe615fa68c"><td class="memItemLeft" align="right" valign="top">enum &#160;</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>,
  106. <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68caa0fdee0e3b14865c1ee4e7d89a46cc64">GRPC_SSL_ROOTS_OVERRIDE_FAIL_PERMANENTLY</a>,
  107. <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68ca0c132ade28f3f56729b82119fc9f8142">GRPC_SSL_ROOTS_OVERRIDE_FAIL</a>
  108. }</td></tr>
  109. <tr class="memdesc:a90c47ae1d8c33145342170fe615fa68c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Results for the SSL roots override callback. <a href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">More...</a><br /></td></tr>
  110. <tr class="separator:a90c47ae1d8c33145342170fe615fa68c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a4f19e93998bbda68d9c24f27673ff627"><td class="memItemLeft" align="right" valign="top">enum &#160;</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>,
  112. <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627a00758a0455bc6cfbfe0e2af5f4f861cb">GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_NEW</a>,
  113. <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627a87b80abccb958ca6899bc7e965ed8855">GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_FAIL</a>
  114. }</td></tr>
  115. <tr class="memdesc:a4f19e93998bbda68d9c24f27673ff627"><td class="mdescLeft">&#160;</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>
  116. <tr class="separator:a4f19e93998bbda68d9c24f27673ff627"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a29ffe63a8bb3b4945ecab42d82758f09"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> { <br />
  118. &#160;&#160;<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f">GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE</a>,
  119. <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09af7c66a36be648bf7e396a145654d79f1">GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY</a>,
  120. <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a7390ee04c71c633589eefdad872c2048">GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY</a>,
  121. <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a6522b7d489da328ef7c9745039a93f42">GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY</a>,
  122. <br />
  123. &#160;&#160;<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09a1041edab0ab12d270937f066f1e1ea0d">GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY</a>
  124. <br />
  125. }</td></tr>
  126. <tr class="separator:a29ffe63a8bb3b4945ecab42d82758f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a3c3165c49cd7a359ddb8656aae7e9dd6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6">grpc_security_level</a> { <br />
  128. &#160;&#160;<a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6a1cb478ac1535b61fdd1cb2c1e2062b3a">GRPC_SECURITY_MIN</a>,
  129. <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6abb83593125096051f1c26ffa8df813b1">GRPC_SECURITY_NONE</a> = GRPC_SECURITY_MIN,
  130. <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6ad9ad5579bef3a4b55e461f29c9fbd957">GRPC_INTEGRITY_ONLY</a>,
  131. <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6af27dbc67f757ccd2ff3537e053ad06c3">GRPC_PRIVACY_AND_INTEGRITY</a>,
  132. <br />
  133. &#160;&#160;<a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6a3dac3570a7b2f7189f426c0377bdb1e1">GRPC_SECURITY_MAX</a> = GRPC_PRIVACY_AND_INTEGRITY
  134. <br />
  135. }</td></tr>
  136. <tr class="separator:a3c3165c49cd7a359ddb8656aae7e9dd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aa4b37b544134e070541912584793446a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a> { <a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446aa2f287b70ed85cf61a025e6c9f82fa785">GRPC_TLS_SERVER_VERIFICATION</a>,
  138. <a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446aaeb4cda98070a6fd330b7253843406106">GRPC_TLS_SKIP_HOSTNAME_VERIFICATION</a>,
  139. <a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446aa7d9c4e1cd0a8986e4dadb95ef976b72e">GRPC_TLS_SKIP_ALL_SERVER_VERIFICATION</a>
  140. }</td></tr>
  141. <tr class="separator:aa4b37b544134e070541912584793446a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a31d00ce5c064e1fff4261a6d6298dc11"><td class="memItemLeft" align="right" valign="top">enum &#160;</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,
  143. <a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11acb07333a9323d16e7e2258fe5bb4aed8">LOCAL_TCP</a>
  144. }</td></tr>
  145. <tr class="memdesc:a31d00ce5c064e1fff4261a6d6298dc11"><td class="mdescLeft">&#160;</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>
  146. <tr class="separator:a31d00ce5c064e1fff4261a6d6298dc11"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ab7f46c1753e3601b1de9aa31958748dd"><td class="memItemLeft" align="right" valign="top">enum &#160;</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>,
  148. <a class="el" href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dda900414265a7f4babe6386ce7356b5ebb">TLS1_3</a>
  149. }</td></tr>
  150. <tr class="memdesc:ab7f46c1753e3601b1de9aa31958748dd"><td class="mdescLeft">&#160;</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>
  151. <tr class="separator:ab7f46c1753e3601b1de9aa31958748dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <h2 class="groupheader">Macro Definition Documentation</h2>
  154. <a id="a48565da473b7c82fa2453798f620fd59"></a>
  155. <h2 class="memtitle"><span class="permalink"><a href="#a48565da473b7c82fa2453798f620fd59">&#9670;&nbsp;</a></span>GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR</h2>
  156. <div class="memitem">
  157. <div class="memproto">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">#define GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR&#160;&#160;&#160;&quot;GRPC_DEFAULT_SSL_ROOTS_FILE_PATH&quot;</td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Environment variable that points to the default SSL roots file. </p>
  165. <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 />
  166. </p>
  167. </div>
  168. </div>
  169. <a id="a3874f70577fc9fe15fd2c4ce68a36ecd"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a3874f70577fc9fe15fd2c4ce68a36ecd">&#9670;&nbsp;</a></span>GRPC_GOOGLE_CREDENTIALS_ENV_VAR</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">#define GRPC_GOOGLE_CREDENTIALS_ENV_VAR&#160;&#160;&#160;&quot;GOOGLE_APPLICATION_CREDENTIALS&quot;</td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Environment variable that points to the google default application credentials json key or refresh token. </p>
  180. <p>Used in the grpc_google_default_credentials_create function. </p>
  181. </div>
  182. </div>
  183. <a id="abb77790260f0d5b9ffb8d8095bbbe044"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#abb77790260f0d5b9ffb8d8095bbbe044">&#9670;&nbsp;</a></span>GRPC_PEER_SPIFFE_ID_PROPERTY_NAME</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">#define GRPC_PEER_SPIFFE_ID_PROPERTY_NAME&#160;&#160;&#160;&quot;peer_spiffe_id&quot;</td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <a id="aacbb09bfff7ebda81d9d3d89f0597312"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#aacbb09bfff7ebda81d9d3d89f0597312">&#9670;&nbsp;</a></span>GRPC_SSL_SESSION_REUSED_PROPERTY</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">#define GRPC_SSL_SESSION_REUSED_PROPERTY&#160;&#160;&#160;&quot;ssl_session_reused&quot;</td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. </div>
  206. </div>
  207. <a id="a35a35c597b7090b8ac7e2d854c9bcc7a"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#a35a35c597b7090b8ac7e2d854c9bcc7a">&#9670;&nbsp;</a></span>GRPC_SSL_TRANSPORT_SECURITY_TYPE</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">#define GRPC_SSL_TRANSPORT_SECURITY_TYPE&#160;&#160;&#160;&quot;ssl&quot;</td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. </div>
  218. </div>
  219. <a id="ab19cdead9b37b4818118403d4d3b4ebb"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#ab19cdead9b37b4818118403d4d3b4ebb">&#9670;&nbsp;</a></span>GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">#define GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME&#160;&#160;&#160;&quot;security_level&quot;</td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. </div>
  230. </div>
  231. <a id="aff82fdff9e7c40c4dd4bdc650e38e25a"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#aff82fdff9e7c40c4dd4bdc650e38e25a">&#9670;&nbsp;</a></span>GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">#define GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME&#160;&#160;&#160;&quot;transport_security_type&quot;</td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. </div>
  242. </div>
  243. <a id="afee5e0fade6e0af1954529f1f08afe0c"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#afee5e0fade6e0af1954529f1f08afe0c">&#9670;&nbsp;</a></span>GRPC_X509_CN_PROPERTY_NAME</h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">#define GRPC_X509_CN_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_common_name&quot;</td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. </div>
  254. </div>
  255. <a id="a4ea60d47d799302dc1b760bcfa78e5a1"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#a4ea60d47d799302dc1b760bcfa78e5a1">&#9670;&nbsp;</a></span>GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME</h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">#define GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_pem_cert_chain&quot;</td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. </div>
  266. </div>
  267. <a id="ad46c3fd565d6a24eeb25d1fdc342cb28"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#ad46c3fd565d6a24eeb25d1fdc342cb28">&#9670;&nbsp;</a></span>GRPC_X509_PEM_CERT_PROPERTY_NAME</h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">#define GRPC_X509_PEM_CERT_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_pem_cert&quot;</td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. </div>
  278. </div>
  279. <a id="a1412421653b7999544296f56025a0f36"></a>
  280. <h2 class="memtitle"><span class="permalink"><a href="#a1412421653b7999544296f56025a0f36">&#9670;&nbsp;</a></span>GRPC_X509_SAN_PROPERTY_NAME</h2>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">#define GRPC_X509_SAN_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_subject_alternative_name&quot;</td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. </div>
  290. </div>
  291. <h2 class="groupheader">Enumeration Type Documentation</h2>
  292. <a id="a31d00ce5c064e1fff4261a6d6298dc11"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a31d00ce5c064e1fff4261a6d6298dc11">&#9670;&nbsp;</a></span>grpc_local_connect_type</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a></td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>Type of local connections for which local channel/server credentials will be applied. </p>
  303. <p>It supports UDS and local TCP connections. </p>
  304. <table class="fieldtable">
  305. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a31d00ce5c064e1fff4261a6d6298dc11a94e03cdcc2f95916c9eaf6ab486ed768"></a>UDS&#160;</td><td class="fielddoc"></td></tr>
  306. <tr><td class="fieldname"><a id="a31d00ce5c064e1fff4261a6d6298dc11acb07333a9323d16e7e2258fe5bb4aed8"></a>LOCAL_TCP&#160;</td><td class="fielddoc"></td></tr>
  307. </table>
  308. </div>
  309. </div>
  310. <a id="a3c3165c49cd7a359ddb8656aae7e9dd6"></a>
  311. <h2 class="memtitle"><span class="permalink"><a href="#a3c3165c49cd7a359ddb8656aae7e9dd6">&#9670;&nbsp;</a></span>grpc_security_level</h2>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6">grpc_security_level</a></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <table class="fieldtable">
  321. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6a1cb478ac1535b61fdd1cb2c1e2062b3a"></a>GRPC_SECURITY_MIN&#160;</td><td class="fielddoc"></td></tr>
  322. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6abb83593125096051f1c26ffa8df813b1"></a>GRPC_SECURITY_NONE&#160;</td><td class="fielddoc"></td></tr>
  323. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6ad9ad5579bef3a4b55e461f29c9fbd957"></a>GRPC_INTEGRITY_ONLY&#160;</td><td class="fielddoc"></td></tr>
  324. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6af27dbc67f757ccd2ff3537e053ad06c3"></a>GRPC_PRIVACY_AND_INTEGRITY&#160;</td><td class="fielddoc"></td></tr>
  325. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6a3dac3570a7b2f7189f426c0377bdb1e1"></a>GRPC_SECURITY_MAX&#160;</td><td class="fielddoc"></td></tr>
  326. </table>
  327. </div>
  328. </div>
  329. <a id="a4f19e93998bbda68d9c24f27673ff627"></a>
  330. <h2 class="memtitle"><span class="permalink"><a href="#a4f19e93998bbda68d9c24f27673ff627">&#9670;&nbsp;</a></span>grpc_ssl_certificate_config_reload_status</h2>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Callback results for dynamically loading a SSL certificate config. </p>
  340. <table class="fieldtable">
  341. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627ac5460b1687280e87915d11adc507988d"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_UNCHANGED&#160;</td><td class="fielddoc"></td></tr>
  342. <tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627a00758a0455bc6cfbfe0e2af5f4f861cb"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_NEW&#160;</td><td class="fielddoc"></td></tr>
  343. <tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627a87b80abccb958ca6899bc7e965ed8855"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_FAIL&#160;</td><td class="fielddoc"></td></tr>
  344. </table>
  345. </div>
  346. </div>
  347. <a id="a29ffe63a8bb3b4945ecab42d82758f09"></a>
  348. <h2 class="memtitle"><span class="permalink"><a href="#a29ffe63a8bb3b4945ecab42d82758f09">&#9670;&nbsp;</a></span>grpc_ssl_client_certificate_request_type</h2>
  349. <div class="memitem">
  350. <div class="memproto">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <table class="fieldtable">
  358. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a8bced4a94b58d31fd0718d3203da376f"></a>GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE&#160;</td><td class="fielddoc"><p>Server does not request client certificate. </p>
  359. <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>
  360. </td></tr>
  361. <tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09af7c66a36be648bf7e396a145654d79f1"></a>GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY&#160;</td><td class="fielddoc"><p>Server requests client certificate but does not enforce that the client presents a certificate. </p>
  362. <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>
  363. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  364. </td></tr>
  365. <tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a7390ee04c71c633589eefdad872c2048"></a>GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY&#160;</td><td class="fielddoc"><p>Server requests client certificate but does not enforce that the client presents a certificate. </p>
  366. <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>
  367. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  368. </td></tr>
  369. <tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a6522b7d489da328ef7c9745039a93f42"></a>GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY&#160;</td><td class="fielddoc"><p>Server requests client certificate and enforces that the client presents a certificate. </p>
  370. <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>
  371. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  372. </td></tr>
  373. <tr><td class="fieldname"><a id="a29ffe63a8bb3b4945ecab42d82758f09a1041edab0ab12d270937f066f1e1ea0d"></a>GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY&#160;</td><td class="fielddoc"><p>Server requests client certificate and enforces that the client presents a certificate. </p>
  374. <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>
  375. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  376. </td></tr>
  377. </table>
  378. </div>
  379. </div>
  380. <a id="a90c47ae1d8c33145342170fe615fa68c"></a>
  381. <h2 class="memtitle"><span class="permalink"><a href="#a90c47ae1d8c33145342170fe615fa68c">&#9670;&nbsp;</a></span>grpc_ssl_roots_override_result</h2>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="memname">
  385. <tr>
  386. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">grpc_ssl_roots_override_result</a></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Results for the SSL roots override callback. </p>
  391. <table class="fieldtable">
  392. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68cadc1832235a9330a02cfa9a753eab70bc"></a>GRPC_SSL_ROOTS_OVERRIDE_OK&#160;</td><td class="fielddoc"></td></tr>
  393. <tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68caa0fdee0e3b14865c1ee4e7d89a46cc64"></a>GRPC_SSL_ROOTS_OVERRIDE_FAIL_PERMANENTLY&#160;</td><td class="fielddoc"></td></tr>
  394. <tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68ca0c132ade28f3f56729b82119fc9f8142"></a>GRPC_SSL_ROOTS_OVERRIDE_FAIL&#160;</td><td class="fielddoc"><p>Do not try fallback options. </p>
  395. </td></tr>
  396. </table>
  397. </div>
  398. </div>
  399. <a id="aa4b37b544134e070541912584793446a"></a>
  400. <h2 class="memtitle"><span class="permalink"><a href="#aa4b37b544134e070541912584793446a">&#9670;&nbsp;</a></span>grpc_tls_server_verification_option</h2>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a></td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <table class="fieldtable">
  410. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa4b37b544134e070541912584793446aa2f287b70ed85cf61a025e6c9f82fa785"></a>GRPC_TLS_SERVER_VERIFICATION&#160;</td><td class="fielddoc"><p>Default option: performs server certificate verification and hostname verification. </p>
  411. </td></tr>
  412. <tr><td class="fieldname"><a id="aa4b37b544134e070541912584793446aaeb4cda98070a6fd330b7253843406106"></a>GRPC_TLS_SKIP_HOSTNAME_VERIFICATION&#160;</td><td class="fielddoc"><p>Performs server certificate verification, but skips hostname verification Client is responsible for verifying server's identity via server authorization check callback. </p>
  413. </td></tr>
  414. <tr><td class="fieldname"><a id="aa4b37b544134e070541912584793446aa7d9c4e1cd0a8986e4dadb95ef976b72e"></a>GRPC_TLS_SKIP_ALL_SERVER_VERIFICATION&#160;</td><td class="fielddoc"><p>Skips both server certificate and hostname verification. </p>
  415. <p>Client is responsible for verifying server's identity and server's certificate via server authorization check callback. </p>
  416. </td></tr>
  417. </table>
  418. </div>
  419. </div>
  420. <a id="ab7f46c1753e3601b1de9aa31958748dd"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#ab7f46c1753e3601b1de9aa31958748dd">&#9670;&nbsp;</a></span>grpc_tls_version</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#ab7f46c1753e3601b1de9aa31958748dd">grpc_tls_version</a></td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>The TLS versions that are supported by the SSL stack. </p>
  431. <table class="fieldtable">
  432. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab7f46c1753e3601b1de9aa31958748dda05ba9c03f48f1d2ab9774e456d24522f"></a>TLS1_2&#160;</td><td class="fielddoc"></td></tr>
  433. <tr><td class="fieldname"><a id="ab7f46c1753e3601b1de9aa31958748dda900414265a7f4babe6386ce7356b5ebb"></a>TLS1_3&#160;</td><td class="fielddoc"></td></tr>
  434. </table>
  435. </div>
  436. </div>
  437. </div><!-- contents -->
  438. <!-- start footer part -->
  439. <hr class="footer"/><address class="footer"><small>
  440. Generated on Wed Mar 3 2021 19:17:22 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  441. <img class="footer" src="doxygen.png" alt="doxygen"/>
  442. </a> 1.8.17
  443. </small></address>
  444. </body>
  445. </html>