Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ConnectorConfigDefinition.java #1008

Closed
wants to merge 1 commit into from

Conversation

sudeshwasnik
Copy link
Contributor

@sudeshwasnik sudeshwasnik commented Nov 22, 2024

Overview

Configurations that may contain sensitive information (password, token) should be defined as PASSWORD type, there are two reasons :

  1. Raw value of these configurations must not be visible to users on UI/ API responses and should be masked. Values of PASSWORD type configurations are masked in responses.
  2. Connector configurations (and values) are logged at INFO level at various places (raw values for non-secret configurations) in Kafka Connect while it creates tasks/ connector.

This change is backward-compatible, since configuration values are never fetched fromSnowflakeSinkConnectorConfig object in connector (yet). Raw values passed to start() (parsedConfig) are directly used.

Pre-review checklist

  • This change should be part of a Behavior Change Release. See go/behavior-change.
  • This change has passed Merge gate tests
  • Snowpipe Changes
  • Snowpipe Streaming Changes
  • This change is TEST-ONLY
  • This change is README/Javadocs only
  • This change is protected by a config parameter <PARAMETER_NAME> eg snowflake.ingestion.method.
    • Yes - Added end to end and Unit Tests.
    • No - Suggest why it is not param protected
  • Is his change protected by parameter <PARAMETER_NAME> on the server side?
    • The parameter/feature is not yet active in production (partial rollout or PrPr, see Changes for Unreleased Features and Fixes).
    • If there is an issue, it can be safely mitigated by turning the parameter off. This is also verified by a test (See go/ppp).

@sudeshwasnik sudeshwasnik requested a review from a team as a code owner November 22, 2024 07:05
@sudeshwasnik
Copy link
Contributor Author

@sfc-gh-mbobowski Could you please take a look at this small change / PR?
We want to make sure that raw-values of sensitive configurations do not get logged anywhere.

@sfc-gh-achyzy
Copy link
Contributor

@sudeshwasnik Have you signed CLA before? If not, you'd have to sign it first before contributing to the public repo.

@sfc-gh-mbobowski
Copy link
Contributor

Already merged in #1009

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants