structgrpc__ssl__verify__peer__options.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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 Core: grpc_ssl_verify_peer_options Struct 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">15.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.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><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-attribs">Data Fields</a> </div>
  65. <div class="headertitle">
  66. <div class="title">grpc_ssl_verify_peer_options Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Object that holds additional peer-verification options on a secure channel.
  70. <a href="structgrpc__ssl__verify__peer__options.html#details">More...</a></p>
  71. <p><code>#include &lt;<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  74. Data Fields</h2></td></tr>
  75. <tr class="memitem:a8923d0f5340c92f28e2937ed78859489"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__ssl__verify__peer__options.html#a8923d0f5340c92f28e2937ed78859489">verify_peer_callback</a> )(const char *target_name, const char *peer_pem, void *userdata)</td></tr>
  76. <tr class="memdesc:a8923d0f5340c92f28e2937ed78859489"><td class="mdescLeft">&#160;</td><td class="mdescRight">If non-NULL this callback will be invoked with the expected target_name, the peer's certificate (in PEM format), and whatever userdata pointer is set below. <a href="structgrpc__ssl__verify__peer__options.html#a8923d0f5340c92f28e2937ed78859489">More...</a><br /></td></tr>
  77. <tr class="separator:a8923d0f5340c92f28e2937ed78859489"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a6700c305b4af601ba4a38c05f8a9c898"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__ssl__verify__peer__options.html#a6700c305b4af601ba4a38c05f8a9c898">verify_peer_callback_userdata</a></td></tr>
  79. <tr class="memdesc:a6700c305b4af601ba4a38c05f8a9c898"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arbitrary userdata that will be passed as the last argument to verify_peer_callback. <a href="structgrpc__ssl__verify__peer__options.html#a6700c305b4af601ba4a38c05f8a9c898">More...</a><br /></td></tr>
  80. <tr class="separator:a6700c305b4af601ba4a38c05f8a9c898"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a3c2e0c9f822bf4f55a105006ab6d9de4"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__ssl__verify__peer__options.html#a3c2e0c9f822bf4f55a105006ab6d9de4">verify_peer_destruct</a> )(void *userdata)</td></tr>
  82. <tr class="memdesc:a3c2e0c9f822bf4f55a105006ab6d9de4"><td class="mdescLeft">&#160;</td><td class="mdescRight">A destruct callback that will be invoked when the channel is being cleaned up. <a href="structgrpc__ssl__verify__peer__options.html#a3c2e0c9f822bf4f55a105006ab6d9de4">More...</a><br /></td></tr>
  83. <tr class="separator:a3c2e0c9f822bf4f55a105006ab6d9de4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86. <div class="textblock"><p>Object that holds additional peer-verification options on a secure channel. </p>
  87. </div><h2 class="groupheader">Field Documentation</h2>
  88. <a id="a8923d0f5340c92f28e2937ed78859489"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#a8923d0f5340c92f28e2937ed78859489">&#9670;&nbsp;</a></span>verify_peer_callback</h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">int(* grpc_ssl_verify_peer_options::verify_peer_callback) (const char *target_name, const char *peer_pem, void *userdata)</td>
  95. </tr>
  96. </table>
  97. </div><div class="memdoc">
  98. <p>If non-NULL this callback will be invoked with the expected target_name, the peer's certificate (in PEM format), and whatever userdata pointer is set below. </p>
  99. <p>If a non-zero value is returned by this callback then it is treated as a verification failure. Invocation of the callback is blocking, so any implementation should be light-weight. </p>
  100. </div>
  101. </div>
  102. <a id="a6700c305b4af601ba4a38c05f8a9c898"></a>
  103. <h2 class="memtitle"><span class="permalink"><a href="#a6700c305b4af601ba4a38c05f8a9c898">&#9670;&nbsp;</a></span>verify_peer_callback_userdata</h2>
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">void* grpc_ssl_verify_peer_options::verify_peer_callback_userdata</td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. <p>Arbitrary userdata that will be passed as the last argument to verify_peer_callback. </p>
  113. </div>
  114. </div>
  115. <a id="a3c2e0c9f822bf4f55a105006ab6d9de4"></a>
  116. <h2 class="memtitle"><span class="permalink"><a href="#a3c2e0c9f822bf4f55a105006ab6d9de4">&#9670;&nbsp;</a></span>verify_peer_destruct</h2>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">void(* grpc_ssl_verify_peer_options::verify_peer_destruct) (void *userdata)</td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>A destruct callback that will be invoked when the channel is being cleaned up. </p>
  126. <p>The userdata argument will be passed to it. The intent is to perform any cleanup associated with that userdata. </p>
  127. </div>
  128. </div>
  129. <hr/>The documentation for this struct was generated from the following file:<ul>
  130. <li>include/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
  131. </ul>
  132. </div><!-- contents -->
  133. <!-- start footer part -->
  134. <hr class="footer"/><address class="footer"><small>
  135. Generated on Wed Mar 3 2021 19:17:11 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  136. <img class="footer" src="doxygen.png" alt="doxygen"/>
  137. </a> 1.8.17
  138. </small></address>
  139. </body>
  140. </html>