924060929 commented on code in PR #70705: URL: https://github.com/apache/doris/pull/70705#discussion_r4624014273
########## fe/fe-core/src/main/java/org/apache/doris/common/util/DatasourcePropertyRedactor.java: ########## @@ -0,0 +1,208 @@ +// 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.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("^[a-zA-Z][a-zA-Z0-9+.-]*://"); + 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", "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 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; + } + 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) { + 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 (address.indexOf(',') >= 0) { Review Comment: [P2] Preserve resolved S3 files in streaming audit events `S3SourceOffsetProvider.buildFileListUri` renders two selected files as `s3://bucket/input/{1.csv,2.csv}`. The comma check masks the whole batch. A single file is also wrapped in braces (`{1.csv}`), which `new URI(address)` rejects. The insert still reads the selected files, but its final audit event loses the file list that #67489 added for tracing imports. The updated `StreamingInsertTaskAuditTest` now asserts that the list disappears. Could the streaming audit path sanitize each URI from the selected file statuses before rendering the batch? Please cover both one-file and multi-file batches on the final audit event, with an assertion that credentials are still masked. ########## fe/fe-core/src/main/java/org/apache/doris/common/util/DatasourcePropertyRedactor.java: ########## @@ -0,0 +1,208 @@ +// 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.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("^[a-zA-Z][a-zA-Z0-9+.-]*://"); + 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", "s3", "s3a", "s3n", Review Comment: [P3] Preserve the ViewFS mount-table name `HdfsFileSystemProvider` supports both `hdfs` and `viewfs`. The existing Hive regression sets `fs.defaultFS = viewfs://my-cluster`, where `my-cluster` identifies the mount table. With this scheme list, that value becomes `*XXX` in catalog display and lineage, while `hdfs://my-cluster` stays visible. Could ViewFS use the same address sanitization as HDFS, with a display test for this fixture? [Hive ViewFS fixture](https://github.com/apache/doris/blob/125c912163535c6f51c36fa20685c7b0e68b9266/regression-test/suites/external_table_p2/hive/test_viewfs_hive.groovy#L35-L43) ########## fe/fe-core/src/main/java/org/apache/doris/common/util/DatasourcePropertyRedactor.java: ########## @@ -0,0 +1,208 @@ +// 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.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("^[a-zA-Z][a-zA-Z0-9+.-]*://"); + 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", "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 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; + } + if ((key instanceof String && ADDRESS_KEY.matcher((String) key).find()) Review Comment: [P2] Preserve local ADBC paths in SHOW CREATE CATALOG ADBC accepts an absolute library path in `driver_url`, and its SQLite connector uses a local `uri` such as `file:/tmp/catalog.db`. This condition routes both values to `redactAddress` based on their property names, so both print as `*XXX`. The existing SQLite regression explicitly checks that an operator can see the driver and database paths in `SHOW CREATE CATALOG`. [Existing assertions](https://github.com/apache/doris/blob/125c912163535c6f51c36fa20685c7b0e68b9266/regression-test/suites/external_table_p0/adbc/test_adbc_metadata_ops.groovy#L127-L134) Could the ADBC display path recognize these credential-free local forms while preserving credential masking for connection URIs? -- 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]
