HBASE-19400 Add missing security checks in MasterRpcServices

- Added ADMIN permission check for following rpc calls:
  normalize, setNormalizerRunning, runCatalogScan, enableCatalogJanitor, runCleanerChore,
  setCleanerChoreRunning, execMasterService, execProcedure, execProcedureWithRet
- Moved authorizationEnabled check to start of AccessChecker's functions. Currently, and IDK why,
  we call authManager.authorize() first and then discard its result if authorizationEnabled is false. Weird.

----

HBASE-19401 Add missing security checks in RSRpcServices
This commit is contained in:
Apekshit Sharma 2018-02-13 12:33:43 -08:00
parent cdbf001d26
commit c4401b6073
8 changed files with 458 additions and 111 deletions

View File

@ -123,9 +123,7 @@ public class RSGroupAdminEndpoint extends RSGroupAdminService
@Override @Override
public void stop(CoprocessorEnvironment env) { public void stop(CoprocessorEnvironment env) {
if (accessChecker.getAuthManager() != null) { accessChecker.stop();
TableAuthManager.release(accessChecker.getAuthManager());
}
} }
@Override @Override

View File

@ -192,6 +192,7 @@ import org.apache.hadoop.hbase.regionserver.RSRpcServices;
import org.apache.hadoop.hbase.security.User; import org.apache.hadoop.hbase.security.User;
import org.apache.hadoop.hbase.security.access.AccessChecker; import org.apache.hadoop.hbase.security.access.AccessChecker;
import org.apache.hadoop.hbase.security.access.AccessController; import org.apache.hadoop.hbase.security.access.AccessController;
import org.apache.hadoop.hbase.security.access.Permission;
import org.apache.hadoop.hbase.security.visibility.VisibilityController; import org.apache.hadoop.hbase.security.visibility.VisibilityController;
import org.apache.hadoop.hbase.snapshot.ClientSnapshotDescriptionUtils; import org.apache.hadoop.hbase.snapshot.ClientSnapshotDescriptionUtils;
import org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils; import org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils;
@ -249,6 +250,24 @@ public class MasterRpcServices extends RSRpcServices
return new MasterAnnotationReadingPriorityFunction(this); return new MasterAnnotationReadingPriorityFunction(this);
} }
/**
* Checks for the following pre-checks in order:
* <ol>
* <li>Master is initialized</li>
* <li>Rpc caller has admin permissions</li>
* </ol>
* @param requestName name of rpc request. Used in reporting failures to provide context.
* @throws ServiceException If any of the above listed pre-check fails.
*/
private void rpcPreCheck(String requestName) throws ServiceException {
try {
master.checkInitialized();
requirePermission(requestName, Permission.Action.ADMIN);
} catch (IOException ioe) {
throw new ServiceException(ioe);
}
}
enum BalanceSwitchMode { enum BalanceSwitchMode {
SYNC, SYNC,
ASYNC ASYNC
@ -292,25 +311,6 @@ public class MasterRpcServices extends RSRpcServices
return switchBalancer(b, BalanceSwitchMode.SYNC); return switchBalancer(b, BalanceSwitchMode.SYNC);
} }
/**
* Sets normalizer on/off flag in ZK.
*/
public boolean normalizerSwitch(boolean on) {
boolean oldValue = master.getRegionNormalizerTracker().isNormalizerOn();
boolean newValue = on;
try {
try {
master.getRegionNormalizerTracker().setNormalizerOn(newValue);
} catch (KeeperException ke) {
throw new IOException(ke);
}
LOG.info(master.getClientIdAuditPrefix() + " set normalizerSwitch=" + newValue);
} catch (IOException ioe) {
LOG.warn("Error flipping normalizer switch", ioe);
}
return oldValue;
}
/** /**
* @return list of blocking services and their security info classes that this server supports * @return list of blocking services and their security info classes that this server supports
*/ */
@ -649,11 +649,7 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public EnableCatalogJanitorResponse enableCatalogJanitor(RpcController c, public EnableCatalogJanitorResponse enableCatalogJanitor(RpcController c,
EnableCatalogJanitorRequest req) throws ServiceException { EnableCatalogJanitorRequest req) throws ServiceException {
try { rpcPreCheck("enableCatalogJanitor");
master.checkInitialized();
} catch (IOException ioe) {
throw new ServiceException(ioe);
}
return EnableCatalogJanitorResponse.newBuilder().setPrevValue( return EnableCatalogJanitorResponse.newBuilder().setPrevValue(
master.catalogJanitorChore.setEnabled(req.getEnable())).build(); master.catalogJanitorChore.setEnabled(req.getEnable())).build();
} }
@ -661,11 +657,7 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public SetCleanerChoreRunningResponse setCleanerChoreRunning(RpcController c, public SetCleanerChoreRunningResponse setCleanerChoreRunning(RpcController c,
SetCleanerChoreRunningRequest req) throws ServiceException { SetCleanerChoreRunningRequest req) throws ServiceException {
try { rpcPreCheck("setCleanerChoreRunning");
master.checkInitialized();
} catch (IOException ioe) {
throw new ServiceException(ioe);
}
boolean prevValue = boolean prevValue =
master.getLogCleaner().getEnabled() && master.getHFileCleaner().getEnabled(); master.getLogCleaner().getEnabled() && master.getHFileCleaner().getEnabled();
master.getLogCleaner().setEnabled(req.getOn()); master.getLogCleaner().setEnabled(req.getOn());
@ -690,10 +682,9 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public ClientProtos.CoprocessorServiceResponse execMasterService(final RpcController controller, public ClientProtos.CoprocessorServiceResponse execMasterService(final RpcController controller,
final ClientProtos.CoprocessorServiceRequest request) throws ServiceException { final ClientProtos.CoprocessorServiceRequest request) throws ServiceException {
rpcPreCheck("execMasterService");
try { try {
master.checkInitialized();
ServerRpcController execController = new ServerRpcController(); ServerRpcController execController = new ServerRpcController();
ClientProtos.CoprocessorServiceCall call = request.getCall(); ClientProtos.CoprocessorServiceCall call = request.getCall();
String serviceName = call.getServiceName(); String serviceName = call.getServiceName();
String methodName = call.getMethodName(); String methodName = call.getMethodName();
@ -749,8 +740,8 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public ExecProcedureResponse execProcedure(RpcController controller, public ExecProcedureResponse execProcedure(RpcController controller,
ExecProcedureRequest request) throws ServiceException { ExecProcedureRequest request) throws ServiceException {
rpcPreCheck("execProcedure");
try { try {
master.checkInitialized();
ProcedureDescription desc = request.getProcedure(); ProcedureDescription desc = request.getProcedure();
MasterProcedureManager mpm = master.getMasterProcedureManagerHost().getProcedureManager( MasterProcedureManager mpm = master.getMasterProcedureManagerHost().getProcedureManager(
desc.getSignature()); desc.getSignature());
@ -758,12 +749,8 @@ public class MasterRpcServices extends RSRpcServices
throw new ServiceException("The procedure is not registered: " throw new ServiceException("The procedure is not registered: "
+ desc.getSignature()); + desc.getSignature());
} }
LOG.info(master.getClientIdAuditPrefix() + " procedure request for: " + desc.getSignature());
LOG.info(master.getClientIdAuditPrefix() + " procedure request for: "
+ desc.getSignature());
mpm.execProcedure(desc); mpm.execProcedure(desc);
// send back the max amount of time the client should wait for the procedure // send back the max amount of time the client should wait for the procedure
// to complete // to complete
long waitTime = SnapshotDescriptionUtils.DEFAULT_MAX_WAIT_TIME; long waitTime = SnapshotDescriptionUtils.DEFAULT_MAX_WAIT_TIME;
@ -784,21 +771,16 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public ExecProcedureResponse execProcedureWithRet(RpcController controller, public ExecProcedureResponse execProcedureWithRet(RpcController controller,
ExecProcedureRequest request) throws ServiceException { ExecProcedureRequest request) throws ServiceException {
rpcPreCheck("execProcedureWithRet");
try { try {
master.checkInitialized();
ProcedureDescription desc = request.getProcedure(); ProcedureDescription desc = request.getProcedure();
MasterProcedureManager mpm = master.getMasterProcedureManagerHost().getProcedureManager( MasterProcedureManager mpm =
desc.getSignature()); master.getMasterProcedureManagerHost().getProcedureManager(desc.getSignature());
if (mpm == null) { if (mpm == null) {
throw new ServiceException("The procedure is not registered: " throw new ServiceException("The procedure is not registered: " + desc.getSignature());
+ desc.getSignature());
} }
LOG.info(master.getClientIdAuditPrefix() + " procedure request for: " + desc.getSignature());
LOG.info(master.getClientIdAuditPrefix() + " procedure request for: "
+ desc.getSignature());
byte[] data = mpm.execProcedureWithRet(desc); byte[] data = mpm.execProcedureWithRet(desc);
ExecProcedureResponse.Builder builder = ExecProcedureResponse.newBuilder(); ExecProcedureResponse.Builder builder = ExecProcedureResponse.newBuilder();
// set return data if available // set return data if available
if (data != null) { if (data != null) {
@ -1110,8 +1092,7 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public AbortProcedureResponse abortProcedure( public AbortProcedureResponse abortProcedure(
RpcController rpcController, RpcController rpcController, AbortProcedureRequest request) throws ServiceException {
AbortProcedureRequest request) throws ServiceException {
try { try {
AbortProcedureResponse.Builder response = AbortProcedureResponse.newBuilder(); AbortProcedureResponse.Builder response = AbortProcedureResponse.newBuilder();
boolean abortResult = boolean abortResult =
@ -1362,8 +1343,8 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public RunCatalogScanResponse runCatalogScan(RpcController c, public RunCatalogScanResponse runCatalogScan(RpcController c,
RunCatalogScanRequest req) throws ServiceException { RunCatalogScanRequest req) throws ServiceException {
rpcPreCheck("runCatalogScan");
try { try {
master.checkInitialized();
return ResponseConverter.buildRunCatalogScanResponse(master.catalogJanitorChore.scan()); return ResponseConverter.buildRunCatalogScanResponse(master.catalogJanitorChore.scan());
} catch (IOException ioe) { } catch (IOException ioe) {
throw new ServiceException(ioe); throw new ServiceException(ioe);
@ -1373,14 +1354,9 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public RunCleanerChoreResponse runCleanerChore(RpcController c, RunCleanerChoreRequest req) public RunCleanerChoreResponse runCleanerChore(RpcController c, RunCleanerChoreRequest req)
throws ServiceException { throws ServiceException {
try { rpcPreCheck("runCleanerChore");
master.checkInitialized(); Boolean result = master.getHFileCleaner().runCleaner() && master.getLogCleaner().runCleaner();
Boolean result = master.getHFileCleaner().runCleaner()
&& master.getLogCleaner().runCleaner();
return ResponseConverter.buildRunCleanerChoreResponse(result); return ResponseConverter.buildRunCleanerChoreResponse(result);
} catch (IOException ioe) {
throw new ServiceException(ioe);
}
} }
@Override @Override
@ -1614,6 +1590,7 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public NormalizeResponse normalize(RpcController controller, public NormalizeResponse normalize(RpcController controller,
NormalizeRequest request) throws ServiceException { NormalizeRequest request) throws ServiceException {
rpcPreCheck("normalize");
try { try {
return NormalizeResponse.newBuilder().setNormalizerRan(master.normalizeRegions()).build(); return NormalizeResponse.newBuilder().setNormalizerRan(master.normalizeRegions()).build();
} catch (IOException | CoordinatedStateException ex) { } catch (IOException | CoordinatedStateException ex) {
@ -1624,13 +1601,18 @@ public class MasterRpcServices extends RSRpcServices
@Override @Override
public SetNormalizerRunningResponse setNormalizerRunning(RpcController controller, public SetNormalizerRunningResponse setNormalizerRunning(RpcController controller,
SetNormalizerRunningRequest request) throws ServiceException { SetNormalizerRunningRequest request) throws ServiceException {
rpcPreCheck("setNormalizerRunning");
// Sets normalizer on/off flag in ZK.
boolean prevValue = master.getRegionNormalizerTracker().isNormalizerOn();
boolean newValue = request.getOn();
try { try {
master.checkInitialized(); master.getRegionNormalizerTracker().setNormalizerOn(newValue);
boolean prevValue = normalizerSwitch(request.getOn()); } catch (KeeperException ke) {
return SetNormalizerRunningResponse.newBuilder().setPrevNormalizerValue(prevValue).build(); LOG.warn("Error flipping normalizer switch", ke);
} catch (IOException ioe) {
throw new ServiceException(ioe);
} }
LOG.info(master.getClientIdAuditPrefix() + " set normalizerSwitch=" + newValue);
return SetNormalizerRunningResponse.newBuilder().setPrevNormalizerValue(prevValue).build();
} }
@Override @Override

View File

@ -625,7 +625,7 @@ public class HRegionServer extends HasThread implements
} }
this.configurationManager = new ConfigurationManager(); this.configurationManager = new ConfigurationManager();
rpcServices.start(); rpcServices.start(zooKeeper);
putUpWebUI(); putUpWebUI();
this.walRoller = new LogRoller(this, this); this.walRoller = new LogRoller(this, this);
this.choreService = new ChoreService(getServerName().toString(), true); this.choreService = new ChoreService(getServerName().toString(), true);

View File

@ -187,6 +187,8 @@ import org.apache.hadoop.hbase.regionserver.handler.OpenPriorityRegionHandler;
import org.apache.hadoop.hbase.regionserver.handler.OpenRegionHandler; import org.apache.hadoop.hbase.regionserver.handler.OpenRegionHandler;
import org.apache.hadoop.hbase.regionserver.wal.WALEdit; import org.apache.hadoop.hbase.regionserver.wal.WALEdit;
import org.apache.hadoop.hbase.security.User; import org.apache.hadoop.hbase.security.User;
import org.apache.hadoop.hbase.security.access.AccessChecker;
import org.apache.hadoop.hbase.security.access.Permission;
import org.apache.hadoop.hbase.util.Bytes; import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.hbase.util.Counter; import org.apache.hadoop.hbase.util.Counter;
import org.apache.hadoop.hbase.util.DNS; import org.apache.hadoop.hbase.util.DNS;
@ -198,6 +200,7 @@ import org.apache.hadoop.hbase.wal.WAL;
import org.apache.hadoop.hbase.wal.WALKey; import org.apache.hadoop.hbase.wal.WALKey;
import org.apache.hadoop.hbase.wal.WALSplitter; import org.apache.hadoop.hbase.wal.WALSplitter;
import org.apache.hadoop.hbase.zookeeper.ZKSplitLog; import org.apache.hadoop.hbase.zookeeper.ZKSplitLog;
import org.apache.hadoop.hbase.zookeeper.ZooKeeperWatcher;
import org.apache.zookeeper.KeeperException; import org.apache.zookeeper.KeeperException;
/** /**
@ -286,6 +289,13 @@ public class RSRpcServices implements HBaseRPCErrorHandler,
*/ */
private final int rowSizeWarnThreshold; private final int rowSizeWarnThreshold;
// We want to vet all accesses at the point of entry itself; limiting scope of access checker
// instance to only this class to prevent its use from spreading deeper into implementation.
// Initialized in start() since AccessChecker needs ZKWatcher which is created by HRegionServer
// after RSRpcServices constructor and before start() is called.
// Initialized only if authorization is enabled, else remains null.
private AccessChecker accessChecker;
/** /**
* Holder class which holds the RegionScanner, nextCallSeq and RpcCallbacks together. * Holder class which holds the RegionScanner, nextCallSeq and RpcCallbacks together.
*/ */
@ -372,6 +382,24 @@ public class RSRpcServices implements HBaseRPCErrorHandler,
return builder.setIndex(index).build(); return builder.setIndex(index).build();
} }
/**
* Checks for the following pre-checks in order:
* <ol>
* <li>RegionServer is running</li>
* <li>If authorization is enabled, then RPC caller has ADMIN permissions</li>
* </ol>
* @param requestName name of rpc request. Used in reporting failures to provide context.
* @throws ServiceException If any of the above listed pre-check fails.
*/
private void rpcPreCheck(String requestName) throws ServiceException {
try {
checkOpen();
requirePermission(requestName, Permission.Action.ADMIN);
} catch (IOException ioe) {
throw new ServiceException(ioe);
}
}
/** /**
* Starts the nonce operation for a mutation, if needed. * Starts the nonce operation for a mutation, if needed.
* @param mutation Mutation. * @param mutation Mutation.
@ -1166,6 +1194,13 @@ public class RSRpcServices implements HBaseRPCErrorHandler,
return new AnnotationReadingPriorityFunction(this); return new AnnotationReadingPriorityFunction(this);
} }
protected void requirePermission(String request, Permission.Action perm) throws IOException {
if (accessChecker != null) {
accessChecker.requirePermission(RpcServer.getRequestUser(), request, perm);
}
}
public static String getHostname(Configuration conf, boolean isMaster) public static String getHostname(Configuration conf, boolean isMaster)
throws UnknownHostException { throws UnknownHostException {
String hostname = conf.get(isMaster? HRegionServer.MASTER_HOSTNAME_KEY : String hostname = conf.get(isMaster? HRegionServer.MASTER_HOSTNAME_KEY :
@ -1289,21 +1324,26 @@ public class RSRpcServices implements HBaseRPCErrorHandler,
return regionServer.getRegionServerQuotaManager(); return regionServer.getRegionServerQuotaManager();
} }
void start() { void start(ZooKeeperWatcher zkWatcher) {
if (AccessChecker.isAuthorizationSupported(getConfiguration())) {
accessChecker = new AccessChecker(getConfiguration(), zkWatcher);
}
this.scannerIdGenerator = new ScannerIdGenerator(this.regionServer.serverName); this.scannerIdGenerator = new ScannerIdGenerator(this.regionServer.serverName);
rpcServer.start(); rpcServer.start();
} }
void stop() { void stop() {
if (accessChecker != null) {
accessChecker.stop();
}
closeAllScanners(); closeAllScanners();
rpcServer.stop(); rpcServer.stop();
} }
/** /**
* Called to verify that this server is up and running. * Called to verify that this server is up and running.
*
* @throws IOException
*/ */
// TODO : Rename this and HMaster#checkInitialized to isRunning() (or a better name).
protected void checkOpen() throws IOException { protected void checkOpen() throws IOException {
if (regionServer.isAborted()) { if (regionServer.isAborted()) {
throw new RegionServerAbortedException("Server " + regionServer.serverName + " aborting"); throw new RegionServerAbortedException("Server " + regionServer.serverName + " aborting");
@ -3192,6 +3232,7 @@ public class RSRpcServices implements HBaseRPCErrorHandler,
@Override @Override
public CoprocessorServiceResponse execRegionServerService(RpcController controller, public CoprocessorServiceResponse execRegionServerService(RpcController controller,
CoprocessorServiceRequest request) throws ServiceException { CoprocessorServiceRequest request) throws ServiceException {
rpcPreCheck("execRegionServerService");
return regionServer.execRegionServerService(controller, request); return regionServer.execRegionServerService(controller, request);
} }

View File

@ -38,6 +38,9 @@ import org.slf4j.LoggerFactory;
public final class AccessChecker { public final class AccessChecker {
private static final Logger AUDITLOG = private static final Logger AUDITLOG =
LoggerFactory.getLogger("SecurityLogger." + AccessChecker.class.getName()); LoggerFactory.getLogger("SecurityLogger." + AccessChecker.class.getName());
// TODO: we should move to a design where we don't even instantiate an AccessChecker if
// authorization is not enabled (like in RSRpcServices), instead of always instantiating one and
// calling requireXXX() only to do nothing (since authorizationEnabled will be false).
private TableAuthManager authManager; private TableAuthManager authManager;
/** /**
* if we are active, usually false, only true if "hbase.security.authorization" * if we are active, usually false, only true if "hbase.security.authorization"
@ -57,8 +60,6 @@ public final class AccessChecker {
*/ */
public AccessChecker(final Configuration conf, final ZooKeeperWatcher zkw) public AccessChecker(final Configuration conf, final ZooKeeperWatcher zkw)
throws RuntimeException { throws RuntimeException {
// If zk is null or IOException while obtaining auth manager,
// throw RuntimeException so that the coprocessor is unloaded.
if (zkw != null) { if (zkw != null) {
try { try {
this.authManager = TableAuthManager.getOrCreate(zkw, conf); this.authManager = TableAuthManager.getOrCreate(zkw, conf);
@ -71,6 +72,13 @@ public final class AccessChecker {
authorizationEnabled = isAuthorizationSupported(conf); authorizationEnabled = isAuthorizationSupported(conf);
} }
/**
* Releases {@link TableAuthManager}'s reference.
*/
public void stop() {
TableAuthManager.release(authManager);
}
public TableAuthManager getAuthManager() { public TableAuthManager getAuthManager() {
return authManager; return authManager;
} }
@ -159,6 +167,9 @@ public final class AccessChecker {
*/ */
public void requireAccess(User user, String request, TableName tableName, public void requireAccess(User user, String request, TableName tableName,
Action... permissions) throws IOException { Action... permissions) throws IOException {
if (!authorizationEnabled) {
return;
}
AuthResult result = null; AuthResult result = null;
for (Action permission : permissions) { for (Action permission : permissions) {
@ -173,7 +184,7 @@ public final class AccessChecker {
} }
} }
logResult(result); logResult(result);
if (authorizationEnabled && !result.isAllowed()) { if (!result.isAllowed()) {
throw new AccessDeniedException("Insufficient permissions " + result.toContextString()); throw new AccessDeniedException("Insufficient permissions " + result.toContextString());
} }
} }
@ -198,7 +209,10 @@ public final class AccessChecker {
*/ */
public void requireGlobalPermission(User user, String request, Action perm, TableName tableName, public void requireGlobalPermission(User user, String request, Action perm, TableName tableName,
Map<byte[], ? extends Collection<byte[]>> familyMap) throws IOException { Map<byte[], ? extends Collection<byte[]>> familyMap) throws IOException {
AuthResult result = null; if (!authorizationEnabled) {
return;
}
AuthResult result;
if (authManager.authorize(user, perm)) { if (authManager.authorize(user, perm)) {
result = AuthResult.allow(request, "Global check allowed", user, perm, tableName, familyMap); result = AuthResult.allow(request, "Global check allowed", user, perm, tableName, familyMap);
result.getParams().setTableName(tableName).setFamilies(familyMap); result.getParams().setTableName(tableName).setFamilies(familyMap);
@ -207,11 +221,9 @@ public final class AccessChecker {
result = AuthResult.deny(request, "Global check failed", user, perm, tableName, familyMap); result = AuthResult.deny(request, "Global check failed", user, perm, tableName, familyMap);
result.getParams().setTableName(tableName).setFamilies(familyMap); result.getParams().setTableName(tableName).setFamilies(familyMap);
logResult(result); logResult(result);
if (authorizationEnabled) { throw new AccessDeniedException(
throw new AccessDeniedException("Insufficient permissions for user '" + "Insufficient permissions for user '" + (user != null ? user.getShortName() : "null")
(user != null ? user.getShortName() : "null") +"' (global, action=" + + "' (global, action=" + perm.toString() + ")");
perm.toString() + ")");
}
} }
} }
@ -224,7 +236,10 @@ public final class AccessChecker {
*/ */
public void requireGlobalPermission(User user, String request, Action perm, public void requireGlobalPermission(User user, String request, Action perm,
String namespace) throws IOException { String namespace) throws IOException {
AuthResult authResult = null; if (!authorizationEnabled) {
return;
}
AuthResult authResult;
if (authManager.authorize(user, perm)) { if (authManager.authorize(user, perm)) {
authResult = AuthResult.allow(request, "Global check allowed", user, perm, null); authResult = AuthResult.allow(request, "Global check allowed", user, perm, null);
authResult.getParams().setNamespace(namespace); authResult.getParams().setNamespace(namespace);
@ -233,11 +248,9 @@ public final class AccessChecker {
authResult = AuthResult.deny(request, "Global check failed", user, perm, null); authResult = AuthResult.deny(request, "Global check failed", user, perm, null);
authResult.getParams().setNamespace(namespace); authResult.getParams().setNamespace(namespace);
logResult(authResult); logResult(authResult);
if (authorizationEnabled) { throw new AccessDeniedException(
throw new AccessDeniedException("Insufficient permissions for user '" + "Insufficient permissions for user '" + (user != null ? user.getShortName() : "null")
(user != null ? user.getShortName() : "null") +"' (global, action=" + + "' (global, action=" + perm.toString() + ")");
perm.toString() + ")");
}
} }
} }
@ -248,23 +261,24 @@ public final class AccessChecker {
*/ */
public void requireNamespacePermission(User user, String request, String namespace, public void requireNamespacePermission(User user, String request, String namespace,
Action... permissions) throws IOException { Action... permissions) throws IOException {
if (!authorizationEnabled) {
return;
}
AuthResult result = null; AuthResult result = null;
for (Action permission : permissions) { for (Action permission : permissions) {
if (authManager.authorize(user, namespace, permission)) { if (authManager.authorize(user, namespace, permission)) {
result = AuthResult.allow(request, "Namespace permission granted", result =
user, permission, namespace); AuthResult.allow(request, "Namespace permission granted", user, permission, namespace);
break; break;
} else { } else {
// rest of the world // rest of the world
result = AuthResult.deny(request, "Insufficient permissions", user, result = AuthResult.deny(request, "Insufficient permissions", user, permission, namespace);
permission, namespace);
} }
} }
logResult(result); logResult(result);
if (authorizationEnabled && !result.isAllowed()) { if (!result.isAllowed()) {
throw new AccessDeniedException("Insufficient permissions " throw new AccessDeniedException("Insufficient permissions " + result.toContextString());
+ result.toContextString());
} }
} }
@ -273,28 +287,29 @@ public final class AccessChecker {
* @param namespace The given namespace * @param namespace The given namespace
* @param permissions Actions being requested * @param permissions Actions being requested
*/ */
public void requireNamespacePermission(User user, String request, String namespace, TableName tableName, public void requireNamespacePermission(User user, String request, String namespace,
Map<byte[], ? extends Collection<byte[]>> familyMap, Action... permissions) TableName tableName, Map<byte[], ? extends Collection<byte[]>> familyMap,
throws IOException { Action... permissions) throws IOException {
if (!authorizationEnabled) {
return;
}
AuthResult result = null; AuthResult result = null;
for (Action permission : permissions) { for (Action permission : permissions) {
if (authManager.authorize(user, namespace, permission)) { if (authManager.authorize(user, namespace, permission)) {
result = AuthResult.allow(request, "Namespace permission granted", result =
user, permission, namespace); AuthResult.allow(request, "Namespace permission granted", user, permission, namespace);
result.getParams().setTableName(tableName).setFamilies(familyMap); result.getParams().setTableName(tableName).setFamilies(familyMap);
break; break;
} else { } else {
// rest of the world // rest of the world
result = AuthResult.deny(request, "Insufficient permissions", user, result = AuthResult.deny(request, "Insufficient permissions", user, permission, namespace);
permission, namespace);
result.getParams().setTableName(tableName).setFamilies(familyMap); result.getParams().setTableName(tableName).setFamilies(familyMap);
} }
} }
logResult(result); logResult(result);
if (authorizationEnabled && !result.isAllowed()) { if (!result.isAllowed()) {
throw new AccessDeniedException("Insufficient permissions " throw new AccessDeniedException("Insufficient permissions " + result.toContextString());
+ result.toContextString());
} }
} }
} }

View File

@ -846,15 +846,14 @@ public class AccessController extends BaseMasterAndRegionObserver
// set the user-provider. // set the user-provider.
this.userProvider = UserProvider.instantiate(env.getConfiguration()); this.userProvider = UserProvider.instantiate(env.getConfiguration());
// Throws RuntimeException if fails to load TableAuthManager so that coprocessor is unloaded.
accessChecker = new AccessChecker(env.getConfiguration(), zk); accessChecker = new AccessChecker(env.getConfiguration(), zk);
tableAcls = new MapMaker().weakValues().makeMap(); tableAcls = new MapMaker().weakValues().makeMap();
} }
@Override @Override
public void stop(CoprocessorEnvironment env) { public void stop(CoprocessorEnvironment env) {
if (getAuthManager()!= null) { accessChecker.stop();
TableAuthManager.release(getAuthManager());
}
} }
@Override @Override

View File

@ -217,15 +217,16 @@ public class TestAccessController extends SecureTestUtil {
conf.setBoolean(AccessControlConstants.EXEC_PERMISSION_CHECKS_KEY, true); conf.setBoolean(AccessControlConstants.EXEC_PERMISSION_CHECKS_KEY, true);
TEST_UTIL.startMiniCluster(); TEST_UTIL.startMiniCluster();
MasterCoprocessorHost cpHost = MasterCoprocessorHost masterCpHost =
TEST_UTIL.getMiniHBaseCluster().getMaster().getMasterCoprocessorHost(); TEST_UTIL.getMiniHBaseCluster().getMaster().getMasterCoprocessorHost();
cpHost.load(AccessController.class, Coprocessor.PRIORITY_HIGHEST, conf); masterCpHost.load(AccessController.class, Coprocessor.PRIORITY_HIGHEST, conf);
ACCESS_CONTROLLER = (AccessController) cpHost.findCoprocessor(AccessController.class.getName()); ACCESS_CONTROLLER = (AccessController) masterCpHost.findCoprocessor(
CP_ENV = cpHost.createEnvironment(AccessController.class, ACCESS_CONTROLLER, AccessController.class.getName());
CP_ENV = masterCpHost.createEnvironment(AccessController.class, ACCESS_CONTROLLER,
Coprocessor.PRIORITY_HIGHEST, 1, conf); Coprocessor.PRIORITY_HIGHEST, 1, conf);
RegionServerCoprocessorHost rsHost = TEST_UTIL.getMiniHBaseCluster().getRegionServer(0) RegionServerCoprocessorHost rsCpHost = TEST_UTIL.getMiniHBaseCluster().getRegionServer(0)
.getRegionServerCoprocessorHost(); .getRegionServerCoprocessorHost();
RSCP_ENV = rsHost.createEnvironment(AccessController.class, ACCESS_CONTROLLER, RSCP_ENV = rsCpHost.createEnvironment(AccessController.class, ACCESS_CONTROLLER,
Coprocessor.PRIORITY_HIGHEST, 1, conf); Coprocessor.PRIORITY_HIGHEST, 1, conf);
// Wait for the ACL table to become available // Wait for the ACL table to become available

View File

@ -0,0 +1,311 @@
/**
* 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.hbase.security.access;
import static org.apache.hadoop.hbase.AuthUtil.toGroupEntry;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import com.google.protobuf.Service;
import com.google.protobuf.ServiceException;
import java.io.IOException;
import java.security.PrivilegedExceptionAction;
import java.util.HashMap;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.Coprocessor;
import org.apache.hadoop.hbase.CoprocessorEnvironment;
import org.apache.hadoop.hbase.HBaseTestingUtility;
import org.apache.hadoop.hbase.ServerName;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.client.Admin;
import org.apache.hadoop.hbase.client.Connection;
import org.apache.hadoop.hbase.client.ConnectionFactory;
import org.apache.hadoop.hbase.coprocessor.CoprocessorHost;
import org.apache.hadoop.hbase.coprocessor.CoprocessorService;
import org.apache.hadoop.hbase.coprocessor.SingletonCoprocessorService;
import org.apache.hadoop.hbase.ipc.protobuf.generated.TestProtos;
import org.apache.hadoop.hbase.ipc.protobuf.generated.TestRpcServiceProtos;
import org.apache.hadoop.hbase.security.AccessDeniedException;
import org.apache.hadoop.hbase.security.User;
import org.apache.hadoop.hbase.testclassification.MediumTests;
import org.apache.hadoop.hbase.testclassification.SecurityTests;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.experimental.categories.Category;
/**
* This class tests operations in MasterRpcServices which require ADMIN access.
* It doesn't test all operations which require ADMIN access, only those which get vetted within
* MasterRpcServices at the point of entry itself (unlike old approach of using
* hooks in AccessController).
*
* Sidenote:
* There is one big difference between how security tests for AccessController hooks work, and how
* the tests in this class for security in MasterRpcServices work.
* The difference arises because of the way AC & MasterRpcServices get the user.
*
* In AccessController, it first checks if there is an active rpc user in ObserverContext. If not,
* it uses UserProvider for current user. This *might* make sense in the context of coprocessors,
* because they can be called outside the context of RPCs.
* But in the context of MasterRpcServices, only one way makes sense - RPCServer.getRequestUser().
*
* In AC tests, when we do FooUser.runAs on AccessController instance directly, it bypasses
* the rpc framework completely, but works because UserProvider provides the correct user, i.e.
* FooUser in this case.
*
* But this doesn't work for the tests here, so we go around by doing complete RPCs.
*/
@Category({SecurityTests.class, MediumTests.class})
public class TestAdminOnlyOperations {
private final static HBaseTestingUtility TEST_UTIL = new HBaseTestingUtility();
private static Configuration conf;
// user granted with all global permission
private static User USER_ADMIN;
// user without admin permissions
private static User USER_NON_ADMIN;
private static final String GROUP_ADMIN = "admin_group";
private static User USER_GROUP_ADMIN;
// Dummy service to test execService calls. Needs to be public so can be loaded as Coprocessor.
public static class DummyCpService implements Coprocessor, CoprocessorService,
SingletonCoprocessorService {
public DummyCpService() {}
public void start(CoprocessorEnvironment env) {}
public void stop(CoprocessorEnvironment env) {}
@Override
public Service getService() {
return mock(TestRpcServiceProtos.TestProtobufRpcProto.class);
}
}
private static void enableSecurity(Configuration conf) throws IOException {
conf.set("hadoop.security.authorization", "false");
conf.set("hadoop.security.authentication", "simple");
conf.set(CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY, AccessController.class.getName() +
"," + DummyCpService.class.getName());
conf.set(CoprocessorHost.REGION_COPROCESSOR_CONF_KEY, AccessController.class.getName());
conf.set(CoprocessorHost.REGIONSERVER_COPROCESSOR_CONF_KEY, AccessController.class.getName() +
"," + DummyCpService.class.getName());
conf.set(User.HBASE_SECURITY_AUTHORIZATION_CONF_KEY, "true");
SecureTestUtil.configureSuperuser(conf);
}
@BeforeClass
public static void setup() throws Exception {
conf = TEST_UTIL.getConfiguration();
// Enable security
enableSecurity(conf);
TEST_UTIL.startMiniCluster();
// Wait for the ACL table to become available
TEST_UTIL.waitUntilAllRegionsAssigned(AccessControlLists.ACL_TABLE_NAME);
// Create users
USER_ADMIN = User.createUserForTesting(conf, "admin", new String[0]);
USER_NON_ADMIN = User.createUserForTesting(conf, "non_admin", new String[0]);
USER_GROUP_ADMIN =
User.createUserForTesting(conf, "user_group_admin", new String[] { GROUP_ADMIN });
// Assign permissions to users and groups
SecureTestUtil.grantGlobal(TEST_UTIL, USER_ADMIN.getShortName(), Permission.Action.ADMIN);
SecureTestUtil.grantGlobal(TEST_UTIL, toGroupEntry(GROUP_ADMIN), Permission.Action.ADMIN);
// No permissions to USER_NON_ADMIN
}
interface Action {
void run(Admin admin) throws Exception;
}
private void verifyAllowed(User user, final Action action) throws Exception {
user.runAs(new PrivilegedExceptionAction<Object>() {
@Override
public Object run() throws Exception {
try (Connection conn = ConnectionFactory.createConnection(conf);
Admin admin = conn.getAdmin()) {
action.run(admin);
} catch (IOException e) {
fail(e.toString());
}
return null;
}
});
}
private void verifyDenied(User user, final Action action) throws Exception {
user.runAs(new PrivilegedExceptionAction<Object>() {
@Override
public Object run() throws Exception {
boolean accessDenied = false;
try (Connection conn = ConnectionFactory.createConnection(conf);
Admin admin = conn.getAdmin()) {
action.run(admin);
} catch (AccessDeniedException e) {
accessDenied = true;
}
assertTrue("Expected access to be denied", accessDenied);
return null;
}
});
}
private void verifiedDeniedServiceException(User user, final Action action) throws Exception {
user.runAs(new PrivilegedExceptionAction<Object>() {
@Override public Object run() throws Exception {
boolean accessDenied = false;
try (Connection conn = ConnectionFactory.createConnection(conf);
Admin admin = conn.getAdmin()) {
action.run(admin);
} catch (ServiceException e) {
// For MasterRpcServices.execService.
if (e.getCause() instanceof AccessDeniedException) {
accessDenied = true;
}
}
assertTrue("Expected access to be denied", accessDenied);
return null;
}
});
}
private void verifyAdminCheckForAction(Action action) throws Exception {
verifyAllowed(USER_ADMIN, action);
verifyAllowed(USER_GROUP_ADMIN, action);
verifyDenied(USER_NON_ADMIN, action);
}
@Test
public void testEnableCatalogJanitor() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override
public void run(Admin admin) throws Exception {
admin.enableCatalogJanitor(true);
}
});
}
@Test
public void testRunCatalogScan() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override
public void run(Admin admin) throws Exception {
admin.runCatalogScan();
}
});
}
@Test
public void testRunCleanerChore() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override public void run(Admin admin) throws Exception {
admin.runCleanerChore();
}
});
}
@Test
public void testSetCleanerChoreRunning() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override public void run(Admin admin) throws Exception {
admin.setCleanerChoreRunning(true);
}
});
}
@Test
public void testExecProcedure() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override public void run(Admin admin) throws Exception {
// Using existing table instead of creating a new one.
admin.execProcedure("flush-table-proc", TableName.META_TABLE_NAME.getNameAsString(),
new HashMap<String, String>());
}
});
}
@Test
public void testExecService() throws Exception {
final Action action = new Action() {
@Override public void run(Admin admin) throws Exception {
TestRpcServiceProtos.TestProtobufRpcProto.BlockingInterface service =
TestRpcServiceProtos.TestProtobufRpcProto.newBlockingStub(admin.coprocessorService());
service.ping(null, TestProtos.EmptyRequestProto.getDefaultInstance());
}
};
verifyAllowed(USER_ADMIN, action);
verifyAllowed(USER_GROUP_ADMIN, action);
// This is same as above verifyAccessDenied
verifiedDeniedServiceException(USER_NON_ADMIN, action);
}
@Test
public void testExecProcedureWithRet() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override public void run(Admin admin) throws Exception {
// Using existing table instead of creating a new one.
admin.execProcedureWithRet("flush-table-proc", TableName.META_TABLE_NAME.getNameAsString(),
new HashMap<String, String>());
}
});
}
@Test
public void testNormalize() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override
public void run(Admin admin) throws Exception {
admin.normalize();
}
});
}
@Test
public void testSetNormalizerRunning() throws Exception {
verifyAdminCheckForAction(new Action() {
@Override public void run(Admin admin) throws Exception {
admin.setNormalizerRunning(true);
}
});
}
@Test
public void testExecRegionServerService() throws Exception {
Action action = new Action() {
@Override
public void run(Admin admin) throws Exception {
ServerName serverName = TEST_UTIL.getHBaseCluster().getRegionServer(0).getServerName();
TestRpcServiceProtos.TestProtobufRpcProto.BlockingInterface service =
TestRpcServiceProtos.TestProtobufRpcProto.newBlockingStub(
admin.coprocessorService(serverName));
service.ping(null, TestProtos.EmptyRequestProto.getDefaultInstance());
}
};
verifyAllowed(USER_ADMIN, action);
verifyAllowed(USER_GROUP_ADMIN, action);
verifiedDeniedServiceException(USER_NON_ADMIN, action);
}
}