github-actions[bot] commented on code in PR #70705: URL: https://github.com/apache/doris/pull/70705#discussion_r4609073214
########## fe/fe-core/src/main/java/org/apache/doris/common/util/DatasourcePropertyRedactor.java: ########## @@ -0,0 +1,188 @@ +// 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 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 uri = new URI(address); + if (uri.getScheme() == null || !URI_SCHEMES.contains(uri.getScheme().toLowerCase(Locale.ROOT)) + || uri.isOpaque() || uri.getHost() == null || uri.getPort() > 65535) { + return MASK; + } + String path = uri.getPath(); + // Matrix parameters and nested encodings have no common credential grammar across SDKs. + if (path != null && (path.contains(";") || ENCODED_ESCAPE.matcher(path).find())) { + return MASK; + } + String query = redactQuery(uri.getRawQuery()); + if (MASK.equals(query)) { + return MASK; + } + String authority = uri.getRawAuthority(); + authority = authority.substring(authority.lastIndexOf('@') + 1); + return uri.getScheme() + "://" + authority + uri.getRawPath() Review Comment: [P1] Fail closed on URL lists before copying the path A supported ES `hosts` value such as `https://host1.example:9200/,https://user:[email protected]:9200/` parses here as one URI: the first endpoint supplies the authority, while the entire second URL becomes path text. The path passes the checks above and is appended unchanged, so `fixture-password` remains visible in SHOW CATALOG/SHOW CREATE, `catalogs()`, CREATE/ALTER audit SQL and lineage. `EsCatalogProperties.of()` actually splits this value into separate endpoints. Please redact each member or mask unsupported URL-list input before copying the path, and cover a list whose first URL ends in `/` and whose later URL contains credentials. -- 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]
