Add --json JSON Lines output support#47
Open
ocervell wants to merge 1 commit into
Open
Conversation
Add a global `--json` option that makes beanshooter emit machine readable
result records as JSON Lines (one JSON object per line, parseable with jq).
Records are written live as they are produced.
The option takes an optional file argument:
--json write JSON Lines to stdout (human readable logging is
redirected to stderr so stdout stays valid JSON)
--json <file> append JSON Lines to the given file
Result records are currently emitted for:
- brute -> "credentials" records (host, port, username, password)
- list -> "mbean" records (class, objectName, interesting)
- enum -> "enum" records (check, category, status)
Each record additionally carries a "type" and an ISO-8601 "time" field.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a global
--jsonoption to beanshooter that emits machine readable resultrecords as JSON Lines (one JSON object per line, easily parseable
with
jq). This mirrors the live JSON Lines support recently added toMANSPIDER and makes it much
easier to consume beanshooter output programmatically.
Records are written live, as they are produced, so the output can be consumed in a
streaming fashion.
Usage
The
--jsonoption takes an optional file argument:--json– write JSON Lines to stdout. The human readable logging is redirected tostderr, so stdout contains valid JSON Lines only.
--json <file>– append JSON Lines to the given file. Human readable logging stays on stdout.Result records
typecredentialsbrutehost,port,username,passwordmbeanlistclass,objectName,interestingenumenumcheck,category,statusEvery record additionally carries a
typeand an ISO-8601timefield.Example
Implementation notes
JsonLoggerclass in theiopackage handles record serialization (no newdependencies – a small, self-contained JSON writer is used) and output routing.
Loggertransparently redirects human readable output to stderr.Logger.status*methods, labelled with aper-check context set by
EnumHelper.Testing
Built with
mvn clean packageand verified end-to-end against thejmx-example-server:2.1container:--jsonappears in help, stdout/stderr routing works,and
credentials,mbean, andenumrecords are emitted as valid, jq-parseable JSON Lines.🤖 Generated with Claude Code