Skip to content
Open
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 @@ -114,6 +114,7 @@
import org.apache.hadoop.mapreduce.v2.app.rm.RMHeartbeatHandler;
import org.apache.hadoop.mapreduce.v2.app.rm.preemption.AMPreemptionPolicy;
import org.apache.hadoop.mapreduce.v2.app.rm.preemption.NoopAMPreemptionPolicy;
import org.apache.hadoop.mapreduce.v2.app.security.authorize.TaskLevelSecurityEnforcer;
import org.apache.hadoop.mapreduce.v2.app.speculate.DefaultSpeculator;
import org.apache.hadoop.mapreduce.v2.app.speculate.Speculator;
import org.apache.hadoop.mapreduce.v2.app.speculate.SpeculatorEvent;
Expand Down Expand Up @@ -1683,6 +1684,7 @@ public static void main(String[] args) {
String jobUserName = System
.getenv(ApplicationConstants.Environment.USER.name());
conf.set(MRJobConfig.USER_NAME, jobUserName);
TaskLevelSecurityEnforcer.validate(conf);
initAndStartAppMaster(appMaster, conf, jobUserName);
} catch (Throwable t) {
LOG.error("Error starting MRAppMaster", t);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/**
* 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.mapreduce.v2.app.security.authorize;

import java.util.Arrays;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.hadoop.mapred.JobConf;
import org.apache.hadoop.mapreduce.MRConfig;
import org.apache.hadoop.mapreduce.MRJobConfig;

/**
* Enforces task-level security rules for MapReduce jobs.
*
* <p>This security enforcement mechanism validates whether the user who submitted
* a job is allowed to execute the mapper/reducer/task classes defined in the job
* configuration. The check is performed inside the Application Master before
* task containers are launched.</p>
* <p>If the user is not on the allowed list and any job property within the configured
* security property domain references a denied class/prefix, a
* {@link TaskLevelSecurityException} is thrown and the job is rejected.</p>
* <p>This prevents unauthorized or unsafe custom code from running inside
* cluster containers.</p>
*/
public final class TaskLevelSecurityEnforcer {
private static final Logger LOG = LoggerFactory.getLogger(TaskLevelSecurityEnforcer.class);

/**
* Default constructor.
*/
private TaskLevelSecurityEnforcer() {
}

/**
* Validates a MapReduce job's configuration against the cluster's task-level
* security policy.
*
* <p>The method performs the following steps:</p>
* <ol>
* <li>Check whether task-level security is enabled.</li>
* <li>Allow the job immediately if the user is on the configured allowed-users list.</li>
* <li>Retrieve the security property domain (list of job configuration keys to inspect).</li>
* <li>Retrieve the list of denied task class prefixes.</li>
* <li>For each domain property, check whether its value begins with any denied prefix.</li>
* <li>If a match is found, reject the job by throwing {@link TaskLevelSecurityException}.</li>
* </ol>
*
* @param conf the job configuration to validate
* @throws TaskLevelSecurityException if the user is not authorized to use one of the task classes
*/
public static void validate(JobConf conf) throws TaskLevelSecurityException {
if (!conf.getBoolean(MRConfig.SECURITY_ENABLED, MRConfig.DEFAULT_SECURITY_ENABLED)) {
LOG.debug("The {} is disabled", MRConfig.SECURITY_ENABLED);
return;
}

String currentUser = conf.get(MRJobConfig.USER_NAME);
Copy link
Contributor

Choose a reason for hiding this comment

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

looking at JobSubmitter, this is set to UGI.currentUser.shortName. Is that enough? Shouldn't it be on fullName?
if so, JobSubmitter should add that as a property too

List<String> allowedUsers = Arrays.asList(conf.getTrimmedStrings(
MRConfig.SECURITY_ALLOWED_USERS,
MRConfig.DEFAULT_SECURITY_ALLOWED_USERS
));
if (allowedUsers.contains(currentUser)) {
LOG.debug("The {} is allowed to execute every task", currentUser);
return;
}

String[] propertyDomain = conf.getTrimmedStrings(
MRConfig.SECURITY_PROPERTY_DOMAIN,
MRConfig.DEFAULT_SECURITY_PROPERTY_DOMAIN
);
String[] deniedTasks = conf.getTrimmedStrings(
MRConfig.SECURITY_DENIED_TASKS,
MRConfig.DEFAULT_SECURITY_DENIED_TASKS
);
for (String property : propertyDomain) {
String propertyValue = conf.get(property, "");
for (String deniedTask : deniedTasks) {
if (propertyValue.startsWith(deniedTask)) {
throw new TaskLevelSecurityException(currentUser, property, propertyValue, deniedTask);
}
}
}
LOG.debug("The {} is allowed to execute the submitted job", currentUser);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/**
* 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.mapreduce.v2.app.security.authorize;

import org.apache.hadoop.security.AccessControlException;

/**
* Exception thrown when a MapReduce job violates the Task-Level Security policy.
*/
public class TaskLevelSecurityException extends AccessControlException {

/**
* Constructs a new TaskLevelSecurityException describing the specific policy violation.
*
* @param user the submitting user
* @param property the MapReduce configuration key that was checked
* @param propertyValue the value provided for that configuration property
* @param deniedTask the blacklist entry that the value matched
*/
public TaskLevelSecurityException(
String user, String property, String propertyValue, String deniedTask
) {
super(String.format(
"The %s is not allowed to use %s = %s config, cause it match with %s denied task",
user, property, propertyValue, deniedTask
));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
/**
* 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.mapreduce.v2.app.security.authorize;

import org.junit.jupiter.api.Test;

import org.apache.hadoop.mapred.JobConf;
import org.apache.hadoop.mapreduce.MRConfig;
import org.apache.hadoop.mapreduce.MRJobConfig;

import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class TestTaskLevelSecurityEnforcer {
Copy link
Contributor

Choose a reason for hiding this comment

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

extends 'AbstractHadoopTestBase`


@Test
public void testServiceDisabled() {
JobConf conf = new JobConf();
assertPass(conf);
}

@Test
public void testServiceEnabled() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, true);
assertPass(conf);
}

@Test
public void testDeniedPackage() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, true);
conf.setStrings(MRConfig.SECURITY_DENIED_TASKS, "org.apache.hadoop.streaming");
conf.set(MRJobConfig.MAP_CLASS_ATTR, "org.apache.hadoop.streaming.PipeMapper");
assertDenied(conf);
}

@Test
public void testDeniedClass() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, true);
conf.setStrings(MRConfig.SECURITY_DENIED_TASKS,
"org.apache.hadoop.streaming",
"org.apache.hadoop.examples.QuasiMonteCarlo$QmcReducer");
conf.set(MRJobConfig.REDUCE_CLASS_ATTR,
"org.apache.hadoop.examples.QuasiMonteCarlo$QmcReducer");
assertDenied(conf);
}

@Test
public void testIgnoreReducer() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, true);
conf.setStrings(MRConfig.SECURITY_PROPERTY_DOMAIN,
MRJobConfig.MAP_CLASS_ATTR,
MRJobConfig.COMBINE_CLASS_ATTR);
conf.setStrings(MRConfig.SECURITY_DENIED_TASKS,
"org.apache.hadoop.streaming",
"org.apache.hadoop.examples.QuasiMonteCarlo$QmcReducer");
conf.set(MRJobConfig.REDUCE_CLASS_ATTR,
"org.apache.hadoop.examples.QuasiMonteCarlo$QmcReducer");
assertPass(conf);
}

@Test
public void testDeniedUser() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, true);
conf.setStrings(MRConfig.SECURITY_DENIED_TASKS, "org.apache.hadoop.streaming");
conf.setStrings(MRConfig.SECURITY_ALLOWED_USERS, "alice");
conf.set(MRJobConfig.MAP_CLASS_ATTR, "org.apache.hadoop.streaming.PipeMapper");
conf.set(MRJobConfig.USER_NAME, "bob");
assertDenied(conf);
}

@Test
public void testAllowedUser() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, true);
conf.setStrings(MRConfig.SECURITY_DENIED_TASKS, "org.apache.hadoop.streaming");
conf.setStrings(MRConfig.SECURITY_ALLOWED_USERS, "alice", "bob");
conf.set(MRJobConfig.MAP_CLASS_ATTR, "org.apache.hadoop.streaming.PipeMapper");
conf.set(MRJobConfig.USER_NAME, "bob");
assertPass(conf);
}

@Test
public void testTurnOff() {
JobConf conf = new JobConf();
conf.setBoolean(MRConfig.SECURITY_ENABLED, false);
conf.setStrings(MRConfig.SECURITY_DENIED_TASKS, "org.apache.hadoop.streaming");
conf.setStrings(MRConfig.SECURITY_ALLOWED_USERS, "alice");
conf.set(MRJobConfig.MAP_CLASS_ATTR, "org.apache.hadoop.streaming.PipeMapper");
conf.set(MRJobConfig.USER_NAME, "bob");
assertPass(conf);
}

@Test
public void testJobConfigCanNotOverwriteMapreduceConfig() {
JobConf mapreduceConf = new JobConf();
mapreduceConf.setBoolean(MRConfig.SECURITY_ENABLED, true);
mapreduceConf.setStrings(MRConfig.SECURITY_DENIED_TASKS, "org.apache.hadoop.streaming");
mapreduceConf.setStrings(MRConfig.SECURITY_ALLOWED_USERS, "alice");

JobConf jobConf = new JobConf();
jobConf.setStrings(MRConfig.SECURITY_ALLOWED_USERS, "bob");
jobConf.set(MRJobConfig.MAP_CLASS_ATTR, "org.apache.hadoop.streaming.PipeMapper");
jobConf.set(MRJobConfig.USER_NAME, "bob");

mapreduceConf.addResource(jobConf);
assertDenied(mapreduceConf);
}

private void assertPass(JobConf conf) {
assertDoesNotThrow(
() -> TaskLevelSecurityEnforcer.validate(conf),
"Config denied but validation pass was expected");
}

private void assertDenied(JobConf conf) {
assertThrows(TaskLevelSecurityException.class,
() -> TaskLevelSecurityEnforcer.validate(conf),
"Config validation pass but denied was expected");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,82 @@ public interface MRConfig {
boolean DEFAULT_MASTER_WEBAPP_UI_ACTIONS_ENABLED = true;
String MULTIPLE_OUTPUTS_CLOSE_THREAD_COUNT = "mapreduce.multiple-outputs-close-threads";
int DEFAULT_MULTIPLE_OUTPUTS_CLOSE_THREAD_COUNT = 10;

/**
* Enables MapReduce Task-Level Security Enforcement.
*
* When enabled, the Application Master performs validation of user-submitted
* mapper, reducer, and other task-related classes before launching containers.
* This mechanism protects the cluster from running disallowed or unsafe task
* implementations as defined by administrator-controlled policies.
*
* Property type: boolean
* Default: false (security disabled)
*/
String SECURITY_ENABLED = "mapreduce.security.enabled";
boolean DEFAULT_SECURITY_ENABLED = false;

/**
* MapReduce Task-Level Security Enforcement: Property Domain
*
* Defines the set of MapReduce configuration keys that represent user-supplied
* class names involved in task execution (e.g., mapper, reducer, partitioner).
* The Application Master examines the values of these properties and checks
* whether any referenced class is listed in {@link #SECURITY_DENIED_TASKS}.
* Administrators may override this list to expand or restrict the validation
* domain.
*
* Property type: list of configuration keys
* Default: all known task-level class properties (see list below)
*/
String SECURITY_PROPERTY_DOMAIN = "mapreduce.security.property-domain";
String[] DEFAULT_SECURITY_PROPERTY_DOMAIN = {
"mapreduce.job.combine.class",
"mapreduce.job.combiner.group.comparator.class",
"mapreduce.job.end-notification.custom-notifier-class",
"mapreduce.job.inputformat.class",
"mapreduce.job.map.class",
"mapreduce.job.map.output.collector.class",
"mapreduce.job.output.group.comparator.class",
"mapreduce.job.output.key.class",
"mapreduce.job.output.key.comparator.class",
"mapreduce.job.output.value.class",
"mapreduce.job.outputformat.class",
"mapreduce.job.partitioner.class",
"mapreduce.job.reduce.class",
"mapreduce.map.output.key.class",
"mapreduce.map.output.value.class"
};

/**
* MapReduce Task-Level Security Enforcement: Denied Tasks
*
* Specifies the list of disallowed task implementation classes or packages.
* If a user submits a job whose mapper, reducer, or other task-related classes
* match any entry in this blacklist.
*
* Property type: list of class name or package patterns
* Default: empty (no restrictions)
* Example: org.apache.hadoop.streaming,org.apache.hadoop.examples.QuasiMonteCarlo
*/
String SECURITY_DENIED_TASKS = "mapreduce.security.denied-tasks";
String[] DEFAULT_SECURITY_DENIED_TASKS = {};

/**
* MapReduce Task-Level Security Enforcement: Allowed Users
*
* Specifies users who may bypass the blacklist defined in
* {@link #SECURITY_DENIED_TASKS}.
* This whitelist is intended for trusted or system-level workflows that may
* legitimately require the use of restricted task implementations.
* If the submitting user is listed here, blacklist enforcement is skipped,
* although standard Hadoop authentication and ACL checks still apply.
*
* Property type: list of usernames
* Default: empty (no bypass users)
* Example: hue,hive
*/
String SECURITY_ALLOWED_USERS = "mapreduce.security.allowed-users";
String[] DEFAULT_SECURITY_ALLOWED_USERS = {};
}

Loading
Loading