grpc__security__constants_8h.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: 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 Core
  25. &#160;<span id="projectnumber">10.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.16 -->
  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. </table>
  148. <h2 class="groupheader">Macro Definition Documentation</h2>
  149. <a id="a48565da473b7c82fa2453798f620fd59"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#a48565da473b7c82fa2453798f620fd59">&#9670;&nbsp;</a></span>GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR</h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">#define GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR&#160;&#160;&#160;&quot;GRPC_DEFAULT_SSL_ROOTS_FILE_PATH&quot;</td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>Environment variable that points to the default SSL roots file. </p>
  160. <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 />
  161. </p>
  162. </div>
  163. </div>
  164. <a id="a3874f70577fc9fe15fd2c4ce68a36ecd"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a3874f70577fc9fe15fd2c4ce68a36ecd">&#9670;&nbsp;</a></span>GRPC_GOOGLE_CREDENTIALS_ENV_VAR</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">#define GRPC_GOOGLE_CREDENTIALS_ENV_VAR&#160;&#160;&#160;&quot;GOOGLE_APPLICATION_CREDENTIALS&quot;</td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Environment variable that points to the google default application credentials json key or refresh token. </p>
  175. <p>Used in the grpc_google_default_credentials_create function. </p>
  176. </div>
  177. </div>
  178. <a id="abb77790260f0d5b9ffb8d8095bbbe044"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#abb77790260f0d5b9ffb8d8095bbbe044">&#9670;&nbsp;</a></span>GRPC_PEER_SPIFFE_ID_PROPERTY_NAME</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">#define GRPC_PEER_SPIFFE_ID_PROPERTY_NAME&#160;&#160;&#160;&quot;peer_spiffe_id&quot;</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. </div>
  189. </div>
  190. <a id="aacbb09bfff7ebda81d9d3d89f0597312"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#aacbb09bfff7ebda81d9d3d89f0597312">&#9670;&nbsp;</a></span>GRPC_SSL_SESSION_REUSED_PROPERTY</h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">#define GRPC_SSL_SESSION_REUSED_PROPERTY&#160;&#160;&#160;&quot;ssl_session_reused&quot;</td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. </div>
  201. </div>
  202. <a id="a35a35c597b7090b8ac7e2d854c9bcc7a"></a>
  203. <h2 class="memtitle"><span class="permalink"><a href="#a35a35c597b7090b8ac7e2d854c9bcc7a">&#9670;&nbsp;</a></span>GRPC_SSL_TRANSPORT_SECURITY_TYPE</h2>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">#define GRPC_SSL_TRANSPORT_SECURITY_TYPE&#160;&#160;&#160;&quot;ssl&quot;</td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. </div>
  213. </div>
  214. <a id="ab19cdead9b37b4818118403d4d3b4ebb"></a>
  215. <h2 class="memtitle"><span class="permalink"><a href="#ab19cdead9b37b4818118403d4d3b4ebb">&#9670;&nbsp;</a></span>GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME</h2>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">#define GRPC_TRANSPORT_SECURITY_LEVEL_PROPERTY_NAME&#160;&#160;&#160;&quot;security_level&quot;</td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. </div>
  225. </div>
  226. <a id="aff82fdff9e7c40c4dd4bdc650e38e25a"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#aff82fdff9e7c40c4dd4bdc650e38e25a">&#9670;&nbsp;</a></span>GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">#define GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME&#160;&#160;&#160;&quot;transport_security_type&quot;</td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. </div>
  237. </div>
  238. <a id="afee5e0fade6e0af1954529f1f08afe0c"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#afee5e0fade6e0af1954529f1f08afe0c">&#9670;&nbsp;</a></span>GRPC_X509_CN_PROPERTY_NAME</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">#define GRPC_X509_CN_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_common_name&quot;</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. </div>
  249. </div>
  250. <a id="a4ea60d47d799302dc1b760bcfa78e5a1"></a>
  251. <h2 class="memtitle"><span class="permalink"><a href="#a4ea60d47d799302dc1b760bcfa78e5a1">&#9670;&nbsp;</a></span>GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME</h2>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="memname">
  255. <tr>
  256. <td class="memname">#define GRPC_X509_PEM_CERT_CHAIN_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_pem_cert_chain&quot;</td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. </div>
  261. </div>
  262. <a id="ad46c3fd565d6a24eeb25d1fdc342cb28"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#ad46c3fd565d6a24eeb25d1fdc342cb28">&#9670;&nbsp;</a></span>GRPC_X509_PEM_CERT_PROPERTY_NAME</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">#define GRPC_X509_PEM_CERT_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_pem_cert&quot;</td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. </div>
  273. </div>
  274. <a id="a1412421653b7999544296f56025a0f36"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#a1412421653b7999544296f56025a0f36">&#9670;&nbsp;</a></span>GRPC_X509_SAN_PROPERTY_NAME</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">#define GRPC_X509_SAN_PROPERTY_NAME&#160;&#160;&#160;&quot;x509_subject_alternative_name&quot;</td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. </div>
  285. </div>
  286. <h2 class="groupheader">Enumeration Type Documentation</h2>
  287. <a id="a31d00ce5c064e1fff4261a6d6298dc11"></a>
  288. <h2 class="memtitle"><span class="permalink"><a href="#a31d00ce5c064e1fff4261a6d6298dc11">&#9670;&nbsp;</a></span>grpc_local_connect_type</h2>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a></td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>Type of local connections for which local channel/server credentials will be applied. </p>
  298. <p>It supports UDS and local TCP connections. </p>
  299. <table class="fieldtable">
  300. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a31d00ce5c064e1fff4261a6d6298dc11a94e03cdcc2f95916c9eaf6ab486ed768"></a>UDS&#160;</td><td class="fielddoc"></td></tr>
  301. <tr><td class="fieldname"><a id="a31d00ce5c064e1fff4261a6d6298dc11acb07333a9323d16e7e2258fe5bb4aed8"></a>LOCAL_TCP&#160;</td><td class="fielddoc"></td></tr>
  302. </table>
  303. </div>
  304. </div>
  305. <a id="a3c3165c49cd7a359ddb8656aae7e9dd6"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#a3c3165c49cd7a359ddb8656aae7e9dd6">&#9670;&nbsp;</a></span>grpc_security_level</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a3c3165c49cd7a359ddb8656aae7e9dd6">grpc_security_level</a></td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <table class="fieldtable">
  316. <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>
  317. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6abb83593125096051f1c26ffa8df813b1"></a>GRPC_SECURITY_NONE&#160;</td><td class="fielddoc"></td></tr>
  318. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6ad9ad5579bef3a4b55e461f29c9fbd957"></a>GRPC_INTEGRITY_ONLY&#160;</td><td class="fielddoc"></td></tr>
  319. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6af27dbc67f757ccd2ff3537e053ad06c3"></a>GRPC_PRIVACY_AND_INTEGRITY&#160;</td><td class="fielddoc"></td></tr>
  320. <tr><td class="fieldname"><a id="a3c3165c49cd7a359ddb8656aae7e9dd6a3dac3570a7b2f7189f426c0377bdb1e1"></a>GRPC_SECURITY_MAX&#160;</td><td class="fielddoc"></td></tr>
  321. </table>
  322. </div>
  323. </div>
  324. <a id="a4f19e93998bbda68d9c24f27673ff627"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#a4f19e93998bbda68d9c24f27673ff627">&#9670;&nbsp;</a></span>grpc_ssl_certificate_config_reload_status</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a></td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Callback results for dynamically loading a SSL certificate config. </p>
  335. <table class="fieldtable">
  336. <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>
  337. <tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627a00758a0455bc6cfbfe0e2af5f4f861cb"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_NEW&#160;</td><td class="fielddoc"></td></tr>
  338. <tr><td class="fieldname"><a id="a4f19e93998bbda68d9c24f27673ff627a87b80abccb958ca6899bc7e965ed8855"></a>GRPC_SSL_CERTIFICATE_CONFIG_RELOAD_FAIL&#160;</td><td class="fielddoc"></td></tr>
  339. </table>
  340. </div>
  341. </div>
  342. <a id="a29ffe63a8bb3b4945ecab42d82758f09"></a>
  343. <h2 class="memtitle"><span class="permalink"><a href="#a29ffe63a8bb3b4945ecab42d82758f09">&#9670;&nbsp;</a></span>grpc_ssl_client_certificate_request_type</h2>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a></td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <table class="fieldtable">
  353. <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>
  354. <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>
  355. </td></tr>
  356. <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>
  357. <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>
  358. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  359. </td></tr>
  360. <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>
  361. <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>
  362. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  363. </td></tr>
  364. <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>
  365. <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>
  366. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  367. </td></tr>
  368. <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>
  369. <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>
  370. <p>The client's key certificate pair must be valid for the SSL connection to be established. </p>
  371. </td></tr>
  372. </table>
  373. </div>
  374. </div>
  375. <a id="a90c47ae1d8c33145342170fe615fa68c"></a>
  376. <h2 class="memtitle"><span class="permalink"><a href="#a90c47ae1d8c33145342170fe615fa68c">&#9670;&nbsp;</a></span>grpc_ssl_roots_override_result</h2>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">grpc_ssl_roots_override_result</a></td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Results for the SSL roots override callback. </p>
  386. <table class="fieldtable">
  387. <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>
  388. <tr><td class="fieldname"><a id="a90c47ae1d8c33145342170fe615fa68caa0fdee0e3b14865c1ee4e7d89a46cc64"></a>GRPC_SSL_ROOTS_OVERRIDE_FAIL_PERMANENTLY&#160;</td><td class="fielddoc"></td></tr>
  389. <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>
  390. </td></tr>
  391. </table>
  392. </div>
  393. </div>
  394. <a id="aa4b37b544134e070541912584793446a"></a>
  395. <h2 class="memtitle"><span class="permalink"><a href="#aa4b37b544134e070541912584793446a">&#9670;&nbsp;</a></span>grpc_tls_server_verification_option</h2>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">enum <a class="el" href="grpc__security__constants_8h.html#aa4b37b544134e070541912584793446a">grpc_tls_server_verification_option</a></td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <table class="fieldtable">
  405. <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>
  406. </td></tr>
  407. <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>
  408. </td></tr>
  409. <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>
  410. <p>Client is responsible for verifying server's identity and server's certificate via server authorization check callback. </p>
  411. </td></tr>
  412. </table>
  413. </div>
  414. </div>
  415. </div><!-- contents -->
  416. <!-- start footer part -->
  417. <hr class="footer"/><address class="footer"><small>
  418. Generated on Tue Jun 30 2020 18:16:56 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  419. <img class="footer" src="doxygen.png" alt="doxygen"/>
  420. </a> 1.8.16
  421. </small></address>
  422. </body>
  423. </html>