[#4993] feat(iceberg): integrate credential framework to iceberg REST server #5134
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /* | ||
| * 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.gravitino.credential; | ||
|
|
||
| public class CredentialConstants { | ||
| public static final String CREDENTIAL_PROVIDER_TYPE = "credential-provider-type"; | ||
|
|
||
| private CredentialConstants() {} | ||
| } | ||
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,38 @@ | ||
| /* | ||
| * 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.gravitino.credential; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Helper class to generate specific credential properties for different table format and engine. | ||
| */ | ||
| public class CredentialPropertyUtils { | ||
| /** | ||
| * Transforms a specific credential into a map of Iceberg properties. | ||
| * | ||
| * @param credential the credential to be transformed into Iceberg properties | ||
| * @return a map of Iceberg properties derived from the credential | ||
| */ | ||
| public static Map<String, String> toIcebergProperties(Credential credential) { | ||
| // todo: transform specific credential to iceberg properties | ||
| return credential.toProperties(); | ||
|
Comment on lines
+34
to
+36
There was a problem hiding this comment. This two lines code is not worthy to create a new class here, why can't you put this in iceberg package? There was a problem hiding this comment. it's like a placeholder function to support more credential properties transform logic, this function will be used in client side and Iceberg REST server side, so I place it in common module. |
||
| } | ||
| } | ||
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,73 @@ | ||
| /* | ||
| * 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.gravitino.credential; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import java.io.IOException; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import javax.annotation.Nullable; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class CredentialProviderManager { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(CredentialProviderManager.class); | ||
| private Map<String, CredentialProvider> credentialProviders; | ||
|
|
||
| public CredentialProviderManager() { | ||
| this.credentialProviders = new ConcurrentHashMap<>(); | ||
| } | ||
|
|
||
| public void registerCredentialProvider( | ||
| String catalogName, CredentialProvider credentialProvider) { | ||
| CredentialProvider current = credentialProviders.putIfAbsent(catalogName, credentialProvider); | ||
|
There was a problem hiding this comment. Do we support one catalog with multiple credential vendors? If so, seems this map cannot support it. There was a problem hiding this comment. Not in current PR, I prefer to support it later in integrate Credential vending to Gravitino server to have a better overall design. |
||
| Preconditions.checkState( | ||
| !credentialProvider.equals(current), | ||
| String.format( | ||
| "Should not register multiple times to CredentialProviderManager, catalog: %s, " | ||
| + "credential provider: %s", | ||
| catalogName, credentialProvider.credentialType())); | ||
| LOG.info( | ||
| "Register catalog:%s credential provider:%s to CredentialProviderManager", | ||
| catalogName, credentialProvider.credentialType()); | ||
| } | ||
|
|
||
| public void unregisterCredentialProvider(String catalogName) { | ||
| CredentialProvider credentialProvider = credentialProviders.remove(catalogName); | ||
| // Not all catalog has credential provider | ||
| if (credentialProvider != null) { | ||
| LOG.info( | ||
| "Unregister catalog:{} credential provider:{} to CredentialProviderManager", | ||
| catalogName, | ||
| credentialProvider.credentialType()); | ||
| try { | ||
| credentialProvider.close(); | ||
| } catch (IOException e) { | ||
| LOG.warn("Close credential provider failed", e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| public CredentialProvider getCredentialProvider(String catalogName) { | ||
| return credentialProviders.get(catalogName); | ||
| } | ||
| } | ||
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,32 @@ | ||
| /* | ||
| * 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.gravitino.credential; | ||
|
|
||
| import com.google.common.collect.ImmutableSet; | ||
| import org.apache.gravitino.utils.PrincipalUtils; | ||
|
|
||
| public class CredentialUtils { | ||
| public static Credential vendCredential(CredentialProvider credentialProvider, String path) { | ||
| PathBasedCredentialContext pathBasedCredentialContext = | ||
| new PathBasedCredentialContext( | ||
| PrincipalUtils.getCurrentUserName(), ImmutableSet.of(path), ImmutableSet.of()); | ||
| return credentialProvider.getCredential(pathBasedCredentialContext); | ||
| } | ||
| } |
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
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 remembered that we already defined this in
Credential, we don't have to define this again here.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's not the same, one is the credential type in
Credential, this is the credential type in catalog properties. They are happen to the same name.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.
Why can't you use a different name?
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.
use
credential-provider-typeThere 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.
If it is a catalog property, it is better to define in catalog-common, so other engines can also use it.
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.
the property already defined in
catalog-common