ChenSammi commented on code in PR #9239: URL: https://github.com/apache/ozone/pull/9239#discussion_r2532885225
########## hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/security/acl/iam/IamSessionPolicyResolver.java: ########## @@ -0,0 +1,329 @@ +/* + * 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.hadoop.ozone.security.acl.iam; + +import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.INVALID_REQUEST; +import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.NOT_SUPPORTED_OPERATION; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.Collections; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.Objects; +import java.util.Set; +import org.apache.commons.lang3.StringUtils; +import org.apache.hadoop.ozone.om.exceptions.OMException; +import org.apache.hadoop.ozone.security.acl.AssumeRoleRequest; + +/** + * Resolves a limited subset of AWS IAM session policies into Ozone ACL grants, + * according to either the RangerOzoneAuthorizer or OzoneNativeAuthorizer constructs. + * <p> + * Here are some differences between the RangerOzoneAuthorizer and OzoneNativeAuthorizer: + * - RangerOzoneAuthorizer doesn't currently use ResourceType.PREFIX, whereas OzoneNativeAuthorizer does. + * - OzoneNativeAuthorizer doesn't allow wildcards in bucket names (ex. ResourceArn `arn:aws:s3:::*`, + * `arn:aws:s3:::bucket*` or `*`), whereas RangerOzoneAuthorizer does. + * - For OzoneNativeAuthorizer, certain object wildcards are accepted. For example, ResourceArn + * `arn:aws:s3:::myBucket/*` and `arn:aws:s3:::myBucket/folder/logs/*` are accepted but not + * `arn:aws:s3:::myBucket/file*.txt`. + * <p> + * The only supported ResourceArn has prefix arn:aws:s3::: - all others will throw + * OMException with NOT_SUPPORTED_OPERATION. + * <p> + * The only supported Condition operator is StringEquals - all others will throw + * OMException with NOT_SUPPORTED_OPERATION. Furthermore, only one Condition is supported in a + * statement. + * <p> + * The only supported Condition attribute is s3:prefix - all others will throw + * OMException with NOT_SUPPORTED_OPERATION. + * <p> + * The only supported Effect is Allow - all others will throw OMException with NOT_SUPPORTED_OPERATION. + * <p> + * If a (currently) unsupported S3 action is requested, such as s3:GetAccelerateConfiguration, + * it will be silently ignored. + * <p> + * Supported wildcard expansions in Actions are: s3:*, s3:Get*, s3:Put*, s3:List*, + * s3:Create*, and s3:Delete*. + */ +public final class IamSessionPolicyResolver { + + private static final ObjectMapper MAPPER = new ObjectMapper(); + + private static final int MAX_JSON_LENGTH = 2048; + + private IamSessionPolicyResolver() { + } + + /** + * Resolves an S3 IAM session policy in the form of a JSON String to a data structure comprising + * the IOzoneObjs and permissions that IAM policy grants (if any). + * <p> + * Each entry represents a path (such as /s3v/bucket1 or /s3v/bucket1/*) and a set of + * permissions (such as READ, LIST, CREATE). + * <p> + * The OzoneObj can be different depending on the AuthorizerType (see main Javadoc at top of file + * for examples). + * <p> + * + * @param policyJson the IAM session policy + * @param volumeName the volume under which the resource(s) live. This may not be s3v in + * multi-tenant scenarios + * @param authorizerType whether the IOzoneObjs should be generated for use by the + * RangerOzoneAuthorizer or the OzoneNativeAuthorizer + * @return the data structure comprising the paths and permission pairings that + * the session policy grants (if any) + * @throws OMException if the policy JSON is invalid, malformed, or contains unsupported features + */ + public static Set<AssumeRoleRequest.OzoneGrant> resolve(String policyJson, String volumeName, + AuthorizerType authorizerType) throws OMException { + + validateInputParameters(policyJson, volumeName, authorizerType); + + final Set<AssumeRoleRequest.OzoneGrant> result = new LinkedHashSet<>(); + + // Parse JSON into set of statements + final Set<JsonNode> statements = parseJsonAndRetrieveStatements(policyJson); + + for (JsonNode stmt : statements) { + validateEffectInJsonStatement(stmt); + + final Set<String> actions = readStringOrArray(stmt.get("Action")); + final Set<String> resources = readStringOrArray(stmt.get("Resource")); + + // Parse prefixes from conditions, if any + final Set<String> prefixes = parsePrefixesFromConditions(stmt); + + // Map actions to S3Action enum if possible + final Set<S3Action> mappedS3Actions = mapPolicyActionsToS3Actions(actions); + if (mappedS3Actions.isEmpty()) { + // No actions recognized - no need to look at Resources for this Statement + continue; + } + + // Categorize resources according to bucket resource, object resource, etc + final Set<ResourceSpec> resourceSpecs = validateAndCategorizeResources(authorizerType, resources); + + // For each action, map to Ozone objects (paths) and acls based on resource specs and prefixes + final Set<AssumeRoleRequest.OzoneGrant> stmtResults = createPathsAndPermissions( + volumeName, authorizerType, mappedS3Actions, resourceSpecs, prefixes); + + result.addAll(stmtResults); + } + + return result; + } + + /** + * Ensures required input parameters are supplied. + */ + private static void validateInputParameters(String policyJson, String volumeName, + AuthorizerType authorizerType) throws OMException { + if (StringUtils.isBlank(policyJson)) { + throw new OMException("The IAM session policy JSON is required", INVALID_REQUEST); + } + + if (StringUtils.isBlank(volumeName)) { + throw new OMException("The volume name is required", INVALID_REQUEST); + } + + Objects.requireNonNull(authorizerType, "The authorizer type is required"); + + if (policyJson.length() > MAX_JSON_LENGTH) { + throw new OMException("Invalid policy JSON - exceeds maximum length of " + + MAX_JSON_LENGTH + " characters", INVALID_REQUEST); + } + } + + /** + * Parses IAM session policy and retrieve the statement(s). + */ + private static Set<JsonNode> parseJsonAndRetrieveStatements(String policyJson) throws OMException { + final JsonNode root; + try { + root = MAPPER.readTree(policyJson); + } catch (Exception e) { + throw new OMException("Invalid policy JSON (most likely JSON structure is incorrect)", e, INVALID_REQUEST); + } + + final JsonNode statementsNode = root.path("Statement"); + if (statementsNode.isMissingNode()) { + throw new OMException("Invalid policy JSON - missing Statement", INVALID_REQUEST); + } + + final Set<JsonNode> statements = new HashSet<>(); + + if (statementsNode.isArray()) { + statementsNode.forEach(statements::add); + } else { + statements.add(statementsNode); + } + return statements; + } + + /** + * Parses Effect from IAM session policy and ensures it is valid and supported. + */ + private static void validateEffectInJsonStatement(JsonNode statement) throws OMException { + final JsonNode effectNode = statement.get("Effect"); + if (effectNode != null) { + if (effectNode.isTextual()) { + final String effect = effectNode.asText(); + if (!"Allow".equalsIgnoreCase(effect)) { + throw new OMException("Unsupported Effect - " + effect, NOT_SUPPORTED_OPERATION); + } + return; + } + + throw new OMException( + "Invalid Effect in JSON policy (must be a String) - " + effectNode, INVALID_REQUEST); + } + + throw new OMException("Effect is missing from JSON policy", INVALID_REQUEST); + } + + /** + * Reads a JsonNode and converts to a Set of String, if the node represents + * a textual value or an array of textual values. Otherwise, returns + * an empty List. + */ + private static Set<String> readStringOrArray(JsonNode node) { + if (node == null || node.isMissingNode() || node.isNull()) { + return Collections.emptySet(); + } + if (node.isTextual()) { + return Collections.singleton(node.asText()); + } + if (node.isArray()) { + final Set<String> set = new HashSet<>(); + node.forEach(n -> { + if (n.isTextual()) { + set.add(n.asText()); + } + }); + return set; + } + + return Collections.emptySet(); + } + + /** + * Parses and returns prefixes from Conditions (if any). Also validates + * that if there is a Condition, there is only one and that the Condition + * operator and attribute are supported. + * <p> + * Only the StringEquals operator and s3:prefix attribute are supported. + */ + private static Set<String> parsePrefixesFromConditions(JsonNode stmt) throws OMException { + Set<String> prefixes = Collections.emptySet(); + final JsonNode cond = stmt.get("Condition"); + if (cond != null && !cond.isMissingNode() && !cond.isNull()) { + if (cond.size() != 1) { + throw new OMException("Only one Condition is supported", NOT_SUPPORTED_OPERATION); + } + + if (!cond.isObject()) { + throw new OMException( + "Invalid Condition (must have operator StringEquals " + "and attribute s3:prefix) - " + + cond, INVALID_REQUEST); + } + + final String operator = cond.fieldNames().next(); + if (!"StringEquals".equals(operator)) { + throw new OMException("Unsupported Condition operator - " + operator, NOT_SUPPORTED_OPERATION); + } + + final JsonNode attribute = cond.get("StringEquals"); + if ("null".equals(attribute.asText())) { + throw new OMException("Missing Condition attribute - StringEquals", INVALID_REQUEST); + } + + if (!attribute.isObject()) { + throw new OMException("Invalid Condition attribute structure - " + attribute, INVALID_REQUEST); + } + + final String attributeFieldName = attribute.fieldNames().hasNext() ? attribute.fieldNames().next() : null; + if (!"s3:prefix".equals(attributeFieldName)) { Review Comment: It's said that "Context key names are not case-sensitive." in https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html Can you double check it? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
