Skip to content

BE: RBAC: Replaced restart with 'operate' KC action #1121

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

Merged
merged 3 commits into from
Jun 5, 2025
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 @@ -191,11 +191,7 @@ public Mono<ResponseEntity<Void>> updateConnectorState(String clusterName, Strin
ConnectorActionDTO action,
ServerWebExchange exchange) {
ConnectAction[] connectActions;
if (RESTART_ACTIONS.contains(action)) {
connectActions = new ConnectAction[] {ConnectAction.VIEW, ConnectAction.RESTART};
} else {
connectActions = new ConnectAction[] {ConnectAction.VIEW, ConnectAction.EDIT};
}
connectActions = new ConnectAction[] {ConnectAction.VIEW, ConnectAction.OPERATE};

var context = AccessContext.builder()
.cluster(clusterName)
Expand Down Expand Up @@ -237,7 +233,7 @@ public Mono<ResponseEntity<Void>> restartConnectorTask(String clusterName, Strin

var context = AccessContext.builder()
.cluster(clusterName)
.connectActions(connectName, ConnectAction.VIEW, ConnectAction.RESTART)
.connectActions(connectName, ConnectAction.VIEW, ConnectAction.OPERATE)
.operationName("restartConnectorTask")
.operationParams(Map.of(CONNECTOR_NAME, connectorName))
.build();
Expand Down
42 changes: 29 additions & 13 deletions api/src/main/java/io/kafbat/ui/model/rbac/Resource.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@
import io.kafbat.ui.model.rbac.permission.SchemaAction;
import io.kafbat.ui.model.rbac.permission.TopicAction;
import jakarta.annotation.Nullable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.lang3.EnumUtils;

Expand All @@ -28,7 +34,7 @@ public enum Resource {

SCHEMA(SchemaAction.values()),

CONNECT(ConnectAction.values()),
CONNECT(ConnectAction.values(), ConnectAction.ALIASES),

KSQL(KsqlAction.values()),

Expand All @@ -38,14 +44,27 @@ public enum Resource {

CLIENT_QUOTAS(ClientQuotaAction.values());

private final List<PermissibleAction> actions;

private final Map<String, PermissibleAction> actions;
private final Map<String, PermissibleAction> aliases;

Resource(PermissibleAction[] actions, Map<String, PermissibleAction> aliases) {
this.actions = Arrays.stream(actions)
.collect(
Collectors.toMap(
a -> a.name().toLowerCase(),
a -> a
)
);
this.aliases = aliases;
}

Resource(PermissibleAction[] actions) {
this.actions = List.of(actions);
this(actions, Map.of());
}

public List<PermissibleAction> allActions() {
return actions;
return new ArrayList<>(actions.values());
}

@Nullable
Expand All @@ -54,17 +73,14 @@ public static Resource fromString(String name) {
}

public List<PermissibleAction> parseActionsWithDependantsUnnest(List<String> actionsToParse) {
return actionsToParse.stream()
.map(toParse -> actions.stream()
.filter(a -> toParse.equalsIgnoreCase(a.name()))
.findFirst()
return actionsToParse.stream().map(toParse ->
Optional.ofNullable(actions.get(toParse.toLowerCase()))
.or(() -> Optional.ofNullable(aliases.get(toParse.toLowerCase())))
.orElseThrow(() -> new IllegalArgumentException(
"'%s' actions not applicable for resource %s".formatted(toParse, name())))
)
// unnesting all dependant actions
.flatMap(a -> Stream.concat(Stream.of(a), a.unnestAllDependants()))
.distinct()
.toList();
).flatMap(a ->
Stream.concat(Stream.of(a), a.unnestAllDependants())
).distinct().toList();
}

}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.kafbat.ui.model.rbac.permission;

import java.util.Map;
import java.util.Set;
import org.apache.commons.lang3.EnumUtils;
import org.jetbrains.annotations.Nullable;
Expand All @@ -9,10 +10,9 @@ public enum ConnectAction implements PermissibleAction {
VIEW,
EDIT(VIEW),
CREATE(VIEW),
RESTART(VIEW),
OPERATE(VIEW),
DELETE(VIEW),
RESET_OFFSETS(VIEW)

RESET_OFFSETS(VIEW),
;

private final ConnectAction[] dependantActions;
Expand All @@ -21,7 +21,9 @@ public enum ConnectAction implements PermissibleAction {
this.dependantActions = dependantActions;
}

public static final Set<ConnectAction> ALTER_ACTIONS = Set.of(CREATE, EDIT, DELETE, RESTART, RESET_OFFSETS);
public static final Set<ConnectAction> ALTER_ACTIONS = Set.of(CREATE, EDIT, DELETE, OPERATE, RESET_OFFSETS);

public static final Map<String, PermissibleAction> ALIASES = Map.of("restart", OPERATE);

@Nullable
public static ConnectAction fromString(String name) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import io.kafbat.ui.model.rbac.AccessContext.ResourceAccess;
import io.kafbat.ui.model.rbac.AccessContext.SingleResourceAccess;
import io.kafbat.ui.model.rbac.permission.ClusterConfigAction;
import io.kafbat.ui.model.rbac.permission.ConnectAction;
import io.kafbat.ui.model.rbac.permission.PermissibleAction;
import io.kafbat.ui.model.rbac.permission.TopicAction;
import jakarta.annotation.Nullable;
Expand Down Expand Up @@ -98,10 +99,30 @@ void deniesAccessForResourceWithoutNameIfUserHasAllNeededPermissions() {
assertThat(allowed).isFalse();
}

@Test
void shouldMapActionAliases() {
SingleResourceAccess sra =
new SingleResourceAccess(Resource.CONNECT, List.of(ConnectAction.OPERATE));

var allowed = sra.isAccessible(
List.of(
permission(Resource.CONNECT, null, List.of("restart"))
)
);

assertThat(allowed).isTrue();
}

private Permission permission(Resource res, @Nullable String namePattern, PermissibleAction... actions) {
return permission(
res, namePattern, Stream.of(actions).map(PermissibleAction::name).toList()
);
}

private Permission permission(Resource res, @Nullable String namePattern, List<String> actions) {
Permission p = new Permission();
p.setResource(res.name());
p.setActions(Stream.of(actions).map(PermissibleAction::name).toList());
p.setActions(actions);
p.setValue(namePattern);
p.validate();
p.transform();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ void transformSetsFullActionsListIfAllActionPassed() {
p.transform();

assertThat(p.getParsedActions())
.isEqualTo(List.of(TopicAction.values()));
.containsExactlyInAnyOrder(TopicAction.values());
}

@Test
Expand Down
1 change: 1 addition & 0 deletions contract/src/main/resources/swagger/kafbat-ui-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3947,6 +3947,7 @@ components:
- MESSAGES_READ
- MESSAGES_PRODUCE
- MESSAGES_DELETE
- OPERATE
- RESTART

ResourceType:
Expand Down
12 changes: 6 additions & 6 deletions frontend/src/components/Connect/Details/Actions/Actions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ const Actions: React.FC = () => {
onClick={pauseConnectorHandler}
permission={{
resource: ResourceType.CONNECT,
action: Action.EDIT,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand All @@ -103,7 +103,7 @@ const Actions: React.FC = () => {
onClick={stopConnectorHandler}
permission={{
resource: ResourceType.CONNECT,
action: Action.EDIT,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand All @@ -116,7 +116,7 @@ const Actions: React.FC = () => {
onClick={resumeConnectorHandler}
permission={{
resource: ResourceType.CONNECT,
action: Action.EDIT,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand All @@ -127,7 +127,7 @@ const Actions: React.FC = () => {
onClick={restartConnectorHandler}
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand All @@ -137,7 +137,7 @@ const Actions: React.FC = () => {
onClick={restartAllTasksHandler}
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand All @@ -147,7 +147,7 @@ const Actions: React.FC = () => {
onClick={restartFailedTasksHandler}
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const ActionsCellTasks: React.FC<CellContext<Task, unknown>> = ({ row }) => {
confirm="Are you sure you want to restart the task?"
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: routerProps.connectName,
}}
>
Expand Down
6 changes: 3 additions & 3 deletions frontend/src/components/Connect/List/ActionsCell.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ const ActionsCell: React.FC<CellContext<FullConnectorInfo, unknown>> = ({
disabled={isMutating}
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: connect,
}}
>
Expand All @@ -137,7 +137,7 @@ const ActionsCell: React.FC<CellContext<FullConnectorInfo, unknown>> = ({
disabled={isMutating}
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: connect,
}}
>
Expand All @@ -148,7 +148,7 @@ const ActionsCell: React.FC<CellContext<FullConnectorInfo, unknown>> = ({
disabled={isMutating}
permission={{
resource: ResourceType.CONNECT,
action: Action.RESTART,
action: Action.OPERATE,
value: connect,
}}
>
Expand Down
Loading