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

[#4994][#4369] feat(core): support S3 credential vending #4966

Merged
merged 10 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ public class GCSTokenCredential implements Credential {
/** GCS credential property, token name. */
public static final String GCS_TOKEN_NAME = "token";

private String token;
private long expireMs;
private final String token;
private final long expireMs;

/**
* @param token The GCS token.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
/*
* 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;

/** S3 secret key credential. */
public class S3SecretKeyCredential implements Credential {

/** S3 secret key credential type. */
public static final String S3_SECRET_KEY_CREDENTIAL_TYPE = "s3-secret-key";
/** The static access key ID used to access S3 data. */
public static final String GRAVITINO_S3_STATIC_ACCESS_KEY_ID = "s3-access-key-id";
/** The static secret access key used to access S3 data. */
public static final String GRAVITINO_S3_STATIC_SECRET_ACCESS_KEY = "s3-secret-access-key";

private final String accessKeyId;
private final String secretAccessKey;

/**
* Constructs an instance of {@link S3SecretKeyCredential} with the static S3 access key ID and
* secret access key.
*
* @param accessKeyId The S3 static access key ID.
* @param secretAccessKey The S3 static secret access key.
*/
public S3SecretKeyCredential(String accessKeyId, String secretAccessKey) {
Preconditions.checkNotNull(accessKeyId, "S3 access key Id should not null");
Preconditions.checkNotNull(secretAccessKey, "S3 secret access key should not null");

this.accessKeyId = accessKeyId;
this.secretAccessKey = secretAccessKey;
}

@Override
public String credentialType() {
return S3_SECRET_KEY_CREDENTIAL_TYPE;
}

@Override
public long expireTimeInMs() {
return 0;
}

@Override
public Map<String, String> credentialInfo() {
return (new ImmutableMap.Builder<String, String>())
.put(GRAVITINO_S3_STATIC_ACCESS_KEY_ID, accessKeyId)
.put(GRAVITINO_S3_STATIC_SECRET_ACCESS_KEY, secretAccessKey)
.build();
}

/**
* Get S3 static access key ID.
*
* @return The S3 access key ID.
*/
public String accessKeyId() {
return accessKeyId;
}

/**
* Get S3 static secret access key.
*
* @return The S3 secret access key.
*/
public String secretAccessKey() {
return secretAccessKey;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/*
* 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;

/** S3 token credential. */
public class S3TokenCredential implements Credential {

/** S3 token credential type. */
public static final String S3_TOKEN_CREDENTIAL_TYPE = "s3-token";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you mean about token and session-token?

Copy link
Collaborator

@jerqi jerqi Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I misunderstand this. I got it now.

/** S3 session access key ID used to access S3 data. */
public static final String GRAVITINO_S3_SESSION_ACCESS_KEY_ID = "s3-access-key-id";
/** S3 session secret access key used to access S3 data. */
public static final String GRAVITINO_S3_SESSION_SECRET_ACCESS_KEY = "s3-secret-access-key";
/** S3 session token. */
public static final String GRAVITINO_S3_TOKEN = "s3-session-token";

private final String accessKeyId;
private final String secretAccessKey;
private final String sessionToken;
private final long expireTimeInMS;

/**
* Constructs an instance of {@link S3SecretKeyCredential} with session secret key and token.
*
* @param accessKeyId The S3 session access key ID.
* @param secretAccessKey The S3 session secret access key.
* @param sessionToken The S3 session token.
* @param expireTimeInMS The S3 session token expire time in ms.
*/
public S3TokenCredential(
String accessKeyId, String secretAccessKey, String sessionToken, long expireTimeInMS) {
Preconditions.checkArgument(
StringUtils.isNotBlank(accessKeyId), "S3 access key Id should not be empty");
Preconditions.checkArgument(
StringUtils.isNotBlank(secretAccessKey), "S3 secret access key should not be empty");
Preconditions.checkArgument(
StringUtils.isNotBlank(sessionToken), "S3 session token should not be empty");

this.accessKeyId = accessKeyId;
this.secretAccessKey = secretAccessKey;
this.sessionToken = sessionToken;
this.expireTimeInMS = expireTimeInMS;
}

@Override
public String credentialType() {
return S3_TOKEN_CREDENTIAL_TYPE;
}

@Override
public long expireTimeInMs() {
return expireTimeInMS;
}

@Override
public Map<String, String> credentialInfo() {
return (new ImmutableMap.Builder<String, String>())
.put(GRAVITINO_S3_SESSION_ACCESS_KEY_ID, accessKeyId)
.put(GRAVITINO_S3_SESSION_SECRET_ACCESS_KEY, secretAccessKey)
.put(GRAVITINO_S3_TOKEN, sessionToken)
.build();
}

/**
* Get S3 session access key ID.
*
* @return The S3 access key ID.
*/
public String accessKeyId() {
return accessKeyId;
}

/**
* Get S3 session secret access key.
*
* @return The S3 secret access key.
*/
public String secretAccessKey() {
return secretAccessKey;
}

/**
* Get S3 session token.
*
* @return The S3 session token.
*/
public String sessionToken() {
return sessionToken;
}
}
7 changes: 7 additions & 0 deletions bundles/aws-bundle/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,15 @@ plugins {
}

dependencies {
compileOnly(project(":api"))
compileOnly(project(":core"))
compileOnly(project(":catalogs:catalog-common"))
compileOnly(project(":catalogs:catalog-hadoop"))
compileOnly(libs.hadoop3.common)

implementation(libs.aws.iam)
implementation(libs.aws.policy)
implementation(libs.aws.sts)
implementation(libs.hadoop3.aws)
}

Expand Down
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.s3.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.S3SecretKeyCredential;
import org.apache.gravitino.credential.config.S3CredentialConfig;

/** Generate S3 access key and secret key to access S3 data. */
public class S3SecretKeyProvider implements CredentialProvider {

private String accessKey;
private String secretKey;

@Override
public void initialize(Map<String, String> properties) {
S3CredentialConfig s3CredentialConfig = new S3CredentialConfig(properties);
this.accessKey = s3CredentialConfig.accessKeyID();
this.secretKey = s3CredentialConfig.secretAccessKey();
}

@Override
public void close() {}

@Override
public String credentialType() {
return S3SecretKeyCredential.S3_SECRET_KEY_CREDENTIAL_TYPE;
}

@Override
public Credential getCredential(CredentialContext context) {
return new S3SecretKeyCredential(accessKey, secretKey);
}
}
Loading
Loading