All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.hadoop.hbase.security.access.AuthManager Maven / Gradle / Ivy

There is a newer version: 3.0.0-beta-1
Show newest version
/*
 * 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 java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicLong;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.AuthUtil;
import org.apache.hadoop.hbase.Cell;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.exceptions.DeserializationException;
import org.apache.hadoop.hbase.security.Superusers;
import org.apache.hadoop.hbase.security.User;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.yetus.audience.InterfaceAudience;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap;

/**
 * Performs authorization checks for a given user's assigned permissions.
 * 

* There're following scopes: Global, Namespace, Table, Family, * Qualifier, Cell. Generally speaking, higher scopes can overrides lower scopes, * except for Cell permission can be granted even a user has not permission on specified table, * which means the user can get/scan only those granted cells parts. *

* e.g, if user A has global permission R(ead), he can read table T without checking table scope * permission, so authorization checks alway starts from Global scope. *

* For each scope, not only user but also groups he belongs to will be checked. *

*/ @InterfaceAudience.Private public final class AuthManager { /** * Cache of permissions, it is thread safe. * @param T extends Permission */ private static class PermissionCache { private final Object mutex = new Object(); private Map> cache = new HashMap<>(); void put(String name, T perm) { synchronized (mutex) { Set perms = cache.getOrDefault(name, ConcurrentHashMap.newKeySet()); perms.add(perm); cache.put(name, perms); } } Set get(String name) { synchronized (mutex) { return cache.get(name); } } void clear() { synchronized (mutex) { for (Map.Entry> entry : cache.entrySet()) { entry.getValue().clear(); } cache.clear(); } } } PermissionCache NS_NO_PERMISSION = new PermissionCache<>(); PermissionCache TBL_NO_PERMISSION = new PermissionCache<>(); /** * Cache for global permission excluding superuser and supergroup. Since every user/group can only * have one global permission, no need to use PermissionCache. */ private Map globalCache = new ConcurrentHashMap<>(); /** Cache for namespace permission. */ private ConcurrentHashMap> namespaceCache = new ConcurrentHashMap<>(); /** Cache for table permission. */ private ConcurrentHashMap> tableCache = new ConcurrentHashMap<>(); private static final Logger LOG = LoggerFactory.getLogger(AuthManager.class); private Configuration conf; private final AtomicLong mtime = new AtomicLong(0L); AuthManager(Configuration conf) { this.conf = conf; } /** * Update acl info for table. * @param table name of table * @param data updated acl data * @throws IOException exception when deserialize data */ public void refreshTableCacheFromWritable(TableName table, byte[] data) throws IOException { if (data != null && data.length > 0) { try { ListMultimap perms = PermissionStorage.readPermissions(data, conf); if (perms != null) { if (Bytes.equals(table.getName(), PermissionStorage.ACL_GLOBAL_NAME)) { updateGlobalCache(perms); } else { updateTableCache(table, perms); } } } catch (DeserializationException e) { throw new IOException(e); } } else { LOG.info("Skipping permission cache refresh because writable data is empty"); } } /** * Update acl info for namespace. * @param namespace namespace * @param data updated acl data * @throws IOException exception when deserialize data */ public void refreshNamespaceCacheFromWritable(String namespace, byte[] data) throws IOException { if (data != null && data.length > 0) { try { ListMultimap perms = PermissionStorage.readPermissions(data, conf); if (perms != null) { updateNamespaceCache(namespace, perms); } } catch (DeserializationException e) { throw new IOException(e); } } else { LOG.debug("Skipping permission cache refresh because writable data is empty"); } } /** * Updates the internal global permissions cache. * @param globalPerms new global permissions */ private void updateGlobalCache(ListMultimap globalPerms) { globalCache.clear(); for (String name : globalPerms.keySet()) { for (Permission permission : globalPerms.get(name)) { // Before 2.2, the global permission which storage in zk is not right. It was saved as a // table permission. So here need to handle this for compatibility. See HBASE-22503. if (permission instanceof TablePermission) { globalCache.put(name, new GlobalPermission(permission.getActions())); } else { globalCache.put(name, (GlobalPermission) permission); } } } mtime.incrementAndGet(); } /** * Updates the internal table permissions cache for specified table. * @param table updated table name * @param tablePerms new table permissions */ private void updateTableCache(TableName table, ListMultimap tablePerms) { PermissionCache cacheToUpdate = tableCache.getOrDefault(table, new PermissionCache<>()); clearCache(cacheToUpdate); updateCache(tablePerms, cacheToUpdate); tableCache.put(table, cacheToUpdate); mtime.incrementAndGet(); } /** * Updates the internal namespace permissions cache for specified namespace. * @param namespace updated namespace * @param nsPerms new namespace permissions */ private void updateNamespaceCache(String namespace, ListMultimap nsPerms) { PermissionCache cacheToUpdate = namespaceCache.getOrDefault(namespace, new PermissionCache<>()); clearCache(cacheToUpdate); updateCache(nsPerms, cacheToUpdate); namespaceCache.put(namespace, cacheToUpdate); mtime.incrementAndGet(); } private void clearCache(PermissionCache cacheToUpdate) { cacheToUpdate.clear(); } @SuppressWarnings("unchecked") private void updateCache(ListMultimap newPermissions, PermissionCache cacheToUpdate) { for (String name : newPermissions.keySet()) { for (Permission permission : newPermissions.get(name)) { cacheToUpdate.put(name, permission); } } } /** * Check if user has given action privilige in global scope. * @param user user name * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeUserGlobal(User user, Permission.Action action) { if (user == null) { return false; } if (Superusers.isSuperUser(user)) { return true; } if (authorizeGlobal(globalCache.get(user.getShortName()), action)) { return true; } for (String group : user.getGroupNames()) { if (authorizeGlobal(globalCache.get(AuthUtil.toGroupEntry(group)), action)) { return true; } } return false; } private boolean authorizeGlobal(GlobalPermission permissions, Permission.Action action) { return permissions != null && permissions.implies(action); } /** * Check if user has given action privilige in namespace scope. * @param user user name * @param namespace namespace * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeUserNamespace(User user, String namespace, Permission.Action action) { if (user == null) { return false; } if (authorizeUserGlobal(user, action)) { return true; } PermissionCache nsPermissions = namespaceCache.getOrDefault(namespace, NS_NO_PERMISSION); if (authorizeNamespace(nsPermissions.get(user.getShortName()), namespace, action)) { return true; } for (String group : user.getGroupNames()) { if (authorizeNamespace(nsPermissions.get(AuthUtil.toGroupEntry(group)), namespace, action)) { return true; } } return false; } private boolean authorizeNamespace(Set permissions, String namespace, Permission.Action action) { if (permissions == null) { return false; } for (NamespacePermission permission : permissions) { if (permission.implies(namespace, action)) { return true; } } return false; } /** * Checks if the user has access to the full table or at least a family/qualifier for the * specified action. * @param user user name * @param table table name * @param action action in one of [Read, Write, Create, Exec, Admin] * @return true if the user has access to the table, false otherwise */ public boolean accessUserTable(User user, TableName table, Permission.Action action) { if (user == null) { return false; } if (table == null) { table = PermissionStorage.ACL_TABLE_NAME; } if (authorizeUserNamespace(user, table.getNamespaceAsString(), action)) { return true; } PermissionCache tblPermissions = tableCache.getOrDefault(table, TBL_NO_PERMISSION); if (hasAccessTable(tblPermissions.get(user.getShortName()), action)) { return true; } for (String group : user.getGroupNames()) { if (hasAccessTable(tblPermissions.get(AuthUtil.toGroupEntry(group)), action)) { return true; } } return false; } private boolean hasAccessTable(Set permissions, Permission.Action action) { if (permissions == null) { return false; } for (TablePermission permission : permissions) { if (permission.implies(action)) { return true; } } return false; } /** * Check if user has given action privilige in table scope. * @param user user name * @param table table name * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeUserTable(User user, TableName table, Permission.Action action) { return authorizeUserTable(user, table, null, null, action); } /** * Check if user has given action privilige in table:family scope. * @param user user name * @param table table name * @param family family name * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeUserTable(User user, TableName table, byte[] family, Permission.Action action) { return authorizeUserTable(user, table, family, null, action); } /** * Check if user has given action privilige in table:family:qualifier scope. * @param user user name * @param table table name * @param family family name * @param qualifier qualifier name * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeUserTable(User user, TableName table, byte[] family, byte[] qualifier, Permission.Action action) { if (user == null) { return false; } if (table == null) { table = PermissionStorage.ACL_TABLE_NAME; } if (authorizeUserNamespace(user, table.getNamespaceAsString(), action)) { return true; } PermissionCache tblPermissions = tableCache.getOrDefault(table, TBL_NO_PERMISSION); if (authorizeTable(tblPermissions.get(user.getShortName()), table, family, qualifier, action)) { return true; } for (String group : user.getGroupNames()) { if ( authorizeTable(tblPermissions.get(AuthUtil.toGroupEntry(group)), table, family, qualifier, action) ) { return true; } } return false; } private boolean authorizeTable(Set permissions, TableName table, byte[] family, byte[] qualifier, Permission.Action action) { if (permissions == null) { return false; } for (TablePermission permission : permissions) { if (permission.implies(table, family, qualifier, action)) { return true; } } return false; } /** * Check if user has given action privilige in table:family scope. This method is for backward * compatibility. * @param user user name * @param table table name * @param family family names * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeUserFamily(User user, TableName table, byte[] family, Permission.Action action) { PermissionCache tblPermissions = tableCache.getOrDefault(table, TBL_NO_PERMISSION); if (authorizeFamily(tblPermissions.get(user.getShortName()), table, family, action)) { return true; } for (String group : user.getGroupNames()) { if ( authorizeFamily(tblPermissions.get(AuthUtil.toGroupEntry(group)), table, family, action) ) { return true; } } return false; } private boolean authorizeFamily(Set permissions, TableName table, byte[] family, Permission.Action action) { if (permissions == null) { return false; } for (TablePermission permission : permissions) { if (permission.implies(table, family, action)) { return true; } } return false; } /** * Check if user has given action privilige in cell scope. * @param user user name * @param table table name * @param cell cell to be checked * @param action one of action in [Read, Write, Create, Exec, Admin] * @return true if user has, false otherwise */ public boolean authorizeCell(User user, TableName table, Cell cell, Permission.Action action) { try { List perms = PermissionStorage.getCellPermissionsForUser(user, cell); if (LOG.isTraceEnabled()) { LOG.trace("Perms for user {} in table {} in cell {}: {}", user.getShortName(), table, cell, (perms != null ? perms : "")); } if (perms != null) { for (Permission p : perms) { if (p.implies(action)) { return true; } } } } catch (IOException e) { // We failed to parse the KV tag LOG.error("Failed parse of ACL tag in cell " + cell); // Fall through to check with the table and CF perms we were able // to collect regardless } return false; } /** * Remove given namespace from AuthManager's namespace cache. * @param ns namespace */ public void removeNamespace(byte[] ns) { namespaceCache.remove(Bytes.toString(ns)); } /** * Remove given table from AuthManager's table cache. * @param table table name */ public void removeTable(TableName table) { tableCache.remove(table); } /** * Last modification logical time */ public long getMTime() { return mtime.get(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy