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/03/02 16:26:31 UTC
[GitHub] [nifi] jwoschitz opened a new pull request #4866: NIFI-8286 Extended CertificateUtils to allow parsing of CNs conforming to RFC5280
jwoschitz opened a new pull request #4866:
URL: https://github.com/apache/nifi/pull/4866
Thank you for submitting a contribution to Apache NiFi.
Please provide a short description of the PR here:
#### Description of PR
This PR addresses the issues described in https://issues.apache.org/jira/browse/NIFI-8286. It enables parsing of subject distinguished names which contain an embedded emailAddress attribute, which is a valid (though legacy) way to define a subject according to RFC5280.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [x] 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.
- [x] Has your PR been rebased against the latest commit within the target branch (typically `main`)?
- [x] 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:
- [x] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
- [x] Have you written or updated unit tests to verify your changes?
- [ ] Have you verified that the full build is successful on JDK 8?
- [x] 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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] jwoschitz commented on a change in pull request #4866: NIFI-8286 Extended CertificateUtils to allow parsing of CNs conforming to RFC5280
Posted by GitBox <gi...@apache.org>.
jwoschitz commented on a change in pull request #4866:
URL: https://github.com/apache/nifi/pull/4866#discussion_r585777687
##########
File path: nifi-commons/nifi-security-utils/src/main/java/org/apache/nifi/security/util/CertificateUtils.java
##########
@@ -149,6 +149,27 @@ public static String extractUsername(String dn) {
username = StringUtils.substring(dn, cnIndex + cnPattern.length());
}
}
+
+ /*
+ https://tools.ietf.org/html/rfc5280#section-4.1.2.6
+
+ Legacy implementations exist where an electronic mail address is
+ embedded in the subject distinguished name as an emailAddress
+ attribute [RFC2985]. The attribute value for emailAddress is of type
+ IA5String to permit inclusion of the character '@', which is not part
+ of the PrintableString character set. emailAddress attribute values
+ are not case-sensitive (e.g., "subscriber@example.com" is the same as
+ "SUBSCRIBER@EXAMPLE.COM").
+ */
+ final String emailPattern = "/emailAddress=";
+ final int index = StringUtils.indexOfIgnoreCase(username, emailPattern);
+ if (index >= 0) {
+ String[] dnParts = username.split(emailPattern);
+ if (dnParts.length > 0) {
+ // only use the actual CN
+ username = dnParts[0];
+ }
+ }
Review comment:
Yes, I considered it, though as the other logic (see already existing code above the lines added by me) was not using regex for a similar problem, I tried to keep the code consistent by following the same approach.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] exceptionfactory commented on a change in pull request #4866: NIFI-8286 Extended CertificateUtils to allow parsing of CNs conforming to RFC5280
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #4866:
URL: https://github.com/apache/nifi/pull/4866#discussion_r585743722
##########
File path: nifi-commons/nifi-security-utils/src/main/java/org/apache/nifi/security/util/CertificateUtils.java
##########
@@ -149,6 +149,27 @@ public static String extractUsername(String dn) {
username = StringUtils.substring(dn, cnIndex + cnPattern.length());
}
}
+
+ /*
+ https://tools.ietf.org/html/rfc5280#section-4.1.2.6
+
+ Legacy implementations exist where an electronic mail address is
+ embedded in the subject distinguished name as an emailAddress
+ attribute [RFC2985]. The attribute value for emailAddress is of type
+ IA5String to permit inclusion of the character '@', which is not part
+ of the PrintableString character set. emailAddress attribute values
+ are not case-sensitive (e.g., "subscriber@example.com" is the same as
+ "SUBSCRIBER@EXAMPLE.COM").
+ */
+ final String emailPattern = "/emailAddress=";
+ final int index = StringUtils.indexOfIgnoreCase(username, emailPattern);
+ if (index >= 0) {
+ String[] dnParts = username.split(emailPattern);
+ if (dnParts.length > 0) {
+ // only use the actual CN
+ username = dnParts[0];
+ }
+ }
Review comment:
Did you consider using regular expression pattern? That might simplify the approach and the Pattern could be compiled as a static variable.
```suggestion
// Replace variable with: private static final Pattern EMAIL_ATTRIBUTE_PATTERN = Pattern.compile("/emailAddress=.+");
final Pattern emailAttributePattern = Pattern.compile("/emailAddress=.+");
final Matcher emailMatcher = emailAttributePattern.matcher(username);
if (emailMatcher.find()) {
username = emailMatcher.replace(StringUtils.EMPTY);
}
```
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] exceptionfactory commented on a change in pull request #4866: NIFI-8286 Extended CertificateUtils to allow parsing of CNs conforming to RFC5280
Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #4866:
URL: https://github.com/apache/nifi/pull/4866#discussion_r585786422
##########
File path: nifi-commons/nifi-security-utils/src/main/java/org/apache/nifi/security/util/CertificateUtils.java
##########
@@ -149,6 +149,27 @@ public static String extractUsername(String dn) {
username = StringUtils.substring(dn, cnIndex + cnPattern.length());
}
}
+
+ /*
+ https://tools.ietf.org/html/rfc5280#section-4.1.2.6
+
+ Legacy implementations exist where an electronic mail address is
+ embedded in the subject distinguished name as an emailAddress
+ attribute [RFC2985]. The attribute value for emailAddress is of type
+ IA5String to permit inclusion of the character '@', which is not part
+ of the PrintableString character set. emailAddress attribute values
+ are not case-sensitive (e.g., "subscriber@example.com" is the same as
+ "SUBSCRIBER@EXAMPLE.COM").
+ */
+ final String emailPattern = "/emailAddress=";
+ final int index = StringUtils.indexOfIgnoreCase(username, emailPattern);
+ if (index >= 0) {
+ String[] dnParts = username.split(emailPattern);
+ if (dnParts.length > 0) {
+ // only use the actual CN
+ username = dnParts[0];
+ }
+ }
Review comment:
Thanks for the reply @jwoschitz, that's a good point. Following the approach of the existing code sounds good.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] asfgit closed pull request #4866: NIFI-8286 Extended CertificateUtils to allow parsing of CNs conforming to RFC5280
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #4866:
URL: https://github.com/apache/nifi/pull/4866
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org