structgrpc_1_1_ssl_credentials_options.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  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++: grpc::SslCredentialsOptions 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 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="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html">SslCredentialsOptions</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-attribs">Data Fields</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::SslCredentialsOptions Struct Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>Options used to build SslCredentials.
  74. <a href="structgrpc_1_1_ssl_credentials_options.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="grpcpp_2security_2credentials_8h_source.html">credentials.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  78. Data Fields</h2></td></tr>
  79. <tr class="memitem:a0ce1730020e18d04b6af48c88e069869"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html#a0ce1730020e18d04b6af48c88e069869">pem_root_certs</a></td></tr>
  80. <tr class="memdesc:a0ce1730020e18d04b6af48c88e069869"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the server root certificates. <a href="structgrpc_1_1_ssl_credentials_options.html#a0ce1730020e18d04b6af48c88e069869">More...</a><br /></td></tr>
  81. <tr class="separator:a0ce1730020e18d04b6af48c88e069869"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a5b661f8daf02db7283774e0fb9a8979e"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html#a5b661f8daf02db7283774e0fb9a8979e">pem_private_key</a></td></tr>
  83. <tr class="memdesc:a5b661f8daf02db7283774e0fb9a8979e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the client's private key. <a href="structgrpc_1_1_ssl_credentials_options.html#a5b661f8daf02db7283774e0fb9a8979e">More...</a><br /></td></tr>
  84. <tr class="separator:a5b661f8daf02db7283774e0fb9a8979e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a01015d8ec7dbf49f2ac3cd21f21d383b"><td class="memItemLeft" align="right" valign="top">grpc::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html#a01015d8ec7dbf49f2ac3cd21f21d383b">pem_cert_chain</a></td></tr>
  86. <tr class="memdesc:a01015d8ec7dbf49f2ac3cd21f21d383b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the client's certificate chain. <a href="structgrpc_1_1_ssl_credentials_options.html#a01015d8ec7dbf49f2ac3cd21f21d383b">More...</a><br /></td></tr>
  87. <tr class="separator:a01015d8ec7dbf49f2ac3cd21f21d383b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table>
  89. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  90. <div class="textblock"><p>Options used to build SslCredentials. </p>
  91. </div><h2 class="groupheader">Field Documentation</h2>
  92. <a id="a01015d8ec7dbf49f2ac3cd21f21d383b"></a>
  93. <h2 class="memtitle"><span class="permalink"><a href="#a01015d8ec7dbf49f2ac3cd21f21d383b">&#9670;&nbsp;</a></span>pem_cert_chain</h2>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname">grpc::string grpc::SslCredentialsOptions::pem_cert_chain</td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. <p>The buffer containing the PEM encoding of the client's certificate chain. </p>
  103. <p>This parameter can be empty if the client does not have a certificate chain. </p>
  104. </div>
  105. </div>
  106. <a id="a5b661f8daf02db7283774e0fb9a8979e"></a>
  107. <h2 class="memtitle"><span class="permalink"><a href="#a5b661f8daf02db7283774e0fb9a8979e">&#9670;&nbsp;</a></span>pem_private_key</h2>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">grpc::string grpc::SslCredentialsOptions::pem_private_key</td>
  113. </tr>
  114. </table>
  115. </div><div class="memdoc">
  116. <p>The buffer containing the PEM encoding of the client's private key. </p>
  117. <p>This parameter can be empty if the client does not have a private key. </p>
  118. </div>
  119. </div>
  120. <a id="a0ce1730020e18d04b6af48c88e069869"></a>
  121. <h2 class="memtitle"><span class="permalink"><a href="#a0ce1730020e18d04b6af48c88e069869">&#9670;&nbsp;</a></span>pem_root_certs</h2>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">grpc::string grpc::SslCredentialsOptions::pem_root_certs</td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>The buffer containing the PEM encoding of the server root certificates. </p>
  131. <p>If this parameter is empty, the default roots will be used. The default roots can be overridden using the <em>GRPC_DEFAULT_SSL_ROOTS_FILE_PATH</em> environment variable pointing to a file on the file system containing the roots. </p>
  132. </div>
  133. </div>
  134. <hr/>The documentation for this struct was generated from the following file:<ul>
  135. <li>include/grpcpp/security/<a class="el" href="grpcpp_2security_2credentials_8h_source.html">credentials.h</a></li>
  136. </ul>
  137. </div><!-- contents -->
  138. <!-- start footer part -->
  139. <hr class="footer"/><address class="footer"><small>
  140. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  141. <img class="footer" src="doxygen.png" alt="doxygen"/>
  142. </a> 1.8.17
  143. </small></address>
  144. </body>
  145. </html>