Jibril GitHub Plugin¶
GitHub Integration¶
The Jibril Github plugin is a plugin that interacts with GitHub repositories. Despite being a full runtime security tool, Jibril's first mission and current mission is to protect CI/CD pipelines.
This plugin is designed to do the interface between the Jibril runtime security tool, GitHub runners, the GitHub API and Listen.dev's backend.
Jibril GitHub Plugin is not designed to be used in a standalone mode.
Summary Events¶
Jibril uses OpenAI (with a given token) to generate summary events. At the end of its execution, during shutdown, Jibril will generate events with the most important information about the runner execution, after having requested the OpenAI API.
This plugin is one of the parts that empower the Listen.dev's dashboard.
There are 3 types of summary events about the run execution:
Full Summary¶
A full summary of the runner execution, taking in consideration all existing events and the other summary events. Read: A summary of the summary.
Detections Summary¶
A summary of the detections made by Jibril during the execution. It uses OpenAI to distingue the most important detections and provide important calls to action.
Flows Summary¶
A summary of the network flows detected by Jibril during the execution. It uses OpenAI to distingue the most important flows and deviations from what should be considered normal for expected workloads.
And 2 types of summary events about the GitHub pull request itself:
Change Summary¶
A summary of the changes made in the pull request. If the pull request consists of multiple commits, there will be one change_summary event for each file change, for each existing commit.
Pull Request Summary¶
A summary of the pull request itself. It will contain information about the pull request, the commits, the files changed and a parallel to every other event generated by Jibril.
The summary events related to the pull request are generated after the code changes, and parts of the original code are submitted to the OpenAI API. This means that the code is sent to a third-party service and should be considered when using this plugin.
Printers¶
Listen.dev¶
The listendev printer is the printer that sends the events to the Listen.dev backend. It needs an account and a token to be used.
Listen.dev Debug¶
The listendevdebug printer is a debug file for the listendev printer. It is used to debug the listendev printer and should not be used in production environments.