From be617b1ab64db42e5eb2c9e8be75506df4591320 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Knut=20Olav=20L=C3=B8ite?= Date: Tue, 10 Nov 2026 15:46:50 +0100 Subject: [PATCH] fix(spanner): support plaintext connections for Spanner Omni in pool Spanner Omni instances are often deployed in local or edge environments (such as local Docker containers for development and testing) where TLS certificates are not configured. In these scenarios, clients authenticate using a username and password over an unencrypted connection. Previously, when a connection requested plaintext communication, the connection pool unconditionally stripped all credentials and failed to properly configure plaintext transport on the underlying client. This made it impossible to authenticate with local Spanner Omni instances because the credentials were discarded and token refreshes attempted to use TLS against an unencrypted endpoint. This change ensures that plaintext Spanner Omni connections retain their credentials and configure plaintext transport correctly. Connections to Cloud Spanner and the emulator continue to have their credentials stripped to prevent credential leakage over unencrypted channels. --- .../cloud/spanner/connection/SpannerPool.java | 19 ++--- .../spanner/connection/SpannerPoolTest.java | 71 +++++++++++++++++++ 2 files changed, 81 insertions(+), 9 deletions(-) diff --git a/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java b/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java index 601713b9890a..beb6976fa431 100644 --- a/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java +++ b/java-spanner/google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java @@ -16,7 +16,6 @@ package com.google.cloud.spanner.connection; -import com.google.cloud.NoCredentials; import com.google.cloud.grpc.GcpManagedChannelOptions.GcpChannelPoolOptions; import com.google.cloud.spanner.DecodeMode; import com.google.cloud.spanner.ErrorCode; @@ -25,11 +24,11 @@ import com.google.cloud.spanner.SpannerException; import com.google.cloud.spanner.SpannerExceptionFactory; import com.google.cloud.spanner.SpannerOptions; +import com.google.cloud.spanner.omni.SpannerOmniCredentials; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.MoreObjects; import com.google.common.base.Preconditions; import com.google.common.base.Ticker; -import io.grpc.ManagedChannelBuilder; import io.opentelemetry.api.OpenTelemetry; import java.io.IOException; import java.time.Duration; @@ -535,11 +534,16 @@ Spanner createSpanner(SpannerPoolKey key, ConnectionOptions options) { if (options.isEndToEndTracingEnabled()) { builder.setEnableEndToEndTracing(true); } + if (key.instanceType != null) { + builder.setType(key.instanceType); + } if (key.usePlainText) { - // Credentials may not be sent over a plain text channel. - builder.setCredentials(NoCredentials.getInstance()); - // Set a custom channel configurator to allow http instead of https. - builder.setChannelConfigurator(ManagedChannelBuilder::usePlaintext); + // Credentials may not be sent over a plain text channel, unless it is Spanner Omni + // credentials. + builder.usePlainText(); + if (options.getCredentials() instanceof SpannerOmniCredentials) { + builder.setCredentials(options.getCredentials()); + } } if (key.clientCertificate != null || key.clientCertificateKey != null) { builder.useClientCert(key.clientCertificate, key.clientCertificateKey); @@ -547,9 +551,6 @@ Spanner createSpanner(SpannerPoolKey key, ConnectionOptions options) { if (key.caCertificate != null) { builder.setCaCertificate(key.caCertificate); } - if (key.instanceType != null) { - builder.setType(key.instanceType); - } if (key.enableDirectAccess != null) { builder.setEnableDirectAccess(key.enableDirectAccess); } diff --git a/java-spanner/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java b/java-spanner/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java index dc732764076b..6363013d081c 100644 --- a/java-spanner/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java +++ b/java-spanner/google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/SpannerPoolTest.java @@ -18,8 +18,11 @@ import static com.google.common.truth.Truth.assertThat; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotEquals; +import static org.junit.Assert.assertSame; import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; @@ -36,9 +39,11 @@ import com.google.cloud.spanner.SessionPoolOptions; import com.google.cloud.spanner.Spanner; import com.google.cloud.spanner.SpannerException; +import com.google.cloud.spanner.SpannerOptions; import com.google.cloud.spanner.connection.ConnectionImpl.LeakedConnectionException; import com.google.cloud.spanner.connection.SpannerPool.CheckAndCloseSpannersMode; import com.google.cloud.spanner.connection.SpannerPool.SpannerPoolKey; +import com.google.cloud.spanner.omni.SpannerOmniCredentials; import com.google.common.base.Ticker; import com.google.common.testing.FakeTicker; import io.opentelemetry.api.OpenTelemetry; @@ -922,4 +927,70 @@ public void testPartialClientKeyThrowsException() { assertThrows( IllegalArgumentException.class, () -> SpannerPool.INSTANCE.createSpanner(key, options)); } + + @Test + public void testCreateSpannerWithOmniCredentialsPlainText() { + ConnectionOptions options = + ConnectionOptions.newBuilder() + .setUri( + "spanner://localhost:15000/projects/default/instances/default/databases/test-db" + + ";usePlainText=true;type=omni;username=test_user;password=test_password") + .build(); + SpannerPoolKey key = SpannerPoolKey.of(options); + try (Spanner spanner = SpannerPool.INSTANCE.createSpanner(key, options)) { + assertTrue(spanner.getOptions().isUsePlainText()); + assertEquals(SpannerOptions.InstanceType.OMNI, spanner.getOptions().getInstanceType()); + assertSame(options.getCredentials(), spanner.getOptions().getCredentials()); + assertTrue(spanner.getOptions().getCredentials() instanceof SpannerOmniCredentials); + assertEquals("http://localhost:15000", spanner.getOptions().getHost()); + } + } + + @Test + public void testCreateSpannerWithOmniCredentialsTls() { + ConnectionOptions options = + ConnectionOptions.newBuilder() + .setUri( + "spanner://localhost:15000/projects/default/instances/default/databases/test-db" + + ";usePlainText=false;type=omni;username=test_user;password=test_password") + .build(); + SpannerPoolKey key = SpannerPoolKey.of(options); + try (Spanner spanner = SpannerPool.INSTANCE.createSpanner(key, options)) { + assertFalse(spanner.getOptions().isUsePlainText()); + assertEquals(SpannerOptions.InstanceType.OMNI, spanner.getOptions().getInstanceType()); + assertSame(options.getCredentials(), spanner.getOptions().getCredentials()); + assertTrue(spanner.getOptions().getCredentials() instanceof SpannerOmniCredentials); + } + } + + @Test + public void testCreateSpannerWithPlainTextDefaultCredentials() { + ConnectionOptions options = + ConnectionOptions.newBuilder() + .setUri( + "cloudspanner://localhost:9010/projects/p/instances/i/databases/d?usePlainText=true") + .setCredentials(NoCredentials.getInstance()) + .build(); + SpannerPoolKey key = SpannerPoolKey.of(options); + try (Spanner spanner = SpannerPool.INSTANCE.createSpanner(key, options)) { + assertTrue(spanner.getOptions().isUsePlainText()); + assertEquals(NoCredentials.getInstance(), spanner.getOptions().getCredentials()); + } + } + + @Test + public void testCreateSpannerWithPlainTextReplacesNonOmniCredentials() { + Credentials credentials = mock(Credentials.class, withSettings().withoutAnnotations()); + ConnectionOptions options = + ConnectionOptions.newBuilder() + .setUri( + "cloudspanner://localhost:9010/projects/p/instances/i/databases/d?usePlainText=true") + .setCredentials(credentials) + .build(); + SpannerPoolKey key = SpannerPoolKey.of(options); + try (Spanner spanner = SpannerPool.INSTANCE.createSpanner(key, options)) { + assertTrue(spanner.getOptions().isUsePlainText()); + assertEquals(NoCredentials.getInstance(), spanner.getOptions().getCredentials()); + } + } }