Add a flag to control whether credentials are printed during bootstrapping #461
+293
−103
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * 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.polaris.core.persistence.secrets; | ||
|
|
||
| import org.apache.polaris.core.entity.PolarisPrincipalSecrets; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public class DefaultPrincipalSecretsGenerator extends PrincipalSecretsGenerator { | ||
|
|
||
| public DefaultPrincipalSecretsGenerator(@Nullable String realmName) { | ||
| super(realmName); | ||
| } | ||
|
|
||
| private PrincipalSecretsGenerator getDelegate( | ||
| @Nullable String realmName, @NotNull String principalName) { | ||
| var envVarGenerator = new EnvVariablePrincipalSecretsGenerator(realmName); | ||
| if (envVarGenerator.systemGeneratedSecrets(principalName)) { | ||
| return new RandomPrincipalSecretsGenerator(realmName); | ||
| } else { | ||
| return envVarGenerator; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public PolarisPrincipalSecrets produceSecrets(@NotNull String principalName, long principalId) { | ||
| PrincipalSecretsGenerator delegate = getDelegate(realmName, principalName); | ||
| return delegate.produceSecrets(principalName, principalId); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean systemGeneratedSecrets(@NotNull String principalName) { | ||
| PrincipalSecretsGenerator delegate = getDelegate(realmName, principalName); | ||
| return delegate.systemGeneratedSecrets(principalName); | ||
| } | ||
| } |
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,69 @@ | ||
| /* | ||
| * 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.polaris.core.persistence.secrets; | ||
|
|
||
| import org.apache.polaris.core.entity.PolarisPrincipalSecrets; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| public class EnvVariablePrincipalSecretsGenerator extends PrincipalSecretsGenerator { | ||
|
|
||
| public EnvVariablePrincipalSecretsGenerator(@Nullable String realmName) { | ||
| super(realmName); | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public PolarisPrincipalSecrets produceSecrets(@NotNull String principalName, long principalId) { | ||
| String clientIdKey = clientIdEnvironmentVariable(realmName, principalName); | ||
| String clientSecretKey = clientSecretEnvironmentVariable(realmName, principalName); | ||
|
|
||
| String clientId = getEnvironmentVariable(clientIdKey); | ||
| String clientSecret = getEnvironmentVariable(clientSecretKey); | ||
| if (clientId == null || clientSecret == null) { | ||
| return null; | ||
| } else { | ||
| return new PolarisPrincipalSecrets(principalId, clientId, clientSecret, null); | ||
| } | ||
| } | ||
|
|
||
| /** {@inheritDoc} */ | ||
| @Override | ||
| public boolean systemGeneratedSecrets(@NotNull String principalName) { | ||
| String clientIdKey = clientIdEnvironmentVariable(realmName, principalName); | ||
| String clientSecretKey = clientSecretEnvironmentVariable(realmName, principalName); | ||
| return getEnvironmentVariable(clientIdKey) != null | ||
| && getEnvironmentVariable(clientSecretKey) != null; | ||
| } | ||
|
|
||
| /** Load a single environment variable */ | ||
| private static String getEnvironmentVariable(String key) { | ||
| return System.getenv(key); | ||
| } | ||
|
|
||
| /** Build the key for the env variable used to store client ID */ | ||
| private static String clientIdEnvironmentVariable(String realmName, String principalName) { | ||
| return String.format("POLARIS_BOOTSTRAP_%s_%s_CLIENT_ID", realmName, principalName); | ||
| } | ||
|
|
||
| /** Build the key for the env variable used to store client secret */ | ||
| private static String clientSecretEnvironmentVariable(String realmName, String principalName) { | ||
| return String.format("POLARIS_BOOTSTRAP_%s_%s_CLIENT_SECRET", realmName, principalName); | ||
| } | ||
| } |
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
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.
I think this logic belongs to the secrets generator. The MetaStoreManager doesn't need to know anything about whether the secrets generated are provided by the user or if they've been generated randomly. So why would it be concerned with printing the credentials? The secrets generator knows if the secrets were provided explicitly or if they were randomly generated.
I think the
bootstrapcommand should take aprint-credentialsconfig flag and the constructed secrets generator can react accordingly.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.
It seems like the
PrincipalSecretsGeneratoris doing exactly what the name suggests: generating secrets.Whatever is done with those secrets -- persisting them, using them, printing them -- is outside the purview of the generator itself.
You are right that the
MetaStoreManagerdoesn't need to know anything about printing either (it doesn't in this PR) and clearly this should be outside the purview of the metastore itself.And so we landed on the factory. I would be happy to take this bootstrapping logic and excise it to somewhere more idiomatic if that is a concern. But right now the bootstrapping logic lives here (e.g. the
purgecheck) and this seems like the most appropriate place that doesn't change the responsibility of either the metastore or generator classes.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.
Looking again, is your objection specifically to the protected method
printCredentials?That only exists to support the legacy behavior of the in-memory metastore always printing credentials, and if possible I would very much be in favor of removing that.
However it feels like pushing that logic down into an existing method (whether
secretsGenerator,createMetaStoreSession, or elsewhere) could be a bit hacky if it winds up somewhere it doesn't belong.