-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cleanup(docs): edit libs page content for technical clarity
Signed-off-by: Melissa Kilby <[email protected]>
- Loading branch information
Showing
3 changed files
with
33 additions
and
22 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,13 @@ | ||
# Falcosecurity drivers | ||
|
||
## Falco drivers kernel testing matrixes | ||
## Falco Drivers Kernel Testing | ||
|
||
Here you can find kernel testing support matrixes for [Falco](https://falco.org/) drivers. | ||
For more info, make sure to read the [driver kernel testing framework proposal](https://github.com/falcosecurity/libs/blob/master/proposals/20230530-driver-kernel-testing-framework.md). | ||
This page gives you the latest updates on Falco's kernel driver testing. We test each driver (kmod, bpf, modern_bpf) on various kernels and distributions (which we call the kernel testing matrix). These tests ensure that each driver not only compiles correctly, but also functions and provides the right events to userspace. These tests are super important to make sure Falco keeps working well and adopters can update or change their kernels without any problems. Another positive result for the project maintainers is the increased confidence in releasing new versions of Falco. | ||
|
||
## Syscalls Report | ||
To learn more, check out the [kernel testing framework proposal](https://github.com/falcosecurity/libs/blob/master/proposals/20230530-driver-kernel-testing-framework.md) and visit the official Falco [website](https://falco.org/). | ||
|
||
You can also find the list of supported syscalls by our drivers, be it through specific filler or generic. | ||
## Supported Syscalls Report | ||
|
||
The Falco Projects' kernel drivers support monitoring a range of syscalls. For a subset of syscalls (indicated with 🟡), we only monitor when the syscalls are triggered (internally in libs, we refer to these as generic syscalls), but we do not extract the syscall arguments for those. | ||
|
||
On the other hand, syscalls indicated with 🟢 in the report are fully monitored. This means we read and parse each syscall argument. You can learn more about the specific syscall arguments for these syscalls by referring to the libs' [event_table](https://github.com/falcosecurity/libs/blob/master/driver/event_table.c) or the official Linux man pages. |
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,14 @@ | ||
# Home of Falco drivers syscalls report | ||
# Home of Falco Drivers Syscalls Report | ||
|
||
Thanks to our [syscalls-bumper](https://github.com/falcosecurity/syscalls-bumper) project, we are able to always support latest syscalls added to linux kernel. | ||
Support for new syscalls is initially automatically added by the tool as generic events; when needed, a generic event can be made "specific", | ||
by creating a whole new event to track it. | ||
Thanks to our [syscalls-bumper](https://github.com/falcosecurity/syscalls-bumper) project, we are able to always support latest syscalls added to the Linux kernel. | ||
|
||
Our automation adds new syscalls as generic events (you can find the definition below to better understand what this term means within our libs). If necessary, developers can create new parsers to extract and make available each syscall argument. Internally, we refer to the extractors on the kernel side as "fillers". This process also involves the creation of a new event type in libsinsp. | ||
|
||
## Glossary | ||
|
||
* 🟢 -> means that the syscall is implemented as a specific event | ||
* 🟡 -> means that the syscall is implemented as a generic event | ||
The Falco Projects' kernel drivers support monitoring a range of syscalls. For a subset of syscalls (indicated with 🟡), we only monitor when the syscalls are triggered (internally in libs, we refer to these as generic syscalls), but we do not extract the syscall arguments for those. | ||
|
||
On the other hand, syscalls indicated with 🟢 in the report are fully monitored. This means we read and parse each syscall argument. You can learn more about the specific syscall arguments for these syscalls by referring to the libs' [event_table](https://github.com/falcosecurity/libs/blob/master/driver/event_table.c) or the official Linux man pages. | ||
|
||
* 🟢 -> syscall is implemented as dedicated libsinsp event type and each argument of the syscall is extracted and parsed. | ||
* 🟡 -> syscall is implemented as a generic event; we only monitor when a syscall triggers. |