Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ObjectifLibre/csf
Continuous Security Framework
https://github.com/ObjectifLibre/csf
Last synced: 3 months ago
JSON representation
Continuous Security Framework
- Host: GitHub
- URL: https://github.com/ObjectifLibre/csf
- Owner: ObjectifLibre
- License: apache-2.0
- Archived: true
- Created: 2018-08-23T08:24:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-08-31T14:29:27.000Z (about 6 years ago)
- Last Synced: 2024-07-18T04:34:16.452Z (4 months ago)
- Language: Go
- Size: 620 KB
- Stars: 5
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Continuous Security Framework
[](https://godoc.org/github.com/ObjectifLibre/csf) [](https://travis-ci.org/ObjectifLibre/csf) [](https://app.fossa.io/projects/custom%2B4963%2Fgit%40github.com%3AObjectifLibre%2Fcsf.git?ref=badge_shield) [](https://codebeat.co/projects/github-com-objectiflibre-csf-master) [](https://www.codacy.com/project/Patazerty/csf/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ObjectifLibre/csf&utm_campaign=Badge_Grade_Dashboard) [](https://codecov.io/gh/ObjectifLibre/csf) [](https://microbadger.com/images/objectiflibre/csf "Get your own image badge on microbadger.com")
Continuous Security Framework (CSF for short) is an open-source project aiming at enabling continous security in cloud infrastructures (but not only).
You can see it as IFTTT for the cloud. Similar to a typical continuous integration, CSF can be used to build pipelines composed of different tasks. Unlike a typical continuous integration, it can respond to a variety of events and uses simple scripting that anyone can use to build powerful automatic decision-making scripts.
## Getting started
### Terminology
Modules:
- *Event source* - a module that will send events to CSF (ex: a new vulnerability has been found by clair)
- *Action module* - a module that contains one or more actions (ex: send a mail)
### Installation
The best way to run csf is to use the docker image `objectiflibre/csf`. You can also download the binary or build CSF yourself.
Take a look at [this sample config](https://github.com/ObjectifLibre/csf/blob/master/csf_config/config_sample.yaml) and modify it if needed.
```bash
docker run -d \
-v $PWD/csf_config:/csf_config \
-v $PWD/csf_data:/db \
-p 8888:8888 \
objectiflibre/csf
```
Take a look at [config_sample.yaml](https://github.com/ObjectifLibre/csf/blob/master/csf_config/config_sample.yaml) for the config. The default `localfiles` configProvider loads modules configuration files from the `./config` folder matching the names of the modules (if you load the `k8s_imagevalidator` module your config file for this module must be named `k8s_imagevalidator.*`, the extension does not matter). The default `localdb` storageProvider stores everything in `./db` using [tiedot](https://github.com/HouzuoGuo/tiedot).
### Use cases
Events trigger pipelines that can dynamically respond to events using scripts. Currently implemented events are:
- [Clair notification](https://github.com/coreos/clair) about a new vulnerability in a docker image
- A new pod is spawned in kubernetes
- An [ImagePolicyWebhook review request](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#what-does-each-admission-controller-do) from kubernetes (can allow or deny the use of an image in k8s)
- Notifications from Openstack Nova (via AMQP)
Currently implemented actions are:
- Send a mail
- Check if an image is in a kubernetes pod or deployment
- Respond to an ImagePolicyWebhook image review request
- Scan a docker image using an external clair server
- Scan an instance / virtual machine / host via ssh using [vuls.io](https://vuls.io) and docker
More details on the different modules [here](https://github.com/ObjectifLibre/csf/blob/master/docs/modules.md).
Need something else ? Open an issue or [write your own module](https://github.com/ObjectifLibre/csf/blob/master/docs/write_modules.md) !
### Pipelines
You can use multiple actions to easily build complex pipelines. Here is a simple example:
Another use case is [on the fly docker images scanning](https://github.com/ObjectifLibre/csf/blob/master/docs/k8s_imagereviewWebhook_clair.md) with kubernetes.
To write your own pipelines (called reactions here), you can find different sample json files in the `samples` folder or check out the [docs about reactions](https://github.com/ObjectifLibre/csf/blob/master/docs/write_reactions.md).