| /* |
| * 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.nifi.web.api; |
| |
| import io.swagger.annotations.Api; |
| import io.swagger.annotations.ApiOperation; |
| import io.swagger.annotations.ApiParam; |
| import io.swagger.annotations.ApiResponse; |
| import io.swagger.annotations.ApiResponses; |
| import io.swagger.annotations.Authorization; |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.nifi.authorization.Authorizer; |
| import org.apache.nifi.authorization.AuthorizerCapabilityDetection; |
| import org.apache.nifi.authorization.RequestAction; |
| import org.apache.nifi.authorization.resource.Authorizable; |
| import org.apache.nifi.authorization.user.NiFiUserUtils; |
| import org.apache.nifi.cluster.coordination.ClusterCoordinator; |
| import org.apache.nifi.cluster.coordination.http.replication.RequestReplicator; |
| import org.apache.nifi.controller.FlowController; |
| import org.apache.nifi.util.NiFiProperties; |
| import org.apache.nifi.web.NiFiServiceFacade; |
| import org.apache.nifi.web.Revision; |
| import org.apache.nifi.web.api.dto.AccessPolicyDTO; |
| import org.apache.nifi.web.api.dto.RevisionDTO; |
| import org.apache.nifi.web.api.entity.AccessPolicyEntity; |
| import org.apache.nifi.web.api.request.ClientIdParameter; |
| import org.apache.nifi.web.api.request.LongParameter; |
| import org.apache.nifi.web.dao.AccessPolicyDAO; |
| |
| import javax.servlet.http.HttpServletRequest; |
| import javax.ws.rs.Consumes; |
| import javax.ws.rs.DELETE; |
| import javax.ws.rs.DefaultValue; |
| import javax.ws.rs.GET; |
| import javax.ws.rs.HttpMethod; |
| import javax.ws.rs.POST; |
| import javax.ws.rs.PUT; |
| import javax.ws.rs.Path; |
| import javax.ws.rs.PathParam; |
| import javax.ws.rs.Produces; |
| import javax.ws.rs.QueryParam; |
| import javax.ws.rs.core.Context; |
| import javax.ws.rs.core.MediaType; |
| import javax.ws.rs.core.Response; |
| import java.net.URI; |
| |
| /** |
| * RESTful endpoint for managing access policies. |
| */ |
| @Path("/policies") |
| @Api( |
| value = "/policies", |
| description = "Endpoint for managing access policies." |
| ) |
| public class AccessPolicyResource extends ApplicationResource { |
| |
| private final NiFiServiceFacade serviceFacade; |
| private final Authorizer authorizer; |
| |
| public AccessPolicyResource(NiFiServiceFacade serviceFacade, Authorizer authorizer, NiFiProperties properties, RequestReplicator requestReplicator, |
| ClusterCoordinator clusterCoordinator, FlowController flowController) { |
| this.serviceFacade = serviceFacade; |
| this.authorizer = authorizer; |
| setProperties(properties); |
| setRequestReplicator(requestReplicator); |
| setClusterCoordinator(clusterCoordinator); |
| setFlowController(flowController); |
| } |
| |
| /** |
| * Populates the uri for the specified access policy. |
| * |
| * @param accessPolicyEntity accessPolicyEntity |
| * @return accessPolicyEntity |
| */ |
| public AccessPolicyEntity populateRemainingAccessPolicyEntityContent(AccessPolicyEntity accessPolicyEntity) { |
| accessPolicyEntity.setUri(generateResourceUri("policies", accessPolicyEntity.getId())); |
| return accessPolicyEntity; |
| } |
| |
| // ----------------- |
| // get access policy |
| // ----------------- |
| |
| /** |
| * Retrieves the specified access policy. |
| * |
| * @return An accessPolicyEntity. |
| */ |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{action}/{resource: .+}") |
| @ApiOperation( |
| value = "Gets an access policy for the specified action and resource", |
| notes = "Will return the effective policy if no component specific policy exists for the specified action and resource. " |
| + "Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is " |
| + "returned will be indicated in the response. This means the client could be authorized to get the policy for a " |
| + "given component but the effective policy may be inherited from an ancestor Process Group. If the client does not " |
| + "have permissions to that policy, the response will not include the policy and the permissions in the response " |
| + "will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource " |
| + "a 403 response will be returned.", |
| response = AccessPolicyEntity.class, |
| authorizations = { |
| @Authorization(value = "Read - /policies/{resource}") |
| } |
| ) |
| @ApiResponses( |
| value = { |
| @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), |
| @ApiResponse(code = 401, message = "Client could not be authenticated."), |
| @ApiResponse(code = 403, message = "Client is not authorized to make this request."), |
| @ApiResponse(code = 404, message = "The specified resource could not be found."), |
| @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") |
| } |
| ) |
| public Response getAccessPolicyForResource( |
| @ApiParam( |
| value = "The request action.", |
| allowableValues = "read, write", |
| required = true |
| ) @PathParam("action") final String action, |
| @ApiParam( |
| value = "The resource of the policy.", |
| required = true |
| ) @PathParam("resource") String rawResource) { |
| |
| // ensure we're running with a configurable authorizer |
| if (!AuthorizerCapabilityDetection.isManagedAuthorizer(authorizer)) { |
| throw new IllegalStateException(AccessPolicyDAO.MSG_NON_MANAGED_AUTHORIZER); |
| } |
| |
| // parse the action and resource type |
| final RequestAction requestAction = RequestAction.valueOfValue(action); |
| final String resource = "/" + rawResource; |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| // authorize access |
| serviceFacade.authorizeAccess(lookup -> { |
| final Authorizable accessPolicy = lookup.getAccessPolicyByResource(resource); |
| accessPolicy.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); |
| }); |
| |
| // get the access policy |
| final AccessPolicyEntity entity = serviceFacade.getAccessPolicy(requestAction, resource); |
| populateRemainingAccessPolicyEntityContent(entity); |
| |
| return generateOkResponse(entity).build(); |
| } |
| |
| // ----------------------- |
| // manage an access policy |
| // ----------------------- |
| |
| /** |
| * Creates a new access policy. |
| * |
| * @param httpServletRequest request |
| * @param requestAccessPolicyEntity An accessPolicyEntity. |
| * @return An accessPolicyEntity. |
| */ |
| @POST |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Produces(MediaType.APPLICATION_JSON) |
| @ApiOperation( |
| value = "Creates an access policy", |
| response = AccessPolicyEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /policies/{resource}") |
| } |
| ) |
| @ApiResponses( |
| value = { |
| @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), |
| @ApiResponse(code = 401, message = "Client could not be authenticated."), |
| @ApiResponse(code = 403, message = "Client is not authorized to make this request."), |
| @ApiResponse(code = 404, message = "The specified resource could not be found."), |
| @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") |
| } |
| ) |
| public Response createAccessPolicy( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The access policy configuration details.", |
| required = true |
| ) final AccessPolicyEntity requestAccessPolicyEntity) { |
| |
| // ensure we're running with a configurable authorizer |
| if (!AuthorizerCapabilityDetection.isConfigurableAccessPolicyProvider(authorizer)) { |
| throw new IllegalStateException(AccessPolicyDAO.MSG_NON_CONFIGURABLE_POLICIES); |
| } |
| |
| if (requestAccessPolicyEntity == null || requestAccessPolicyEntity.getComponent() == null) { |
| throw new IllegalArgumentException("Access policy details must be specified."); |
| } |
| |
| if (requestAccessPolicyEntity.getRevision() == null || (requestAccessPolicyEntity.getRevision().getVersion() == null || requestAccessPolicyEntity.getRevision().getVersion() != 0)) { |
| throw new IllegalArgumentException("A revision of 0 must be specified when creating a new Policy."); |
| } |
| |
| final AccessPolicyDTO requestAccessPolicy = requestAccessPolicyEntity.getComponent(); |
| if (requestAccessPolicy.getId() != null) { |
| throw new IllegalArgumentException("Access policy ID cannot be specified."); |
| } |
| |
| if (requestAccessPolicy.getResource() == null) { |
| throw new IllegalArgumentException("Access policy resource must be specified."); |
| } |
| |
| // ensure this is a valid action |
| RequestAction.valueOfValue(requestAccessPolicy.getAction()); |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.POST, requestAccessPolicyEntity); |
| } else if (isDisconnectedFromCluster()) { |
| verifyDisconnectedNodeModification(requestAccessPolicyEntity.isDisconnectedNodeAcknowledged()); |
| } |
| |
| // handle expects request (usually from the cluster manager) |
| return withWriteLock( |
| serviceFacade, |
| requestAccessPolicyEntity, |
| lookup -> { |
| final Authorizable accessPolicies = lookup.getAccessPolicyByResource(requestAccessPolicy.getResource()); |
| accessPolicies.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| }, |
| null, |
| accessPolicyEntity -> { |
| final AccessPolicyDTO accessPolicy = accessPolicyEntity.getComponent(); |
| |
| // set the access policy id as appropriate |
| accessPolicy.setId(generateUuid()); |
| |
| // get revision from the config |
| final RevisionDTO revisionDTO = accessPolicyEntity.getRevision(); |
| Revision revision = new Revision(revisionDTO.getVersion(), revisionDTO.getClientId(), accessPolicyEntity.getComponent().getId()); |
| |
| // create the access policy and generate the json |
| final AccessPolicyEntity entity = serviceFacade.createAccessPolicy(revision, accessPolicyEntity.getComponent()); |
| populateRemainingAccessPolicyEntityContent(entity); |
| |
| // build the response |
| return generateCreatedResponse(URI.create(entity.getUri()), entity).build(); |
| } |
| ); |
| } |
| |
| /** |
| * Retrieves the specified access policy. |
| * |
| * @param id The id of the access policy to retrieve |
| * @return An accessPolicyEntity. |
| */ |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{id}") |
| @ApiOperation( |
| value = "Gets an access policy", |
| response = AccessPolicyEntity.class, |
| authorizations = { |
| @Authorization(value = "Read - /policies/{resource}") |
| } |
| ) |
| @ApiResponses( |
| value = { |
| @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), |
| @ApiResponse(code = 401, message = "Client could not be authenticated."), |
| @ApiResponse(code = 403, message = "Client is not authorized to make this request."), |
| @ApiResponse(code = 404, message = "The specified resource could not be found."), |
| @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") |
| } |
| ) |
| public Response getAccessPolicy( |
| @ApiParam( |
| value = "The access policy id.", |
| required = true |
| ) |
| @PathParam("id") final String id) { |
| |
| // ensure we're running with a configurable authorizer |
| if (!AuthorizerCapabilityDetection.isManagedAuthorizer(authorizer)) { |
| throw new IllegalStateException(AccessPolicyDAO.MSG_NON_MANAGED_AUTHORIZER); |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| // authorize access |
| serviceFacade.authorizeAccess(lookup -> { |
| Authorizable authorizable = lookup.getAccessPolicyById(id); |
| authorizable.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); |
| }); |
| |
| // get the access policy |
| final AccessPolicyEntity entity = serviceFacade.getAccessPolicy(id); |
| populateRemainingAccessPolicyEntityContent(entity); |
| |
| return generateOkResponse(entity).build(); |
| } |
| |
| /** |
| * Updates an access policy. |
| * |
| * @param httpServletRequest request |
| * @param id The id of the access policy to update. |
| * @param requestAccessPolicyEntity An accessPolicyEntity. |
| * @return An accessPolicyEntity. |
| */ |
| @PUT |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{id}") |
| @ApiOperation( |
| value = "Updates a access policy", |
| response = AccessPolicyEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /policies/{resource}") |
| } |
| ) |
| @ApiResponses( |
| value = { |
| @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), |
| @ApiResponse(code = 401, message = "Client could not be authenticated."), |
| @ApiResponse(code = 403, message = "Client is not authorized to make this request."), |
| @ApiResponse(code = 404, message = "The specified resource could not be found."), |
| @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") |
| } |
| ) |
| public Response updateAccessPolicy( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The access policy id.", |
| required = true |
| ) |
| @PathParam("id") final String id, |
| @ApiParam( |
| value = "The access policy configuration details.", |
| required = true |
| ) final AccessPolicyEntity requestAccessPolicyEntity) { |
| |
| // ensure we're running with a configurable authorizer |
| if (!AuthorizerCapabilityDetection.isConfigurableAccessPolicyProvider(authorizer)) { |
| throw new IllegalStateException(AccessPolicyDAO.MSG_NON_CONFIGURABLE_POLICIES); |
| } |
| |
| if (requestAccessPolicyEntity == null || requestAccessPolicyEntity.getComponent() == null) { |
| throw new IllegalArgumentException("Access policy details must be specified."); |
| } |
| |
| if (requestAccessPolicyEntity.getRevision() == null) { |
| throw new IllegalArgumentException("Revision must be specified."); |
| } |
| |
| // ensure the ids are the same |
| final AccessPolicyDTO requestAccessPolicyDTO = requestAccessPolicyEntity.getComponent(); |
| if (!id.equals(requestAccessPolicyDTO.getId())) { |
| throw new IllegalArgumentException(String.format("The access policy id (%s) in the request body does not equal the " |
| + "access policy id of the requested resource (%s).", requestAccessPolicyDTO.getId(), id)); |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.PUT, requestAccessPolicyEntity); |
| } else if (isDisconnectedFromCluster()) { |
| verifyDisconnectedNodeModification(requestAccessPolicyEntity.isDisconnectedNodeAcknowledged()); |
| } |
| |
| // Extract the revision |
| final Revision requestRevision = getRevision(requestAccessPolicyEntity, id); |
| return withWriteLock( |
| serviceFacade, |
| requestAccessPolicyEntity, |
| requestRevision, |
| lookup -> { |
| Authorizable authorizable = lookup.getAccessPolicyById(id); |
| authorizable.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| }, |
| null, |
| (revision, accessPolicyEntity) -> { |
| final AccessPolicyDTO accessPolicyDTO = accessPolicyEntity.getComponent(); |
| |
| // update the access policy |
| final AccessPolicyEntity entity = serviceFacade.updateAccessPolicy(revision, accessPolicyDTO); |
| populateRemainingAccessPolicyEntityContent(entity); |
| |
| return generateOkResponse(entity).build(); |
| } |
| ); |
| } |
| |
| /** |
| * Removes the specified access policy. |
| * |
| * @param httpServletRequest request |
| * @param version The revision is used to verify the client is working with |
| * the latest version of the flow. |
| * @param clientId Optional client id. If the client id is not specified, a |
| * new one will be generated. This value (whether specified or generated) is |
| * included in the response. |
| * @param id The id of the access policy to remove. |
| * @return A entity containing the client id and an updated revision. |
| */ |
| @DELETE |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{id}") |
| @ApiOperation( |
| value = "Deletes an access policy", |
| response = AccessPolicyEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /policies/{resource}"), |
| @Authorization(value = "Write - Policy of the parent resource - /policies/{resource}") |
| } |
| ) |
| @ApiResponses( |
| value = { |
| @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), |
| @ApiResponse(code = 401, message = "Client could not be authenticated."), |
| @ApiResponse(code = 403, message = "Client is not authorized to make this request."), |
| @ApiResponse(code = 404, message = "The specified resource could not be found."), |
| @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") |
| } |
| ) |
| public Response removeAccessPolicy( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The revision is used to verify the client is working with the latest version of the flow.", |
| required = false |
| ) |
| @QueryParam(VERSION) final LongParameter version, |
| @ApiParam( |
| value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", |
| required = false |
| ) |
| @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) final ClientIdParameter clientId, |
| @ApiParam( |
| value = "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", |
| required = false |
| ) |
| @QueryParam(DISCONNECTED_NODE_ACKNOWLEDGED) @DefaultValue("false") final Boolean disconnectedNodeAcknowledged, |
| @ApiParam( |
| value = "The access policy id.", |
| required = true |
| ) |
| @PathParam("id") final String id) { |
| |
| // ensure we're running with a configurable authorizer |
| if (!AuthorizerCapabilityDetection.isConfigurableAccessPolicyProvider(authorizer)) { |
| throw new IllegalStateException(AccessPolicyDAO.MSG_NON_CONFIGURABLE_POLICIES); |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.DELETE); |
| } else if (isDisconnectedFromCluster()) { |
| verifyDisconnectedNodeModification(disconnectedNodeAcknowledged); |
| } |
| |
| final AccessPolicyEntity requestAccessPolicyEntity = new AccessPolicyEntity(); |
| requestAccessPolicyEntity.setId(id); |
| |
| // handle expects request (usually from the cluster manager) |
| final Revision requestRevision = new Revision(version == null ? null : version.getLong(), clientId.getClientId(), id); |
| return withWriteLock( |
| serviceFacade, |
| requestAccessPolicyEntity, |
| requestRevision, |
| lookup -> { |
| final Authorizable accessPolicy = lookup.getAccessPolicyById(id); |
| |
| // ensure write permission to the access policy |
| accessPolicy.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| |
| // ensure write permission to the policy for the parent process group |
| accessPolicy.getParentAuthorizable().authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| }, |
| null, |
| (revision, accessPolicyEntity) -> { |
| // delete the specified access policy |
| final AccessPolicyEntity entity = serviceFacade.deleteAccessPolicy(revision, accessPolicyEntity.getId()); |
| return generateOkResponse(entity).build(); |
| } |
| ); |
| } |
| } |
