Package org.apache.hadoop.hbase.security.access

Class TestAccessControllerObserverCoverage

java.lang.Object

org.apache.hadoop.hbase.security.access.TestAccessControllerObserverCoverage

@Tag("org.apache.hadoop.hbase.testclassification.SecurityTests") @Tag("org.apache.hadoop.hbase.testclassification.SmallTests")
public class TestAccessControllerObserverCoverage
extends Object

Verifies that AccessController implements every security-relevant method declared in the five observer interfaces it claims to implement: MasterObserver, RegionObserver, RegionServerObserver, EndpointObserver, BulkLoadObserver.

If a new hook is added to any of these interfaces and AccessController does not override it, the default no-op implementation will silently skip the permission check — a potential privilege escalation. This test catches that at build time.

Skipped methods are determined by two mechanisms:

• Pattern rules — methods matching these patterns are always safe to skip:
  • post* — post-operation notifications; the operation has already been authorized and executed.
  • pre*Action — procedure-level action hooks; authorization happens at the RPC layer in the corresponding pre* hook.
• Explicit whitelist — methods that don't match the above rules but are still safe to skip (internal lifecycle hooks, deprecated overloads with default delegation, read-only queries). Each entry has a justification comment.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Class<?>[]	OBSERVER_INTERFACES
private static final Set<String>	WHITELIST	Explicit whitelist for methods that don't match the pattern rules but are intentionally not overridden in AccessController.

Constructor Summary

Constructors

Constructor	Description
TestAccessControllerObserverCoverage()

Method Summary

Modifier and Type	Method	Description
private static String	fullMethodSignatureKey(Method m)
private static boolean	isMethodImplemented(Class<?> implClass, Method ifaceMethod)
private static boolean	matchesSkipPattern(Class<?> iface, Method m)	Returns true if the method matches a pattern rule that makes it safe to skip without an explicit whitelist entry.
private static String	methodSignatureKey(Method m)
void	testAllObserverMethodsAreImplemented()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

WHITELIST

private static final Set<String> WHITELIST

Explicit whitelist for methods that don't match the pattern rules but are intentionally not overridden in AccessController.

Use simple method name (covers all overloads) or full signature key "methodName(ParamType1,ParamType2,..." using simple class names.

OBSERVER_INTERFACES

private static final Class<?>[] OBSERVER_INTERFACES

Constructor Details

TestAccessControllerObserverCoverage

public TestAccessControllerObserverCoverage()

Method Details

matchesSkipPattern

private static boolean matchesSkipPattern(Class<?> iface,
 Method m)

Returns true if the method matches a pattern rule that makes it safe to skip without an explicit whitelist entry.

methodSignatureKey

private static String methodSignatureKey(Method m)

fullMethodSignatureKey

private static String fullMethodSignatureKey(Method m)

isMethodImplemented

private static boolean isMethodImplemented(Class<?> implClass,
 Method ifaceMethod)

testAllObserverMethodsAreImplemented

@Test
public void testAllObserverMethodsAreImplemented()