[FLINK-39685][table] Redact sensitive options in SHOW CREATE and DESCRIBE CATALOG statements#28167
Open
gaborgsomogyi wants to merge 1 commit into
Open
[FLINK-39685][table] Redact sensitive options in SHOW CREATE and DESCRIBE CATALOG statements#28167gaborgsomogyi wants to merge 1 commit into
gaborgsomogyi wants to merge 1 commit into
Conversation
…RIBE CATALOG statements
Collaborator
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What is the purpose of the change
Sensitive table/catalog/model options (e.g. password, api-key, token) were exposed verbatim in the output of SHOW
CREATE TABLE,SHOW CREATE CATALOG,SHOW CREATE MATERIALIZED TABLE,SHOW CREATE MODEL, andDESCRIBE CATALOG EXTENDED. Flink already had redaction infrastructure (GlobalConfiguration.isSensitive/HIDDEN_CONTENT) used for Flink config display and factory error messages, but it was not wired to SQL display operations.Brief change log
ShowCreateUtil-extractFormattedOptionsnow acceptsList<String> additionalSensitiveKeysand redacts matching values with******. The unused 2-arg and lowerCaseKeys overloads were removed (dead code).ShowCreate*Operation/DescribeCatalogOperation- eachexecute()readsSecurityOptions.ADDITIONAL_SENSITIVE_KEYSfromTableConfigand threads it through to the rendering layer.DefaultCatalogTable/DefaultCatalogModel-toString()now usesConfigurationUtils.hideSensitiveValuesto avoid leaking secrets in logs. Built-in sensitive key patterns apply; user-configured additional keys cannot be applied here (no config context intoString()).Verifying this change
ShowCreateUtilTest- extended with redaction cases for table, catalog, materialized table, and custom additionalSensitiveKeys.DescribeCatalogOperationTest- new; verifies extended output redacts password/token, non-sensitive values are unchanged, and non-extended output exposes no options at all.DefaultCatalogTableTest- new; verifiestoString()redacts sensitive keys and preserves safe ones.Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: Claude code