cerebrate/README.md

# cerebrate

The Cerebrate Sync Platform core software.  Cerebrate is an open-source platform meant to act as a trusted contact information provider and interconnection orchestrator for other security tools.

It is currently being built under the MeliCERTes v2 project and is heavily work in progress.

# Current features

- Repository of organisations and individuals
- Maintain signing and encryption keys
- Maintain affiliations between organisations and individuals

## Screenshots

List of individuals along with their affiliations

![List of individuals](/documentation/images/individuals.png)

Adding organisations

![Adding an organisation](/documentation/images/add_org.png)

Everything is available via the API, here an example of a search query for all international organisations in the DB.

![API query](/documentation/images/orgs_api.png)

Managing public keys and assigning them to users both for communication and validating signed information shared in the community

![Encryption key management](/documentation/images/add_encryption_key.png)

# Requirements and installation

The platform is built on CakePHP 4 along with Bootstrap 4 and shares parts of the code-base with [MISP](https://www.github.com/MISP).

The installation is documented at the following location [INSTALL/INSTALL.md](INSTALL/INSTALL.md)

# License

~~~~
    The software is released under the AGPLv3.

    Copyright (C) 2019, 2020  Andras Iklody
    Copyright (C) CIRCL - Computer Incident Response Center Luxembourg
~~~~
Initial commit 2020-01-26 20:28:07 +01:00			`# cerebrate`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00			`The Cerebrate Sync Platform core software. Cerebrate is an open-source platform meant to act as a trusted contact information provider and interconnection orchestrator for other security tools.`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00			`It is currently being built under the MeliCERTes v2 project and is heavily work in progress.`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00			`# Current features`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00			`- Repository of organisations and individuals`
			`- Maintain signing and encryption keys`
			`- Maintain affiliations between organisations and individuals`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00			`## Screenshots`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
			`List of individuals along with their affiliations`

			`![List of individuals](/documentation/images/individuals.png)`

			`Adding organisations`

fix: [documentation] invalid image link 2020-06-04 10:03:38 +02:00			`![Adding an organisation](/documentation/images/add_org.png)`
new: [documentation] Added screenshots and a short descriptin 2020-06-04 10:00:03 +02:00
			`Everything is available via the API, here an example of a search query for all international organisations in the DB.`

			`![API query](/documentation/images/orgs_api.png)`

			`Managing public keys and assigning them to users both for communication and validating signed information shared in the community`

fix: [documentation] fixed another image link 2020-06-04 10:04:50 +02:00			`![Encryption key management](/documentation/images/add_encryption_key.png)`
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00
chg: [doc] install link added 2020-06-24 14:22:40 +02:00			`# Requirements and installation`
chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00
			`The platform is built on CakePHP 4 along with Bootstrap 4 and shares parts of the code-base with [MISP](https://www.github.com/MISP).`

chg: [doc] install link added 2020-06-24 14:22:40 +02:00			`The installation is documented at the following location [INSTALL/INSTALL.md](INSTALL/INSTALL.md)`

chg: [doc] some clean-up 2020-06-04 10:17:15 +02:00			`# License`

			`~~~~`
			`The software is released under the AGPLv3.`

			`Copyright (C) 2019, 2020 Andras Iklody`
			`Copyright (C) CIRCL - Computer Incident Response Center Luxembourg`
			`~~~~`