plugin-sdk-go

Introduction

This SDK facilitates writing plugins for Falco or application using Falcosecurity's libs.

Quick start

Before using this SDK, review the developer's guide which fully documents the API and provides best practices for writing plugins. The developer's guide includes a walkthrough 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
• plugin with event sourcing
• plugin with both event sourcing and field extraction

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 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 to find more.

How to reach out?

• Join the #falco channel on the Kubernetes Slack
• Join the Falco mailing list

Contributing

See the CONTRIBUTING.md.

Security Audit

A third party security audit was performed by Cure53, you can see the full report here.

Reporting security vulnerabilities

Please report security vulnerabilities following the community process documented here.

License Terms

This project is licensed to you under the Apache 2.0 open source license.