Redact sensitive information in catalog queries #24563
+1,166
−14
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * Licensed 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 io.trino.sql; | ||
|
|
||
| import com.google.inject.Inject; | ||
| import io.trino.FeaturesConfig; | ||
| import io.trino.connector.CatalogFactory; | ||
| import io.trino.spi.connector.ConnectorName; | ||
| import io.trino.sql.tree.AstVisitor; | ||
| import io.trino.sql.tree.CreateCatalog; | ||
| import io.trino.sql.tree.Explain; | ||
| import io.trino.sql.tree.ExplainAnalyze; | ||
| import io.trino.sql.tree.Identifier; | ||
| import io.trino.sql.tree.Node; | ||
| import io.trino.sql.tree.Property; | ||
| import io.trino.sql.tree.Statement; | ||
| import io.trino.sql.tree.StringLiteral; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Set; | ||
|
|
||
| import static com.google.common.collect.ImmutableList.toImmutableList; | ||
| import static com.google.common.collect.ImmutableSet.toImmutableSet; | ||
|
|
||
| public class SensitiveStatementRedactor | ||
| { | ||
| public static final String REDACTED_VALUE = "***"; | ||
|
There was a problem hiding this comment. We should consider a better value here than just There was a problem hiding this comment.
Can you expand on the function idea? Is that to make it so that the output of |
||
|
|
||
| private final boolean enabled; | ||
| private final CatalogFactory catalogFactory; | ||
|
|
||
| @Inject | ||
| public SensitiveStatementRedactor(FeaturesConfig config, CatalogFactory catalogFactory) | ||
| { | ||
| this.enabled = config.isStatementRedactingEnabled(); | ||
| this.catalogFactory = catalogFactory; | ||
| } | ||
|
|
||
| public String redact(String rawQuery, Statement statement) | ||
| { | ||
| if (enabled) { | ||
| RedactingVisitor visitor = new RedactingVisitor(); | ||
| Node redactedStatement = visitor.process(statement); | ||
| if (visitor.isRedacted()) { | ||
| return SqlFormatter.formatSql(redactedStatement); | ||
| } | ||
| } | ||
| return rawQuery; | ||
| } | ||
|
|
||
| public String redact(String rawQuery) | ||
| { | ||
| if (enabled) { | ||
| return REDACTED_VALUE; | ||
| } | ||
| return rawQuery; | ||
| } | ||
|
|
||
| private class RedactingVisitor | ||
| extends AstVisitor<Node, Void> | ||
| { | ||
| private boolean redacted; | ||
|
|
||
| public boolean isRedacted() | ||
| { | ||
| return redacted; | ||
| } | ||
|
|
||
| @Override | ||
| protected Node visitNode(Node node, Void context) | ||
| { | ||
| return node; | ||
| } | ||
|
|
||
| @Override | ||
| protected Node visitExplain(Explain explain, Void context) | ||
| { | ||
| Statement statement = (Statement) process(explain.getStatement()); | ||
| return new Explain(explain.getLocation().orElseThrow(), statement, explain.getOptions()); | ||
| } | ||
|
|
||
| @Override | ||
| protected Node visitExplainAnalyze(ExplainAnalyze explainAnalyze, Void context) | ||
| { | ||
| Statement statement = (Statement) process(explainAnalyze.getStatement()); | ||
| return new ExplainAnalyze(explainAnalyze.getLocation().orElseThrow(), statement, explainAnalyze.isVerbose()); | ||
| } | ||
|
|
||
| @Override | ||
| protected Node visitCreateCatalog(CreateCatalog createCatalog, Void context) | ||
|
There was a problem hiding this comment. Is there some way to notice when we need to add new node visitors here? Should this be a "wrapper" like the various WDYT? Might be overkill for now so need to change anything - just to have a discussion. |
||
| { | ||
| ConnectorName connectorName = new ConnectorName(createCatalog.getConnectorName().getValue()); | ||
| List<Property> redactedProperties = redact(connectorName, createCatalog.getProperties()); | ||
| return createCatalog.withProperties(redactedProperties); | ||
| } | ||
|
|
||
| private List<Property> redact(ConnectorName connectorName, List<Property> properties) | ||
| { | ||
| redacted = true; | ||
| Set<String> propertyNames = properties.stream() | ||
| .map(Property::getName) | ||
| .map(Identifier::getValue) | ||
| .collect(toImmutableSet()); | ||
| Set<String> redactableProperties = catalogFactory.getRedactablePropertyNames(connectorName, propertyNames); | ||
| return redactProperties(properties, redactableProperties); | ||
| } | ||
|
|
||
| private List<Property> redactProperties(List<Property> properties, Set<String> redactableProperties) | ||
| { | ||
| return properties.stream() | ||
| .map(property -> { | ||
| if (redactableProperties.contains(property.getName().getValue())) { | ||
| return new Property(property.getName(), new StringLiteral(REDACTED_VALUE)); | ||
| } | ||
| return property; | ||
| }) | ||
| .collect(toImmutableList()); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mosabua for suggestions about config naming. 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we want an option to disable this. Maybe as a temporary kill switch, but we should remove this as soon as we are happy with this feature
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, we can prefix with
experimental.in that case like we have done in past to clarify this. Or maybedeprecated.from the beginning.