diff --git a/doc/architecture.md b/doc/architecture.md index 63f0497037133e9ff54ca496d20e9b8b98efa917..8825d092b62c4e6e4dbaa7251ef73573f836eebb 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -1,6 +1,6 @@ # Architecture -SOCTools is a collection of tools for collecting, enriching and analysing logs and other security data, threat information sharing and incident handling. Many SOCs will already have some tools in place that they want to continue to use. One main feature of SOCTools is therefore to have a flexible architecture where it is simple to integrate existing tools even if they are not directly supported by SOCTools. It is also easy to select which components of SOCTools to install. +SOCTools is a collection of tools for collecting, enriching and analyzing logs and other security data, threat information sharing and incident handling. Many SOCs will already have some tools in place that they want to continue to use. One main feature of SOCTools is therefore to have a flexible architecture where it is simple to integrate existing tools even if they are not directly supported by SOCTools. It is also easy to select which components of SOCTools to install. ## High level architecture <img src="images/high_level_arch.png" width=640> @@ -11,11 +11,31 @@ The high level architecture is shown in the figure above and consists of the fol * Data transport - [Apache Nifi](https://nifi.apache.org/), the key component that collects data from data sources, normalize it, do simple data enrichment and then ship it to one or more of the other components in the architecture. * Storage - in the current version all storage is done in [Elasiticsearch](https://opendistro.github.io/for-elasticsearch/), but it is easy to make changes to the data transport so that data is sent to other log analysis tools like Splunk or Humio. * Manual analysis - In the current version [Kibana](https://opendistro.github.io/for-elasticsearch/) is used for manual analysis of collected data. -* Enrichment - This component tenriches the collected data either before or after storage. In the current version this is done as part of the data transport component before data is sent to storage. -* Threat analysis - collects and analyzes threat intelligence data. Typical source for enrichment data. The current vesion uses [MISP](https://www.misp-project.org/). +* Enrichment - This component enriches the collected data either before or after storage. In the current version this is done as part of the data transport component before data is sent to storage. +* Threat analysis - collects and analyzes threat intelligence data. Typical source for enrichment data. The current version uses [MISP](https://www.misp-project.org/). * Automatic analysis - this is automatic real time analysis of collected data and will be added to later versions of SOCTools. It can be simple scripts looking at thresholds or advanced machine learning algorithms. * Incident response - [The Hive and Cortex](https://thehive-project.org/) is used for this and new cases can be created automatically from manual analysis in Kibana. ### Authentication SOCTools uses [Keycloak](https://www.keycloak.org/) to provide single sign on to all web interfaces of the various components. + +## NiFi pipeline + +The main job of Nifi is to collect data from various sources, enrich it and send it to storage which currently is Elasticsearch. The pipeline in Nifi is organized into two main prcoess groups, "Data processing" and "Enrichment data". + +### Enrichment data +This process group is basically a collection of "cron jobs" that runs regularly to update various enrichment data that is used by "Data processing" to enrich collected data. The current version supports the following enrichment data: +* Umbrella top 1 million domains - http://s3-us-west-1.amazonaws.com/umbrella-static/top-1m.csv.zip +* Alexa top 1 million - http://s3.amazonaws.com/alexa-static/top-1m.csv.zip +* Tor exit nodes - https://check.torproject.org/torbulkexitlist +* MaxMind GeoLite2-City database - Requires a free account. https://dev.maxmind.com/geoip/geoip2/geolite2/ +* Misp - NiFi automatically downloads new IOCs from the Misp instance that is part of SOCTools. IP addresses and host names are then enriched to show if they are registered in Misp. + +### Data processing +The processing group is divided into 3 parts: +* Data input - receives data, normalizes it and converts it to JSON. This also adds attributes to the data that specifies which filed names to enrich. +* Enrichment - enriches the data. It currently supports enriching IP addresses, domain names and fully qualified domain name (FQDN). +* Data output - sends data to storage. In future version data will also be sent to other tools doing real time stream processing of the data. + +Each group contains a process group called "Custom ..." where it is possible to add new processors to the pipeline that will not be overwritten when upgrading to newer versions of SOCTools. diff --git a/doc/dataingestion.md b/doc/dataingestion.md new file mode 100644 index 0000000000000000000000000000000000000000..8b137891791fe96927ad78e64b0aad7bded08bdc --- /dev/null +++ b/doc/dataingestion.md @@ -0,0 +1 @@ +