github-actions[bot] commented on code in PR #70705:
URL: https://github.com/apache/doris/pull/70705#discussion_r4625519903


##########
fe/fe-core/src/main/java/org/apache/doris/common/util/DatasourcePropertyRedactor.java:
##########
@@ -0,0 +1,289 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.apache.doris.common.util;
+
+import org.apache.doris.common.Config;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/** Value-aware masking shared by catalog display, audit property rendering, 
and lineage metadata. */
+final class DatasourcePropertyRedactor {
+    private static final String MASK = DatasourcePrintableMap.PASSWORD_MASK;
+    // The bare URI alias is shared with REST catalogs, so its 
connection-string status depends on the value.
+    private static final Pattern CONNECTION_KEY = Pattern.compile(
+            
"(?i)(?:connection[._-]?string|(?:^|[._-])jdbc[._-]?(?:url|uri))$");
+    private static final Pattern NATIVE_CREDENTIAL = 
Pattern.compile("(?i)(?:^|[._-])(?:token|credentials?)$");
+    private static final Pattern HADOOP_CREDENTIAL = 
Pattern.compile("(?i)(?:^|\\.)fs\\.(?:"
+            + 
"s3a?\\.(?:bucket\\..+\\.)?(?:access\\.key|secret\\.key|session\\.token|"
+            + "(?:server-side-)?encryption\\.key|proxy\\.password)|"
+            + "azure\\.(?:account\\.key|sas(?:\\.fixed\\.token)?|"
+            + "account\\.oauth2\\.(?:client\\.secret|refresh\\.token)|"
+            + 
"encryption\\.encoded\\.client-provided\\.key)(?:\\..*)?|adl\\.oauth2\\.(?:credential|refresh\\.token)|"
+            + 
"oss\\.(?:accessKeyId|accessKeySecret|securityToken)|cosn\\.(?:userInfo\\.)?(?:secretId|secretKey)|"
+            + 
"obs\\.(?:access\\.key|secret\\.key|(?:session|security)\\.token))$");
+    private static final Pattern ADDRESS_KEY = Pattern.compile(
+            
"(?i)(?:^|[._-])(?:uris?|urls?|hosts?|endpoints?|addresses|address)$");
+    private static final Pattern URL_VALUE = 
Pattern.compile("(?i)^(?:[a-z][a-z0-9+.-]*://|(?:file|hdfs|viewfs):/)");
+    private static final Pattern DRIVER_URL_KEY = 
Pattern.compile("(?i)(?:^|[._-])driver[._-]url$");
+    private static final Pattern AMBIGUOUS_LOCAL_PATH = 
Pattern.compile("[\\p{Cntrl}?#@;]|://");
+    private static final Pattern RESOLVED_FILE_LOCATION = Pattern.compile(
+            "^([a-zA-Z][a-zA-Z0-9+.-]*)://([^/?#]*)([^?]*)(\\?.*)?$", 
Pattern.DOTALL);
+    private static final String HOST = "(?:[a-zA-Z0-9_][a-zA-Z0-9._-]*|"
+            + "\\[[a-fA-F0-9:.]+(?:%[a-zA-Z0-9_.~-]+)?\\])(?::[0-9]+)?";
+    private static final Pattern HOST_PATTERN = Pattern.compile(HOST);
+    private static final Set<String> URI_SCHEMES = Set.of("http", "https", 
"thrift", "hdfs", "viewfs", "file",
+            "s3", "s3a", "s3n",
+            "oss", "cos", "cosn", "obs", "gs", "abfs", "abfss", "wasb", 
"wasbs");
+    private static final Set<String> AZURE_STORAGE_SCHEMES = Set.of("abfs", 
"abfss", "wasb", "wasbs");
+    // Match AzureUri's container grammar, including its single-character 
compatibility form.
+    private static final Pattern AZURE_CONTAINER_NAME = 
Pattern.compile("[a-z0-9](?:[a-z0-9-]{1,61}[a-z0-9])?");
+    private static final Pattern GCS_BUCKET_NAME = 
Pattern.compile("[a-z0-9][a-z0-9._-]{1,220}[a-z0-9]");
+    private static final Pattern QUERY_NAME = 
Pattern.compile("[a-zA-Z0-9_.~-]+");
+    private static final Pattern QUERY_CREDENTIAL = Pattern.compile(
+            
"(?i)password|passwd|pwd|secret|token|credential|access[._-]?key|api[._-]?key|"
+                    + "account[._-]?key|private[._-]?key|auth[._-]?key|"
+                    + "app(?:lication)?[._-]?key|authorization|^auth$|^key$");
+    private static final Pattern SIGNATURE = 
Pattern.compile("(?i)signature|(?:^|[._-])(?:sig|sas)(?:$|[._-])");
+    private static final Pattern ENCODED_ESCAPE = 
Pattern.compile("%[a-fA-F0-9]{2}");
+    private static volatile NamePattern namePattern = new 
NamePattern(Config.datasource_sensitive_property_pattern);
+
+    private DatasourcePropertyRedactor() {
+    }
+
+    static boolean isSensitiveName(String key) {
+        return CONNECTION_KEY.matcher(key).find()
+                || NATIVE_CREDENTIAL.matcher(key).find()
+                || HADOOP_CREDENTIAL.matcher(key).find() || 
configuredNamePattern().matcher(key).find();
+    }
+
+    private static Pattern configuredNamePattern() {
+        String configured = Config.datasource_sensitive_property_pattern;
+        NamePattern snapshot = namePattern;
+        if (!snapshot.source.equals(configured)) {
+            // Publish source and compiled pattern together; a concurrent 
update cannot pair different versions.
+            snapshot = new NamePattern(configured);
+            namePattern = snapshot;
+        }
+        return snapshot.pattern;
+    }
+
+    static String redact(Object key, Object value) {
+        if (DatasourcePrintableMap.isSensitiveKey(key)) {
+            return MASK;
+        }
+        String text = String.valueOf(value);
+        String address = text.trim();
+        // JDBC drivers accept incompatible credential syntaxes, including 
forms with no URI authority.
+        if (address.regionMatches(true, 0, "jdbc:", 0, 5)) {
+            return MASK;
+        }
+        // Local driver identifiers have filesystem semantics; ambiguous 
connection syntax still fails closed.
+        if (key instanceof String && DRIVER_URL_KEY.matcher((String) 
key).find() && address.startsWith("/")) {
+            return address.startsWith("//") || 
AMBIGUOUS_LOCAL_PATH.matcher(address).find() ? MASK : address;
+        }
+        if ((key instanceof String && ADDRESS_KEY.matcher((String) key).find())
+                || URL_VALUE.matcher(address).find()) {
+            return redactAddress(address);
+        }
+        return text;
+    }
+
+    private static String redactAddress(String address) {
+        return redactAddress(address, null, null);
+    }
+
+    static String redactResolvedFileLocation(String location) {
+        if (DatasourcePrintableMap.isSensitiveKey("uri")) {
+            return MASK;
+        }
+        Matcher parts = RESOLVED_FILE_LOCATION.matcher(location);
+        if (!parts.matches()) {
+            return MASK;
+        }
+        try {
+            String path = parts.group(3);
+            // A resolved singleton may contain literal glob characters; 
encode only for URI validation.
+            String encodedPath = new URI(null, "placeholder", path, null, 
null).getRawPath();
+            // Selected keys are already decoded: '#' is literal, including in 
a query-shaped suffix.
+            String rawQuery = parts.group(4) == null ? null : 
parts.group(4).substring(1);
+            String address = parts.group(1) + "://" + parts.group(2) + 
encodedPath
+                    + (rawQuery == null ? "" : "?" + rawQuery.replace("#", 
"%23"));
+            return redactAddress(address, path, rawQuery);
+        } catch (URISyntaxException | IllegalArgumentException e) {
+            return MASK;
+        }
+    }
+
+    private static String redactAddress(String address, String resolvedPath, 
String resolvedQuery) {
+        if (address.isEmpty()) {
+            return address;
+        }
+        try {
+            if (!address.contains("://") && isPlainHosts(address)) {
+                return address;
+            }
+            // URI accepts a later URL as path text after the first host; SDKs 
may instead split the list.
+            if (resolvedPath == null && address.indexOf(',') >= 0) {
+                return MASK;
+            }
+            URI uri = new URI(address);
+            if (uri.getScheme() == null) {
+                return MASK;
+            }
+            String scheme = uri.getScheme().toLowerCase(Locale.ROOT);
+            boolean localFile = "file".equals(scheme);
+            if (!URI_SCHEMES.contains(scheme)
+                    || uri.isOpaque() || uri.getPort() > 65535) {
+                return MASK;
+            }
+            String authority = uri.getRawAuthority();
+            if (localFile && authority != null) {
+                return MASK;
+            }
+            if (authority == null) {
+                // HDFS and ViewFS can resolve an absolute path through 
configured nameservices/default mounts.
+                if (!(localFile || "hdfs".equals(scheme) || 
"viewfs".equals(scheme))
+                        || !uri.getRawPath().startsWith("/")) {
+                    return MASK;
+                }
+                authority = "";
+            } else if ("gs".equals(scheme)) {
+                // GCS bucket authorities allow underscores, which 
java.net.URI does not treat as DNS hosts.
+                authority = authority.substring(authority.lastIndexOf('@') + 
1);
+                if (!isGcsBucket(authority)) {
+                    return MASK;
+                }
+            } else if ("viewfs".equals(scheme)) {
+                // ViewFS authorities name configured mount tables, which need 
not be DNS hostnames.
+                authority = authority.substring(authority.lastIndexOf('@') + 
1);
+                if (!isPlainHosts(authority)) {
+                    return MASK;
+                }
+            } else if (uri.getHost() == null) {
+                return MASK;
+            }
+            String path = resolvedPath == null ? uri.getPath()
+                    : URLDecoder.decode(resolvedPath.replace("+", "%2B"), 
StandardCharsets.UTF_8);
+            // Matrix parameters and nested encodings have no common 
credential grammar across SDKs.
+            if (path != null && (path.contains(";") || (resolvedPath == null 
&& path.contains(","))
+                    || path.contains("://") || path.contains(",//")
+                    || ENCODED_ESCAPE.matcher(path).find())) {
+                return MASK;
+            }
+            String query = redactQuery(resolvedPath == null ? 
uri.getRawQuery() : resolvedQuery);

Review Comment:
   [P2] Preserve literal separators in selected S3 key suffixes
   
   For an ObjectCreated notification containing 
`logs/data%3Fx%3D1%3By%3D2.csv`, the producer decodes the key and retains the 
selected status as `s3://bucket/logs/data?x=1;y=2.csv`. Passing its suffix 
through `redactQuery()` here splits on `[&;]` and rejoins with `&`, so the 
final audit event instead names `data?x=1&y=2.csv`. Those two distinct selected 
inputs become indistinguishable, including on failed attempts, despite neither 
suffix containing credentials. This is separate from percent-key thread 
4625210741: the selected status has no percent escape and the mutation occurs 
during query normalization. Preserve non-secret separators and empty components 
in trusted selected-key suffixes while retaining credential/signature checks, 
and cover the distinct spellings on the final audit event.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to