You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2021/12/06 14:17:03 UTC
[GitHub] [nifi] simonbence opened a new pull request #5574: NIFI-9397 Extending JettyWebServerClient authorization possibilities with custom setup
simonbence opened a new pull request #5574:
URL: https://github.com/apache/nifi/pull/5574
[NIFI-9397](https://issues.apache.org/jira/browse/NIFI-9397)
Adding a new property in order to open the possibility of using custom authorization, like for example using api key as a manner of auth.
<!--
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.
-->
Thank you for submitting a contribution to Apache NiFi.
Please provide a short description of the PR here:
#### Description of PR
_Enables X functionality; fixes bug NIFI-YYYY._
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 `main`)?
- [ ] Is your initial contribution a single, squashed commit? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
### 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?
- [ ] Have you verified that the full build is successful on JDK 8?
- [ ] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] 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 GitHub Actions CI for build issues and submit an update to your PR as soon as possible.
--
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
[GitHub] [nifi] exceptionfactory commented on a change in pull request #5574: NIFI-9397 Extending JettyWebServerClient authorization possibilities with custom setup
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5574:
URL: https://github.com/apache/nifi/pull/5574#discussion_r763566902
##########
File path: nifi-nar-bundles/nifi-websocket-bundle/nifi-websocket-services-jetty/src/main/java/org/apache/nifi/websocket/jetty/JettyWebSocketClient.java
##########
@@ -145,6 +145,19 @@
.defaultValue("US-ASCII")
.build();
+ public static final PropertyDescriptor CUSTOM_AUTH = new PropertyDescriptor.Builder()
+ .name("custom-authorization")
+ .displayName("Custom Authorization")
+ .description(
+ "If set tgether with \"User Name\" and \"User Password\", instead of using Basic" +
Review comment:
For additional documentation, it would be helpful to include the official standard reference [RFC 7235 Section 4.2](https://datatracker.ietf.org/doc/html/rfc7235#section-4.2).
```suggestion
"Configures a custom HTTP Authorization Header as described in RFC 7235 Section 4.2. Setting a custom Authorization Header excludes configuring the User Name and User Password properties for Basic Authentication." +
```
##########
File path: nifi-nar-bundles/nifi-websocket-bundle/nifi-websocket-services-jetty/src/main/java/org/apache/nifi/websocket/jetty/JettyWebSocketClient.java
##########
@@ -145,6 +145,19 @@
.defaultValue("US-ASCII")
.build();
+ public static final PropertyDescriptor CUSTOM_AUTH = new PropertyDescriptor.Builder()
+ .name("custom-authorization")
+ .displayName("Custom Authorization")
+ .description(
+ "If set tgether with \"User Name\" and \"User Password\", instead of using Basic" +
+ " Authentication the value of the property will be assigned to the \"Authorization\" HTTP header.")
Review comment:
Instead of describing the behavior this way, what do you think about extending the `customValidate()` method to ensure that setting this property excludes setting `User Name` and `User Password`, and vice versa? Checking the both this property and the other credentials properties and not set would help avoid potential confusion in the component configuration.
--
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
[GitHub] [nifi] exceptionfactory closed pull request #5574: NIFI-9397 Extending JettyWebSocketClient authorization possibilities with custom setup
Posted by GitBox <gi...@apache.org>.
exceptionfactory closed pull request #5574:
URL: https://github.com/apache/nifi/pull/5574
--
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
[GitHub] [nifi] simonbence commented on a change in pull request #5574: NIFI-9397 Extending JettyWebSocketClient authorization possibilities with custom setup
Posted by GitBox <gi...@apache.org>.
simonbence commented on a change in pull request #5574:
URL: https://github.com/apache/nifi/pull/5574#discussion_r764029839
##########
File path: nifi-nar-bundles/nifi-websocket-bundle/nifi-websocket-services-jetty/src/main/java/org/apache/nifi/websocket/jetty/JettyWebSocketClient.java
##########
@@ -145,6 +145,19 @@
.defaultValue("US-ASCII")
.build();
+ public static final PropertyDescriptor CUSTOM_AUTH = new PropertyDescriptor.Builder()
+ .name("custom-authorization")
+ .displayName("Custom Authorization")
+ .description(
+ "If set tgether with \"User Name\" and \"User Password\", instead of using Basic" +
+ " Authentication the value of the property will be assigned to the \"Authorization\" HTTP header.")
Review comment:
Thank again, this is a good idea. I really had no strong reason to go with just documenting it.
--
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
[GitHub] [nifi] exceptionfactory commented on a change in pull request #5574: NIFI-9397 Extending JettyWebServerClient authorization possibilities with custom setup
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5574:
URL: https://github.com/apache/nifi/pull/5574#discussion_r763564415
##########
File path: nifi-nar-bundles/nifi-websocket-bundle/nifi-websocket-services-jetty/src/main/java/org/apache/nifi/websocket/jetty/JettyWebSocketClient.java
##########
@@ -145,6 +145,19 @@
.defaultValue("US-ASCII")
.build();
+ public static final PropertyDescriptor CUSTOM_AUTH = new PropertyDescriptor.Builder()
+ .name("custom-authorization")
+ .displayName("Custom Authorization")
+ .description(
+ "If set tgether with \"User Name\" and \"User Password\", instead of using Basic" +
+ " Authentication the value of the property will be assigned to the \"Authorization\" HTTP header.")
Review comment:
Instead of describing the behavior this way, what do you think about extending the `customValidate()` method to ensure that setting this property excludes setting `User Name` and `User Password`, and vice versa? Checking that both this property and the other credentials properties are not set would help avoid potential confusion in the component configuration.
--
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