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

Improve rule files validity checking #1332

Open
Tracked by #3148
leogr opened this issue Jul 29, 2020 · 53 comments
Open
Tracked by #3148

Improve rule files validity checking #1332

leogr opened this issue Jul 29, 2020 · 53 comments

Comments

@leogr
Copy link
Member

leogr commented Jul 29, 2020

Motivation

Currently, if some properties are misplaced within the rule's document (ie. the YAML file), no warning is emitted and non-obvious side effects can occur (here an example regarding required_engine_version property).

Feature

The rule loader should emit warnings or errors when a node in the document contains unexpected properties. Further validity checking is desirable too.

Alternatives

Do nothing?

Additional context

This problem was discovered by working on #1273. It was initially considered a bug ( #1315 ), but it can actually be considered a missing feature, IMHO.

/area engine

@leogr leogr changed the title Improve validity checking on rule files Improve rule files validity checking Jul 29, 2020
@leogr
Copy link
Member Author

leogr commented Aug 3, 2020

Interesting #1338

@leogr
Copy link
Member Author

leogr commented Sep 8, 2020

Another example 👉 #1379

@poiana
Copy link
Contributor

poiana commented Dec 7, 2020

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@poiana
Copy link
Contributor

poiana commented Jan 6, 2021

Stale issues rot after 30d of inactivity.

Mark the issue as fresh with /remove-lifecycle rotten.

Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle rotten

@leogr
Copy link
Member Author

leogr commented Jan 8, 2021

/cc @mstemm

@leogr
Copy link
Member Author

leogr commented Jan 8, 2021

/remove-lifecycle stale
/milestone 1.0.0

@poiana poiana added this to the 1.0.0 milestone Jan 8, 2021
@poiana
Copy link
Contributor

poiana commented Feb 7, 2021

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community.
/close

@poiana
Copy link
Contributor

poiana commented Feb 7, 2021

@poiana: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@poiana poiana closed this as completed Feb 7, 2021
@leogr
Copy link
Member Author

leogr commented Feb 8, 2021

/reopen
/remove-lifecycle rotten

@poiana
Copy link
Contributor

poiana commented Feb 8, 2021

@leogr: Reopened this issue.

In response to this:

/reopen
/remove-lifecycle rotten

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@poiana poiana reopened this Feb 8, 2021
@poiana
Copy link
Contributor

poiana commented May 9, 2021

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@poiana
Copy link
Contributor

poiana commented Jun 8, 2021

Stale issues rot after 30d of inactivity.

Mark the issue as fresh with /remove-lifecycle rotten.

Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle rotten

1 similar comment
@poiana
Copy link
Contributor

poiana commented Jul 8, 2021

Stale issues rot after 30d of inactivity.

Mark the issue as fresh with /remove-lifecycle rotten.

Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle rotten

@poiana
Copy link
Contributor

poiana commented Aug 9, 2021

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community.
/close

@poiana
Copy link
Contributor

poiana commented Aug 9, 2021

@poiana: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue with /reopen.

Mark the issue as fresh with /remove-lifecycle rotten.

Provide feedback via https://github.com/falcosecurity/community.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@leogr
Copy link
Member Author

leogr commented May 18, 2023

cc @loresuso

@poiana
Copy link
Contributor

poiana commented Aug 16, 2023

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@Andreagit97
Copy link
Member

/remove-lifecycle stale

@Andreagit97
Copy link
Member

can we define concrete next steps here?

@leogr
Copy link
Member Author

leogr commented Aug 21, 2023

cc @jasondellaluce

@Andreagit97 Andreagit97 modified the milestones: 0.36.0, TBD Aug 31, 2023
@poiana
Copy link
Contributor

poiana commented Jan 12, 2024

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@leogr
Copy link
Member Author

leogr commented Jan 12, 2024

/remove-lifecycle stale

cc @LucaGuerra (since you recently worked on the rules override feature, perhaps you have some thoughts about this too)

@leogr
Copy link
Member Author

leogr commented Jan 12, 2024

/help

@poiana
Copy link
Contributor

poiana commented Apr 11, 2024

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@leogr
Copy link
Member Author

leogr commented Apr 11, 2024

/remove-lifecycle stale

@leogr
Copy link
Member Author

leogr commented Apr 11, 2024

/assign

cc @LucaGuerra @FedeDP @jasondellaluce

Let me know if you have any ideas. I think this is somehow tied to #3149
If we have a schema, we can validate the rules file against it.

@poiana
Copy link
Contributor

poiana commented Jul 10, 2024

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

@leogr
Copy link
Member Author

leogr commented Jul 11, 2024

/remove-lifecycle stale

@leogr
Copy link
Member Author

leogr commented Aug 28, 2024

More recent thoughts on this issue:

By autogenerating a JSON Schema file from Falco and using it for validation and linting, we can ensure that rules files adhere to the expected structure and syntax. This will help catch errors early and maintain high-quality, consistent rule files.

The schema file is also required by the Playground (see #3149 )

Thus, the goals of this issue should be:

/assign
/assign @FedeDP

@poiana
Copy link
Contributor

poiana commented Nov 26, 2024

Issues go stale after 90d of inactivity.

Mark the issue as fresh with /remove-lifecycle stale.

Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Provide feedback via https://github.com/falcosecurity/community.

/lifecycle stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants