-
Notifications
You must be signed in to change notification settings - Fork 400
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
### What changes were proposed in this pull request? Support OSS secret key credential ### Why are the changes needed? Fix: [# (5778)](#5778) ### How was this patch tested? IcebergRESTOSSSecretIT
- Loading branch information
1 parent
31d3b4a
commit 26a8b37
Showing
9 changed files
with
336 additions
and
15 deletions.
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
api/src/main/java/org/apache/gravitino/credential/OSSSecretKeyCredential.java
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,120 @@ | ||
| /* | ||
| * 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 com.google.common.collect.ImmutableMap; | ||
| import java.util.Map; | ||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| /** OSS secret key credential. */ | ||
| public class OSSSecretKeyCredential implements Credential { | ||
|
|
||
| /** OSS secret key credential type. */ | ||
| public static final String OSS_SECRET_KEY_CREDENTIAL_TYPE = "oss-secret-key"; | ||
| /** The static access key ID used to access OSS data. */ | ||
| public static final String GRAVITINO_OSS_STATIC_ACCESS_KEY_ID = "oss-access-key-id"; | ||
| /** The static secret access key used to access OSS data. */ | ||
| public static final String GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY = "oss-secret-access-key"; | ||
|
|
||
| private String accessKeyId; | ||
| private String secretAccessKey; | ||
|
|
||
| /** | ||
| * Constructs an instance of {@link OSSSecretKeyCredential} with the static OSS access key ID and | ||
| * secret access key. | ||
| * | ||
| * @param accessKeyId The OSS static access key ID. | ||
| * @param secretAccessKey The OSS static secret access key. | ||
| */ | ||
| public OSSSecretKeyCredential(String accessKeyId, String secretAccessKey) { | ||
| validate(accessKeyId, secretAccessKey, 0); | ||
| this.accessKeyId = accessKeyId; | ||
| this.secretAccessKey = secretAccessKey; | ||
| } | ||
|
|
||
| /** | ||
| * This is the constructor that is used by credential factory to create an instance of credential | ||
| * according to the credential information. | ||
| */ | ||
| public OSSSecretKeyCredential() {} | ||
|
|
||
| @Override | ||
| public String credentialType() { | ||
| return OSS_SECRET_KEY_CREDENTIAL_TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public long expireTimeInMs() { | ||
| return 0; | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, String> credentialInfo() { | ||
| return (new ImmutableMap.Builder<String, String>()) | ||
| .put(GRAVITINO_OSS_STATIC_ACCESS_KEY_ID, accessKeyId) | ||
| .put(GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY, secretAccessKey) | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Initialize the credential with the credential information. | ||
| * | ||
| * <p>This method is invoked to deserialize the credential in client side. | ||
| * | ||
| * @param credentialInfo The credential information from {@link #credentialInfo}. | ||
| * @param expireTimeInMs The expire-time from {@link #expireTimeInMs()}. | ||
| */ | ||
| @Override | ||
| public void initialize(Map<String, String> credentialInfo, long expireTimeInMs) { | ||
| String accessKeyId = credentialInfo.get(GRAVITINO_OSS_STATIC_ACCESS_KEY_ID); | ||
| String secretAccessKey = credentialInfo.get(GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY); | ||
| validate(accessKeyId, secretAccessKey, expireTimeInMs); | ||
| this.accessKeyId = accessKeyId; | ||
| this.secretAccessKey = secretAccessKey; | ||
| } | ||
|
|
||
| /** | ||
| * Get OSS static access key ID. | ||
| * | ||
| * @return The OSS access key ID. | ||
| */ | ||
| public String accessKeyId() { | ||
| return accessKeyId; | ||
| } | ||
|
|
||
| /** | ||
| * Get OSS static secret access key. | ||
| * | ||
| * @return The OSS secret access key. | ||
| */ | ||
| public String secretAccessKey() { | ||
| return secretAccessKey; | ||
| } | ||
|
|
||
| private void validate(String accessKeyId, String secretAccessKey, long expireTimeInMs) { | ||
| Preconditions.checkArgument( | ||
| StringUtils.isNotBlank(accessKeyId), "OSS access key Id should not empty"); | ||
| Preconditions.checkArgument( | ||
| StringUtils.isNotBlank(secretAccessKey), "OSS secret access key should not empty"); | ||
| Preconditions.checkArgument( | ||
| expireTimeInMs == 0, "The expire time of OSSSecretKeyCredential is not 0"); | ||
| } | ||
| } |
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
54 changes: 54 additions & 0 deletions
54
...aliyun-bundle/src/main/java/org/apache/gravitino/oss/credential/OSSSecretKeyProvider.java
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,54 @@ | ||
| /* | ||
| * 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.oss.credential; | ||
|
|
||
| import java.util.Map; | ||
| import org.apache.gravitino.credential.Credential; | ||
| import org.apache.gravitino.credential.CredentialContext; | ||
| import org.apache.gravitino.credential.CredentialProvider; | ||
| import org.apache.gravitino.credential.OSSSecretKeyCredential; | ||
| import org.apache.gravitino.credential.config.OSSCredentialConfig; | ||
|
|
||
| /** Generate OSS access key and secret key to access OSS data. */ | ||
| public class OSSSecretKeyProvider implements CredentialProvider { | ||
|
|
||
| private String accessKey; | ||
| private String secretKey; | ||
|
|
||
| @Override | ||
| public void initialize(Map<String, String> properties) { | ||
| OSSCredentialConfig ossCredentialConfig = new OSSCredentialConfig(properties); | ||
| this.accessKey = ossCredentialConfig.accessKeyID(); | ||
| this.secretKey = ossCredentialConfig.secretAccessKey(); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() {} | ||
|
|
||
| @Override | ||
| public String credentialType() { | ||
| return OSSSecretKeyCredential.OSS_SECRET_KEY_CREDENTIAL_TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public Credential getCredential(CredentialContext context) { | ||
| return new OSSSecretKeyCredential(accessKey, secretKey); | ||
| } | ||
| } |
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.