log4jscanner

Module utilizing Google's log4jscanner to scan infrastructure for vulnerable log4j JARs

Project URL RSS Feed Report issues

Module Stats

7,408 downloads

3,645 latest version

5.0 quality score

Version information

released Jan 14th 2022

This version is compatible with:

Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
Puppet >= 6.0.0 < 8.0.0
, , , , , , , , , , ,

Tasks:

run_scan

run_scan_osx

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-log4jscanner', '0.4.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-log4jscanner

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-log4jscanner --version 0.4.0

Documentation

puppetlabs/log4jscanner — version 0.4.0 Jan 14th 2022

log4jscanner

This module utilizes Google's log4jscanner tool to monitor your infrastructure for vulnerable jar files.

Description

This module can be used in two ways:

Run the log4jscanner::run_scan task on a node. A list of vulernable jars is printed in the task output.
Apply the log4jscanner class to any Linux or Windows nodes with a Puppet Agent. This will set up a scheduled task to scan for vulnerable jars once per day, and keeps a custom fact called 'log4jscanner' updated with the results.

Log4jscanner binaries

The binaries were compiled using Go version 1.17.5 and running go build from the google/log4jscanner repo at SHA edf4af1a38a2930c86fdd955da1719e3d649441c. log4jscanner_nix was compiled on Centos 7, log4jscanner.exe on Windows 2019, and log4jscanner_osx on 10.15.

Compiling your own binaries

If you'd like to compile your own binaries or add support for another platform, this is the rough workflow to follow. Feel free to contribute new platform support with a pull request to this repository.

Compile binaries and add them to the /files directory. Use the existing naming convention of log4jscanner_<platform>.
- If you're replacing a binary, ensure it's named exactly the same as the original.
Calculate the sha256 checksum for each binary with a command like sha256sum log4jscanner_nix.
Add the checksums to the appropriate places in the log4jscanner class in /manifests/init.pp.
- Add the appropriate conditional logic if you're adding new platform support.
If you're adding support for another platform, then create a platform specific task following the example of the log4jscanner::run_scan_osx task.

Setup

What log4jscanner affects

When the class is applied, the module provides an additional fact (log4jscanner). This also adds a cron job (Linux) or scheduled task (Windows) that defaults to running once per day.

On Linux systems, files are saved to /opt/puppetlabs/log4jscanner. On Windows, they are saved to C:\ProgramData\PuppetLabs\log4jscanner.

Usage

Manifest

Include the module:

include log4jscanner

Advanced usage:

class { 'log4jscanner':
  linux_directories => ['/opt', '/usr'],
  linux_skip_directories => ['/opt/puppetlabs'],
  cron_hour = 12,
  cron_minute = 30,
  windows_directories => ["C:"],
  windows_skip_directories => ["C:\\Windows\\Temp"],
  scheduled_task_every = 2,
}

In this example, all Linux nodes will scan the /opt and /usr directories, while skipping /opt/puppetlabs, and all Windows nodes will scan C: and skip the Windows temp directory. It will scan Linux nodes every day at 12:30 PM, and Windows nodes every other day.

Note that when using the class with OSX, you'll want to use the osx_directories and osx_skip parameters, and you'll likely need to change the scan_data_group to admin rather than root.

Task

Run a basic scan from the command line:

puppet task run log4jscanner::run_scan --nodes <nodes> directories=/opt,/var skip=/opt/puppetlabs

Note that for OSX, you'll want to run the log4jscanner::run_scan_osx task.

Reference

Manifest Parameters

ensure: Set to 'absent' to remove artifacts (cron/scheduled tasks, files) from nodes. (default 'present')
linux_directories: Array of directories to scan on Linux nodes. (default ['/'])
linux_skip: Array of glob patterns to skip scanning on Linux nodes. (default ['/proc','/sys','/tmp'])
scan_data_owner: User to own log4jscanner files. (default 'root')
scan_data_group: Group to own log4jscanner files. (default 'root')
cron_user: User to run the cron job for scanning. (default 'root')
cron_hour: Hour for cron job run. (default 'absent')
cron_month: Month for cron job run. (default 'absent')
cron_monthday: Day of the month for cron job run. (default 'absent')
cron_weekday: Day of the week for cron job run. (default 'absent')
cron_minutes: Minute for cron job run. (default is a random int between 0 and 59)
windows_directories: Array of directories to scan on Windows nodes. (default ['C:'])
windows_skip: Array of glob patterns to skip scanning on Windows nodes. (default ["C:\Windows\Temp"])
scheduled_task_every: Run the scheduled task every X days. (default 1)
osx_directories: Array of directories to scan on OSX nodes (default ['/'])
osx_skip: Array of glob patterns to skip scanning on OSX nodes (default ['/tmp', '/Users/osx', '/dev', '/private/var/db', '/private/var/folders', '/System/Volumes/Data/private/var/db', '/System/Volumes/Data/private/var/folders'])

Task Parameters

directories: Comma-separated list of directories to search for vulnerable log4j jars
skip: Comma-separated list of glob patterns to skip when scanning
rewrite: When true, rewrite vulnerable jars as they are detected. NOT RECOMMENDED.

Limitations

Tested on a limited number of OS flavors. Please submit fixes if you find bugs!

Development

Fork, develop, submit pull request.

Contributors

Nick Burgan
Ben Ford
Charlie Sharpsteen

Class/fact code heavily cribbed from os_patching by Tony Green

Reference

Classes

log4jscanner

Tasks

run_scan: Runs Google's log4jscanner on a target node
run_scan_osx: Runs Google's log4jscanner on an OSX target node

Classes

`log4jscanner`

The log4jscanner class.

Parameters

The following parameters are available in the log4jscanner class:

present
linux_directories
linux_skip
scan_data_owner
scan_data_group
cron_user
cron_hour
cron_month
cron_monthday
cron_weekday
cron_minute
windows_directories
windows_skip
scheduled_task_every
osx_directories
osx_skip
ensure

`present`

Whether the scanner should be installed

`linux_directories`

Data type: Array[String]

Which directories to scan on Linux nodes

Default value: ['/']

`linux_skip`

Data type: Array[String]

Which directories to skip on Linux nodes

Default value: ['/proc', '/sys', '/tmp']

`scan_data_owner`

Data type: String

Owner of the generated scan results

Default value: 'root'

`scan_data_group`

Data type: String

Group of the generated scan results

Default value: 'root'

`cron_user`

Data type: String

Default value: 'root'

`cron_hour`

Data type: Any

Default value: absent

`cron_month`

Data type: Any

Default value: absent

`cron_monthday`

Data type: Any

Default value: absent

`cron_weekday`

Data type: Any

Default value: absent

`cron_minute`

Data type: Any

Default value: fqdn_rand(59)

`windows_directories`

Data type: Array[String]

Which directories to scan on Windows nodes

Default value: ['C:']

`windows_skip`

Data type: Array[String]

Which directories to skip on Windows nodes

Default value: ['C:\Windows\Temp']

`scheduled_task_every`

Data type: Integer

How often the task should run, as a number of days

Default value: 1

`osx_directories`

Data type: Array[String]

Which directories to scan on OSX nodes

Default value: ['/']

`osx_skip`

Data type: Array[String]

Which directories to skip on OSX nodes

Default value: ['/tmp', '/Users/osx', '/dev', '/private/var/db', '/private/var/folders', '/System/Volumes/Data/private/var/db', '/System/Volumes/Data/private/var/folders']

`ensure`

Data type: Enum['present', 'absent']

Default value: 'present'

Tasks

`run_scan`

Runs Google's log4jscanner on a target node

Supports noop? false

Parameters

`directories`

Data type: String

Comma-separated list of directories to search for vulnerable log4j JARs

`skip`

Data type: Optional[String]

Comma-separated list of glob patterns to skip when scanning (e.g. '/var/run/*')

`rewrite`

Data type: Optional[Boolean]

Rewrite vulnerable JARs as they are detected

`run_scan_osx`

Runs Google's log4jscanner on an OSX target node

Supports noop? false

Parameters

`directories`

Data type: String

Comma-separated list of directories to search for vulnerable log4j JARs

`skip`

Data type: Optional[String]

Comma-separated list of glob patterns to skip when scanning (e.g. '/var/run/*')

`rewrite`

Data type: Optional[Boolean]

Rewrite vulnerable JARs as they are detected

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

run_scan

Runs Google's log4jscanner on a target node

Parameters
directories	Comma-separated list of directories to search for vulnerable log4j JARs `String`
rewrite	Rewrite vulnerable JARs as they are detected `Optional[Boolean]`
skip	Comma-separated list of glob patterns to skip when scanning (e.g. '/var/run/*') `Optional[String]`

run_scan_osx

Runs Google's log4jscanner on an OSX target node

Parameters
directories	Comma-separated list of directories to search for vulnerable log4j JARs `String`
rewrite	Rewrite vulnerable JARs as they are detected `Optional[Boolean]`
skip	Comma-separated list of glob patterns to skip when scanning (e.g. '/var/run/*') `Optional[String]`

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed 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.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

log4jscanner

Version information

This version is compatible with:

Tasks:

Start using this module

Documentation

log4jscanner

Description

Log4jscanner binaries

Compiling your own binaries

Setup

What log4jscanner affects

Usage

Manifest

Task

Reference

Manifest Parameters

Task Parameters

Limitations

Development

Contributors

Reference

Table of Contents

Classes

Tasks

Classes

log4jscanner

Parameters

present

linux_directories

linux_skip

scan_data_owner

scan_data_group

cron_user

cron_hour

cron_month

cron_monthday

cron_weekday

cron_minute

windows_directories

windows_skip

scheduled_task_every

osx_directories

osx_skip

ensure

Tasks

run_scan

Parameters

directories

skip

rewrite

run_scan_osx

Parameters

directories

skip

rewrite

What are tasks?

Tasks in this module release

run_scan

run_scan_osx

Change log

v0.4.0 (2022-01-14)

Added

Fixed

v0.3.0 (2022-01-06)

Added

Fixed

v0.2.0 (2022-01-05)

Added

Dependencies

`log4jscanner`

`present`

`linux_directories`

`linux_skip`

`scan_data_owner`

`scan_data_group`

`cron_user`

`cron_hour`

`cron_month`

`cron_monthday`

`cron_weekday`

`cron_minute`

`windows_directories`

`windows_skip`

`scheduled_task_every`

`osx_directories`

`osx_skip`

`ensure`

`run_scan`

`directories`

`skip`

`rewrite`

`run_scan_osx`

`directories`

`skip`

`rewrite`