NIFI-375: Added operation policy #2990

ijokarumawak · 2018-09-05T07:45:36Z

The operation policy allows that a user to operate components even if they does not have direct READ/WRITE permission of the component.

Following operations are controlled by the new operate policy:

Start/stop/enable/disable Processors, ControllerServices,
ReportingTasks, Input/OuputPorts
Enable/disable transmission of RemoteInput/OutputPorts and
RemoteProcessGroups
Terminate Processor threads

ControllerServices table view

If the user doesn't have READ permission for the CS, 'Name' shows its uuid, and 'Type' and 'Bundle' are hidden.
If the user has either WRITE or OPERATE permission, the enable/disable icon is shown to open the enable/disable dialog.
If the user has READ, but no WRITE permission, they can only 'View Configuration'
Only users having both READ and WRITE permissions can 'Configure' the CS

Enabling/Disabling ControllerService

This PR supports following spec based on the ControllerService and its referencing components permissions:

No	CS READ	CS WRITE or OPS	Ref READ	Ref WRITE or OPS	Can Disable?	Can Enable?	Detail
1	F	F	-	-	No	No	No action button is shown.
2	T	F	-	-	No	No	Enable/Disable buttons are hidden.
3	F	T	Uncertain	-	No	Service Only	UI can't if there's any referencing components to disable. But directly sending a PUT request to `controller-services/{id}/run-status` can be successful, and can be used from operational scripts. NOTE Technically we can update the UI to do the same thing, but currently this PR doesn't allow this from UI.
4	T	T	No Ref	-	Yes	Yes	Since there's no referencing component, all actions are supported.
5	T	T	F	F	No	Service Only	Currently, UI doesn't look at referencing components run status if the user doesn't have READ permission.
6	T	T	T	F	No	Service Only	UI requires all referencing components can be operated. NOTE UI doesn't check if the referencing component is stopped or running. If all referencing components are stopped, it would be fine to allow disabling the CS. Directly calling API may be successful if all referencing components are stopped.
7	T	T	F	T	No	Service Only	UI can't traverse all referencing components. Directly calling API may be successful if all referencing components are stopped.
8	T	T	T	T	Yes	Yes	All actions are supported.

ReportingTasks view

If the user doesn't have READ permission for the CS, 'Name' shows its uuid, and 'Type' and 'Bundle' are hidden.
If the user has READ permission, they can see configuration and usage
Start/stop icons can be seen by users having WRITE or OPERATE permission
Only users having both READ and WRITE permissions can edit the ReportingTask. Delete icon is shown if the user has WRITE permission to controller.

Thank you for submitting a contribution to Apache NiFi.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically master)?
Is your initial contribution a single, squashed commit?

For code changes:

Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
Have you written or updated unit tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

mcgilman · 2018-09-05T12:53:04Z

Will review...

ijokarumawak · 2018-09-07T15:38:26Z

@mcgilman Updated how API exposes required data to operate components. Although I need to do the similar refactoring with RGPs, the most complex ControllerService implementation is done. I updated the PR description, too, to illustrate how ControllerService enable/disable operations are authorized. It'd be great if you can review this while I'm working on the remaining RPG stuffs. Thanks!

ijokarumawak · 2018-09-10T07:02:41Z

@mcgilman I hope this PR is now fully ready for review. Thanks.

mcgilman · 2018-09-11T12:29:30Z

@ijokarumawak Thanks for the additional commits! Will review...

mcgilman · 2018-09-12T15:41:47Z

@ijokarumawak Thanks for the update. I'm still in the process of reviewing but one thing that concerns me is where we've identified Service Only in the scenarios above. Currently (before the PR) the Enable case we allow the user to specify if they want to enable just this service or this service and all components that reference it (including other services and their referencing components). During the Disable case, we require that the user disables this service and all referencing components. This is because the referencing components require this service's availability to continue running.

The issue that we're hitting now is that a user with permissions outlined above with Service Only will be able to Enable this service but will be unable to subsequently disable it. Because of this, I'm wondering if we need to be even more strict to prevent this cases via the UI. I don't think its too restrictive as this is more of a corner case. The more common use case here will be granting operators permissions to the read policies and operation policies for these components.

Thoughts?

...ork-cluster/src/main/java/org/apache/nifi/cluster/manager/ControllerServiceEntityMerger.java

...k/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerServiceResource.java

...framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/InputPortResource.java

...ramework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/OutputPortResource.java

...framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java

...ework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java

mcgilman · 2018-09-12T18:26:09Z

...i-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/ComponentEntityMerger.java

@@ -68,10 +75,13 @@ default void merge(final EntityType clientEntity, final Map<NodeIdentifier, Enti
            if (clientEntity.getBulletins().size() > MAX_BULLETINS_PER_COMPONENT) {
                clientEntity.setBulletins(clientEntity.getBulletins().subList(0, MAX_BULLETINS_PER_COMPONENT));
            }
+        } else {
+            clientEntity.setBulletins(null);


I think we need to continue to set the component to null when canRead is false. It may have been changed to accommodate an earlier iteration of this PR.

Fixed. Thanks for caching this!

The operation policy allows that a user to operate components even if they does not have direct READ/WRITE permission of the component. Following operations are controlled by the new operate policy: - Start/stop/enable/disable Processors, ControllerServices, ReportingTasks, Input/OuputPorts - Enable/disable transmission of RemoteInput/OutputPorts and RemoteProcessGroups - Terminate Processor threads

The previous commit let API exposes few fields in DTO. But we should avoid returning partial DTO as it complicates authorization logic. Instead, this commit adds StatusDTO for ReportingTaskEntity and ControllerServiceEntity, so that it can be returned regardless of having READ permission. Component DTO can only be returned with a READ permission.

- Cleaned up merger classes - Recreate DTO instance at each function during two phase commmit

ijokarumawak · 2018-09-13T08:39:22Z

@mcgilman Rebased with the latest master and incorporated the feedback.

About the concern:

The issue that we're hitting now is that a user with permissions outlined above with Service Only will be able to Enable this service but will be unable to subsequently disable it.

I added another commit to address this, but I'm going to remove that commit. Because...

I confirmed that even before this PR, NiFi UI works like this if the user has READ/WRITE permissions for a CS, but only has READ to its referencing components. Such user can enable the CS if 'Service Only', but can not disable the CS because the referencing component can not be written.

mcgilman · 2018-09-13T13:17:02Z

@ijokarumawak I see. You're correct that the existing codebase also exhibits this behavior. However, I think that its an issue we should consider fixing separately from this. Generally speaking, I think the UI should not allow the user to change something that they cannot change back (assuming the same permissions).

Let's proceed here and we can address this concern in a future effort. Thanks... I'll continue reviewing!

.../nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java

...uthorization/src/main/java/org/apache/nifi/authorization/resource/OperationAuthorizable.java

.../nifi-framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/canvas/nf-remote-process-group.js

...ework-bundle/nifi-framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/canvas/nf-settings.js

- Renamed confusing static method names and its parameters - Removed unnecessary permission checks from UI condition

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java

mcgilman · 2018-09-18T18:00:04Z

@ijokarumawak This is looking really good! Just seeing a couple minor things aside from the NPE I commented in the code.

It looks like the operatePermissions were added to the ComponentEntity. This is good since this applied to the majority of components. However, I noticed that the operatePermissions was also added to the each of the concrete implementations (ProcessorEntity, PortEntity, etc). I do not believe we need the field and getter/setter methods within each concrete implementation. Is there a reason they are there?

Also, I think we need to apply the new Operation policy checks in FlowResource#activeControllerServices. This is essentially like the corresponding FlowResource#scheduleComponents but for ControllerServices. This endpoint is not called directly by the NiFi UI but I think it should probably utilize the new policy.

Thanks again!

ijokarumawak · 2018-09-19T06:47:29Z

@mcgilman Incorporated the last review comments.

The original intent of having operatePermissions at each concrete entity implementation is to clarify which entity is OperationPermissible. I thought adding that to ComponentEntity is to vague as ComponentEntity is the super class of various entities, including those do not have running status such as AccessPolicySummaryEntity, TemplateEntity or UserGroupEntity.

I wasn't consistent enough while I was refactoring the code at some point and added it to ComponentEntity. But I still think the operatePermissions should exist with only component those can be operated. So, I removed operatePermissions from ComponentEntity.

I hope this we have polished this PR enough to get merged. Thanks for your comprehensive review comments!

mcgilman · 2018-09-19T19:27:58Z

@ijokarumawak Thanks this looks good. I'm going to squash and merged to master. I've created two new JIRAs that are related to this effort but separate from the initial concern. Thanks again for working through all the review comments!

https://issues.apache.org/jira/browse/NIFI-5610
https://issues.apache.org/jira/browse/NIFI-5611

The operation policy allows that a user to operate components even if they does not have direct READ/WRITE permission of the component. Following operations are controlled by the new operate policy: - Start/stop/enable/disable Processors, ControllerServices, ReportingTasks, Input/OuputPorts - Enable/disable transmission of RemoteInput/OutputPorts and RemoteProcessGroups - Terminate Processor threads Refactored what API exposes The previous commit let API exposes few fields in DTO. But we should avoid returning partial DTO as it complicates authorization logic. Instead, this commit adds StatusDTO for ReportingTaskEntity and ControllerServiceEntity, so that it can be returned regardless of having READ permission. Component DTO can only be returned with a READ permission. Refactor RPG same as ControllerService. WIP incorporating review comments. Incorporated review comments - Cleaned up merger classes - Recreate DTO instance at each function during two phase commmit Restrict enabling ControllerService without read permission Revert the last commit. Fix review comments. - Renamed confusing static method names and its parameters - Removed unnecessary permission checks from UI condition Fixed delete action display condition. Fixed NPE at Summary. Apply operation policy to activateControllerServices. Removed OperationPermissible from ComponentEntity. This closes apache#2990

ijokarumawak force-pushed the nifi-375 branch from 722fa60 to a538639 Compare September 10, 2018 07:02

mcgilman reviewed Sep 12, 2018

View reviewed changes

ijokarumawak added 5 commits September 13, 2018 11:16

Refactor RPG same as ControllerService.

d9243c9

WIP incorporating review comments.

4ab7eb8

Incorporated review comments

2a1e6a1

- Cleaned up merger classes - Recreate DTO instance at each function during two phase commmit

ijokarumawak force-pushed the nifi-375 branch from a538639 to 2a1e6a1 Compare September 13, 2018 06:11

Restrict enabling ControllerService without read permission

d09371e

Revert the last commit.

5e25c71

mcgilman reviewed Sep 13, 2018

View reviewed changes

ijokarumawak added 2 commits September 14, 2018 15:15

Fix review comments.

f76d8b2

- Renamed confusing static method names and its parameters - Removed unnecessary permission checks from UI condition

Fixed delete action display condition.

6bbe2a6

mcgilman reviewed Sep 18, 2018

View reviewed changes

...fi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java Outdated Show resolved Hide resolved

ijokarumawak added 3 commits September 19, 2018 06:25

Fixed NPE at Summary.

f8b7fb9

Apply operation policy to activateControllerServices.

a52f709

Removed OperationPermissible from ComponentEntity.

702b332

asfgit closed this in f570cb9 Sep 19, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NIFI-375: Added operation policy #2990

NIFI-375: Added operation policy #2990

ijokarumawak commented Sep 5, 2018 •

edited

mcgilman commented Sep 5, 2018

ijokarumawak commented Sep 7, 2018

ijokarumawak commented Sep 10, 2018

mcgilman commented Sep 11, 2018

mcgilman commented Sep 12, 2018

mcgilman Sep 12, 2018

ijokarumawak Sep 13, 2018

ijokarumawak commented Sep 13, 2018

mcgilman commented Sep 13, 2018

mcgilman commented Sep 18, 2018

ijokarumawak commented Sep 19, 2018

mcgilman commented Sep 19, 2018

NIFI-375: Added operation policy #2990

NIFI-375: Added operation policy #2990

Conversation

ijokarumawak commented Sep 5, 2018 • edited

ControllerServices table view

Enabling/Disabling ControllerService

ReportingTasks view

For all changes:

For code changes:

For documentation related changes:

Note:

mcgilman commented Sep 5, 2018

ijokarumawak commented Sep 7, 2018

ijokarumawak commented Sep 10, 2018

mcgilman commented Sep 11, 2018

mcgilman commented Sep 12, 2018

mcgilman Sep 12, 2018

Choose a reason for hiding this comment

ijokarumawak Sep 13, 2018

Choose a reason for hiding this comment

ijokarumawak commented Sep 13, 2018

mcgilman commented Sep 13, 2018

mcgilman commented Sep 18, 2018

ijokarumawak commented Sep 19, 2018

mcgilman commented Sep 19, 2018

ijokarumawak commented Sep 5, 2018 •

edited