Skip to content

feat(jdbc): enforce strict JDBC URL parsing and sync DataSource properties #4107

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
keshavdandeva wants to merge 12 commits into
base: main
Choose a base branch
from
Open

feat(jdbc): enforce strict JDBC URL parsing and sync DataSource properties #4107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
523eed3
feat(jdbc): enforce strict JDBC URL parsing and validation
keshavdandeva Feb 17, 2026
5d6304f
feat(jdbc): sync DataSource properties with BigQueryConnection
keshavdandeva Feb 17, 2026
df71d2c
test: update tests for strict parsing
keshavdandeva Feb 17, 2026
56b7b09
chore: fix failing tests
keshavdandeva Feb 17, 2026
fe67f1d
chore: throw original `BigQueryJdbcRuntimeException`
keshavdandeva Feb 18, 2026
73c0bce
chore: add url encoding to appendProperties to prevent injection vuln…
keshavdandeva Feb 18, 2026
e25caf4
chore: refactor `parseAndRemovePartnerTokenProperty()`
keshavdandeva Feb 18, 2026
9fa4bae
fix: use "ProjectId" instead of "Project_Id" in tests
keshavdandeva Feb 18, 2026
423594a
chore: add error message sanitization
keshavdandeva Feb 18, 2026
6709e7e
chore: address pr feedback
keshavdandeva Feb 21, 2026
2b55c32
Merge branch 'main' into jdbc/feat-strict-url-parse-and-sync-dataSource
keshavdandeva Feb 21, 2026
290d317
fix: regex for partnerToken
keshavdandeva Feb 21, 2026
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
6 changes: 6 additions & 0 deletions google-cloud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryDriver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package com.google.cloud.bigquery.jdbc;

import com.google.cloud.bigquery.exception.BigQueryJdbcException;
import com.google.cloud.bigquery.exception.BigQueryJdbcRuntimeException;
import io.grpc.LoadBalancerRegistry;
import io.grpc.internal.PickFirstLoadBalancerProvider;
import java.io.IOException;
Expand Down Expand Up @@ -123,6 +124,11 @@ public Connection connect(String url, Properties info) throws SQLException {
// strip 'jdbc:' from the URL, add any extra properties
String connectionUri =
BigQueryJdbcUrlUtility.appendPropertiesToURL(url.substring(5), this.toString(), info);
try {
BigQueryJdbcUrlUtility.parseUrl(connectionUri);
} catch (BigQueryJdbcRuntimeException e) {
throw new BigQueryJdbcException(e.getMessage(), e);
Copy link
Contributor

@logachev logachev Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason to wrap BigQueryJdbcRuntimeException with BigQueryJdbcException?

Copy link
Contributor Author

@keshavdandeva keshavdandeva Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the JDBC spec required the connect() method to throw SQLException for connection failures and BigQueryJdbcException extends SQLException

}

// LogLevel
String logLevelStr =
Expand Down
155 changes: 134 additions & 21 deletions ...ud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryJdbcUrlUtility.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,16 @@
import com.google.api.client.util.escape.CharEscapers;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.exception.BigQueryJdbcRuntimeException;
import com.google.common.collect.ImmutableList;
import com.google.common.net.UrlEscapers;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
Expand All @@ -39,6 +45,14 @@
*/
final class BigQueryJdbcUrlUtility {

private static final Map<String, Map<String, String>> PARSE_CACHE =
Collections.synchronizedMap(
new LinkedHashMap<String, Map<String, String>>(50, 0.75f, true) {
protected boolean removeEldestEntry(Map.Entry<String, Map<String, String>> eldest) {
return size() > 50; // bound cache size
}
});

// TODO: Add all Connection options
static final String ALLOW_LARGE_RESULTS_PROPERTY_NAME = "AllowLargeResults";
static final String LARGE_RESULTS_TABLE_PROPERTY_NAME = "LargeResultTable";
Expand Down Expand Up @@ -122,6 +136,10 @@ final class BigQueryJdbcUrlUtility {
static final String BYOID_SUBJECT_TOKEN_TYPE_PROPERTY_NAME = "BYOID_SubjectTokenType";
static final String BYOID_TOKEN_URI_PROPERTY_NAME = "BYOID_TokenUri";
static final String PARTNER_TOKEN_PROPERTY_NAME = "PartnerToken";
private static final Pattern PARTNER_TOKEN_PATTERN =
Pattern.compile(
"(?:^|(?<=;))" + PARTNER_TOKEN_PROPERTY_NAME + "=\\s*((?:\\([^)]*\\)|[^;])*?)(?=(?:;|$))",
Pattern.CASE_INSENSITIVE);
static final String METADATA_FETCH_THREAD_COUNT_PROPERTY_NAME = "MetaDataFetchThreadCount";
static final int DEFAULT_METADATA_FETCH_THREAD_COUNT_VALUE = 32;
static final String RETRY_TIMEOUT_IN_SECS_PROPERTY_NAME = "Timeout";
Expand Down Expand Up @@ -591,6 +609,37 @@ final class BigQueryJdbcUrlUtility {
+ " header.")
.build())));

private static final List<String> NETWORK_PROPERTIES =
ImmutableList.of(
PARTNER_TOKEN_PROPERTY_NAME,
ENDPOINT_OVERRIDES_PROPERTY_NAME,
PRIVATE_SERVICE_CONNECT_PROPERTY_NAME);

private static final Map<String, String> PROPERTY_NAME_MAP;

static {
Map<String, String> map = new HashMap<>();
for (BigQueryConnectionProperty p : VALID_PROPERTIES) {
map.put(p.getName().toUpperCase(), p.getName());
Copy link
Contributor

@logachev logachev Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that map is supposed to be name->default rather than name->name?

Copy link
Contributor Author

@keshavdandeva keshavdandeva Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this map is for normalizing propertry names (mapping UPPER_CASE -> CamelCase) to support case-insensitive property keys in the connection URL.
Default values are handled separately during property retrieval.

}
for (BigQueryConnectionProperty p : AUTH_PROPERTIES) {
map.put(p.getName().toUpperCase(), p.getName());
}
for (BigQueryConnectionProperty p : PROXY_PROPERTIES) {
map.put(p.getName().toUpperCase(), p.getName());
}
for (String p : OVERRIDE_PROPERTIES) {
map.put(p.toUpperCase(), p);
}
for (String p : BYOID_PROPERTIES) {
map.put(p.toUpperCase(), p);
}
for (String p : NETWORK_PROPERTIES) {
map.put(p.toUpperCase(), p);
}
PROPERTY_NAME_MAP = Collections.unmodifiableMap(map);
}

private BigQueryJdbcUrlUtility() {}

/**
Expand All @@ -601,12 +650,72 @@ private BigQueryJdbcUrlUtility() {}
* @return The String value of the property, or the default value if the property is not found.
*/
static String parseUriProperty(String uri, String property) {
Pattern pattern = Pattern.compile(String.format("(?is)(?:;|\\?)%s=(.*?)(?:;|$)", property));
Matcher matcher = pattern.matcher(uri);
if (matcher.find() && matcher.groupCount() == 1) {
return CharEscapers.decodeUriPath(matcher.group(1));
Map<String, String> map = parseUrl(uri);
if (PROPERTY_NAME_MAP.containsKey(property.toUpperCase())) {
Copy link
Contributor

@logachev logachev Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems incorrect? It never returns default value

Copy link
Contributor Author

@keshavdandeva keshavdandeva Feb 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parseUriProperty method is intended to return the value or null if not present (as per the code before this PR as well)
The default value logic is handled by its wrapper methods like parseStringProperty, parseBooleanProperty etc

return map.get(PROPERTY_NAME_MAP.get(property.toUpperCase()));
}
return null;
return map.get(property);
}

/**
* Parses the URL into a map of key-value pairs, validating that all keys are known properties.
*
* @param url The URL to parse.
* @return A map of property names to values.
* @throws BigQueryJdbcRuntimeException if an unknown property is found or the URL is malformed.
*/
static Map<String, String> parseUrl(String url) {
if (url == null) {
return Collections.emptyMap();
}
return PARSE_CACHE.computeIfAbsent(url, BigQueryJdbcUrlUtility::parseUrlInternal);
}

private static Map<String, String> parseUrlInternal(String url) {
Map<String, String> map = new HashMap<>();
if (url == null) {
return map;
}

String[] urlParts = url.split(";", 2);
if (urlParts.length < 2) {
return map;
}

String urlToParse = urlParts[1];

// Parse PartnerToken separately as it contains ';'
Matcher matcher = PARTNER_TOKEN_PATTERN.matcher(urlToParse);
if (matcher.find()) {
String rawToken = matcher.group(1).trim();
String token =
(rawToken.startsWith("(") && rawToken.endsWith(")"))
? rawToken.substring(1, rawToken.length() - 1).trim()
: rawToken;

if (token.toUpperCase().startsWith("GPN:")) {
map.put(PARTNER_TOKEN_PROPERTY_NAME, " (" + token + ")");
}
urlToParse = matcher.replaceFirst("");
}

String[] parts = urlToParse.split(";");
for (String part : parts) {
if (part.trim().isEmpty()) {
continue;
}
String[] kv = part.split("=", 2);
String key = kv[0].trim().toUpperCase();
if (kv.length != 2 || !PROPERTY_NAME_MAP.containsKey(key)) {
String ref = (kv.length == 2) ? key : part;
String safeRef = ref.length() > 32 ? ref.substring(0, 32) + "..." : ref;
throw new BigQueryJdbcRuntimeException(
String.format("Wrong value or unknown setting: %s", safeRef));
}

map.put(PROPERTY_NAME_MAP.get(key), CharEscapers.decodeUriPath(kv[1]));
}
return Collections.unmodifiableMap(map);
}

/**
Expand All @@ -622,7 +731,11 @@ static String appendPropertiesToURL(String url, String callerClassName, Properti
for (Entry<Object, Object> entry : properties.entrySet()) {
if (entry.getValue() != null && !"".equals(entry.getValue())) {
LOG.finest("Appending %s with value %s to URL", entry.getKey(), entry.getValue());
urlBuilder.append(";").append(entry.getKey()).append("=").append(entry.getValue());
String encodedValue =
UrlEscapers.urlFormParameterEscaper()
.escape((String) entry.getValue())
.replace("+", "%20");
urlBuilder.append(";").append(entry.getKey()).append("=").append(encodedValue);
}
}
return urlBuilder.toString();
Expand Down Expand Up @@ -697,22 +810,17 @@ public static String parsePartnerTokenProperty(String url, String callerClassNam
LOG.finest("++enter++\t" + callerClassName);
// This property is expected to be set by partners only. For more details on exact format
// supported, refer b/396086960
String regex =
PARTNER_TOKEN_PROPERTY_NAME + "=\\s*\\(\\s*(GPN:[^;]*?)\\s*(?:;\\s*([^)]*?))?\\s*\\)";
Pattern pattern = Pattern.compile(regex);
Matcher matcher = pattern.matcher(url);

Matcher matcher = PARTNER_TOKEN_PATTERN.matcher(url);
if (matcher.find()) {
String gpnPart = matcher.group(1);
String environmentPart = matcher.group(2);
StringBuilder partnerToken = new StringBuilder(" (");
partnerToken.append(gpnPart);
if (environmentPart != null && !environmentPart.trim().isEmpty()) {
partnerToken.append("; ");
partnerToken.append(environmentPart);
String rawToken = matcher.group(1).trim();
String token =
(rawToken.startsWith("(") && rawToken.endsWith(")"))
? rawToken.substring(1, rawToken.length() - 1).trim()
: rawToken;

if (token.toUpperCase().startsWith("GPN:")) {
return " (" + token + ")";
}
partnerToken.append(")");
return partnerToken.toString();
}
return null;
}
Expand Down Expand Up @@ -793,7 +901,12 @@ static Map<String, String> parseOverrideProperties(String url, String callerClas
Matcher matcher = pattern.matcher(url);
String overridePropertiesString;
if (matcher.find() && matcher.groupCount() >= 1) {
overridePropertiesString = matcher.group(2);
try {
overridePropertiesString =
URLDecoder.decode(matcher.group(2), StandardCharsets.UTF_8.name());
} catch (UnsupportedEncodingException e) {
throw new BigQueryJdbcRuntimeException(e);
}
} else {
return overrideProps;
}
Expand Down
Loading
Loading