feat: Add "modules" subcommand to display modules available. #179
Conversation
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
Add the ability to print available modules via "yr debug modules". I experimented with making it take a "verbose" flag that would also print the protobuf definition of the module, which would make it easier for users to find out what is "available" to use from the module in their rules, but it was a lot to print out and would require users to translate from the protobuf types into YARA types, which is probably more than they want to do.
Add a "developer" feature that enables the debug command. Prior to this the command was always available but just hidden. This makes it a compile-time feature that can be useful if you're into doing developer type things like debugging the syntax trees.
plusvic
reviewed
Aug 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds a "developers" feature that when enabled will turn on the "debug" command - and without it the command is not available. Prior to this the command was always available but hidden.
I think the ability to list modules is a nice feature for users to have available, so I'm not sure I like the idea of putting this behind a features flag that is off by default. Does it make sense to have "debug" be behind developers but move the ability to list modules to it's own command that is on by default?