Skip to content

xds: Keep saved certs and roots after SslContext update #13085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nicolas-EM wants to merge 1 commit into
base: master
Choose a base branch
from
+284 −62
Open

xds: Keep saved certs and roots after SslContext update #13085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions .../main/java/io/grpc/xds/internal/security/certprovider/CertProviderSslContextProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,34 +167,24 @@ public final void updateSpiffeTrustMap(Map<String, List<X509Certificate>> spiffe
updateSslContextWhenReady();
}

// Saved credentials and roots persist across builds, so an update from either provider
// rebuilds using the latest values from both.
private void updateSslContextWhenReady() {
if (isMtls()) {
if (savedKey != null && (savedTrustedRoots != null || savedSpiffeTrustMap != null)) {
updateSslContext();
clearKeysAndCerts();
}
} else if (isRegularTlsAndClientSide()) {
if (savedTrustedRoots != null || savedSpiffeTrustMap != null) {
updateSslContext();
clearKeysAndCerts();
}
} else if (isRegularTlsAndServerSide()) {
if (savedKey != null) {
updateSslContext();
clearKeysAndCerts();
}
}
}

private void clearKeysAndCerts() {
savedKey = null;
if (!isUsingSystemRootCerts) {
savedTrustedRoots = null;
savedSpiffeTrustMap = null;
}
savedCertChain = null;
}

protected final boolean isMtls() {
return certInstance != null && (rootCertInstance != null || isUsingSystemRootCerts);
}
Expand Down
168 changes: 140 additions & 28 deletions .../io/grpc/xds/internal/security/certprovider/CertProviderClientSslContextProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,6 @@ public void testProviderForClient_mtls() throws Exception {
// now generate root cert update
watcherCaptor[0].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand All @@ -166,27 +163,157 @@ public void testProviderForClient_mtls() throws Exception {
CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isSameInstanceAs(testCallback.updatedSslContext);

// just do root cert update: sslContext should still be the same
// just do root cert update: sslContext should be updated
watcherCaptor[0].updateTrustedRoots(
ImmutableList.of(getCertFromResourceName(SERVER_0_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isSameInstanceAs(testCallback.updatedSslContext);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
testCallback = testCallback1;

// now update id cert: sslContext should be updated i.e.different from the previous one
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
}

@Test
public void testProviderForClient_mtls_sharedInstance_certUpdateOnly() throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
new CertificateProvider.DistributorWatcher[1];
TestCertificateProvider.createAndRegisterProviderProvider(
certificateProviderRegistry, watcherCaptor, "testca", 0);
CertProviderClientSslContextProvider provider =
getSslContextProvider(
"gcp_id",
"gcp_id",
CommonBootstrapperTestUtils.getTestBootstrapInfo(),
/* alpnProtocols= */ null,
/* staticCertValidationContext= */ null, false);
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
watcherCaptor[0].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
TestCallback testCallback = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback.updatedSslContext).isNotNull();

// just do id cert update: sslContext should be updated
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
TestCallback testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);

// another id cert update: sslContext should be updated again
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
TestCallback testCallback2 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback2.updatedSslContext)
.isNotSameInstanceAs(testCallback1.updatedSslContext);
}

/**
* Helper method to build CertProviderClientSslContextProvider with separate cert and root
* instances. watcherCaptor[0] is the cert watcher and watcherCaptor[1] is the root watcher.
*/
private CertProviderClientSslContextProvider getSslContextProviderWithSeparateInstances(
CertificateProvider.DistributorWatcher[] watcherCaptor) {
TestCertificateProvider.createAndRegisterProviderProvider(
certificateProviderRegistry, watcherCaptor, "testca", 0);
TestCertificateProvider.createAndRegisterProviderProvider(
certificateProviderRegistry, watcherCaptor, "file_watcher", 1);
return getSslContextProvider(
"gcp_id",
"file_provider",
CommonBootstrapperTestUtils.getTestBootstrapInfo(),
/* alpnProtocols= */ null,
/* staticCertValidationContext= */ null, false);
}

@Test
public void testProviderForClient_mtls_separateInstances_certUpdateOnly() throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
new CertificateProvider.DistributorWatcher[2];
CertProviderClientSslContextProvider provider =
getSslContextProviderWithSeparateInstances(watcherCaptor);
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
watcherCaptor[1].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
TestCallback testCallback = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback.updatedSslContext).isNotNull();

// just do id cert update: sslContext should be updated
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
TestCallback testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);

// another id cert update: sslContext should be updated again
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
TestCallback testCallback2 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback2.updatedSslContext)
.isNotSameInstanceAs(testCallback1.updatedSslContext);
}

@Test
public void testProviderForClient_mtls_separateInstances_rootUpdateOnly() throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
new CertificateProvider.DistributorWatcher[2];
CertProviderClientSslContextProvider provider =
getSslContextProviderWithSeparateInstances(watcherCaptor);
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
watcherCaptor[1].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
TestCallback testCallback = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback.updatedSslContext).isNotNull();

// just do root cert update: sslContext should be updated
watcherCaptor[1].updateTrustedRoots(
ImmutableList.of(getCertFromResourceName(SERVER_0_PEM_FILE)));
TestCallback testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);

// another root cert update: sslContext should be updated again
watcherCaptor[1].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
TestCallback testCallback2 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback2.updatedSslContext)
.isNotSameInstanceAs(testCallback1.updatedSslContext);
}

@Test
public void testProviderForClient_mtls_separateInstances_ignoresOtherInstanceUpdates()
throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
new CertificateProvider.DistributorWatcher[2];
CertProviderClientSslContextProvider provider =
getSslContextProviderWithSeparateInstances(watcherCaptor);
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
watcherCaptor[1].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
TestCallback testCallback = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback.updatedSslContext).isNotNull();

// root cert update from the cert instance: sslContext should still be the same
watcherCaptor[0].updateTrustedRoots(
ImmutableList.of(getCertFromResourceName(SERVER_0_PEM_FILE)));
// id cert update from the root instance: sslContext should still be the same
watcherCaptor[1].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
TestCallback testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isSameInstanceAs(testCallback.updatedSslContext);
}

@Test
public void testProviderForClient_systemRootCerts_mtls() throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
Expand Down Expand Up @@ -214,8 +341,6 @@ public void testProviderForClient_systemRootCerts_mtls() throws Exception {
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();

Expand All @@ -231,8 +356,6 @@ public void testProviderForClient_systemRootCerts_mtls() throws Exception {
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand Down Expand Up @@ -298,9 +421,6 @@ public void testProviderForClient_mtls_newXds() throws Exception {
// now generate root cert update
watcherCaptor[0].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand All @@ -310,22 +430,18 @@ public void testProviderForClient_mtls_newXds() throws Exception {
CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isSameInstanceAs(testCallback.updatedSslContext);

// just do root cert update: sslContext should still be the same
// just do root cert update: sslContext should be updated
watcherCaptor[0].updateTrustedRoots(
ImmutableList.of(getCertFromResourceName(SERVER_0_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isSameInstanceAs(testCallback.updatedSslContext);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
testCallback = testCallback1;

// now update id cert: sslContext should be updated i.e.different from the previous one
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
Expand Down Expand Up @@ -388,7 +504,6 @@ public void testProviderForClient_tls() throws Exception {
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand Down Expand Up @@ -517,9 +632,6 @@ public void testProviderForClient_deprecatedCertProviderField() throws Exception
// Generate root cert update
watcherCaptor[0].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand Down
Loading
Loading