| package org.apache.hadoop.mapred; |
| |
| import java.net.InetAddress; |
| |
| import org.apache.commons.logging.Log; |
| import org.apache.commons.logging.LogFactory; |
| import org.apache.hadoop.ipc.Server; |
| |
| /** Manages MapReduce audit logs. Audit logs provides information about |
| * authorization/authentication events (success/failure). |
| * |
| * Audit log format is written as key=value pairs. |
| */ |
| class AuditLogger { |
| private static final Log LOG = LogFactory.getLog(AuditLogger.class); |
| |
| // Keys |
| static enum Keys {USER, OPERATION, TARGET, RESULT, IP, PERMISSIONS, |
| DESCRIPTION} |
| |
| static class Constants { |
| // Some constants used by AuditLogger itself. |
| static final String SUCCESS = "SUCCESS"; |
| static final String FAILURE = "FAILURE"; |
| static final String KEY_VAL_SEPARATOR = "="; |
| static final char PAIR_SEPARATOR = '\t'; |
| |
| // Some constants used by others using AuditLogger. |
| |
| // Some commonly used targets |
| static final String JOBTRACKER = "JobTracker"; |
| |
| // Some commonly used operations |
| static final String REFRESH_QUEUE = "REFRESH_QUEUE"; |
| static final String REFRESH_NODES = "REFRESH_NODES"; |
| |
| // Some commonly used descriptions |
| static final String UNAUTHORIZED_USER = "Unauthorized user"; |
| } |
| |
| /** |
| * A helper api for creating an audit log for a successful event. |
| * This is factored out for testing purpose. |
| */ |
| static String createSuccessLog(String user, String operation, String target) { |
| StringBuilder b = new StringBuilder(); |
| start(Keys.USER, user, b); |
| addRemoteIP(b); |
| add(Keys.OPERATION, operation, b); |
| add(Keys.TARGET, target ,b); |
| add(Keys.RESULT, Constants.SUCCESS, b); |
| return b.toString(); |
| } |
| |
| /** |
| * Create a readable and parseable audit log string for a successful event. |
| * |
| * @param user User who made the service request to the JobTracker. |
| * @param operation Operation requested by the user |
| * @param target The target on which the operation is being performed. Most |
| * commonly operated targets are jobs, JobTracker, queues etc |
| * |
| * <br><br> |
| * Note that the {@link AuditLogger} uses tabs ('\t') as a key-val delimiter |
| * and hence the value fields should not contains tabs ('\t'). |
| */ |
| static void logSuccess(String user, String operation, String target) { |
| LOG.info(createSuccessLog(user, operation, target)); |
| } |
| |
| /** |
| * A helper api for creating an audit log for a failure event. |
| * This is factored out for testing purpose. |
| */ |
| static String createFailureLog(String user, String operation, String perm, |
| String target, String description) { |
| StringBuilder b = new StringBuilder(); |
| start(Keys.USER, user, b); |
| addRemoteIP(b); |
| add(Keys.OPERATION, operation, b); |
| add(Keys.TARGET, target ,b); |
| add(Keys.RESULT, Constants.FAILURE, b); |
| add(Keys.DESCRIPTION, description, b); |
| add(Keys.PERMISSIONS, perm, b); |
| return b.toString(); |
| } |
| |
| /** |
| * Create a readable and parseable audit log string for a failed event. |
| * |
| * @param user User who made the service request to the JobTracker. |
| * @param operation Operation requested by the user |
| * @param perm Target permissions like JobACLs for jobs, QueueACLs for queues. |
| * @param target The target on which the operation is being performed. Most |
| * commonly operated targets are jobs, JobTracker, queues etc |
| * @param description Some additional information as to why the operation |
| * failed. |
| * |
| * <br><br> |
| * Note that the {@link AuditLogger} uses tabs ('\t') as a key-val delimiter |
| * and hence the value fields should not contains tabs ('\t'). |
| */ |
| static void logFailure(String user, String operation, String perm, |
| String target, String description) { |
| LOG.warn(createFailureLog(user, operation, perm, target, description)); |
| } |
| |
| // A helper api to add remote IP address |
| static void addRemoteIP(StringBuilder b) { |
| InetAddress ip = Server.getRemoteIp(); |
| // ip address can be null for testcases |
| if (ip != null) { |
| add(Keys.IP, ip.getHostAddress(), b); |
| } |
| } |
| |
| // Adds the first key-val pair to the passed builder in the following format |
| // key=value |
| static void start(Keys key, String value, StringBuilder b) { |
| b.append(key.name()).append(Constants.KEY_VAL_SEPARATOR).append(value); |
| } |
| |
| // Appends the key-val pair to the passed builder in the following format |
| // <pair-delim>key=value |
| static void add(Keys key, String value, StringBuilder b) { |
| b.append(Constants.PAIR_SEPARATOR).append(key.name()) |
| .append(Constants.KEY_VAL_SEPARATOR).append(value); |
| } |
| } |