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

docs: changes to the policies documentation #3416

Merged
merged 7 commits into from
Sep 18, 2023

Conversation

AnaisUrlichs
Copy link
Member

#3403

and

#3398

Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
docs/docs/policies/rules.md Outdated Show resolved Hide resolved
docs/docs/policies/rules.md Outdated Show resolved Hide resolved
scope:
- global
rules:
event: TRC-101
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
event: TRC-101
event: TRC-101

TRCs are internal ids, we need to use the event name, soon TRCs won't be exposed anymore.
eg:

EventName: "proc_mem_access",

Copy link
Member Author

Choose a reason for hiding this comment

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

What do you mean by soon TRCs won't be exposed anymore?

Copy link
Collaborator

Choose a reason for hiding this comment

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

We will remove the TRCs ids from tracee.

Copy link
Collaborator

Choose a reason for hiding this comment

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

@AnaisUrlichs This one still needs to be fixed before we can merge this PR

Copy link
Member Author

Choose a reason for hiding this comment

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

I changed it

AnaisUrlichs and others added 3 commits August 29, 2023 14:12
Co-authored-by: Jose Donizetti <jdbjunior@gmail.com>
Co-authored-by: Jose Donizetti <jdbjunior@gmail.com>
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
@@ -43,6 +43,6 @@ This policy applies to any workload (global) and will log the dropped_executable
While specifying event filters is optional, policies must have the `name`, `description`, `scope` and `rules` fields.

!!! Note
A current limitation is that only one rule can be defined per any event type in a policy
Note that only one rule can be defined per any event type in a policy
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't see why this is a limitation -- I know users should be aware of it but I would not call it a limitation

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ok, but I would add the word "currently" since we want to support more than one rule per event in the future

Copy link
Member Author

Choose a reason for hiding this comment

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

oki, sounds good, will add it

@AnaisUrlichs
Copy link
Member Author

@yanivagman @itaysk I have added the names for the behavioral signatures -- I think they are all added correctly but for the following, I could not find the right name && the list provided by tracee list misses one. While the table in the docs has 31 events -- the list in the rules section of the CLI only has 30 events

this one currently is wrong and misses the event name:
Screenshot 2023-09-01 at 12 05 36

Note the name here for the event on the left is just the placeholder

@yanivagman
Copy link
Collaborator

@yanivagman @itaysk I have added the names for the behavioral signatures -- I think they are all added correctly but for the following, I could not find the right name && the list provided by tracee list misses one. While the table in the docs has 31 events -- the list in the rules section of the CLI only has 30 events

this one currently is wrong and misses the event name: Screenshot 2023-09-01 at 12 05 36

Note the name here for the event on the left is just the placeholder

This is its name: https://github.com/aquasecurity/tracee/blob/main/signatures/golang/kubernetes_certificate_theft_attempt.go#L31

Not sure why it is not printed in the list

Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
@josedonizetti josedonizetti merged commit 2ba983d into aquasecurity:main Sep 18, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: syscalls as Tracee events docs: Why does it say "tracee will start with a sane default"
3 participants