Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added catalog and schema level access checks in USE statement #23882

Merged
merged 1 commit into from
Nov 6, 2024
Merged
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 @@ -14,24 +14,34 @@
package com.facebook.presto.execution;

import com.facebook.presto.Session;
import com.facebook.presto.common.CatalogSchemaName;
import com.facebook.presto.common.transaction.TransactionId;
import com.facebook.presto.metadata.Metadata;
import com.facebook.presto.spi.PrestoException;
import com.facebook.presto.spi.analyzer.MetadataResolver;
import com.facebook.presto.spi.security.AccessControl;
import com.facebook.presto.spi.security.AccessControlContext;
import com.facebook.presto.spi.security.AccessDeniedException;
import com.facebook.presto.spi.security.Identity;
import com.facebook.presto.sql.analyzer.SemanticException;
import com.facebook.presto.sql.tree.Expression;
import com.facebook.presto.sql.tree.Use;
import com.facebook.presto.transaction.TransactionManager;
import com.google.common.collect.ImmutableSet;
import com.google.common.util.concurrent.ListenableFuture;

import java.util.List;

import static com.facebook.presto.spi.StandardErrorCode.NOT_FOUND;
import static com.facebook.presto.spi.security.AccessDeniedException.denyCatalogAccess;
import static com.facebook.presto.sql.analyzer.SemanticErrorCode.CATALOG_NOT_SPECIFIED;
import static com.google.common.util.concurrent.Futures.immediateFuture;
import static java.util.Locale.ENGLISH;

public class UseTask
implements SessionTransactionControlTask<Use>
{
String catalog;
@Override
public String getName()
{
Expand All @@ -49,11 +59,38 @@ public ListenableFuture<?> execute(
{
Session session = stateMachine.getSession();

TransactionId transactionId = session.getTransactionId().get();

Identity identity = session.getIdentity();

AccessControlContext context = session.getAccessControlContext();

checkCatalogAndSessionPresent(statement, session);

checkAndSetCatalog(statement, metadata, stateMachine, session);

stateMachine.setSetSchema(statement.getSchema().getValueLowerCase());
String schema = statement.getSchema().getValue();

stateMachine.setSetSchema(schema);

if (!hasCatalogAccess(identity, context, catalog, accessControl)) {
denyCatalogAccess(catalog);
}

CatalogSchemaName name = new CatalogSchemaName(catalog, schema);

MetadataResolver metadataresolver = metadata.getMetadataResolver(session);
if (!metadataresolver.schemaExists(name)) {
throw new PrestoException(NOT_FOUND, "Schema does not exist: " + name);
}

if (!hasSchemaAccess(transactionId, identity, context, catalog, schema, accessControl)) {
throw new AccessDeniedException("Cannot access schema: " + name);
}

if (statement.getCatalog().isPresent()) {
stateMachine.setSetCatalog(catalog);
}

return immediateFuture(null);
}
Expand All @@ -67,12 +104,24 @@ private void checkCatalogAndSessionPresent(Use statement, Session session)

private void checkAndSetCatalog(Use statement, Metadata metadata, QueryStateMachine stateMachine, Session session)
{
if (statement.getCatalog().isPresent()) {
String catalog = statement.getCatalog().get().getValueLowerCase();
if (statement.getCatalog().isPresent() || session.getCatalog().isPresent()) {
catalog = statement.getCatalog()
.map(identifier -> identifier.getValue().toLowerCase(ENGLISH))
.orElseGet(() -> session.getCatalog().get());
if (!metadata.getCatalogHandle(session, catalog).isPresent()) {
throw new PrestoException(NOT_FOUND, "Catalog does not exist: " + catalog);
}
stateMachine.setSetCatalog(catalog);
}
}

private boolean hasCatalogAccess(Identity identity, AccessControlContext context, String catalog, AccessControl accessControl)
{
return !accessControl.filterCatalogs(identity, context, ImmutableSet.of(catalog)).isEmpty();
}

private boolean hasSchemaAccess(TransactionId transactionId, Identity identity, AccessControlContext context, String catalog, String schema, AccessControl accessControl)
{
return !accessControl.filterSchemas(transactionId, identity, context, catalog, ImmutableSet.of(schema)).isEmpty();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
/*
* Licensed 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 com.facebook.presto.execution;

import com.facebook.presto.Session;
import com.facebook.presto.connector.MockConnectorFactory;
import com.facebook.presto.metadata.Catalog;
import com.facebook.presto.metadata.CatalogManager;
import com.facebook.presto.metadata.MetadataManager;
import com.facebook.presto.spi.ConnectorId;
import com.facebook.presto.spi.PrestoException;
import com.facebook.presto.spi.connector.Connector;
import com.facebook.presto.spi.security.AccessControl;
import com.facebook.presto.spi.security.AccessDeniedException;
import com.facebook.presto.spi.security.AllowAllAccessControl;
import com.facebook.presto.spi.security.DenyAllAccessControl;
import com.facebook.presto.spi.security.Identity;
import com.facebook.presto.sql.analyzer.SemanticException;
import com.facebook.presto.sql.tree.Identifier;
import com.facebook.presto.sql.tree.Use;
import com.facebook.presto.testing.TestingConnectorContext;
import com.facebook.presto.transaction.TransactionManager;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.testng.annotations.AfterClass;
import org.testng.annotations.Test;

import java.util.Optional;
import java.util.concurrent.ExecutorService;

import static com.facebook.airlift.concurrent.Threads.daemonThreadsNamed;
import static com.facebook.presto.SessionTestUtils.TEST_SESSION;
import static com.facebook.presto.execution.TaskTestUtils.createQueryStateMachine;
import static com.facebook.presto.metadata.MetadataManager.createTestMetadataManager;
import static com.facebook.presto.spi.ConnectorId.createInformationSchemaConnectorId;
import static com.facebook.presto.spi.ConnectorId.createSystemTablesConnectorId;
import static com.facebook.presto.spi.StandardErrorCode.NOT_FOUND;
import static com.facebook.presto.testing.TestingSession.testSessionBuilder;
import static com.facebook.presto.transaction.InMemoryTransactionManager.createTestTransactionManager;
import static java.util.Collections.emptyList;
import static java.util.concurrent.Executors.newCachedThreadPool;
import static org.testng.Assert.assertEquals;

public class TestUseTask
{
private final ExecutorService executor = newCachedThreadPool(daemonThreadsNamed("test-%s"));
private CatalogManager catalogManager;
private Catalog testCatalog;
private TransactionManager transactionManager;
private MetadataManager metadata = createTestMetadataManager();
MockConnectorFactory.Builder builder = MockConnectorFactory.builder();
MockConnectorFactory mockConnectorFactory = builder.withListSchemaNames(connectorSession -> ImmutableList.of("test_schema"))
.build();
@AfterClass(alwaysRun = true)
public void tearDown()
{
executor.shutdownNow();
}

@Test
public void testUse()
{
Use use = new Use(Optional.of(identifier("test_catalog")), identifier("test_schema"));
String sqlString = "USE test_catalog.test_schema";
executeUse(use, sqlString, TEST_SESSION);
}

@Test
public void testUseNoCatalog()
{
Use use = new Use(Optional.empty(), identifier("test_schema"));
String sqlString = "USE test_schema";
Session session = testSessionBuilder()
.setCatalog(null)
.setSchema(null)
.build();
try {
executeUse(use, sqlString, session);
}
catch (SemanticException e) {
assertEquals(e.getMessage(), "Catalog must be specified when session catalog is not set");
}
}

@Test
public void testUseInvalidCatalog()
{
Use use = new Use(Optional.of(identifier("invalid_catalog")), identifier("test_schema"));
String sqlString = "USE invalid_catalog.test_schema";
try {
executeUse(use, sqlString, TEST_SESSION);
}
catch (PrestoException e) {
assertEquals(e.getErrorCode(), NOT_FOUND.toErrorCode());
assertEquals(e.getMessage(), "Catalog does not exist: invalid_catalog");
}
}

@Test
public void testUseInvalidSchema()
{
Use use = new Use(Optional.of(identifier("test_catalog")), identifier("invalid_schema"));
String sqlString = "USE test_catalog.invalid_schema";
Session session = testSessionBuilder()
.setSchema("invalid_schema")
.build();
try {
executeUse(use, sqlString, session);
}
catch (PrestoException e) {
assertEquals(e.getErrorCode(), NOT_FOUND.toErrorCode());
assertEquals(e.getMessage(), "Schema does not exist: test_catalog.invalid_schema");
}
}

@Test
public void testUseAccessDenied()
{
Use use = new Use(Optional.of(identifier("test_catalog")), identifier("test_schema"));
String sqlString = "USE test_catalog.test_schema";
Session session = testSessionBuilder()
.setIdentity(new Identity("user", Optional.empty()))
.build();
AccessControl accessControl = new DenyAllAccessControl();
try {
executeUse(use, sqlString, session);
}
catch (AccessDeniedException e) {
assertEquals(e.getMessage(), "Cannot access schema: test_catalog.test_schema");
}
}

private void executeUse(Use use, String sqlString, Session session)
{
executeUse(use, sqlString, session, new AllowAllAccessControl());
}

private void executeUse(Use use, String sqlString, Session session, AccessControl accessControl)
{
Connector testConnector = mockConnectorFactory.create("test", ImmutableMap.of(), new TestingConnectorContext());
catalogManager = new CatalogManager();
String catalogName = "test_catalog";
ConnectorId connectorId = new ConnectorId(catalogName);
catalogManager.registerCatalog(new Catalog(
catalogName,
connectorId,
testConnector,
createInformationSchemaConnectorId(connectorId),
testConnector,
createSystemTablesConnectorId(connectorId),
testConnector));
transactionManager = createTestTransactionManager(catalogManager);
metadata = createTestMetadataManager(transactionManager);
QueryStateMachine stateMachine = createQueryStateMachine(sqlString, session, false, transactionManager, executor, metadata);
UseTask useTask = new UseTask();
useTask.execute(use, transactionManager, metadata, accessControl, stateMachine, emptyList());
}
private Identifier identifier(String name)
{
return new Identifier(name);
}
}
Loading