|
@@ -90,7 +90,10 @@ Data Structures</h2></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Object that holds a private key / certificate chain pair in PEM format. <a href="structgrpc__ssl__pem__key__cert__pair.html#details">More...</a><br /></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Object that holds a private key / certificate chain pair in PEM format. <a href="structgrpc__ssl__pem__key__cert__pair.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structverify__peer__options.html">verify_peer_options</a></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structverify__peer__options.html">verify_peer_options</a></td></tr>
|
|
-<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Object that holds additional peer-verification options on a secure channel. <a href="structverify__peer__options.html#details">More...</a><br /></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated in favor of <a class="el" href="structgrpc__ssl__verify__peer__options.html" title="Object that holds additional peer-verification options on a secure channel. ">grpc_ssl_verify_peer_options</a>. <a href="structverify__peer__options.html#details">More...</a><br /></td></tr>
|
|
|
|
+<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
|
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__ssl__verify__peer__options.html">grpc_ssl_verify_peer_options</a></td></tr>
|
|
|
|
+<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Object that holds additional peer-verification options on a secure channel. <a href="structgrpc__ssl__verify__peer__options.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html">grpc_auth_metadata_context</a></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html">grpc_auth_metadata_context</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Context that can be used by metadata credentials plugin in order to create auth related metadata. <a href="structgrpc__auth__metadata__context.html#details">More...</a><br /></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Context that can be used by metadata credentials plugin in order to create auth related metadata. <a href="structgrpc__auth__metadata__context.html#details">More...</a><br /></td></tr>
|
|
@@ -235,8 +238,10 @@ Functions</h2></td></tr>
|
|
<tr class="memdesc:a44c23e47832d9cc27bb56822d66bf436"><td class="mdescLeft"> </td><td class="mdescRight">Setup a callback to override the default TLS/SSL roots. <a href="#a44c23e47832d9cc27bb56822d66bf436">More...</a><br /></td></tr>
|
|
<tr class="memdesc:a44c23e47832d9cc27bb56822d66bf436"><td class="mdescLeft"> </td><td class="mdescRight">Setup a callback to override the default TLS/SSL roots. <a href="#a44c23e47832d9cc27bb56822d66bf436">More...</a><br /></td></tr>
|
|
<tr class="separator:a44c23e47832d9cc27bb56822d66bf436"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a44c23e47832d9cc27bb56822d66bf436"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7440216a2192f7c5ecadf5704e7c7bda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a7440216a2192f7c5ecadf5704e7c7bda">grpc_ssl_credentials_create</a> (const char *pem_root_certs, <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pair, const <a class="el" href="structverify__peer__options.html">verify_peer_options</a> *verify_options, void *reserved)</td></tr>
|
|
<tr class="memitem:a7440216a2192f7c5ecadf5704e7c7bda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a7440216a2192f7c5ecadf5704e7c7bda">grpc_ssl_credentials_create</a> (const char *pem_root_certs, <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pair, const <a class="el" href="structverify__peer__options.html">verify_peer_options</a> *verify_options, void *reserved)</td></tr>
|
|
-<tr class="memdesc:a7440216a2192f7c5ecadf5704e7c7bda"><td class="mdescLeft"> </td><td class="mdescRight">Creates an SSL credentials object. <a href="#a7440216a2192f7c5ecadf5704e7c7bda">More...</a><br /></td></tr>
|
|
|
|
|
|
+<tr class="memdesc:a7440216a2192f7c5ecadf5704e7c7bda"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated in favor of grpc_ssl_server_credentials_create_ex. <a href="#a7440216a2192f7c5ecadf5704e7c7bda">More...</a><br /></td></tr>
|
|
<tr class="separator:a7440216a2192f7c5ecadf5704e7c7bda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:a7440216a2192f7c5ecadf5704e7c7bda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
|
|
+<tr class="memitem:a57e477a6fdd9a6a66cc37614701d9088"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a57e477a6fdd9a6a66cc37614701d9088">grpc_ssl_credentials_create_ex</a> (const char *pem_root_certs, <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pair, const <a class="el" href="structgrpc__ssl__verify__peer__options.html">grpc_ssl_verify_peer_options</a> *verify_options, void *reserved)</td></tr>
|
|
|
|
+<tr class="separator:a57e477a6fdd9a6a66cc37614701d9088"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb21611154f3defe05e4eac4cc25af5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aeb21611154f3defe05e4eac4cc25af5a">grpc_call_credentials_release</a> (<a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds)</td></tr>
|
|
<tr class="memitem:aeb21611154f3defe05e4eac4cc25af5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aeb21611154f3defe05e4eac4cc25af5a">grpc_call_credentials_release</a> (<a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds)</td></tr>
|
|
<tr class="memdesc:aeb21611154f3defe05e4eac4cc25af5a"><td class="mdescLeft"> </td><td class="mdescRight">Releases a call credentials object. <a href="#aeb21611154f3defe05e4eac4cc25af5a">More...</a><br /></td></tr>
|
|
<tr class="memdesc:aeb21611154f3defe05e4eac4cc25af5a"><td class="mdescLeft"> </td><td class="mdescRight">Releases a call credentials object. <a href="#aeb21611154f3defe05e4eac4cc25af5a">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb21611154f3defe05e4eac4cc25af5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="separator:aeb21611154f3defe05e4eac4cc25af5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
@@ -1818,15 +1823,55 @@ Functions</h2></td></tr>
|
|
</table>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
</div><div class="memdoc">
|
|
|
|
|
|
-<p>Creates an SSL credentials object. </p>
|
|
|
|
-<ul>
|
|
|
|
|
|
+<p>Deprecated in favor of grpc_ssl_server_credentials_create_ex. </p>
|
|
|
|
+<p>It will be removed after all of its call sites are migrated to grpc_ssl_server_credentials_create_ex. Creates an SSL credentials object.</p><ul>
|
|
<li><p class="startli">pem_root_certs is the NULL-terminated string containing the PEM encoding of the server root certificates. If this parameter is NULL, the implementation will first try to dereference the file pointed by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable, and if that fails, try to get the roots set by grpc_override_ssl_default_roots. Eventually, if all these fail, it will try to get the roots from a well-known place on disk (in the grpc install directory).</p>
|
|
<li><p class="startli">pem_root_certs is the NULL-terminated string containing the PEM encoding of the server root certificates. If this parameter is NULL, the implementation will first try to dereference the file pointed by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable, and if that fails, try to get the roots set by grpc_override_ssl_default_roots. Eventually, if all these fail, it will try to get the roots from a well-known place on disk (in the grpc install directory).</p>
|
|
<p class="startli">gRPC has implemented root cache if the underlying OpenSSL library supports it. The gRPC root certificates cache is only applicable on the default root certificates, which is used when this parameter is nullptr. If user provides their own pem_root_certs, when creating an SSL credential object, gRPC would not be able to cache it, and each subchannel will generate a copy of the root store. So it is recommended to avoid providing large room pem with pem_root_certs parameter to avoid excessive memory consumption, particularly on mobile platforms such as iOS.</p>
|
|
<p class="startli">gRPC has implemented root cache if the underlying OpenSSL library supports it. The gRPC root certificates cache is only applicable on the default root certificates, which is used when this parameter is nullptr. If user provides their own pem_root_certs, when creating an SSL credential object, gRPC would not be able to cache it, and each subchannel will generate a copy of the root store. So it is recommended to avoid providing large room pem with pem_root_certs parameter to avoid excessive memory consumption, particularly on mobile platforms such as iOS.</p>
|
|
</li>
|
|
</li>
|
|
<li>pem_key_cert_pair is a pointer on the object containing client's private key and certificate chain. This parameter can be NULL if the client does not have such a key/cert pair.</li>
|
|
<li>pem_key_cert_pair is a pointer on the object containing client's private key and certificate chain. This parameter can be NULL if the client does not have such a key/cert pair.</li>
|
|
-<li>verify_options is an optional <a class="el" href="structverify__peer__options.html" title="Object that holds additional peer-verification options on a secure channel. ">verify_peer_options</a> object which holds additional options controlling how peer certificates are verified. For example, you can supply a callback which receives the peer's certificate with which you can do additional verification. Can be NULL, in which case verification will retain default behavior. Any settings in verify_options are copied during this call, so the verify_options object can be released afterwards. </li>
|
|
|
|
|
|
+<li>verify_options is an optional <a class="el" href="structverify__peer__options.html" title="Deprecated in favor of grpc_ssl_verify_peer_options. ">verify_peer_options</a> object which holds additional options controlling how peer certificates are verified. For example, you can supply a callback which receives the peer's certificate with which you can do additional verification. Can be NULL, in which case verification will retain default behavior. Any settings in verify_options are copied during this call, so the verify_options object can be released afterwards. </li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
+</div>
|
|
|
|
+</div>
|
|
|
|
+<a id="a57e477a6fdd9a6a66cc37614701d9088"></a>
|
|
|
|
+<h2 class="memtitle"><span class="permalink"><a href="#a57e477a6fdd9a6a66cc37614701d9088">◆ </a></span>grpc_ssl_credentials_create_ex()</h2>
|
|
|
|
+
|
|
|
|
+<div class="memitem">
|
|
|
|
+<div class="memproto">
|
|
|
|
+ <table class="memname">
|
|
|
|
+ <tr>
|
|
|
|
+ <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a>* grpc_ssl_credentials_create_ex </td>
|
|
|
|
+ <td>(</td>
|
|
|
|
+ <td class="paramtype">const char * </td>
|
|
|
|
+ <td class="paramname"><em>pem_root_certs</em>, </td>
|
|
|
|
+ </tr>
|
|
|
|
+ <tr>
|
|
|
|
+ <td class="paramkey"></td>
|
|
|
|
+ <td></td>
|
|
|
|
+ <td class="paramtype"><a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> * </td>
|
|
|
|
+ <td class="paramname"><em>pem_key_cert_pair</em>, </td>
|
|
|
|
+ </tr>
|
|
|
|
+ <tr>
|
|
|
|
+ <td class="paramkey"></td>
|
|
|
|
+ <td></td>
|
|
|
|
+ <td class="paramtype">const <a class="el" href="structgrpc__ssl__verify__peer__options.html">grpc_ssl_verify_peer_options</a> * </td>
|
|
|
|
+ <td class="paramname"><em>verify_options</em>, </td>
|
|
|
|
+ </tr>
|
|
|
|
+ <tr>
|
|
|
|
+ <td class="paramkey"></td>
|
|
|
|
+ <td></td>
|
|
|
|
+ <td class="paramtype">void * </td>
|
|
|
|
+ <td class="paramname"><em>reserved</em> </td>
|
|
|
|
+ </tr>
|
|
|
|
+ <tr>
|
|
|
|
+ <td></td>
|
|
|
|
+ <td>)</td>
|
|
|
|
+ <td></td><td></td>
|
|
|
|
+ </tr>
|
|
|
|
+ </table>
|
|
|
|
+</div><div class="memdoc">
|
|
|
|
+
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="a0fbb46fa71b635516037e6b265f937f5"></a>
|
|
<a id="a0fbb46fa71b635516037e6b265f937f5"></a>
|
|
@@ -1990,7 +2035,7 @@ Functions</h2></td></tr>
|
|
</div><div class="memdoc">
|
|
</div><div class="memdoc">
|
|
|
|
|
|
<p>Deprecated in favor of grpc_ssl_server_credentials_create_with_options. </p>
|
|
<p>Deprecated in favor of grpc_ssl_server_credentials_create_with_options. </p>
|
|
-<p>Same as grpc_ssl_server_credentials_create method except uses grpc_ssl_client_certificate_request_type enum to support more ways to authenticate client cerificates. </p>
|
|
|
|
|
|
+<p>Same as grpc_ssl_server_credentials_create method except uses grpc_ssl_client_certificate_request_type enum to support more ways to authenticate client certificates. </p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
@@ -2531,7 +2576,7 @@ Functions</h2></td></tr>
|
|
</div><!-- contents -->
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
-Generated on Fri May 31 2019 16:39:26 for GRPC Core by  <a href="http://www.doxygen.org/index.html">
|
|
|
|
|
|
+Generated on Wed Jul 3 2019 14:51:26 for GRPC Core by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</small></address>
|