Skip to content

A utility that watches a path for test result files on behalf of a STIG Manager Collection

License

Notifications You must be signed in to change notification settings

NUWCDIVNPT/stigman-watcher

Repository files navigation

STIG Manager Watcher

A STIG Manager CLI client that watches a path for test result files formatted as CKL or XCCDF and posts the results to a Collection.

The client is suitable for use as a service or daemon, as a scheduled task, in automated testing pipelines, or from the command line. Test result files discovered on the path and sub-paths are parsed and the parsed content is pushed to a timed cargo queue. If configured to do so, the queue worker creates new Assets as needed and updates STIG assignments. Reviews from the result files are then posted to the corresponding Asset.

Requirements

  • Node.js 14+ and npm, if Watcher is run from source or as a global npm module
  • An OIDC Provider supporting the Client Credentials Flow which issues tokens scoped for the STIG Manager API.
  • STIG Manager API with a Collection grant of "Manage" for the client

Installation and Usage

You can install Watcher using one of these methods:

Copy a Release binary to a destination of your choice and execute

$ ./stigman-watcher-linuxstatic [options]

or

C:/> stigman-watcher-win.exe [options]

Install globally via NPM and run the module

$ npm install --global @nuwcdivnpt/stigman-watcher
$ stigman-watcher [options]

Clone this repo and run the source code

$ git clone https://github.com/NUWCDIVNPT/stigman-watcher.git
$ node index.js [options]

Wiki

Please see the Wiki for documentation.