PaperMtn / slack-watchman-enterprise-grid

Monitoring your Slack Enterprise Grid for sensitive information
GNU General Public License v3.0
15 stars 2 forks source link

Output Option #2

Open LewisLebentz opened 1 year ago

LewisLebentz commented 1 year ago

Is your feature request related to a problem? Please describe. It's difficult to read through the output of a scan.

Describe the solution you'd like Noticed that slack-watchman has an --output flag whereas this one doesn't.

--output {csv,file,stdout,stream}

Describe alternatives you've considered /

Additional context Ran this with a Docker container, so maybe it is outputting somewhere but the container is getting deleted after being run so I'm not seeing it?

LewisLebentz commented 1 year ago

Could we may just get the output to a log file for now, looks like you should be able to add another handler here: https://github.com/PaperMtn/slack-watchman-enterprise-grid/blob/8b70acfab894751235e8a2b06f6ddf17afb8510d/src/slack_watchman_eg/logger.py

Like this: https://stackoverflow.com/a/44760039/3365278

PaperMtn commented 1 year ago

I've not really considered adding CSV logging to the Enterprise Grid version, and its something that will probably be removed from the standard version of Slack Watchman as well if I get round to updating it.

It's difficult to support new features for lots of different logging formats. With more complex data structures, like with Slack Watchman for Enterprise Grid, the best way to serialise that output is via JSON, particularly if you want to ingest that into a log analysis platform, or do some processing on it.

Logging to file should be possible by redirecting stdout to a file, even with Docker. You should be able to do something like:

docker run --rm -e SLACK_WATCHMAN_EG_TOKEN=xoxp... papermountain/slack-watchman-eg --hours 1 --cores 8 > ~/slack_watchman.log

Is that the sort of thing you're looking for?