forked from intel/envoy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsds_dynamic_integration_test.cc
1124 lines (963 loc) · 45.9 KB
/
sds_dynamic_integration_test.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include <memory>
#include <string>
#include "envoy/config/bootstrap/v3/bootstrap.pb.h"
#include "envoy/config/core/v3/config_source.pb.h"
#include "envoy/extensions/transport_sockets/quic/v3/quic_transport.pb.h"
#include "envoy/extensions/transport_sockets/quic/v3/quic_transport.pb.validate.h"
#include "envoy/extensions/transport_sockets/tls/v3/cert.pb.h"
#include "envoy/service/discovery/v3/discovery.pb.h"
#include "envoy/service/secret/v3/sds.pb.h"
#include "source/common/config/api_version.h"
#include "source/common/event/dispatcher_impl.h"
#include "source/common/http/utility.h"
#include "source/common/network/connection_impl.h"
#include "source/common/network/utility.h"
#ifdef ENVOY_ENABLE_QUIC
#include "source/common/quic/client_connection_factory_impl.h"
#endif
#include "source/extensions/transport_sockets/tls/context_config_impl.h"
#include "source/extensions/transport_sockets/tls/context_manager_impl.h"
#include "source/extensions/transport_sockets/tls/ssl_socket.h"
#include "test/common/grpc/grpc_client_integration.h"
#include "test/config/integration/certs/clientcert_hash.h"
#include "test/extensions/transport_sockets/tls/test_private_key_method_provider.h"
#include "test/integration/http_integration.h"
#include "test/integration/server.h"
#include "test/integration/ssl_utility.h"
#include "test/mocks/secret/mocks.h"
#include "test/test_common/network_utility.h"
#include "test/test_common/registry.h"
#include "test/test_common/resources.h"
#include "test/test_common/test_time_system.h"
#include "test/test_common/utility.h"
#include "absl/strings/match.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include "integration.h"
#include "utility.h"
namespace Envoy {
namespace Ssl {
// Hack to force linking of the service: https://github.com/google/protobuf/issues/4221.
const envoy::service::secret::v3::SdsDummy _sds_dummy;
struct TestParams {
Network::Address::IpVersion ip_version;
Grpc::ClientType sds_grpc_type;
bool test_quic;
};
std::string sdsTestParamsToString(const ::testing::TestParamInfo<TestParams>& p) {
return fmt::format(
"{}_{}_{}", p.param.ip_version == Network::Address::IpVersion::v4 ? "IPv4" : "IPv6",
p.param.sds_grpc_type == Grpc::ClientType::GoogleGrpc ? "GoogleGrpc" : "EnvoyGrpc",
p.param.test_quic ? "UsesQuic" : "UsesTcp");
}
std::vector<TestParams> getSdsTestsParams(bool disable_quic = false) {
std::vector<TestParams> ret;
for (auto ip_version : TestEnvironment::getIpVersionsForTest()) {
for (auto sds_grpc_type : TestEnvironment::getsGrpcVersionsForTest()) {
ret.push_back(TestParams{ip_version, sds_grpc_type, false});
#ifdef ENVOY_ENABLE_QUIC
if (!disable_quic) {
ret.push_back(TestParams{ip_version, sds_grpc_type, true});
}
#else
UNREFERENCED_PARAMETER(disable_quic);
ENVOY_LOG_MISC(warn, "Skipping HTTP/3 as support is compiled out");
#endif
}
}
return ret;
}
// Sds integration base class with following support:
// * functions to create sds upstream, and send sds response
// * functions to create secret protobuf.
class SdsDynamicIntegrationBaseTest : public Grpc::BaseGrpcClientIntegrationParamTest,
public HttpIntegrationTest,
public testing::TestWithParam<TestParams> {
public:
SdsDynamicIntegrationBaseTest()
: HttpIntegrationTest(Http::CodecType::HTTP1, GetParam().ip_version),
test_quic_(GetParam().test_quic) {
// TODO(ggreenway): add tag extraction rules.
// Missing stat tag-extraction rule for stat
// 'sds.client_cert.grpc.sds_cluster.lyft.com.streams_closed_12' and stat_prefix
// 'sds_cluster.lyft.com'.
skip_tag_extraction_rule_check_ = true;
}
SdsDynamicIntegrationBaseTest(Http::CodecType downstream_protocol,
Network::Address::IpVersion version, const std::string& config)
: HttpIntegrationTest(downstream_protocol, version, config),
test_quic_(GetParam().test_quic) {
// TODO(ggreenway): add tag extraction rules.
// Missing stat tag-extraction rule for stat
// 'sds.client_cert.grpc.sds_cluster.lyft.com.streams_closed_12' and stat_prefix
// 'sds_cluster.lyft.com'.
skip_tag_extraction_rule_check_ = true;
}
Network::Address::IpVersion ipVersion() const override { return GetParam().ip_version; }
Grpc::ClientType clientType() const override { return GetParam().sds_grpc_type; }
protected:
void createSdsStream(FakeUpstream&) {
createXdsConnection();
AssertionResult result2 = xds_connection_->waitForNewStream(*dispatcher_, xds_stream_);
RELEASE_ASSERT(result2, result2.message());
xds_stream_->startGrpcStream();
}
void setUpSdsConfig(envoy::extensions::transport_sockets::tls::v3::SdsSecretConfig* secret_config,
const std::string& secret_name) {
secret_config->set_name(secret_name);
auto* config_source = secret_config->mutable_sds_config();
config_source->set_resource_api_version(envoy::config::core::v3::ApiVersion::V3);
auto* api_config_source = config_source->mutable_api_config_source();
api_config_source->set_api_type(envoy::config::core::v3::ApiConfigSource::GRPC);
api_config_source->set_transport_api_version(envoy::config::core::v3::V3);
auto* grpc_service = api_config_source->add_grpc_services();
setGrpcService(*grpc_service, "sds_cluster.lyft.com", fake_upstreams_.back()->localAddress());
}
envoy::extensions::transport_sockets::tls::v3::Secret getServerSecretRsa() {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
secret.set_name(server_cert_rsa_);
auto* tls_certificate = secret.mutable_tls_certificate();
tls_certificate->mutable_certificate_chain()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/servercert.pem"));
tls_certificate->mutable_private_key()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/serverkey.pem"));
return secret;
}
envoy::extensions::transport_sockets::tls::v3::Secret getCvcSecret() {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
secret.set_name(validation_secret_);
auto* validation_context = secret.mutable_validation_context();
validation_context->mutable_trusted_ca()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/cacert.pem"));
validation_context->add_verify_certificate_hash(TEST_CLIENT_CERT_HASH);
return secret;
}
envoy::extensions::transport_sockets::tls::v3::Secret getCvcSecretWithOnlyTrustedCa() {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
secret.set_name(validation_secret_);
auto* validation_context = secret.mutable_validation_context();
validation_context->mutable_trusted_ca()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/cacert.pem"));
return secret;
}
envoy::extensions::transport_sockets::tls::v3::Secret getClientSecret() {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
secret.set_name(client_cert_);
auto* tls_certificate = secret.mutable_tls_certificate();
tls_certificate->mutable_certificate_chain()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/clientcert.pem"));
tls_certificate->mutable_private_key()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/clientkey.pem"));
return secret;
}
envoy::extensions::transport_sockets::tls::v3::Secret
getWrongSecret(const std::string& secret_name) {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
secret.set_name(secret_name);
secret.mutable_tls_certificate();
return secret;
}
void sendSdsResponse(const envoy::extensions::transport_sockets::tls::v3::Secret& secret) {
envoy::service::discovery::v3::DiscoveryResponse discovery_response;
discovery_response.set_version_info("1");
discovery_response.set_type_url(Config::TypeUrl::get().Secret);
discovery_response.add_resources()->PackFrom(secret);
xds_stream_->sendGrpcMessage(discovery_response);
}
void PrintServerCounters() {
std::cerr << "all counters" << std::endl;
for (const auto& c : test_server_->counters()) {
std::cerr << "counter: " << c->name() << ", value: " << c->value() << std::endl;
}
}
const std::string server_cert_rsa_{"server_cert_rsa"};
const std::string server_cert_ecdsa_{"server_cert_ecdsa"};
const std::string validation_secret_{"validation_secret"};
const std::string client_cert_{"client_cert"};
bool v3_resource_api_{false};
bool test_quic_;
};
// Downstream SDS integration test: static Listener with ssl cert from SDS
class SdsDynamicDownstreamIntegrationTest : public SdsDynamicIntegrationBaseTest {
public:
SdsDynamicDownstreamIntegrationTest()
: SdsDynamicIntegrationBaseTest(
(GetParam().test_quic ? Http::CodecType::HTTP3 : Http::CodecType::HTTP1),
GetParam().ip_version, ConfigHelper::httpProxyConfig(GetParam().test_quic)) {}
void initialize() override {
ASSERT(test_quic_ ? downstream_protocol_ == Http::CodecType::HTTP3
: downstream_protocol_ == Http::CodecType::HTTP1);
config_helper_.addConfigModifier([this](envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
config_helper_.configDownstreamTransportSocketWithTls(
bootstrap,
[this](
envoy::extensions::transport_sockets::tls::v3::CommonTlsContext& common_tls_context) {
configToUseSds(common_tls_context);
});
// The SNI of the certificates loaded in this test.
default_request_headers_.setHost("www.lyft.com");
});
config_helper_.addConfigModifier([](envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
// Add a static sds cluster
auto* sds_cluster = bootstrap.mutable_static_resources()->add_clusters();
sds_cluster->MergeFrom(bootstrap.static_resources().clusters()[0]);
sds_cluster->set_name("sds_cluster.lyft.com");
ConfigHelper::setHttp2(*sds_cluster);
});
HttpIntegrationTest::initialize();
client_ssl_ctx_ = createClientSslTransportSocketFactory({}, context_manager_, *api_);
}
void configToUseSds(
envoy::extensions::transport_sockets::tls::v3::CommonTlsContext& common_tls_context) {
common_tls_context.add_alpn_protocols(test_quic_ ? Http::Utility::AlpnNames::get().Http3
: Http::Utility::AlpnNames::get().Http11);
auto* validation_context = common_tls_context.mutable_validation_context();
validation_context->mutable_trusted_ca()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/cacert.pem"));
validation_context->add_verify_certificate_hash(TEST_CLIENT_CERT_HASH);
// Modify the listener ssl cert to use SDS from sds_cluster
auto* secret_config_rsa = common_tls_context.add_tls_certificate_sds_secret_configs();
setUpSdsConfig(secret_config_rsa, server_cert_rsa_);
// Add an additional SDS config for an EC cert (the base test has SDS config for an RSA cert).
// This is done via the filesystem instead of gRPC to simplify the test setup.
if (dual_cert_) {
auto* secret_config_ecdsa = common_tls_context.add_tls_certificate_sds_secret_configs();
secret_config_ecdsa->set_name(server_cert_ecdsa_);
auto* config_source = secret_config_ecdsa->mutable_sds_config();
const std::string sds_template =
R"EOF(
---
version_info: "0"
resources:
- "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret
name: "{}"
tls_certificate:
certificate_chain:
filename: "{}"
private_key:
filename: "{}"
)EOF";
const std::string sds_content = fmt::format(
sds_template, server_cert_ecdsa_,
TestEnvironment::runfilesPath("test/config/integration/certs/server_ecdsacert.pem"),
TestEnvironment::runfilesPath("test/config/integration/certs/server_ecdsakey.pem"));
auto sds_path =
TestEnvironment::writeStringToFileForTest("server_cert_ecdsa.sds.yaml", sds_content);
config_source->mutable_path_config_source()->set_path(sds_path);
config_source->set_resource_api_version(envoy::config::core::v3::ApiVersion::V3);
}
}
void createUpstreams() override {
create_xds_upstream_ = true;
HttpIntegrationTest::createUpstreams();
}
void waitForSdsUpdateStats(size_t times) {
test_server_->waitForCounterGe(
listenerStatPrefix(test_quic_
? "quic_server_transport_socket_factory.context_config_update_by_sds"
: "server_ssl_socket_factory.ssl_context_update_by_sds"),
times, std::chrono::milliseconds(5000));
}
void TearDown() override {
cleanUpXdsConnection();
client_ssl_ctx_.reset();
}
Network::ClientConnectionPtr makeSslClientConnection() {
int port = lookupPort("http");
if (downstream_protocol_ <= Http::CodecType::HTTP2) {
Network::Address::InstanceConstSharedPtr address = getSslAddress(version_, port);
return dispatcher_->createClientConnection(
address, Network::Address::InstanceConstSharedPtr(),
client_ssl_ctx_->createTransportSocket(nullptr, nullptr), nullptr, nullptr);
}
return makeClientConnectionWithOptions(port, nullptr);
}
protected:
Network::UpstreamTransportSocketFactoryPtr client_ssl_ctx_;
bool dual_cert_{false};
};
INSTANTIATE_TEST_SUITE_P(IpVersionsClientType, SdsDynamicDownstreamIntegrationTest,
testing::ValuesIn(getSdsTestsParams()), sdsTestParamsToString);
class SdsDynamicKeyRotationIntegrationTest : public SdsDynamicDownstreamIntegrationTest {
protected:
envoy::extensions::transport_sockets::tls::v3::Secret getCurrentServerSecret() {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
secret.set_name(server_cert_rsa_);
auto* tls_certificate = secret.mutable_tls_certificate();
tls_certificate->mutable_certificate_chain()->set_filename(
TestEnvironment::temporaryPath("root/current/servercert.pem"));
tls_certificate->mutable_private_key()->set_filename(
TestEnvironment::temporaryPath("root/current/serverkey.pem"));
auto* watched_directory = tls_certificate->mutable_watched_directory();
watched_directory->set_path(TestEnvironment::temporaryPath("root"));
return secret;
}
};
// We don't care about multiple gRPC types here, Envoy gRPC is fine, the
// interest is on the filesystem.
INSTANTIATE_TEST_SUITE_P(IpVersionsClientType, SdsDynamicKeyRotationIntegrationTest,
testing::ValuesIn(getSdsTestsParams()), sdsTestParamsToString);
// Validate that a basic key-cert rotation works via symlink rename.
TEST_P(SdsDynamicKeyRotationIntegrationTest, BasicRotation) {
v3_resource_api_ = true;
TestEnvironment::exec(
{TestEnvironment::runfilesPath("test/integration/sds_dynamic_key_rotation_setup.sh")});
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getCurrentServerSecret());
};
initialize();
// Initial update from filesystem.
waitForSdsUpdateStats(1);
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
// First request with server{cert,key}.pem.
testRouterHeaderOnlyRequestAndResponse(&creator);
cleanupUpstreamAndDownstream();
// Rotate.
TestEnvironment::renameFile(TestEnvironment::temporaryPath("root/new"),
TestEnvironment::temporaryPath("root/current"));
waitForSdsUpdateStats(2);
// The rotation is not a SDS attempt, so no change to these stats.
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.server_cert_rsa.update_rejected")->value());
// First request with server_ecdsa{cert,key}.pem.
testRouterHeaderOnlyRequestAndResponse(&creator);
}
// Validate that rotating to a directory with missing certs is handled.
TEST_P(SdsDynamicKeyRotationIntegrationTest, EmptyRotation) {
v3_resource_api_ = true;
TestEnvironment::exec(
{TestEnvironment::runfilesPath("test/integration/sds_dynamic_key_rotation_setup.sh")});
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getCurrentServerSecret());
};
initialize();
// Initial update from filesystem.
waitForSdsUpdateStats(1);
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
// First request with server{cert,key}.pem.
testRouterHeaderOnlyRequestAndResponse(&creator);
cleanupUpstreamAndDownstream();
// Rotate to an empty directory, this should fail.
TestEnvironment::renameFile(TestEnvironment::temporaryPath("root/empty"),
TestEnvironment::temporaryPath("root/current"));
test_server_->waitForCounterEq("sds.server_cert_rsa.key_rotation_failed", 1);
waitForSdsUpdateStats(1);
// The rotation is not a SDS attempt, so no change to these stats.
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.server_cert_rsa.update_rejected")->value());
// Requests continue to work with key/cert pair.
testRouterHeaderOnlyRequestAndResponse(&creator);
}
// A test that SDS server send a good server secret for a static listener.
// The first ssl request should be OK.
TEST_P(SdsDynamicDownstreamIntegrationTest, BasicSuccess) {
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getServerSecretRsa());
};
initialize();
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.server_cert_rsa.update_rejected")->value());
}
TEST_P(SdsDynamicDownstreamIntegrationTest, DualCert) {
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getServerSecretRsa());
};
dual_cert_ = true;
initialize();
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
client_ssl_ctx_ = createClientSslTransportSocketFactory(
ClientSslTransportOptions()
.setTlsVersion(envoy::extensions::transport_sockets::tls::v3::TlsParameters::TLSv1_2)
.setCipherSuites({"ECDHE-ECDSA-AES128-GCM-SHA256"}),
context_manager_, *api_);
testRouterHeaderOnlyRequestAndResponse(&creator);
cleanupUpstreamAndDownstream();
client_ssl_ctx_ = createClientSslTransportSocketFactory(
ClientSslTransportOptions()
.setTlsVersion(envoy::extensions::transport_sockets::tls::v3::TlsParameters::TLSv1_2)
.setCipherSuites({"ECDHE-RSA-AES128-GCM-SHA256"}),
context_manager_, *api_);
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.server_cert_rsa.update_rejected")->value());
EXPECT_EQ(1, test_server_->counter("sds.server_cert_ecdsa.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.server_cert_ecdsa.update_rejected")->value());
// QUIC ignores the `setTlsVersion` set above and always uses TLS 1.3, and TLS 1.3 ignores the
// `setCipherSuites`, so in the QUIC config, this test only uses one of the certs.
if (!test_quic_) {
EXPECT_EQ(1,
test_server_->counter(listenerStatPrefix("ssl.ciphers.ECDHE-RSA-AES128-GCM-SHA256"))
->value());
EXPECT_EQ(1,
test_server_->counter(listenerStatPrefix("ssl.ciphers.ECDHE-ECDSA-AES128-GCM-SHA256"))
->value());
}
}
// A test that SDS server send a bad secret for a static listener,
// The first ssl request should fail at connecting.
// then SDS send a good server secret, the second request should be OK.
TEST_P(SdsDynamicDownstreamIntegrationTest, WrongSecretFirst) {
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getWrongSecret(server_cert_rsa_));
};
initialize();
codec_client_ = makeRawHttpConnection(makeSslClientConnection(), absl::nullopt);
// the connection state is not connected.
EXPECT_FALSE(codec_client_->connected());
codec_client_->connection()->close(Network::ConnectionCloseType::NoFlush);
// Failure
EXPECT_EQ(0, test_server_->counter("sds.server_cert_rsa.update_success")->value());
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_rejected")->value());
sendSdsResponse(getServerSecretRsa());
// Wait for sds update counter.
waitForSdsUpdateStats(1);
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_success")->value());
EXPECT_EQ(1, test_server_->counter("sds.server_cert_rsa.update_rejected")->value());
}
class SdsDynamicDownstreamCertValidationContextTest : public SdsDynamicDownstreamIntegrationTest {
public:
SdsDynamicDownstreamCertValidationContextTest() = default;
void initialize() override {
config_helper_.addConfigModifier([this](envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
config_helper_.configDownstreamTransportSocketWithTls(
bootstrap,
[this](
envoy::extensions::transport_sockets::tls::v3::CommonTlsContext& common_tls_context) {
common_tls_context.add_alpn_protocols(test_quic_
? Http::Utility::AlpnNames::get().Http3
: Http::Utility::AlpnNames::get().Http11);
configureInlinedCerts(&common_tls_context);
});
// Add a static sds cluster
auto* sds_cluster = bootstrap.mutable_static_resources()->add_clusters();
sds_cluster->MergeFrom(bootstrap.static_resources().clusters()[0]);
sds_cluster->set_name("sds_cluster.lyft.com");
ConfigHelper::setHttp2(*sds_cluster);
envoy::extensions::transport_sockets::tls::v3::UpstreamTlsContext upstream_tls_context;
if (share_validation_secret_) {
// Configure static cluster with SDS config referencing "validation_secret",
// which is going to be processed before LDS resources.
ASSERT(use_lds_);
setUpSdsValidationContext(upstream_tls_context.mutable_common_tls_context());
}
// Enable SSL/TLS with a client certificate in the first cluster.
auto* upstream_tls_certificate =
upstream_tls_context.mutable_common_tls_context()->add_tls_certificates();
upstream_tls_certificate->mutable_certificate_chain()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/clientcert.pem"));
upstream_tls_certificate->mutable_private_key()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/clientkey.pem"));
auto* upstream_transport_socket =
bootstrap.mutable_static_resources()->mutable_clusters(0)->mutable_transport_socket();
upstream_transport_socket->set_name("envoy.transport_sockets.tls");
upstream_transport_socket->mutable_typed_config()->PackFrom(upstream_tls_context);
});
HttpIntegrationTest::initialize();
registerTestServerPorts({"http"});
client_ssl_ctx_ = createClientSslTransportSocketFactory({}, context_manager_, *api_);
}
void configureInlinedCerts(
envoy::extensions::transport_sockets::tls::v3::CommonTlsContext* common_tls_context) {
auto* tls_certificate = common_tls_context->add_tls_certificates();
tls_certificate->mutable_certificate_chain()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/servercert.pem"));
tls_certificate->mutable_private_key()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/serverkey.pem"));
setUpSdsValidationContext(common_tls_context);
}
void setUpSdsValidationContext(
envoy::extensions::transport_sockets::tls::v3::CommonTlsContext* common_tls_context) {
if (use_combined_validation_context_) {
// Modify the listener context validation type to use combined certificate validation
// context.
auto* combined_config = common_tls_context->mutable_combined_validation_context();
auto* default_validation_context = combined_config->mutable_default_validation_context();
default_validation_context->add_verify_certificate_hash(TEST_CLIENT_CERT_HASH);
auto* secret_config = combined_config->mutable_validation_context_sds_secret_config();
setUpSdsConfig(secret_config, validation_secret_);
} else {
// Modify the listener context validation type to use dynamic certificate validation
// context.
auto* secret_config = common_tls_context->mutable_validation_context_sds_secret_config();
setUpSdsConfig(secret_config, validation_secret_);
}
}
void createUpstreams() override {
// Fake upstream with SSL/TLS for the first cluster.
addFakeUpstream(createUpstreamSslContext(), upstreamProtocol(), /*autonomous_upstream=*/false);
create_xds_upstream_ = true;
}
Network::DownstreamTransportSocketFactoryPtr createUpstreamSslContext() {
envoy::extensions::transport_sockets::tls::v3::DownstreamTlsContext tls_context;
auto* common_tls_context = tls_context.mutable_common_tls_context();
auto* tls_certificate = common_tls_context->add_tls_certificates();
tls_certificate->mutable_certificate_chain()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/clientcert.pem"));
tls_certificate->mutable_private_key()->set_filename(
TestEnvironment::runfilesPath("test/config/integration/certs/clientkey.pem"));
auto cfg = std::make_unique<Extensions::TransportSockets::Tls::ServerContextConfigImpl>(
tls_context, factory_context_);
static Stats::Scope* upstream_stats_store = new Stats::TestIsolatedStoreImpl();
return std::make_unique<Extensions::TransportSockets::Tls::ServerSslSocketFactory>(
std::move(cfg), context_manager_, *upstream_stats_store, std::vector<std::string>{});
}
void TearDown() override {
cleanUpXdsConnection();
client_ssl_ctx_.reset();
cleanupUpstreamAndDownstream();
codec_client_.reset();
}
void enableCombinedValidationContext(bool enable) { use_combined_validation_context_ = enable; }
void shareValidationSecret(bool share) { share_validation_secret_ = share; }
private:
bool use_combined_validation_context_{false};
bool share_validation_secret_{false};
};
INSTANTIATE_TEST_SUITE_P(IpVersionsClientType, SdsDynamicDownstreamCertValidationContextTest,
testing::ValuesIn(getSdsTestsParams()), sdsTestParamsToString);
// A test that SDS server send a good certificate validation context for a static listener.
// The first ssl request should be OK.
TEST_P(SdsDynamicDownstreamCertValidationContextTest, BasicSuccess) {
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getCvcSecret());
};
initialize();
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.validation_secret.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.validation_secret.update_rejected")->value());
}
// A test that SDS server sends a certificate validation context for a static listener.
// Listener combines default certificate validation context and the dynamic one.
// The first ssl request should be OK.
TEST_P(SdsDynamicDownstreamCertValidationContextTest, CombinedCertValidationContextSuccess) {
enableCombinedValidationContext(true);
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getCvcSecretWithOnlyTrustedCa());
};
initialize();
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.validation_secret.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.validation_secret.update_rejected")->value());
}
// A test that verifies that both: static cluster and LDS listener are updated when using
// the same verification secret (standalone validation context) from the SDS server.
TEST_P(SdsDynamicDownstreamCertValidationContextTest, BasicWithSharedSecret) {
shareValidationSecret(true);
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getCvcSecret());
};
initialize();
// Wait for "ssl_context_updated_by_sds" counters to indicate that both resources
// depending on the verification_secret were updated.
test_server_->waitForCounterGe(
"cluster.cluster_0.client_ssl_socket_factory.ssl_context_update_by_sds", 1);
waitForSdsUpdateStats(1);
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.validation_secret.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.validation_secret.update_rejected")->value());
}
// A test that verifies that both: static cluster and LDS listener are updated when using
// the same verification secret (combined validation context) from the SDS server.
TEST_P(SdsDynamicDownstreamCertValidationContextTest, CombinedValidationContextWithSharedSecret) {
enableCombinedValidationContext(true);
shareValidationSecret(true);
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getCvcSecretWithOnlyTrustedCa());
};
initialize();
// Wait for "ssl_context_updated_by_sds" counters to indicate that both resources
// depending on the verification_secret were updated.
test_server_->waitForCounterGe(
"cluster.cluster_0.client_ssl_socket_factory.ssl_context_update_by_sds", 1);
waitForSdsUpdateStats(1);
ConnectionCreationFunction creator = [&]() -> Network::ClientConnectionPtr {
return makeSslClientConnection();
};
testRouterHeaderOnlyRequestAndResponse(&creator);
// Success
EXPECT_EQ(1, test_server_->counter("sds.validation_secret.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.validation_secret.update_rejected")->value());
}
// Upstream SDS integration test: a static cluster has ssl cert from SDS.
class SdsDynamicUpstreamIntegrationTest : public SdsDynamicIntegrationBaseTest {
public:
void initialize() override {
// The SNI of the certificates loaded in this test.
default_request_headers_.setHost("www.lyft.com");
if (test_quic_) {
upstream_tls_ = true;
setUpstreamProtocol(Http::CodecType::HTTP3);
}
config_helper_.addConfigModifier([this](envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
// add sds cluster first.
auto* sds_cluster = bootstrap.mutable_static_resources()->add_clusters();
sds_cluster->MergeFrom(bootstrap.static_resources().clusters()[0]);
sds_cluster->set_name("sds_cluster.lyft.com");
ConfigHelper::setHttp2(*sds_cluster);
// Unwind Quic for sds cluster.
if (test_quic_) {
sds_cluster->clear_transport_socket();
}
// change the first cluster with ssl and sds.
auto* transport_socket =
bootstrap.mutable_static_resources()->mutable_clusters(0)->mutable_transport_socket();
envoy::extensions::transport_sockets::tls::v3::UpstreamTlsContext tls_context;
tls_context.set_sni("lyft.com");
auto* secret_config =
tls_context.mutable_common_tls_context()->add_tls_certificate_sds_secret_configs();
setUpSdsConfig(secret_config, "client_cert");
if (test_quic_) {
envoy::extensions::transport_sockets::quic::v3::QuicUpstreamTransport quic_context;
quic_context.mutable_upstream_tls_context()->CopyFrom(tls_context);
transport_socket->set_name("envoy.transport_sockets.quic");
transport_socket->mutable_typed_config()->PackFrom(quic_context);
} else {
transport_socket->set_name("envoy.transport_sockets.tls");
transport_socket->mutable_typed_config()->PackFrom(tls_context);
}
});
HttpIntegrationTest::initialize();
registerTestServerPorts({"http"});
}
void TearDown() override {
cleanUpXdsConnection();
cleanupUpstreamAndDownstream();
codec_client_.reset();
test_server_.reset();
fake_upstreams_.clear();
}
void createUpstreams() override {
// This is for backend with ssl
addFakeUpstream(createUpstreamSslContext(context_manager_, *api_, test_quic_),
upstreamProtocol(), /*autonomous_upstream=*/false);
create_xds_upstream_ = true;
}
};
INSTANTIATE_TEST_SUITE_P(IpVersions, SdsDynamicUpstreamIntegrationTest,
testing::ValuesIn(getSdsTestsParams()), sdsTestParamsToString);
// To test a static cluster with sds. SDS send a good client secret first.
// The first request should work.
TEST_P(SdsDynamicUpstreamIntegrationTest, BasicSuccess) {
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getClientSecret());
};
initialize();
// There is a race condition here; there are two static clusters:
// backend cluster_0 with sds and sds_cluster. cluster_0 is created first, its init_manager
// is called so it issues a sds call, but fail since sds_cluster is not added yet.
// so cluster_0 is initialized with an empty secret. initialize() will not wait and will return.
// the testing request will be called, even though in the pre_worker_function, a good sds is
// send, the cluster will be updated with good secret, the testing request may fail if it is
// before context is updated. Hence, need to wait for context_update counter.
test_server_->waitForCounterGe(
"cluster.cluster_0.client_ssl_socket_factory.ssl_context_update_by_sds", 1);
testRouterHeaderOnlyRequestAndResponse();
// Success
EXPECT_EQ(1, test_server_->counter("sds.client_cert.update_success")->value());
EXPECT_EQ(0, test_server_->counter("sds.client_cert.update_rejected")->value());
}
// To test a static cluster with sds. SDS send a bad client secret first.
// The first request should fail with 503, then SDS sends a good client secret,
// the second request should work.
TEST_P(SdsDynamicUpstreamIntegrationTest, WrongSecretFirst) {
on_server_init_function_ = [this]() {
createSdsStream(*(fake_upstreams_[1]));
sendSdsResponse(getWrongSecret(client_cert_));
};
initialize();
// Make a simple request, should get 503
BufferingStreamDecoderPtr response = IntegrationUtil::makeSingleRequest(
lookupPort("http"), "GET", "/test/long/url", "", downstream_protocol_, version_);
ASSERT_TRUE(response->complete());
EXPECT_EQ("503", response->headers().getStatusValue());
// Wait for the raw TCP connection with bad credentials and close it.
if (upstreamProtocol() != Http::CodecType::HTTP3) {
FakeRawConnectionPtr fake_upstream_connection;
ASSERT_TRUE(fake_upstreams_[0]->waitForRawConnection(fake_upstream_connection));
ASSERT_TRUE(fake_upstream_connection->waitForDisconnect());
}
test_server_->waitForCounterGe("sds.client_cert.update_rejected", 1);
EXPECT_EQ(0, test_server_->counter("sds.client_cert.update_success")->value());
sendSdsResponse(getClientSecret());
test_server_->waitForCounterGe(
"cluster.cluster_0.client_ssl_socket_factory.ssl_context_update_by_sds", 1);
test_server_->waitForCounterGe("sds.client_cert.update_success", 1);
EXPECT_EQ(1, test_server_->counter("sds.client_cert.update_rejected")->value());
// Verify the update succeeded.
testRouterHeaderOnlyRequestAndResponse();
}
// Test CDS with SDS. A cluster provided by CDS raises new SDS request for upstream cert.
// TODO(15034) Enable SDS support in QUIC upstream.
class SdsCdsIntegrationTest : public SdsDynamicIntegrationBaseTest {
public:
void initialize() override {
config_helper_.addConfigModifier([this](envoy::config::bootstrap::v3::Bootstrap& bootstrap) {
// Create the dynamic cluster. This cluster will be using sds.
dynamic_cluster_ = bootstrap.mutable_static_resources()->clusters(0);
dynamic_cluster_.set_name("dynamic");
dynamic_cluster_.mutable_connect_timeout()->MergeFrom(
ProtobufUtil::TimeUtil::MillisecondsToDuration(500000));
auto* transport_socket = dynamic_cluster_.mutable_transport_socket();
envoy::extensions::transport_sockets::tls::v3::UpstreamTlsContext tls_context;
auto* secret_config =
tls_context.mutable_common_tls_context()->add_tls_certificate_sds_secret_configs();
setUpSdsConfig(secret_config, "client_cert");
transport_socket->set_name("envoy.transport_sockets.tls");
transport_socket->mutable_typed_config()->PackFrom(tls_context);
// Add cds cluster first.
auto* cds_cluster = bootstrap.mutable_static_resources()->add_clusters();
cds_cluster->MergeFrom(bootstrap.static_resources().clusters()[0]);
cds_cluster->set_name("cds_cluster");
ConfigHelper::setHttp2(*cds_cluster);
// Then add sds cluster.
auto* sds_cluster = bootstrap.mutable_static_resources()->add_clusters();
sds_cluster->MergeFrom(bootstrap.static_resources().clusters()[0]);
sds_cluster->set_name("sds_cluster.lyft.com");
ConfigHelper::setHttp2(*sds_cluster);
const std::string cds_yaml = R"EOF(
resource_api_version: V3
api_config_source:
api_type: GRPC
transport_api_version: V3
grpc_services:
envoy_grpc:
cluster_name: cds_cluster
set_node_on_first_message_only: true
)EOF";
auto* cds = bootstrap.mutable_dynamic_resources()->mutable_cds_config();
TestUtility::loadFromYaml(cds_yaml, *cds);
});
HttpIntegrationTest::initialize();
}
void TearDown() override {
{
AssertionResult result = sds_connection_->close();
RELEASE_ASSERT(result, result.message());
result = sds_connection_->waitForDisconnect();
RELEASE_ASSERT(result, result.message());
sds_connection_.reset();
}
cleanUpXdsConnection();
cleanupUpstreamAndDownstream();
codec_client_.reset();
test_server_.reset();
fake_upstreams_.clear();
}
void createUpstreams() override {
// Static cluster.
addFakeUpstream(Http::CodecType::HTTP1);
// Cds Cluster.
addFakeUpstream(Http::CodecType::HTTP2);
// Sds Cluster.
addFakeUpstream(Http::CodecType::HTTP2);
}
void sendCdsResponse() {
EXPECT_TRUE(compareDiscoveryRequest(Config::TypeUrl::get().Cluster, "", {}, {}, {}, true));
sendDiscoveryResponse<envoy::config::cluster::v3::Cluster>(
Config::TypeUrl::get().Cluster, {dynamic_cluster_}, {dynamic_cluster_}, {}, "55");
}
void sendSdsResponse2(const envoy::extensions::transport_sockets::tls::v3::Secret& secret,
FakeStream& sds_stream) {
envoy::service::discovery::v3::DiscoveryResponse discovery_response;
discovery_response.set_version_info("1");
discovery_response.set_type_url(Config::TypeUrl::get().Secret);
discovery_response.add_resources()->PackFrom(secret);
sds_stream.sendGrpcMessage(discovery_response);
}
envoy::config::cluster::v3::Cluster dynamic_cluster_;
FakeHttpConnectionPtr sds_connection_;
FakeStreamPtr sds_stream_;
};
INSTANTIATE_TEST_SUITE_P(IpVersions, SdsCdsIntegrationTest, testing::ValuesIn(getSdsTestsParams()),
sdsTestParamsToString);
TEST_P(SdsCdsIntegrationTest, BasicSuccess) {
on_server_init_function_ = [this]() {
{
// CDS.
AssertionResult result =
fake_upstreams_[1]->waitForHttpConnection(*dispatcher_, xds_connection_);
RELEASE_ASSERT(result, result.message());
result = xds_connection_->waitForNewStream(*dispatcher_, xds_stream_);
RELEASE_ASSERT(result, result.message());
xds_stream_->startGrpcStream();
sendCdsResponse();
}
{
// SDS.
AssertionResult result =
fake_upstreams_[2]->waitForHttpConnection(*dispatcher_, sds_connection_);
RELEASE_ASSERT(result, result.message());
result = sds_connection_->waitForNewStream(*dispatcher_, sds_stream_);
RELEASE_ASSERT(result, result.message());
sds_stream_->startGrpcStream();
sendSdsResponse2(getClientSecret(), *sds_stream_);
}
};
initialize();
test_server_->waitForCounterGe(
"cluster.dynamic.client_ssl_socket_factory.ssl_context_update_by_sds", 1);
// The 4 clusters are CDS,SDS,static and dynamic cluster.
test_server_->waitForGaugeGe("cluster_manager.active_clusters", 4);
sendDiscoveryResponse<envoy::config::cluster::v3::Cluster>(Config::TypeUrl::get().Cluster, {}, {},
{}, "42");
// Successfully removed the dynamic cluster.
test_server_->waitForGaugeEq("cluster_manager.active_clusters", 3);
}
class SdsDynamicDownstreamPrivateKeyIntegrationTest : public SdsDynamicDownstreamIntegrationTest {
public:
envoy::extensions::transport_sockets::tls::v3::Secret getCurrentServerPrivateKeyProviderSecret() {
envoy::extensions::transport_sockets::tls::v3::Secret secret;
const std::string yaml =
R"EOF(
name: "abc.com"
tls_certificate:
certificate_chain:
filename: "{{ test_tmpdir }}/root/current/servercert.pem"
private_key_provider:
provider_name: test
typed_config:
"@type": "type.googleapis.com/google.protobuf.Struct"
value:
private_key_file: "{{ test_tmpdir }}/root/current/serverkey.pem"