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

createst: Allow to exclude certain fields #2135

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,8 @@ options:
Adds a suricata.yaml to the test
--features <features>
Adds specified features
--exclude-fields [EXCLUDE_FIELDS]
Exclude specified fields from filter block
```

### Examples
Expand Down
22 changes: 20 additions & 2 deletions createst.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,18 +222,34 @@ def is_valid_suri_directory():

def get_manipulated_list():
"""
Manipulate eve.json to load json successfully and skip the fields
Manipulate eve.json to load JSON successfully and skip the fields
mentioned in `skip_fields` variable.
"""
eve_path = os.path.join(test_dir, "output", "eve.json")
exclude_fields = args["exclude_fields"].strip().split(",") if args["exclude_fields"] else []
allow_events = args["allow_events"].strip().split(",") if args["allow_events"] else []

def exclude_nested_fields(data, base_key=""):
"""
Function to recursively exclude nested fields
"""
if isinstance(data, dict):
filtered_data = {}
for k, v in data.items():
full_key = f"{base_key}.{k}" if base_key else k
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will we not compare "timestamp" and ".timestamp" ?

if full_key not in skip_fields and not any(full_key == excl or full_key.startswith(f"{excl}.") for excl in exclude_fields):
filtered_data[k] = exclude_nested_fields(v, full_key)
return filtered_data
return data

with open(eve_path, "r") as fp:
content = fp.read()
content_list = content.strip().split("\n")
jcontent_list = [json.loads(e) for e in content_list]
all_content_list = []
for e in jcontent_list:
md = {k: v for k, v in e.items() if k not in skip_fields}
md = exclude_nested_fields(e)

if "event_type" in md and md["event_type"] == "stats":
continue
all_content_list.append(md)
Expand Down Expand Up @@ -393,6 +409,8 @@ def parse_args():
help="Adds a suricata.yaml to the test")
parser.add_argument("--features", default=None, metavar="<features>",
help="Adds specified features")
parser.add_argument("--exclude-fields", nargs="?", default=None,
help="Exclude specified fields from filter block")
# add arg to allow stdout only
args = parser.parse_args()

Expand Down
Loading