-
Notifications
You must be signed in to change notification settings - Fork 13.8k
[FLINK-38263][table] add secret store related interfaces #27394
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
Open
lihaosky
wants to merge
1
commit into
apache:master
Choose a base branch
from
confluentinc:connection-api
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+471
−2
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
41 changes: 41 additions & 0 deletions
41
...e/flink-table-common/src/main/java/org/apache/flink/table/secret/CommonSecretOptions.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * 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.flink.table.secret; | ||
|
|
||
| import org.apache.flink.annotation.Internal; | ||
| import org.apache.flink.configuration.ConfigOption; | ||
| import org.apache.flink.configuration.ConfigOptions; | ||
|
|
||
| /** A collection of {@link ConfigOption} which are used for secret store configuration. */ | ||
| @Internal | ||
| public class CommonSecretOptions { | ||
|
|
||
| public static final String DEFAULT_SECRET_STORE_KIND = "default_in_memory"; | ||
| public static final ConfigOption<String> TABLE_SECRET_STORE_KIND = | ||
| ConfigOptions.key("table.secret-store.kind") | ||
| .stringType() | ||
| .defaultValue(DEFAULT_SECRET_STORE_KIND) | ||
| .withDescription( | ||
| "The kind of secret store to be used. Out of the box, 'default_in_memory' option is supported. " | ||
| + "Implementations can provide custom secret stores for different backends " | ||
| + "(e.g., cloud-specific secret managers)."); | ||
|
|
||
| /** Used to filter the specific options for secret store. */ | ||
| public static final String TABLE_SECRET_STORE_OPTION_PREFIX = "table.secret-store."; | ||
| } |
45 changes: 45 additions & 0 deletions
45
...e/flink-table-common/src/main/java/org/apache/flink/table/secret/ReadableSecretStore.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * 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.flink.table.secret; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
| import org.apache.flink.table.secret.exceptions.SecretNotFoundException; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Interface for retrieving secrets from a secret store. | ||
| * | ||
| * <p>This interface enables read-only access to stored secrets, allowing applications to retrieve | ||
| * sensitive configuration data such as credentials, API tokens, and passwords. | ||
| * | ||
| * <p>Implementations of this interface should ensure secure retrieval and handling of secret data. | ||
| */ | ||
| @PublicEvolving | ||
| public interface ReadableSecretStore extends SecretStore { | ||
|
|
||
| /** | ||
| * Retrieves a secret from the store by its identifier. | ||
| * | ||
| * @param secretId the unique identifier of the secret to retrieve | ||
| * @return a map containing the secret data as key-value pairs | ||
| * @throws SecretNotFoundException if the secret with the given identifier does not exist | ||
| */ | ||
| Map<String, String> getSecret(String secretId) throws SecretNotFoundException; | ||
| } |
33 changes: 33 additions & 0 deletions
33
flink-table/flink-table-common/src/main/java/org/apache/flink/table/secret/SecretStore.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * 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.flink.table.secret; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
|
|
||
| /** | ||
| * Base marker interface for secret store implementations. | ||
| * | ||
| * <p>This interface serves as the common base for both {@link ReadableSecretStore} and {@link | ||
| * WritableSecretStore}, allowing for flexible secret management implementations. | ||
| * | ||
| * <p>Secret stores are used to manage sensitive configuration data (credentials, tokens, passwords, | ||
| * etc.) in Flink SQL and Table API applications. | ||
| */ | ||
| @PublicEvolving | ||
| public interface SecretStore {} |
60 changes: 60 additions & 0 deletions
60
...le/flink-table-common/src/main/java/org/apache/flink/table/secret/SecretStoreFactory.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * 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.flink.table.secret; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
| import org.apache.flink.configuration.ReadableConfig; | ||
| import org.apache.flink.table.catalog.exceptions.CatalogException; | ||
| import org.apache.flink.table.factories.Factory; | ||
| import org.apache.flink.table.secret.exceptions.SecretException; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| /** Factory for creating SecretStore instances. */ | ||
| @PublicEvolving | ||
| public interface SecretStoreFactory extends Factory { | ||
|
|
||
| /** Creates a SecretStore instance. */ | ||
| SecretStore createSecretStore(); | ||
|
|
||
| /** Initialize secret store. */ | ||
| void open(Context context) throws SecretException; | ||
|
|
||
| /** Close secret store. */ | ||
| void close() throws CatalogException; | ||
|
|
||
| interface Context { | ||
| /** | ||
| * Returns the options with which the secret store is created. | ||
| * | ||
| * <p>An implementation should perform validation of these options. | ||
| */ | ||
| Map<String, String> getOptions(); | ||
|
|
||
| /** Gives read-only access to the configuration of the current session. */ | ||
| ReadableConfig getConfiguration(); | ||
|
|
||
| /** | ||
| * Returns the class loader of the current session. | ||
| * | ||
| * <p>The class loader is in particular useful for discovering further (nested) factories. | ||
| */ | ||
| ClassLoader getClassLoader(); | ||
| } | ||
| } |
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.
I suggest adding a test implementation of these interfaces to drive the usage of the interfaces from tests, including writeable readable stores with config options.