grpc/cpp/structgrpc__impl_1_1_ssl_cr...

159 lines
8.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc_impl::SslCredentialsOptions Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
&#160;<span id="projectnumber">1.31.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegrpc__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html">SslCredentialsOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">grpc_impl::SslCredentialsOptions Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options used to build SslCredentials.
<a href="structgrpc__impl_1_1_ssl_credentials_options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="credentials__impl_8h_source.html">credentials_impl.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a44813813edd9bfcc74f58a64e07e6ab5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html#a44813813edd9bfcc74f58a64e07e6ab5">pem_root_certs</a></td></tr>
<tr class="memdesc:a44813813edd9bfcc74f58a64e07e6ab5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the server root certificates. <a href="structgrpc__impl_1_1_ssl_credentials_options.html#a44813813edd9bfcc74f58a64e07e6ab5">More...</a><br /></td></tr>
<tr class="separator:a44813813edd9bfcc74f58a64e07e6ab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23b4783a3bcf2ea43c637657469cc0bc"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html#a23b4783a3bcf2ea43c637657469cc0bc">pem_private_key</a></td></tr>
<tr class="memdesc:a23b4783a3bcf2ea43c637657469cc0bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the client's private key. <a href="structgrpc__impl_1_1_ssl_credentials_options.html#a23b4783a3bcf2ea43c637657469cc0bc">More...</a><br /></td></tr>
<tr class="separator:a23b4783a3bcf2ea43c637657469cc0bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f9b95dedc15ff763bfa1c02b47e1e7f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html#a4f9b95dedc15ff763bfa1c02b47e1e7f">pem_cert_chain</a></td></tr>
<tr class="memdesc:a4f9b95dedc15ff763bfa1c02b47e1e7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the client's certificate chain. <a href="structgrpc__impl_1_1_ssl_credentials_options.html#a4f9b95dedc15ff763bfa1c02b47e1e7f">More...</a><br /></td></tr>
<tr class="separator:a4f9b95dedc15ff763bfa1c02b47e1e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Options used to build SslCredentials. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a4f9b95dedc15ff763bfa1c02b47e1e7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f9b95dedc15ff763bfa1c02b47e1e7f">&#9670;&nbsp;</a></span>pem_cert_chain</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string grpc_impl::SslCredentialsOptions::pem_cert_chain</td>
</tr>
</table>
</div><div class="memdoc">
<p>The buffer containing the PEM encoding of the client's certificate chain. </p>
<p>This parameter can be empty if the client does not have a certificate chain. </p>
</div>
</div>
<a id="a23b4783a3bcf2ea43c637657469cc0bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23b4783a3bcf2ea43c637657469cc0bc">&#9670;&nbsp;</a></span>pem_private_key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string grpc_impl::SslCredentialsOptions::pem_private_key</td>
</tr>
</table>
</div><div class="memdoc">
<p>The buffer containing the PEM encoding of the client's private key. </p>
<p>This parameter can be empty if the client does not have a private key. </p>
</div>
</div>
<a id="a44813813edd9bfcc74f58a64e07e6ab5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44813813edd9bfcc74f58a64e07e6ab5">&#9670;&nbsp;</a></span>pem_root_certs</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string grpc_impl::SslCredentialsOptions::pem_root_certs</td>
</tr>
</table>
</div><div class="memdoc">
<p>The buffer containing the PEM encoding of the server root certificates. </p>
<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>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/grpcpp/security/<a class="el" href="credentials__impl_8h_source.html">credentials_impl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 18 2020 16:24:48 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>