diff options
| author | Gregory Cooke <gregorycooke@google.com> | 2024-05-10 12:37:37 -0700 |
|---|---|---|
| committer | Copybara-Service <copybara-worker@google.com> | 2024-05-10 12:40:41 -0700 |
| commit | 3e412b4af180e08fce27afd759c3133b2a4fefb4 (patch) | |
| tree | a8171b974349dad63fce116ede30c025bb233365 | |
| parent | 57b7e7780e28f5540dcc82cb20f4268d3dbd5d06 (diff) | |
| download | grpc-grpc-3e412b4af180e08fce27afd759c3133b2a4fefb4.tar.gz | |
[security] Add notices for functions we will be removing (#36488)
Mark the following APIs in `TlsCredentialsOptions` as deprecated: `set_check_call_host`, `set_send_client_ca_list`, `set_crl_directory`. These APIs will be removed in release 1.66.
Closes #36488
COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/36488 from gtcooke94:AddDeprecationNotes df8e4346432b68a46e504f5eeb3527e2a9cae575
PiperOrigin-RevId: 632574716
| -rw-r--r-- | include/grpcpp/security/tls_credentials_options.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/grpcpp/security/tls_credentials_options.h b/include/grpcpp/security/tls_credentials_options.h index 6adf9faac6..11c40f0408 100644 --- a/include/grpcpp/security/tls_credentials_options.h +++ b/include/grpcpp/security/tls_credentials_options.h @@ -103,6 +103,8 @@ class TlsCredentialsOptions { // call is covered by the cert that the peer presented. // We will perform such checks by default. This should be disabled if // verifiers other than the host name verifier is used. + // Deprecated: This function will be removed in the 1.66 release. This will be + // replaced by and handled within the custom verifier settings. void set_check_call_host(bool check_call_host); // Deprecated in favor of set_crl_provider. The @@ -111,6 +113,8 @@ class TlsCredentialsOptions { // If set, gRPC will read all hashed x.509 CRL files in the directory and // enforce the CRL files on all TLS handshakes. Only supported for OpenSSL // version > 1.1. + // Deprecated: This function will be removed in the 1.66 release. Use the + // set_crl_provider function instead. void set_crl_directory(const std::string& path); void set_crl_provider(std::shared_ptr<CrlProvider> crl_provider); @@ -184,6 +188,7 @@ class TlsServerCredentialsOptions final : public TlsCredentialsOptions { // WARNING: This API is extremely dangerous and should not be used. If the // server's trust bundle is too large, then the TLS server will be unable to // form a ServerHello, and hence will be unusable. + // Deprecated: This function will be removed in the 1.66 release. void set_send_client_ca_list(bool send_client_ca_list); private: |