|
| 1 | +/*- |
| 2 | + * #%L |
| 3 | + * athena-hbase |
| 4 | + * %% |
| 5 | + * Copyright (C) 2019 - 2024 Amazon Web Services |
| 6 | + * %% |
| 7 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | + * you may not use this file except in compliance with the License. |
| 9 | + * You may obtain a copy of the License at |
| 10 | + * |
| 11 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | + * |
| 13 | + * Unless required by applicable law or agreed to in writing, software |
| 14 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | + * See the License for the specific language governing permissions and |
| 17 | + * limitations under the License. |
| 18 | + * #L% |
| 19 | + */ |
| 20 | +package com.amazonaws.athena.connectors.hbase; |
| 21 | + |
| 22 | +import com.amazonaws.auth.AWSCredentials; |
| 23 | +import com.amazonaws.auth.AWSStaticCredentialsProvider; |
| 24 | +import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; |
| 25 | +import com.amazonaws.services.s3.AmazonS3; |
| 26 | +import com.amazonaws.services.s3.AmazonS3ClientBuilder; |
| 27 | +import com.amazonaws.services.s3.model.GetObjectRequest; |
| 28 | +import com.amazonaws.services.s3.model.ObjectListing; |
| 29 | +import com.amazonaws.services.s3.model.S3Object; |
| 30 | +import com.amazonaws.services.s3.model.S3ObjectSummary; |
| 31 | +import org.slf4j.Logger; |
| 32 | +import org.slf4j.LoggerFactory; |
| 33 | + |
| 34 | +import java.io.BufferedInputStream; |
| 35 | +import java.io.File; |
| 36 | +import java.io.InputStream; |
| 37 | +import java.nio.file.Files; |
| 38 | +import java.nio.file.Path; |
| 39 | +import java.nio.file.Paths; |
| 40 | +import java.nio.file.StandardCopyOption; |
| 41 | + |
| 42 | +public class HbaseKerberosUtils |
| 43 | +{ |
| 44 | + private static final Logger logger = LoggerFactory.getLogger(HbaseKerberosUtils.class); |
| 45 | + |
| 46 | + /** |
| 47 | + * For Kerberos authentication, user need to give S3 bucket reference where the config |
| 48 | + * files are uploaded. |
| 49 | + */ |
| 50 | + public static final String KERBEROS_CONFIG_FILES_S3_REFERENCE = "kerberos_config_files_s3_reference"; |
| 51 | + /** |
| 52 | + * This is temp folder where the kerberos config files from S3 will be downloaded |
| 53 | + */ |
| 54 | + public static final String TEMP_DIR = "/tmp"; |
| 55 | + public static final String PRINCIPAL_NAME = "principal_name"; |
| 56 | + public static final String HBASE_RPC_PROTECTION = "hbase_rpc_protection"; |
| 57 | + public static final String KERBEROS_AUTH_ENABLED = "kerberos_auth_enabled"; |
| 58 | + |
| 59 | + private HbaseKerberosUtils() {} |
| 60 | + |
| 61 | + /** |
| 62 | + * Downloads the config files from S3 to temp directory. |
| 63 | + * |
| 64 | + * @throws Exception - {@link Exception} |
| 65 | + */ |
| 66 | + public static Path copyConfigFilesFromS3ToTempFolder(java.util.Map<String, String> configOptions) throws Exception |
| 67 | + { |
| 68 | + logger.debug("Creating the connection with AWS S3 for copying config files to Temp Folder"); |
| 69 | + Path tempDir = getTempDirPath(); |
| 70 | + AWSCredentials credentials = new DefaultAWSCredentialsProviderChain().getCredentials(); |
| 71 | + AmazonS3 s3Client = AmazonS3ClientBuilder.standard(). |
| 72 | + withCredentials(new AWSStaticCredentialsProvider(credentials)). |
| 73 | + build(); |
| 74 | + |
| 75 | + String s3uri = getRequiredConfig(KERBEROS_CONFIG_FILES_S3_REFERENCE, configOptions); |
| 76 | + String[] s3Bucket = s3uri.split("s3://")[1].split("/"); |
| 77 | + |
| 78 | + ObjectListing objectListing = s3Client.listObjects(s3Bucket[0], s3Bucket[1]); |
| 79 | + |
| 80 | + for (S3ObjectSummary objectSummary : objectListing.getObjectSummaries()) { |
| 81 | + S3Object object = s3Client.getObject(new GetObjectRequest(s3Bucket[0], objectSummary.getKey())); |
| 82 | + InputStream inputStream = new BufferedInputStream(object.getObjectContent()); |
| 83 | + String key = objectSummary.getKey(); |
| 84 | + String fName = key.substring(key.indexOf('/') + 1); |
| 85 | + if (!fName.isEmpty()) { |
| 86 | + File file = new File(tempDir + File.separator + fName); |
| 87 | + Files.copy(inputStream, file.toPath(), StandardCopyOption.REPLACE_EXISTING); |
| 88 | + } |
| 89 | + } |
| 90 | + return tempDir; |
| 91 | + } |
| 92 | + |
| 93 | + /** |
| 94 | + * Creates the temp directory to put the kerberos auth config files. |
| 95 | + * |
| 96 | + * @return {@link Path} Temp directory path |
| 97 | + */ |
| 98 | + private static Path getTempDirPath() |
| 99 | + { |
| 100 | + Path tmpPath = Paths.get(TEMP_DIR).toAbsolutePath(); |
| 101 | + File filePath = new File(tmpPath + File.separator + "hbasekerberosconfigs"); |
| 102 | + if (filePath.exists()) { |
| 103 | + return filePath.toPath(); |
| 104 | + } |
| 105 | + boolean isCreated = filePath.mkdirs(); |
| 106 | + logger.info("Is new directory created? " + isCreated); |
| 107 | + return filePath.toPath(); |
| 108 | + } |
| 109 | + |
| 110 | + /** |
| 111 | + * Gets the environment variable. |
| 112 | + * |
| 113 | + * @param key - the config key |
| 114 | + * @return {@link String} |
| 115 | + */ |
| 116 | + private static String getRequiredConfig(String key, java.util.Map<String, String> configOptions) |
| 117 | + { |
| 118 | + String value = configOptions.getOrDefault(key, ""); |
| 119 | + if (value.isEmpty()) { |
| 120 | + throw new IllegalArgumentException("Lambda Environment Variable " + key + " has not been populated! "); |
| 121 | + } |
| 122 | + return value; |
| 123 | + } |
| 124 | +} |
0 commit comments