This module provides a RESTful API for interacting with Metron.
- A running Metron cluster
- Java 8 installed
- Storm CLI and Metron topology scripts (start_parser_topology.sh, start_enrichment_topology.sh, start_elasticsearch_topology.sh) installed
- A relational database
-
Package the application with Maven:
mvn clean package
-
Untar the archive in the $METRON_HOME directory. The directory structure will look like:
config rest_application.yml bin metron-rest lib metron-rest-$METRON_VERSION.jar
-
Copy the
$METRON_HOME/bin/metron-rest
script to/etc/init.d/metron-rest
-
Deploy the RPM at
/metron/metron-deployment/packaging/docker/rpm-docker/target/RPMS/noarch/metron-rest-$METRON_VERSION-*.noarch.rpm
-
Install the RPM with:
rpm -ih metron-rest-$METRON_VERSION-*.noarch.rpm
The REST application depends on several configuration parameters:
No optional parameter has a default.
Environment Variable | Description |
---|---|
METRON_JDBC_DRIVER | JDBC driver class |
METRON_JDBC_URL | JDBC url |
METRON_JDBC_USERNAME | JDBC username |
METRON_JDBC_PLATFORM | JDBC platform (one of h2, mysql, postgres, oracle |
ZOOKEEPER | Zookeeper quorum (ex. node1:2181,node2:2181) |
BROKERLIST | Kafka Broker list (ex. node1:6667,node2:6667) |
HDFS_URL | HDFS url or fs.defaultFS Hadoop setting (ex. hdfs://node1:8020) |
Environment Variable | Description | Required | Default |
---|---|---|---|
METRON_LOG_DIR | Directory where the log file is written | Optional | /var/log/metron/ |
METRON_PID_FILE | File where the pid is written | Optional | /var/run/metron/ |
METRON_REST_PORT | REST application port | Optional | 8082 |
METRON_JDBC_CLIENT_PATH | Path to JDBC client jar | Optional | H2 is bundled |
METRON_TEMP_GROK_PATH | Temporary directory used to test grok statements | Optional | ./patterns/temp |
METRON_DEFAULT_GROK_PATH | Defaults HDFS directory used to store grok statements | Optional | /apps/metron/patterns |
SECURITY_ENABLED | Enables Kerberos support | Optional | false |
Environment Variable | Description | Required |
---|---|---|
METRON_JVMFLAGS | JVM flags added to the start command | Optional |
METRON_SPRING_PROFILES_ACTIVE | Active Spring profiles (see below) | Optional |
METRON_SPRING_OPTIONS | Additional Spring input parameters | Optional |
METRON_PRINCIPAL_NAME | Kerberos principal for the metron user | Optional |
METRON_SERVICE_KEYTAB | Path to the Kerberos keytab for the metron user | Optional |
These are set in the /etc/default/metron
file.
The REST application persists data in a relational database and requires a dedicated database user and database (see https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html for more detail).
Spring uses Hibernate as the default ORM framework but another framework is needed becaused Hibernate is not compatible with the Apache 2 license. For this reason Metron uses EclipseLink. See the Spring Data JPA - EclipseLink project for an example on how to configure EclipseLink in Spring.
The REST application comes with embedded database support for development purposes.
For example, edit these variables in /etc/default/metron
before starting the application to configure H2:
METRON_JDBC_DRIVER="org.h2.Driver"
METRON_JDBC_URL="jdbc:h2:file:~/metrondb"
METRON_JDBC_USERNAME="root"
METRON_JDBC_PLATFORM="h2"
The REST application should be configured with a production-grade database outside of development.
Installing with Ambari is recommended for production deployments. Ambari handles setup, configuration, and management of the REST component. This includes managing the PID file, directing logging, etc.
The following configures the application for MySQL:
-
Install MySQL if not already available (this example uses version 5.7, installation instructions can be found here)
-
Create a metron user and REST database and permission the user for that database:
CREATE USER 'metron'@'node1' IDENTIFIED BY 'Myp@ssw0rd'; CREATE DATABASE IF NOT EXISTS metronrest; GRANT ALL PRIVILEGES ON metronrest.* TO 'metron'@'node1';
-
Install the MySQL JDBC client onto the REST application host and configurate the METRON_JDBC_CLIENT_PATH variable:
cd $METRON_HOME/lib wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.41.tar.gz tar xf mysql-connector-java-5.1.41.tar.gz
-
Edit these variables in
/etc/default/metron
to configure the REST application for MySQL:METRON_JDBC_DRIVER="com.mysql.jdbc.Driver" METRON_JDBC_URL="jdbc:mysql://mysql_host:3306/metronrest" METRON_JDBC_USERNAME="metron" METRON_JDBC_PLATFORM="mysql" METRON_JDBC_CLIENT_PATH=$METRON_HOME/lib/mysql-connector-java-5.1.41/mysql-connector-java-5.1.41-bin.jar
-
Switch to the metron user
sudo su - metron
-
Start the REST API. Adjust the password as necessary.
set -o allexport; source /etc/default/metron; set +o allexport; export METRON_JDBC_PASSWORD='Myp@ssw0rd'; $METRON_HOME/bin/metron-rest.sh unset METRON_JDBC_PASSWORD;
The REST application can be accessed with the Swagger UI at http://host:port/swagger-ui.html#/. The default port is 8082.
The metron-rest module uses Spring Security for authentication and stores user credentials in the relational database configured above. The required tables are created automatically the first time the application is started so that should be done first. For example (continuing the MySQL example above), users can be added by connecting to MySQL and running:
use metronrest;
insert into users (username, password, enabled) values ('your_username','your_password',1);
insert into authorities (username, authority) values ('your_username', 'ROLE_USER');
Metron REST can be configured for a cluster with Kerberos enabled. A client JAAS file is required for Kafka and Zookeeper and a Kerberos keytab for the metron user principal is required for all other services. Configure these settings in the /etc/default/metron
file:
SECURITY_ENABLED=true
METRON_JVMFLAGS="-Djava.security.auth.login.config=$METRON_HOME/client_jaas.conf"
METRON_PRINCIPAL_NAME="metron@EXAMPLE.COM"
METRON_SERVICE_KEYTAB="/etc/security/keytabs/metron.keytab"
The REST application comes with a few Spring Profiles to aid in testing and development.
Profile | Description |
---|---|
test | sets variables to in-memory services, only used for integration testing |
dev | adds a test user to the database with credentials user/password |
vagrant | sets configuration variables to match the Metron vagrant environment |
docker | sets configuration variables to match the Metron docker environment |
Setting active profiles is done with the METRON_SPRING_PROFILES_ACTIVE variable. For example, set this variable in /etc/default/metron
to configure the REST application for the Vagrant environment and add a test user:
METRON_SPRING_PROFILES_ACTIVE="vagrant,dev"
Request and Response objects are JSON formatted. The JSON schemas are available in the Swagger UI.
- Description: Escalates a list of alerts by producing it to the Kafka escalate topic
- Input:
- alerts - The alerts to be escalated
- Returns:
- 200 - Alerts were escalated
- Description: Retrieves the current user's alerts profile
- Returns:
- 200 - Alerts profile
- 404 - The current user does not have an alerts profile
- Description: Retrieves all users' alerts profiles. Only users that are part of the "ROLE_ADMIN" role are allowed to get all alerts profiles.
- Returns:
- 200 - List of all alerts profiles
- 403 - The current user does not have permission to get all alerts profiles
- Description: Deletes a user's alerts profile. Only users that are part of the "ROLE_ADMIN" role are allowed to delete user alerts profiles.
- Input:
- user - The user whose prolife will be deleted
- Returns:
- 200 - Alerts profile was deleted
- 403 - The current user does not have permission to delete alerts profiles
- 404 - Alerts profile could not be found
- Description: Creates or updates the current user's alerts profile
- Input:
- alertsProfile - The alerts profile to be saved
- Returns:
- 200 - Alerts profile updated. Returns saved alerts profile.
- 201 - Alerts profile created. Returns saved alerts profile.
- Description: Retrieves the current Global Config from Zookeeper
- Returns:
- 200 - Returns current Global Config JSON in Zookeeper
- 404 - Global Config JSON was not found in Zookeeper
- Description: Deletes the current Global Config from Zookeeper
- Returns:
- 200 - Global Config JSON was deleted
- 404 - Global Config JSON was not found in Zookeeper
- Description: Creates or updates the Global Config in Zookeeper
- Input:
- globalConfig - The Global Config JSON to be saved
- Returns:
- 200 - Global Config updated. Returns saved Global Config JSON
- 201 - Global Config created. Returns saved Global Config JSON
- Description: Retrieves a Grok statement from the classpath
- Input:
- path - Path to classpath resource
- Returns:
- 200 - Grok statement
- Description: Lists the common Grok statements available in Metron
- Returns:
- 200 - JSON object containing pattern label/Grok statements key value pairs
- Description: Applies a Grok statement to a sample message
- Input:
- grokValidation - Object containing Grok statement and sample message
- Returns:
- 200 - JSON results
- Description: Writes contents to an HDFS file. Warning: this will overwrite the contents of a file if it already exists. Permissions must be set for all three groups if they are to be set. If any are missing, the default permissions will be used, and if any are invalid an exception will be thrown.
- Input:
- path - Path to HDFS file
- contents - File contents
- userMode - [optional] symbolic permission string for user portion of the permissions to be set on the file written. For example 'rwx' or read, write, execute. The symbol '-' is used to exclude that permission such as 'rw-' for read, write, no execute
- groupMode - [optional] symbolic permission string for group portion of the permissions to be set on the file written. For example 'rwx' or read, write, execute. The symbol '-' is used to exclude that permission such as 'rw-' for read, write, no execute
- otherMode - [optional] symbolic permission string for other portion of the permissions to be set on the file written. For example 'rwx' or read, write, execute. The symbol '-' is used to exclude that permission such as 'rw-' for read, write, no execute
- Returns:
- 200 - Contents were written
- Description: Reads a file from HDFS and returns the contents
- Input:
- path - Path to HDFS file
- Returns:
- 200 - Returns file contents
- Description: Deletes a file from HDFS
- Input:
- path - Path to HDFS file
- recursive - Delete files recursively
- Returns:
- 200 - File was deleted
- 404 - File was not found in HDFS
- Description: Lists an HDFS directory
- Input:
- path - Path to HDFS directory
- Returns:
- 200 - HDFS directory list
- Description: Retrieves all Kafka topics
- Returns:
- 200 - Returns a list of all Kafka topics
- Description: Creates a new Kafka topic
- Input:
- topic - Kafka topic
- Returns:
- 200 - Returns saved Kafka topic
- Description: Retrieves a Kafka topic
- Input:
- name - Kafka topic name
- Returns:
- 200 - Returns Kafka topic
- 404 - Kafka topic is missing
- Description: Deletes a Kafka topic
- Input:
- name - Kafka topic name
- Returns:
- 200 - Kafka topic was deleted
- 404 - Kafka topic is missing
- Description: Retrieves a sample message from a Kafka topic using the most recent offset
- Input:
- name - Kafka topic name
- Returns:
- 200 - Returns sample message
- 404 - Either Kafka topic is missing or contains no messages
- Description: Get all meta alerts that contain an alert.
- Input:
- guid - GUID of the alert
- Returns:
- 200 - Search results
- Description: Creates a new meta alert from a list of existing alerts. The meta alert status will initially be set to 'ACTIVE' and summary statistics will be computed from the list of alerts. A list of groups included in the request are also added to the meta alert.
- Input:
- request - Meta alert create request which includes a list of alert get requests and a list of custom groups used to annotate a meta alert.
- Returns:
- 200 - The GUID of the new meta alert
- Description: Adds an alert to an existing meta alert. An alert will not be added if it is already contained in a meta alert.
- Input:
- request - Meta alert add request which includes a meta alert GUID and list of alert get requests
- Returns:
- 200 - Returns 'true' if the alert was added and 'false' if the meta alert did not change.
- Description: Removes an alert from an existing meta alert. If the alert to be removed is not in a meta alert, 'false' will be returned.
- Input:
- request - Meta alert remove request which includes a meta alert GUID and list of alert get requests
- Returns:
- 200 - Returns 'true' if the alert was removed and 'false' if the meta alert did not change.
- Description: Updates the status of a meta alert to either 'ACTIVE' or 'INACTIVE'.
- Input:
- guid - Meta alert GUID
- status - Meta alert status with a value of either 'ACTIVE' or 'INACTIVE'
- Returns:
- 200 - Returns 'true' if the status changed and 'false' if it did not.
- Description: Searches the indexing store. GUIDs must be quoted to ensure correct results.
- Input:
- searchRequest - Search request
- Returns:
- 200 - Search response
- Description: Searches the indexing store and returns field groups. GUIDs must be quoted to ensure correct results. Groups are hierarchical and nested in the order the fields appear in the 'groups' request parameter. The default sorting within groups is by count descending. A groupOrder type of count will sort based on then number of documents in a group while a groupType of term will sort by the groupBy term.
- Input:
- groupRequest - Group request
- indices - list of indices to search
- query - lucene query
- scoreField - field used to compute a total score for each group
- groups - List of groups (field name and sort order)
- groupRequest - Group request
- Returns:
- 200 - Group response
- Description: Returns latest document for a guid and sensor
- Input:
- getRequest - Get request
- guid - message UUID
- sensorType - Sensor Type
- Example: Return
bro
document with UUID of000-000-0000
- getRequest - Get request
{
"guid" : "000-000-0000",
"sensorType" : "bro"
}
- Returns:
- 200 - Document representing the output
- 404 - Document with UUID and sensor type not found
- Description: Get index column metadata for a list of sensor types with duplicates removed. Column names and types for each sensor are retrieved from the most recent index. Columns that exist in multiple indices with different types will default to type 'other'.
- Input:
- sensorTypes - Sensor Types
- Returns:
- 200 - Column Metadata
- Description: Retrieves all SensorEnrichmentConfigs from Zookeeper
- Returns:
- 200 - Returns all SensorEnrichmentConfigs
- Description: Lists the available enrichments
- Returns:
- 200 - Returns a list of available enrichments
- Description: Lists the available threat triage aggregators
- Returns:
- 200 - Returns a list of available threat triage aggregators
- Description: Deletes a SensorEnrichmentConfig from Zookeeper
- Input:
- name - SensorEnrichmentConfig name
- Returns:
- 200 - SensorEnrichmentConfig was deleted
- 404 - SensorEnrichmentConfig is missing
- Description: Updates or creates a SensorEnrichmentConfig in Zookeeper
- Input:
- sensorEnrichmentConfig - SensorEnrichmentConfig
- name - SensorEnrichmentConfig name
- Returns:
- 200 - SensorEnrichmentConfig updated. Returns saved SensorEnrichmentConfig
- 201 - SensorEnrichmentConfig created. Returns saved SensorEnrichmentConfig
- Description: Retrieves a SensorEnrichmentConfig from Zookeeper
- Input:
- name - SensorEnrichmentConfig name
- Returns:
- 200 - Returns SensorEnrichmentConfig
- 404 - SensorEnrichmentConfig is missing
- Description: Retrieves all SensorIndexingConfigs from Zookeeper
- Returns:
- 200 - Returns all SensorIndexingConfigs
- Description: Deletes a SensorIndexingConfig from Zookeeper
- Input:
- name - SensorIndexingConfig name
- Returns:
- 200 - SensorIndexingConfig was deleted
- 404 - SensorIndexingConfig is missing
- Description: Updates or creates a SensorIndexingConfig in Zookeeper
- Input:
- sensorIndexingConfig - SensorIndexingConfig
- name - SensorIndexingConfig name
- Returns:
- 200 - SensorIndexingConfig updated. Returns saved SensorIndexingConfig
- 201 - SensorIndexingConfig created. Returns saved SensorIndexingConfig
- Description: Retrieves a SensorIndexingConfig from Zookeeper
- Input:
- name - SensorIndexingConfig name
- Returns:
- 200 - Returns SensorIndexingConfig
- 404 - SensorIndexingConfig is missing
- Description: Updates or creates a SensorParserConfig in Zookeeper
- Input:
- sensorParserConfig - SensorParserConfig
- Returns:
- 200 - SensorParserConfig updated. Returns saved SensorParserConfig
- 201 - SensorParserConfig created. Returns saved SensorParserConfig
- Description: Retrieves all SensorParserConfigs from Zookeeper
- Returns:
- 200 - Returns all SensorParserConfigs
- Description: Lists the available parser classes that can be found on the classpath
- Returns:
- 200 - Returns a list of available parser classes
- Description: Parses a sample message given a SensorParserConfig
- Input:
- parseMessageRequest - Object containing a sample message and SensorParserConfig
- Returns:
- 200 - Returns parsed message
- Description: Scans the classpath for available parser classes and reloads the cached parser class list
- Returns:
- 200 - Returns a list of available parser classes
- Description: Deletes a SensorParserConfig from Zookeeper
- Input:
- name - SensorParserConfig name
- Returns:
- 200 - SensorParserConfig was deleted
- 404 - SensorParserConfig is missing
- Description: Retrieves a SensorParserConfig from Zookeeper
- Input:
- name - SensorParserConfig name
- Returns:
- 200 - Returns SensorParserConfig
- 404 - SensorParserConfig is missing
- Description: Executes transformations against a sample message
- Input:
- transformationValidation - Object containing SensorParserConfig and sample message
- Returns:
- 200 - Returns transformation results
- Description: Retrieves field transformations
- Returns:
- 200 - Returns a list field transformations
- Description: Lists the Stellar functions that can be found on the classpath
- Returns:
- 200 - Returns a list of Stellar functions
- Description: Lists the simple Stellar functions (functions with only 1 input) that can be found on the classpath
- Returns:
- 200 - Returns a list of simple Stellar functions
- Description: Tests Stellar statements to ensure they are well-formed
- Input:
- statements - List of statements to validate
- Returns:
- 200 - Returns validation results
- Description: Retrieves the status of all Storm topologies
- Returns:
- 200 - Returns a list of topologies with status information
- Description: Retrieves information about the Storm command line client
- Returns:
- 200 - Returns storm command line client information
- Description: Retrieves the status of the Storm enrichment topology
- Returns:
- 200 - Returns topology status information
- 404 - Topology is missing
- Description: Activates a Storm enrichment topology
- Returns:
- 200 - Returns activate response message
- Description: Deactivates a Storm enrichment topology
- Returns:
- 200 - Returns deactivate response message
- Description: Starts a Storm enrichment topology
- Returns:
- 200 - Returns start response message
- Description: Stops a Storm enrichment topology
- Input:
- stopNow - Stop the topology immediately
- Returns:
- 200 - Returns stop response message
- Description: Retrieves the status of the Storm indexing topology
- Returns:
- 200 - Returns topology status information
- 404 - Topology is missing
- Description: Activates a Storm indexing topology
- Returns:
- 200 - Returns activate response message
- Description: Deactivates a Storm indexing topology
- Returns:
- 200 - Returns deactivate response message
- Description: Starts a Storm indexing topology
- Returns:
- 200 - Returns start response message
- Description: Stops a Storm enrichment topology
- Input:
- stopNow - Stop the topology immediately
- Returns:
- 200 - Returns stop response message
- Description: Activates a Storm parser topology
- Input:
- name - Parser name
- Returns:
- 200 - Returns activate response message
- Description: Deactivates a Storm parser topology
- Input:
- name - Parser name
- Returns:
- 200 - Returns deactivate response message
- Description: Starts a Storm parser topology
- Input:
- name - Parser name
- Returns:
- 200 - Returns start response message
- Description: Stops a Storm parser topology
- Input:
- name - Parser name
- stopNow - Stop the topology immediately
- Returns:
- 200 - Returns stop response message
- Description: Retrieves the status of a Storm topology
- Input:
- name - Topology name
- Returns:
- 200 - Returns topology status information
- 404 - Topology is missing
- Description: Retrieves the status of all Storm Supervisors
- Returns:
- 200 - Returns a list of the status of all Storm Supervisors
- Description: Update a document with a patch
- Input:
- request - Patch Request
- guid - The Patch UUID
- sensorType - The sensor type
- patch - An array of RFC 6902 patches.
- Example adding a field called
project
with valuemetron
to thebro
message with UUID of000-000-0000
:
- request - Patch Request
{
"guid" : "000-000-0000",
"sensorType" : "bro",
"patch" : [
{
"op": "add"
, "path": "/project"
, "value": "metron"
}
]
}
- Returns:
- 200 - nothing
- 404 - document not found
- Description: Replace a document
- Input:
- request - Replacement request
- guid - The Patch UUID
- sensorType - The sensor type
- replacement - A Map representing the replaced document
- Example replacing a
bro
message with guid of000-000-0000
- request - Replacement request
{
"guid" : "000-000-0000",
"sensorType" : "bro",
"replacement" : {
"source:type": "bro",
"guid" : "bro_index_2017.01.01.01:1",
"ip_src_addr":"192.168.1.2",
"ip_src_port": 8009,
"timestamp":200,
"rejected":false
}
}
- Returns:
- 200 - Current user
- Description: Retrieves the current user
- Returns:
- 200 - Current user
Profiles are includes for both the metron-docker and Full Dev environments.
Start the metron-docker environment. Build the metron-rest module and start it with the Spring Boot Maven plugin:
mvn clean package
mvn spring-boot:run -Drun.profiles=docker,dev
The metron-rest application will be available at http://localhost:8080/swagger-ui.html#/.
Start the Full Dev environment. Build the metron-rest module and start it with the Spring Boot Maven plugin:
mvn clean package
mvn spring-boot:run -Drun.profiles=vagrant,dev
The metron-rest application will be available at http://localhost:8080/swagger-ui.html#/.
To run the application locally on the Full Dev host (node1), follow the Installation instructions above. Then set the METRON_SPRING_PROFILES_ACTIVE variable in /etc/default/metron
:
METRON_SPRING_PROFILES_ACTIVE="vagrant,dev"
and start the application:
service metron-rest start
In a cluster with Kerberos enabled, update the security settings in /etc/default/metron
. Security is disabled by default in the vagrant
Spring profile so that setting must be overriden with the METRON_SPRING_OPTIONS variable:
METRON_SPRING_PROFILES_ACTIVE="vagrant,dev"
METRON_JVMFLAGS="-Djava.security.auth.login.config=$METRON_HOME/client_jaas.conf"
METRON_SPRING_OPTIONS="--kerberos.enabled=true"
The metron-rest application will be available at http://node1:8082/swagger-ui.html#/.
This project depends on the Java Transaction API. See https://java.net/projects/jta-spec/ for more details.