Skip to content

xds: fix identity certificate rotation with separate CA provider #13060

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
Anshika-019 wants to merge 1 commit into
base: master
Choose a base branch
from
+88 −14
Open

xds: fix identity certificate rotation with separate CA provider #13060

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
11 changes: 7 additions & 4 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 @@ -187,11 +187,14 @@ private void updateSslContextWhenReady() {
}

private void clearKeysAndCerts() {
// savedTrustedRoots/savedSpiffeTrustMap are deliberately not cleared here: the root/CA
// provider instance is independent of the identity cert provider instance (they may be two
// separate file_watcher instances polling on different schedules) and may not push another
// update for a long time, or ever again. Clearing them after a rebuild triggered solely by an
// identity-cert update would make updateSslContextWhenReady() get stuck waiting forever for a
// root update that never comes, silently freezing the SslContext on the original identity
// cert. The last known-good trust roots remain valid until the root provider pushes new ones.
savedKey = null;
if (!isUsingSystemRootCerts) {
savedTrustedRoots = null;
savedSpiffeTrustMap = null;
}
savedCertChain = null;
}

Expand Down
77 changes: 71 additions & 6 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 @@ -30,6 +30,7 @@

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.util.concurrent.MoreExecutors;
import io.envoyproxy.envoy.config.core.v3.DataSource;
import io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.CertificateValidationContext;
Expand Down Expand Up @@ -155,7 +156,10 @@ public void testProviderForClient_mtls() throws Exception {
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
// Trust roots are not cleared: the root provider is independent of the identity provider and
// may not push another update for a long time (or ever), so the last known-good value must
// be retained to allow future identity-only rotations to still trigger a rebuild.
assertThat(provider.savedTrustedRoots).isNotNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand All @@ -180,12 +184,70 @@ public void testProviderForClient_mtls() throws Exception {
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
}

/**
* Regression test for https://github.com/grpc/grpc-java/issues/13058: the identity cert and
* the CA trust bundle are served by two *separate* certificate provider instances (as happens
* with two file_watcher instances on independent refresh schedules). Once the root/CA
* instance stops sending updates (e.g. its backing file never changes again), a later
* identity-cert-only rotation on the other, independent instance must still trigger a rebuild,
* reusing the last known-good trust roots rather than getting stuck forever.
*/
@Test
public void testProviderForClient_mtls_separateRootInstance_identityRotationRebuildsContext()
throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
new CertificateProvider.DistributorWatcher[2];
TestCertificateProvider.createAndRegisterProviderProvider(
certificateProviderRegistry, watcherCaptor, "testca_identity", 0);
TestCertificateProvider.createAndRegisterProviderProvider(
certificateProviderRegistry, watcherCaptor, "testca_root", 1);

Bootstrapper.BootstrapInfo bootstrapInfo =
Bootstrapper.BootstrapInfo.builder()
.servers(ImmutableList.<Bootstrapper.ServerInfo>of())
.node(CommonBootstrapperTestUtils.getTestBootstrapInfo().node())
.certProviders(ImmutableMap.of(
"identity_instance",
Bootstrapper.CertificateProviderInfo.create("testca_identity", ImmutableMap.of()),
"ca_instance",
Bootstrapper.CertificateProviderInfo.create("testca_root", ImmutableMap.of())))
.build();

CertProviderClientSslContextProvider provider =
getSslContextProvider(
"identity_instance",
"ca_instance",
bootstrapInfo,
/* alpnProtocols= */ null,
/* staticCertValidationContext= */ null, false);

// Initial mTLS build: the identity provider and the independent root provider each fire once.
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(CLIENT_KEY_FILE),
ImmutableList.of(getCertFromResourceName(CLIENT_PEM_FILE)));
watcherCaptor[1].updateTrustedRoots(ImmutableList.of(getCertFromResourceName(CA_PEM_FILE)));
assertThat(provider.getSslContextAndTrustManager()).isNotNull();

TestCallback initialCallback = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(initialCallback.updatedSslContext).isNotNull();

// The CA/root provider never fires again (its file never changes), but the identity cert
// rotates on its own, independent schedule.
watcherCaptor[0].updateCertificate(
CommonCertProviderTestUtils.getPrivateKey(SERVER_1_KEY_FILE),
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));

TestCallback afterRotationCallback = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(afterRotationCallback.updatedSslContext)
.isNotSameInstanceAs(initialCallback.updatedSslContext);
}

@Test
public void testProviderForClient_systemRootCerts_mtls() throws Exception {
final CertificateProvider.DistributorWatcher[] watcherCaptor =
Expand Down Expand Up @@ -299,7 +361,10 @@ public void testProviderForClient_mtls_newXds() throws Exception {
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
// Trust roots are not cleared: the root provider is independent of the identity provider and
// may not push another update for a long time (or ever), so the last known-good value must
// be retained to allow future identity-only rotations to still trigger a rebuild.
assertThat(provider.savedTrustedRoots).isNotNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand All @@ -324,7 +389,7 @@ public void testProviderForClient_mtls_newXds() throws Exception {
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
Expand Down Expand Up @@ -387,7 +452,7 @@ public void testProviderForClient_tls() throws Exception {
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand Down Expand Up @@ -514,7 +579,7 @@ public void testProviderForClient_deprecatedCertProviderField() throws Exception
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand Down
14 changes: 10 additions & 4 deletions .../io/grpc/xds/internal/security/certprovider/CertProviderServerSslContextProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,10 @@ public void testProviderForServer_mtls() throws Exception {
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
// Trust roots are not cleared: the root provider is independent of the identity provider and
// may not push another update for a long time (or ever), so the last known-good value must
// be retained to allow future identity-only rotations to still trigger a rebuild.
assertThat(provider.savedTrustedRoots).isNotNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand All @@ -167,7 +170,7 @@ public void testProviderForServer_mtls() throws Exception {
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
Expand Down Expand Up @@ -211,7 +214,10 @@ public void testProviderForServer_mtls_newXds() throws Exception {
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
// Trust roots are not cleared: the root provider is independent of the identity provider and
// may not push another update for a long time (or ever), so the last known-good value must
// be retained to allow future identity-only rotations to still trigger a rebuild.
assertThat(provider.savedTrustedRoots).isNotNull();

TestCallback testCallback =
CommonTlsContextTestsUtil.getValueThruCallback(provider);
Expand All @@ -236,7 +242,7 @@ public void testProviderForServer_mtls_newXds() throws Exception {
ImmutableList.of(getCertFromResourceName(SERVER_1_PEM_FILE)));
assertThat(provider.savedKey).isNull();
assertThat(provider.savedCertChain).isNull();
assertThat(provider.savedTrustedRoots).isNull();
assertThat(provider.savedTrustedRoots).isNotNull();
assertThat(provider.getSslContextAndTrustManager()).isNotNull();
testCallback1 = CommonTlsContextTestsUtil.getValueThruCallback(provider);
assertThat(testCallback1.updatedSslContext).isNotSameInstanceAs(testCallback.updatedSslContext);
Expand Down
Loading