https://github.com/falcosecurity/plugin-sdk-go
Falco plugins SDK for Go
https://github.com/falcosecurity/plugin-sdk-go
falco-plugins go sdk
Last synced: about 1 year ago
JSON representation
Falco plugins SDK for Go
- Host: GitHub
- URL: https://github.com/falcosecurity/plugin-sdk-go
- Owner: falcosecurity
- License: apache-2.0
- Created: 2021-09-20T16:26:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-24T11:43:19.000Z (about 1 year ago)
- Last Synced: 2025-03-28T12:03:28.713Z (about 1 year ago)
- Topics: falco-plugins, go, sdk
- Language: Go
- Homepage:
- Size: 492 KB
- Stars: 26
- Watchers: 7
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# plugin-sdk-go
[](https://github.com/falcosecurity/evolution/blob/main/REPOSITORIES.md#core-scope) [](https://github.com/falcosecurity/evolution/blob/main/REPOSITORIES.md#stable) [](./LICENSE)
[](https://pkg.go.dev/github.com/falcosecurity/plugin-sdk-go/pkg/sdk)
[](https://github.com/falcosecurity/plugin-sdk-go/releases/latest)
[](https://goreportcard.com/report/github.com/falcosecurity/plugin-sdk-go)
## Introduction
This SDK facilitates writing [plugins](https://falco.org/docs/plugins) for [Falco](https://github.com/falcosecurity/falco) or application using [Falcosecurity's libs](https://github.com/falcosecurity/libs).
## Quick start
Before using this SDK, review the [developer's guide](https://falco.org/docs/plugins/developers_guide/) which fully documents the API and provides best practices for writing plugins. The developer's guide includes a [walkthrough](https://falco.org/docs/plugins/go-sdk-walkthrough/#example-go-plugin-dummy) of a plugin written in Go that uses this package.
For a quick start, you can refer to the provided examples:
- [plugin with field extraction](https://github.com/falcosecurity/plugin-sdk-go/tree/main/examples/extractor)
- [plugin with event sourcing](https://github.com/falcosecurity/plugin-sdk-go/tree/main/examples/source)
- [plugin with both event sourcing and field extraction](https://github.com/falcosecurity/plugin-sdk-go/tree/main/examples/full)
## What's next
When ready to release your plugin, make sure to register the plugin with the Falcosecurity organization by creating a PR to the [falcosecurity/plugins](https://github.com/falcosecurity/plugins) respository with details on the new plugin. This ensures that a given ID is used by exactly one plugin with event sourcing capability, and allows authors of plugins with field extraction capability to coordinate about event source formats.
## Join the Community
To get involved with The Falco Project please visit [the community repository](https://github.com/falcosecurity/community) to find more.
How to reach out?
- Join the [#falco](https://kubernetes.slack.com/messages/falco) channel on the [Kubernetes Slack](https://slack.k8s.io)
- [Join the Falco mailing list](https://lists.cncf.io/g/cncf-falco-dev)
## Contributing
See the [CONTRIBUTING.md](https://github.com/falcosecurity/.github/blob/master/CONTRIBUTING.md).
## Security Audit
A third party security audit was performed by Cure53, you can see the full report [here](https://github.com/falcosecurity/falco/blob/master/audits/SECURITY_AUDIT_2019_07.pdf).
## Reporting security vulnerabilities
Please report security vulnerabilities following the community process documented [here](https://github.com/falcosecurity/.github/blob/master/SECURITY.md).
## License Terms
This project is licensed to you under the [Apache 2.0](./LICENSE) open source license.