From 4a8008fee7f51be98ed28556b9d09a7d03b48976 Mon Sep 17 00:00:00 2001 From: Long Dai Date: Wed, 26 May 2021 23:51:32 -0700 Subject: [PATCH] grpc_credentials: remove well_known_names Signed-off-by: Long Dai --- source/extensions/bootstrap/wasm/BUILD | 1 - source/extensions/grpc_credentials/BUILD | 19 ------------ .../extensions/grpc_credentials/aws_iam/BUILD | 1 - .../grpc_credentials/aws_iam/config.cc | 2 +- .../grpc_credentials/aws_iam/config.h | 3 +- .../extensions/grpc_credentials/example/BUILD | 1 - .../grpc_credentials/example/config.h | 4 +-- .../file_based_metadata/BUILD | 1 - .../file_based_metadata/config.cc | 2 +- .../file_based_metadata/config.h | 4 +-- .../grpc_credentials/well_known_names.h | 29 ------------------- test/common/grpc/BUILD | 1 - .../grpc/grpc_client_integration_test.cc | 17 ++++------- .../extensions/grpc_credentials/aws_iam/BUILD | 1 - .../aws_iam/aws_iam_grpc_credentials_test.cc | 10 +++---- .../file_based_metadata/BUILD | 1 - .../file_based_metadata/integration_test.cc | 13 +++------ 17 files changed, 18 insertions(+), 92 deletions(-) delete mode 100644 source/extensions/grpc_credentials/BUILD delete mode 100644 source/extensions/grpc_credentials/well_known_names.h diff --git a/source/extensions/bootstrap/wasm/BUILD b/source/extensions/bootstrap/wasm/BUILD index fe58c86f94c02..279a436a59822 100644 --- a/source/extensions/bootstrap/wasm/BUILD +++ b/source/extensions/bootstrap/wasm/BUILD @@ -29,7 +29,6 @@ envoy_cc_extension( "//source/common/config:datasource_lib", "//source/common/protobuf:utility_lib", "//source/extensions/common/wasm:wasm_lib", - "//source/extensions/grpc_credentials:well_known_names", "@envoy_api//envoy/extensions/wasm/v3:pkg_cc_proto", ], ) diff --git a/source/extensions/grpc_credentials/BUILD b/source/extensions/grpc_credentials/BUILD deleted file mode 100644 index 40a5e79b39d3b..0000000000000 --- a/source/extensions/grpc_credentials/BUILD +++ /dev/null @@ -1,19 +0,0 @@ -load( - "//bazel:envoy_build_system.bzl", - "envoy_cc_library", - "envoy_extension_package", -) - -licenses(["notice"]) # Apache 2 - -envoy_extension_package() - -envoy_cc_library( - name = "well_known_names", - hdrs = ["well_known_names.h"], - # well known names files are public as long as they exist. - visibility = ["//visibility:public"], - deps = [ - "//source/common/singleton:const_singleton", - ], -) diff --git a/source/extensions/grpc_credentials/aws_iam/BUILD b/source/extensions/grpc_credentials/aws_iam/BUILD index 41e311cc52c55..01e4dccfe5284 100644 --- a/source/extensions/grpc_credentials/aws_iam/BUILD +++ b/source/extensions/grpc_credentials/aws_iam/BUILD @@ -30,7 +30,6 @@ envoy_cc_extension( "//source/extensions/common/aws:region_provider_impl_lib", "//source/extensions/common/aws:signer_impl_lib", "//source/extensions/common/aws:utility_lib", - "//source/extensions/grpc_credentials:well_known_names", "@envoy_api//envoy/config/core/v3:pkg_cc_proto", "@envoy_api//envoy/config/grpc_credential/v3:pkg_cc_proto", ], diff --git a/source/extensions/grpc_credentials/aws_iam/config.cc b/source/extensions/grpc_credentials/aws_iam/config.cc index 345d975fedbda..454e6265204e3 100644 --- a/source/extensions/grpc_credentials/aws_iam/config.cc +++ b/source/extensions/grpc_credentials/aws_iam/config.cc @@ -34,7 +34,7 @@ std::shared_ptr AwsIamGrpcCredentialsFactory::getChann switch (credential.credential_specifier_case()) { case envoy::config::core::v3::GrpcService::GoogleGrpc::CallCredentials:: CredentialSpecifierCase::kFromPlugin: { - if (credential.from_plugin().name() == GrpcCredentialsNames::get().AwsIam) { + if (credential.from_plugin().name() == "envoy.grpc_credentials.aws_iam") { AwsIamGrpcCredentialsFactory credentials_factory; // We don't deal with validation failures here at runtime today, see // https://github.com/envoyproxy/envoy/issues/8010. diff --git a/source/extensions/grpc_credentials/aws_iam/config.h b/source/extensions/grpc_credentials/aws_iam/config.h index 9ac68a0451fc6..819a45598ac36 100644 --- a/source/extensions/grpc_credentials/aws_iam/config.h +++ b/source/extensions/grpc_credentials/aws_iam/config.h @@ -8,7 +8,6 @@ #include "common/http/message_impl.h" #include "extensions/common/aws/signer.h" -#include "extensions/grpc_credentials/well_known_names.h" namespace Envoy { namespace Extensions { @@ -28,7 +27,7 @@ class AwsIamGrpcCredentialsFactory : public Grpc::GoogleGrpcCredentialsFactory { return std::make_unique(); } - std::string name() const override { return GrpcCredentialsNames::get().AwsIam; } + std::string name() const override { return "envoy.grpc_credentials.aws_iam"; } private: static std::string getRegion(const envoy::config::grpc_credential::v3::AwsIamConfig& config); diff --git a/source/extensions/grpc_credentials/example/BUILD b/source/extensions/grpc_credentials/example/BUILD index 8c43f6c275323..582844968ee51 100644 --- a/source/extensions/grpc_credentials/example/BUILD +++ b/source/extensions/grpc_credentials/example/BUILD @@ -26,7 +26,6 @@ envoy_cc_library( "//include/envoy/registry", "//source/common/common:assert_lib", "//source/common/grpc:google_grpc_creds_lib", - "//source/extensions/grpc_credentials:well_known_names", "@envoy_api//envoy/config/core/v3:pkg_cc_proto", ], ) diff --git a/source/extensions/grpc_credentials/example/config.h b/source/extensions/grpc_credentials/example/config.h index e6bf0db6ef4b7..33cd85e6f425d 100644 --- a/source/extensions/grpc_credentials/example/config.h +++ b/source/extensions/grpc_credentials/example/config.h @@ -3,8 +3,6 @@ #include "envoy/config/core/v3/grpc_service.pb.h" #include "envoy/grpc/google_grpc_creds.h" -#include "extensions/grpc_credentials/well_known_names.h" - namespace Envoy { namespace Extensions { namespace GrpcCredentials { @@ -32,7 +30,7 @@ class AccessTokenExampleGrpcCredentialsFactory : public Grpc::GoogleGrpcCredenti getChannelCredentials(const envoy::config::core::v3::GrpcService& grpc_service_config, Api::Api& api) override; - std::string name() const override { return GrpcCredentialsNames::get().AccessTokenExample; } + std::string name() const override { return "envoy.grpc_credentials.access_token_example"; } }; /* diff --git a/source/extensions/grpc_credentials/file_based_metadata/BUILD b/source/extensions/grpc_credentials/file_based_metadata/BUILD index 45f065419f87e..b23ec1c766bf5 100644 --- a/source/extensions/grpc_credentials/file_based_metadata/BUILD +++ b/source/extensions/grpc_credentials/file_based_metadata/BUILD @@ -24,7 +24,6 @@ envoy_cc_extension( "//source/common/config:utility_lib", "//source/common/grpc:common_lib", "//source/common/grpc:google_grpc_creds_lib", - "//source/extensions/grpc_credentials:well_known_names", "@envoy_api//envoy/config/core/v3:pkg_cc_proto", "@envoy_api//envoy/config/grpc_credential/v3:pkg_cc_proto", ], diff --git a/source/extensions/grpc_credentials/file_based_metadata/config.cc b/source/extensions/grpc_credentials/file_based_metadata/config.cc index 124961d1d57ad..c05f7cc6d611b 100644 --- a/source/extensions/grpc_credentials/file_based_metadata/config.cc +++ b/source/extensions/grpc_credentials/file_based_metadata/config.cc @@ -28,7 +28,7 @@ FileBasedMetadataGrpcCredentialsFactory::getChannelCredentials( switch (credential.credential_specifier_case()) { case envoy::config::core::v3::GrpcService::GoogleGrpc::CallCredentials:: CredentialSpecifierCase::kFromPlugin: { - if (credential.from_plugin().name() == GrpcCredentialsNames::get().FileBasedMetadata) { + if (credential.from_plugin().name() == "envoy.grpc_credentials.file_based_metadata") { FileBasedMetadataGrpcCredentialsFactory file_based_metadata_credentials_factory; // We don't deal with validation failures here at runtime today, see // https://github.com/envoyproxy/envoy/issues/8010. diff --git a/source/extensions/grpc_credentials/file_based_metadata/config.h b/source/extensions/grpc_credentials/file_based_metadata/config.h index c9d7b3dfeeb52..7b844e356500b 100644 --- a/source/extensions/grpc_credentials/file_based_metadata/config.h +++ b/source/extensions/grpc_credentials/file_based_metadata/config.h @@ -6,8 +6,6 @@ #include "common/protobuf/protobuf.h" -#include "extensions/grpc_credentials/well_known_names.h" - namespace Envoy { namespace Extensions { namespace GrpcCredentials { @@ -32,7 +30,7 @@ class FileBasedMetadataGrpcCredentialsFactory : public Grpc::GoogleGrpcCredentia return std::make_unique(); } - std::string name() const override { return GrpcCredentialsNames::get().FileBasedMetadata; } + std::string name() const override { return "envoy.grpc_credentials.file_based_metadata"; } }; class FileBasedMetadataAuthenticator : public grpc::MetadataCredentialsPlugin { diff --git a/source/extensions/grpc_credentials/well_known_names.h b/source/extensions/grpc_credentials/well_known_names.h deleted file mode 100644 index e654414e9b47e..0000000000000 --- a/source/extensions/grpc_credentials/well_known_names.h +++ /dev/null @@ -1,29 +0,0 @@ -#pragma once - -#include - -#include "common/singleton/const_singleton.h" - -namespace Envoy { -namespace Extensions { -namespace GrpcCredentials { - -/** - * Well-known gRPC Credentials names. - * NOTE: New gRPC Credentials should use the well known name: envoy.grpc_credentials.name. - */ -class GrpcCredentialsNameValues { -public: - // Access Token Example. - const std::string AccessTokenExample = "envoy.grpc_credentials.access_token_example"; - // File Based Metadata credentials - const std::string FileBasedMetadata = "envoy.grpc_credentials.file_based_metadata"; - // AWS IAM - const std::string AwsIam = "envoy.grpc_credentials.aws_iam"; -}; - -using GrpcCredentialsNames = ConstSingleton; - -} // namespace GrpcCredentials -} // namespace Extensions -} // namespace Envoy diff --git a/test/common/grpc/BUILD b/test/common/grpc/BUILD index ed8fb7f6170de..78fe8522438e2 100644 --- a/test/common/grpc/BUILD +++ b/test/common/grpc/BUILD @@ -172,7 +172,6 @@ envoy_cc_test( deps = [ ":grpc_client_integration_test_harness_lib", "//source/common/grpc:async_client_lib", - "//source/extensions/grpc_credentials:well_known_names", "//source/extensions/grpc_credentials/example:config", ] + envoy_select_google_grpc(["//source/common/grpc:google_async_client_lib"]), ) diff --git a/test/common/grpc/grpc_client_integration_test.cc b/test/common/grpc/grpc_client_integration_test.cc index 0f3ff252a5891..578f489b848b0 100644 --- a/test/common/grpc/grpc_client_integration_test.cc +++ b/test/common/grpc/grpc_client_integration_test.cc @@ -3,8 +3,6 @@ #include "common/grpc/google_async_client_impl.h" -#include "extensions/grpc_credentials/well_known_names.h" - #endif #include "test/common/grpc/grpc_client_integration_test_harness.h" @@ -452,8 +450,7 @@ INSTANTIATE_TEST_SUITE_P(SslIpVersionsClientType, GrpcAccessTokenClientIntegrati TEST_P(GrpcAccessTokenClientIntegrationTest, AccessTokenAuthRequest) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); access_token_value_ = "accesstokenvalue"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().AccessTokenExample; + credentials_factory_name_ = "envoy.grpc_credentials.access_token_example"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -464,8 +461,7 @@ TEST_P(GrpcAccessTokenClientIntegrationTest, AccessTokenAuthRequest) { TEST_P(GrpcAccessTokenClientIntegrationTest, AccessTokenAuthStream) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); access_token_value_ = "accesstokenvalue"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().AccessTokenExample; + credentials_factory_name_ = "envoy.grpc_credentials.access_token_example"; initialize(); auto stream = createStream(empty_metadata_); stream->sendServerInitialMetadata(empty_metadata_); @@ -480,8 +476,7 @@ TEST_P(GrpcAccessTokenClientIntegrationTest, MultipleAccessTokens) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); access_token_value_ = "accesstokenvalue"; access_token_value_2_ = "accesstokenvalue2"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().AccessTokenExample; + credentials_factory_name_ = "envoy.grpc_credentials.access_token_example"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -493,8 +488,7 @@ TEST_P(GrpcAccessTokenClientIntegrationTest, ExtraCredentialParams) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); access_token_value_ = "accesstokenvalue"; refresh_token_value_ = "refreshtokenvalue"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().AccessTokenExample; + credentials_factory_name_ = "envoy.grpc_credentials.access_token_example"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -504,8 +498,7 @@ TEST_P(GrpcAccessTokenClientIntegrationTest, ExtraCredentialParams) { // Validate that no access token still works TEST_P(GrpcAccessTokenClientIntegrationTest, NoAccessTokens) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().AccessTokenExample; + credentials_factory_name_ = "envoy.grpc_credentials.access_token_example"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); diff --git a/test/extensions/grpc_credentials/aws_iam/BUILD b/test/extensions/grpc_credentials/aws_iam/BUILD index 4c9b6e7f22bf8..392ffda32ac97 100644 --- a/test/extensions/grpc_credentials/aws_iam/BUILD +++ b/test/extensions/grpc_credentials/aws_iam/BUILD @@ -14,7 +14,6 @@ envoy_cc_test( srcs = envoy_select_google_grpc(["aws_iam_grpc_credentials_test.cc"]), data = ["//test/config/integration/certs"], deps = [ - "//source/extensions/grpc_credentials:well_known_names", "//source/extensions/grpc_credentials/aws_iam:config", "//test/common/grpc:grpc_client_integration_test_harness_lib", "//test/integration:integration_lib", diff --git a/test/extensions/grpc_credentials/aws_iam/aws_iam_grpc_credentials_test.cc b/test/extensions/grpc_credentials/aws_iam/aws_iam_grpc_credentials_test.cc index 6a5852bb9a1a3..09bfe76927176 100644 --- a/test/extensions/grpc_credentials/aws_iam/aws_iam_grpc_credentials_test.cc +++ b/test/extensions/grpc_credentials/aws_iam/aws_iam_grpc_credentials_test.cc @@ -5,8 +5,6 @@ #include "common/common/utility.h" #include "common/grpc/google_async_client_impl.h" -#include "extensions/grpc_credentials/well_known_names.h" - #include "test/common/grpc/grpc_client_integration_test_harness.h" #include "test/integration/fake_upstream.h" #include "test/test_common/environment.h" @@ -122,7 +120,7 @@ TEST_P(GrpcAwsIamClientIntegrationTest, AwsIamGrpcAuth_ConfigRegion) { service_name_ = "test_service"; region_name_ = "test_region_static"; region_location_ = RegionLocation::InConfig; - credentials_factory_name_ = Extensions::GrpcCredentials::GrpcCredentialsNames::get().AwsIam; + credentials_factory_name_ = "envoy.grpc_credentials.aws_iam"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -134,7 +132,7 @@ TEST_P(GrpcAwsIamClientIntegrationTest, AwsIamGrpcAuth_EnvRegion) { service_name_ = "test_service"; region_name_ = "test_region_env"; region_location_ = RegionLocation::InEnvironment; - credentials_factory_name_ = Extensions::GrpcCredentials::GrpcCredentialsNames::get().AwsIam; + credentials_factory_name_ = "envoy.grpc_credentials.aws_iam"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -146,14 +144,14 @@ TEST_P(GrpcAwsIamClientIntegrationTest, AwsIamGrpcAuth_NoRegion) { service_name_ = "test_service"; region_name_ = "test_region_env"; region_location_ = RegionLocation::NotProvided; - credentials_factory_name_ = Extensions::GrpcCredentials::GrpcCredentialsNames::get().AwsIam; + credentials_factory_name_ = "envoy.grpc_credentials.aws_iam"; EXPECT_THROW_WITH_REGEX(initialize();, EnvoyException, "AWS region"); } TEST_P(GrpcAwsIamClientIntegrationTest, AwsIamGrpcAuth_UnexpectedCallCredentials) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); call_credentials_ = CallCredentials::AccessToken; - credentials_factory_name_ = Extensions::GrpcCredentials::GrpcCredentialsNames::get().AwsIam; + credentials_factory_name_ = "envoy.grpc_credentials.aws_iam"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); diff --git a/test/extensions/grpc_credentials/file_based_metadata/BUILD b/test/extensions/grpc_credentials/file_based_metadata/BUILD index 8ccb3fe5b848a..2c711ca2dda71 100644 --- a/test/extensions/grpc_credentials/file_based_metadata/BUILD +++ b/test/extensions/grpc_credentials/file_based_metadata/BUILD @@ -14,7 +14,6 @@ envoy_cc_test( srcs = ["integration_test.cc"], data = ["//test/config/integration/certs"], deps = [ - "//source/extensions/grpc_credentials:well_known_names", "//source/extensions/grpc_credentials/file_based_metadata:config", "//test/common/grpc:grpc_client_integration_test_harness_lib", "//test/integration:integration_lib", diff --git a/test/extensions/grpc_credentials/file_based_metadata/integration_test.cc b/test/extensions/grpc_credentials/file_based_metadata/integration_test.cc index 416059bdb7e67..6016c8c6df31f 100644 --- a/test/extensions/grpc_credentials/file_based_metadata/integration_test.cc +++ b/test/extensions/grpc_credentials/file_based_metadata/integration_test.cc @@ -7,7 +7,6 @@ #include "common/grpc/google_async_client_impl.h" #include "extensions/grpc_credentials/file_based_metadata/config.h" -#include "extensions/grpc_credentials/well_known_names.h" #include "test/common/grpc/grpc_client_integration_test_harness.h" #include "test/integration/fake_upstream.h" @@ -90,8 +89,7 @@ TEST_P(GrpcFileBasedMetadataClientIntegrationTest, FileBasedMetadataGrpcAuthRequ header_key_1_ = "header1"; header_prefix_1_ = "prefix1"; header_value_1_ = "secretvalue"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().FileBasedMetadata; + credentials_factory_name_ = "envoy.grpc_credentials.file_based_metadata"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -105,8 +103,7 @@ TEST_P(GrpcFileBasedMetadataClientIntegrationTest, DoubleFileBasedMetadataGrpcAu header_prefix_1_ = "prefix1"; header_value_1_ = "secretvalue"; header_value_2_ = "secret2"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().FileBasedMetadata; + credentials_factory_name_ = "envoy.grpc_credentials.file_based_metadata"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -116,8 +113,7 @@ TEST_P(GrpcFileBasedMetadataClientIntegrationTest, DoubleFileBasedMetadataGrpcAu // Validate that FileBasedMetadata auth plugin works without a config loaded TEST_P(GrpcFileBasedMetadataClientIntegrationTest, EmptyFileBasedMetadataGrpcAuthRequest) { SKIP_IF_GRPC_CLIENT(ClientType::EnvoyGrpc); - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().FileBasedMetadata; + credentials_factory_name_ = "envoy.grpc_credentials.file_based_metadata"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply(); @@ -131,8 +127,7 @@ TEST_P(GrpcFileBasedMetadataClientIntegrationTest, ExtraConfigFileBasedMetadataG header_key_1_ = "header1"; header_prefix_1_ = "prefix1"; header_value_1_ = "secretvalue"; - credentials_factory_name_ = - Extensions::GrpcCredentials::GrpcCredentialsNames::get().FileBasedMetadata; + credentials_factory_name_ = "envoy.grpc_credentials.file_based_metadata"; initialize(); auto request = createRequest(empty_metadata_); request->sendReply();