Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Single JSON Output Schema #50

Closed
utkonos opened this issue Feb 2, 2019 · 5 comments
Closed

Single JSON Output Schema #50

utkonos opened this issue Feb 2, 2019 · 5 comments
Assignees
Labels
enhancement New feature or request
Projects
Milestone

Comments

@utkonos
Copy link
Member

utkonos commented Feb 2, 2019

After making a release announcement on Twitter, the maintainers of YARA joined the conversation and mentioned that they're writing a Go implementation of the YARA parser that will provide JSON output as an option. Also, in the same thread, I learned that there is already a Go implementation here:
https://github.com/Northern-Lights/yara-parser

I've opened an issue on their repo for this same topic here:
Northern-Lights/yara-parser#17

Here is my proposal:
Let's coordinate on one single schema for data structure and JSON output format. We can definitely have local variation, but I think having a single schema that is interoperable among all three projects is a good thing. As a first step, I can post an annotated copy of our full JSON schema along with the reasoning behind various decisions. The short term goal would be to have both annotated schemas sent over to the core YARA developers. An ideal situation would be that core adopts as much of our "unified" schema as makes sense. They would then release the official schema when ready. We would then produce JSON that conforms to that official schema. If there are fields that we can't all agree on, we would then have a flag to enable additional local/optional fields in our output.

@Taskr
Copy link
Contributor

Taskr commented Feb 2, 2019

Makes sense to me. Great idea @utkonos!

@wesinator
Copy link
Contributor

@utkonos
Copy link
Member Author

utkonos commented Jan 2, 2020

It's great they finally released that. Will need to take a look at its output and see if we can output the same thing.

@utkonos
Copy link
Member Author

utkonos commented Jan 2, 2020

From the new repo, it looks like it's based on the Northern Lights Golang repo.

@utkonos utkonos added this to the 3.0 milestone Jan 4, 2020
@utkonos
Copy link
Member Author

utkonos commented Jul 17, 2020

This will be a feature of 3.0.0. The schema of the new JSON format is not finalized (here at least). I want it to be informed by the output from both gyp and yara-python.

@utkonos utkonos self-assigned this Jul 17, 2020
@utkonos utkonos added this to To do in 3.0.0 via automation Jul 17, 2020
@utkonos utkonos closed this as not planned Won't fix, can't repro, duplicate, stale May 16, 2024
3.0.0 automation moved this from To do to Done May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
3.0.0
  
Done
Development

No branches or pull requests

3 participants