You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "gforeman02 (via GitHub)" <gi...@apache.org> on 2024/02/29 23:12:37 UTC
[PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
gforeman02 opened a new pull request, #8462:
URL: https://github.com/apache/nifi/pull/8462
<!-- 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. -->
# Summary
[NIFI-12300](https://issues.apache.org/jira/browse/NIFI-12300)
# Tracking
Please complete the following tracking steps prior to pull request creation.
### Issue Tracking
- [x] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue created
### Pull Request Tracking
- [x] Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000`
- [x] Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000`
### Pull Request Formatting
- [x] Pull Request based on current revision of the `main` branch
- [x] Pull Request refers to a feature branch with one commit containing changes
# Verification
Please indicate the verification steps performed prior to pull request creation.
### Build
- [x] Build completed using `mvn clean install -P contrib-check`
- [x] JDK 21
### Licensing
- [x] New dependencies are compatible with the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html)
- [x] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
### Documentation
- [x] Documentation formatting appears as expected in rendered files
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "gforeman02 (via GitHub)" <gi...@apache.org>.
gforeman02 commented on PR #8462:
URL: https://github.com/apache/nifi/pull/8462#issuecomment-2083160210
@exceptionfactory you are very welcome! I was working on trying to squash the commits but time slipped away from me. I will work on that in the future.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on code in PR #8462:
URL: https://github.com/apache/nifi/pull/8462#discussion_r1578830831
##########
nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/pom.xml:
##########
@@ -148,6 +148,11 @@
<artifactId>nifi-schema-registry-service-api</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.nifi</groupId>
+ <artifactId>nifi-oauth2-provider-api</artifactId>
+ <scope>compile</scope>
Review Comment:
The scope should be removed so that it receives the default `provided` from the parent configuration.
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on code in PR #8462:
URL: https://github.com/apache/nifi/pull/8462#discussion_r1571421430
##########
nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/main/java/org/apache/nifi/lookup/RestLookupService.java:
##########
@@ -125,11 +127,30 @@ public class RestLookupService extends AbstractControllerService implements Reco
.identifiesControllerService(SSLContextService.class)
.build();
+ public static final PropertyDescriptor AUTHENTICATION_STRATEGY = new PropertyDescriptor.Builder()
+ .name("rest-lookup-authentication-strategy")
+ .displayName("Authentication Strategy")
+ .description("Authentication strategy to use with REST service.")
+ .required(true)
+ .allowableValues(AuthenticationStrategy.class)
+ .defaultValue(AuthenticationStrategy.NONE)
+ .build();
+
+ public static final PropertyDescriptor OAUTH2_ACCESS_TOKEN_PROVIDER = new PropertyDescriptor.Builder()
+ .name("rest-lookup-oauth2-access-token-provider")
+ .displayName("OAuth2 Access Token Provider")
+ .description("Enables managed retrieval of OAuth2 Bearer Token applied to HTTP requests using the Authorization Header.")
+ .identifiesControllerService(OAuth2AccessTokenProvider.class)
+ .required(false)
Review Comment:
This can be changed to `true` since the `dependOn()` check makes it conditional, and it is required when the associated strategy is selected.
```suggestion
.required(true)
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on code in PR #8462:
URL: https://github.com/apache/nifi/pull/8462#discussion_r1571469591
##########
nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/main/java/org/apache/nifi/lookup/RestLookupService.java:
##########
@@ -125,11 +127,30 @@ public class RestLookupService extends AbstractControllerService implements Reco
.identifiesControllerService(SSLContextService.class)
.build();
+ public static final PropertyDescriptor AUTHENTICATION_STRATEGY = new PropertyDescriptor.Builder()
+ .name("rest-lookup-authentication-strategy")
+ .displayName("Authentication Strategy")
+ .description("Authentication strategy to use with REST service.")
+ .required(true)
+ .allowableValues(AuthenticationStrategy.class)
+ .defaultValue(AuthenticationStrategy.NONE)
+ .build();
+
+ public static final PropertyDescriptor OAUTH2_ACCESS_TOKEN_PROVIDER = new PropertyDescriptor.Builder()
+ .name("rest-lookup-oauth2-access-token-provider")
+ .displayName("OAuth2 Access Token Provider")
+ .description("Enables managed retrieval of OAuth2 Bearer Token applied to HTTP requests using the Authorization Header.")
+ .identifiesControllerService(OAuth2AccessTokenProvider.class)
+ .required(false)
Review Comment:
That could apply to those properties, but since they are existing, it seems reasonable to leave them unchanged for the scope of this particular pull request so as not to introduce any unexpected changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "gforeman02 (via GitHub)" <gi...@apache.org>.
gforeman02 commented on PR #8462:
URL: https://github.com/apache/nifi/pull/8462#issuecomment-2059882296
@exceptionfactory I appreciate the review. The modifications are ready for review. I believe migrateProperties() method is required to account for controller properties that currently have Basic Authentication selected, but let me know if you see differently.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "gforeman02 (via GitHub)" <gi...@apache.org>.
gforeman02 commented on code in PR #8462:
URL: https://github.com/apache/nifi/pull/8462#discussion_r1571431883
##########
nifi-nar-bundles/nifi-standard-services/nifi-lookup-services-bundle/nifi-lookup-services/src/main/java/org/apache/nifi/lookup/RestLookupService.java:
##########
@@ -125,11 +127,30 @@ public class RestLookupService extends AbstractControllerService implements Reco
.identifiesControllerService(SSLContextService.class)
.build();
+ public static final PropertyDescriptor AUTHENTICATION_STRATEGY = new PropertyDescriptor.Builder()
+ .name("rest-lookup-authentication-strategy")
+ .displayName("Authentication Strategy")
+ .description("Authentication strategy to use with REST service.")
+ .required(true)
+ .allowableValues(AuthenticationStrategy.class)
+ .defaultValue(AuthenticationStrategy.NONE)
+ .build();
+
+ public static final PropertyDescriptor OAUTH2_ACCESS_TOKEN_PROVIDER = new PropertyDescriptor.Builder()
+ .name("rest-lookup-oauth2-access-token-provider")
+ .displayName("OAuth2 Access Token Provider")
+ .description("Enables managed retrieval of OAuth2 Bearer Token applied to HTTP requests using the Authorization Header.")
+ .identifiesControllerService(OAuth2AccessTokenProvider.class)
+ .required(false)
Review Comment:
@exceptionfactory I assume this will also apply to the basic auth username and password fields as well now that they also depend on the selection.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] NIFI-12300: Add oauth2 support for RestLookupService [nifi]
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory merged PR #8462:
URL: https://github.com/apache/nifi/pull/8462
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org