Skip to content

NIFI-9283 Exclude Log4j 1.2 and Upgrade Log4j2 to 2.14.1#5440

Closed
exceptionfactory wants to merge 1 commit intoapache:mainfrom
exceptionfactory:NIFI-9283
Closed

NIFI-9283 Exclude Log4j 1.2 and Upgrade Log4j2 to 2.14.1#5440
exceptionfactory wants to merge 1 commit intoapache:mainfrom
exceptionfactory:NIFI-9283

Conversation

@exceptionfactory
Copy link
Contributor

Description of PR

NIFI-9283 Excludes Log4j 1.2 using Maven coordinates log4j:log4j from all referencing modules and also upgrades older versions of Log4j2 to 2.14.1.

The Encrypt Config Tool included direct usage of Log4j 1.2 and now depends on SLF4J Simple logging. Several unit tests included unnecessary references to the Log4j 1.2 BasicConfigurer.

These changes address several vulnerabilities associated with optional Socket Appenders in Log4j 1.2 and earlier versions of Log4j2.

The Maven Enforcer Plugin configuration also includes log4j:log4j as a banned dependency to avoid potential future inclusion of Log4j 1.2. As noted in comments and changes, log4j-over-slf4j should be used to provide a runtime bridge from Log4j to SLF4J.

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?
  • 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.

Copy link
Contributor

@gresockj gresockj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall approach looks good -- I see one dependency that was missed, perhaps due to NIFI-8002 recently being merged:

$ find . -type f -name 'log4j*'
./work/nar/extensions/nifi-elasticsearch-client-service-nar-1.15.0-SNAPSHOT.nar-unpacked/NAR-INF/bundled-dependencies/log4j-core-2.14.1.jar
./work/nar/extensions/nifi-elasticsearch-client-service-nar-1.15.0-SNAPSHOT.nar-unpacked/NAR-INF/bundled-dependencies/log4j-api-2.14.1.jar
./lib/log4j-over-slf4j-1.7.32.jar

Edit: actually, on second inspection, this would be the Log4j2 update to 2.14.1 you referenced. Disregard!

Copy link
Contributor

@gresockj gresockj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR, @exceptionfactory. I verified that the logging still looks good in nifi-toolkit and NiFi. Will merge!

@asfgit asfgit closed this in 4bcd030 Oct 6, 2021
@exceptionfactory exceptionfactory added the hacktoberfest-accepted Hacktoberfest Accepted label Oct 8, 2021
krisztina-zsihovszki pushed a commit to krisztina-zsihovszki/nifi that referenced this pull request Jun 28, 2022
Signed-off-by: Joe Gresock <jgresock@gmail.com>

This closes apache#5440.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hacktoberfest-accepted Hacktoberfest Accepted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants