Installing a Modular Sensor in AWS

This topic describes how to install a Modular Sensor in an Amazon Web Services (AWS) environment. Refer to the following sections for details:

Use our example as a guideline, as you might be using a different software version.

Stellar Cyber does not support the installation of third-party software on its virtual or physical device sensors.

About Modular Sensors

Sensors provide the data gathering foundation for Stellar Cyber's OpenXDR platform, gathering the right data with context. Modular sensors are purpose-built Stellar Cyber sensors that include both the host and the Stellar Cyber monitoring software. They are provided as both physical devices (Photon sensors) and virtual machine images for different target environments.

Previous releases provided a variety of different types of device sensors, including Network, Security, and Modular. Going forward, the only type of device sensor is Modular. You can use the Modular Sensor Profile to enable whatever sensor features you like, creating the same functionality provided by the different sensor types in previous releases.

A modular sensor lets you easily add the features you like to your sensor. This helps simplify your deployment and lets you manage the VM requirements for the sensors based on the modular features they use.

Modular Sensors always include log ingestion. From there, you can enable different features as part of your modular sensor profile:

  • Enable the Network Traffic feature to monitor the virtual environment, the physical environment if connected to the span port of a physical switch, or the LAN segment via a mirror port on a switch. The sensor monitors network and server response times and can identify applications.

    The sensor converts that information to metadata and forwards it to the DP as Interflow. The DP can then provide security, DDoS, and breach attempt detections.

  • Enable the Sandbox and IDS features to improve your security posture:

    • Sandbox lets you detect malware in files and network traffic through Stellar Cyber's integrated cloud service and also provides anti-virus services.
    • IDS lets you detect intrusion attempts using both files and network traffic.

Keep in mind that VM resource requirements increase as you add more features to the Modular Sensor Profile. Refer to Modular Sensor Specifications for details on the resources required to run different combinations of features in a Modular Sensor Profile, as well as how to use the show module and show module request CLI commands to compare provisioned resources against those required to run specific feature combinations. Stellar Cyber only enables a Modular Sensor Profile on a sensor if the host VM's resources can support it.

Site Preparation

Click to see the minimum system requirements for installing a modular sensor.

You must have:

  • One IP address with access to a default gateway
  • A Stellar Cyber license that can be applied to the sensor

To prepare for the installation:

  1. Open firewall ports for log ingestion.

  2. Open firewall ports for the features you plan on enabling in the Modular Sensor Profile for this sensor.

  3. Contact Stellar Cyber support (support@stellarcyber.ai) for access to the AMI. You must provide:
    1. AWS account name
    2. AWS account number
    3. AWS region for the sensor

Launching the AMI

To configure and launch the AMI:

Use our example as a guideline, as you might be using a different software version.

  1. Log in to your EC2 Dashboard.

  2. Click on AMIs, under Images.

    A list of existing AMIs appears.

  3. If you don't see any products, click the drop-down next to the search bar and choose Private images.

    If you still don't see any products, make sure your region setting is correct.

    And if you still don't see any products, contact technical support.

    AMI Names for Stellar Cyber Images

    For reference, the AMI names for the Stellar Cyber AMIs are as follows:

    • Modular Sensor – ModularSensor-5-x-y

    In all cases, the x-y refers to the minor version numbers of the sensor software (for example, ModularSensor-5-2-0).

  4. Click the check-box to the left of the AMI. The Launch button activates and the details appear.

  5. Click Launch. The Choose an Instance Type page appears.

  6. Choose a t2.2xlarge or higher type. Smaller instance types are not supported.

  7. Click Next: Configure Instance Details. The Configure Instance Details page appears.

    We recommend keeping the default settings.

  8. Click Next: Add Storage. The Add Storage page appears.

    We recommend keeping the default settings.

    As an option, you can encrypt your storage volume as follows:

    1. Click the Advanced button in the Configure Storage panel.

    2. Set the Encrypted dropdown in the EBS Volumes settings to Encrypted.

    You can also convert an existing sensor's unencrypted storage volume to use encryption.

  9. Click Next: Add Tags. The Add Tags page appears.

    Stellar Cyber does not use tags.

  10. Click Next: Configure Security Group. The Configure Security Group page appears.

    You can ignore the warning at the bottom of the page.

    Security groups define which local ports and remote hosts can reach the sensor. AWS enables SSH by default.

  11. Enter the Security group name.

  12. Click Add Rule. A new row appears. Configure inbound rules to allow your sensor to communicate with the DP.

    If you already added rules on a prior installation, you can choose Select an existing security group to see a list of the existing groups.

  13. Click Review and Launch. Make changes if necessary.

  14. Click Launch. The Select an existing key pair screen appears. Stellar Cyber is configured with a user name and password, so does not need a key pair.
  15. Choose Proceed without a key pair.

  16. Click the check-box to acknowledge.

  17. Click Launch Instance.

    You can launch the image but you cannot copy it. This means that the VM must be deployed in the AWS region where the image was authorized.

The VM is now running in the AWS cloud.

Applying a Token to the Installed Sensor

The next step is to obtain and apply the token used to authorize and configure the installed sensor.

Obtaining a Token for the Installation

Tokens are required to authorize and configure the installation of a sensor image downloaded from the DP in the System | Deployment | Sensor Installation page. Tokens point the installed sensor to the correct DP, assign the specified tenant, and authorize the sensor installation.

Use the following procedure to obtain a token in the Tokens tab:

  1. Navigate to the System | Deployment | Sensor Installation page and click on the Tokens tab.

  2. If a token already exists for the target tenant for the sensor installation, you can either use the Copy button to copy it to the clipboard or use the Download button to download it as a file.

    • Copy the token if you plan on applying it by pasting it into a set token string <token> command in the CLI.

    • Download the token as a file if you plan on hosting the file on an HTTP server and referring to it in a set token url <token url> command.

    Refer to Assigning Tokens for a summary of the different ways in which tokens can be applied to a sensor installation.

  3. If there is not already an unexpired token for the target tenant, click the Generate button.

    The Generate Installation Token dialog appears:

  4. Select the tenant for the token from the Tenant dropdown. This is the tenant to which all sensors authorized with this token will be automatically assigned. The dropdown lists all tenants configured for your organization in the System | Tenants page.

  5. Click the Generate button.

    The system generates the token and displays its contents in the Token field. The dialog also updates to display the expiration date for the token, as illustrated below.

  6. You can use the Copy button to copy the token to the clipboard immediately, or simply close the dialog and retrieve the token from the Tokens tab later on.

Applying the Token to the Sensor

Tokens are required to complete the installation of a sensor image downloaded from the DP in the Download Image tab.

You apply tokens to sensors as the last step in the overall installation procedure:

  1. Log in to your new Sensor. The default username/password is aella/changeme. You are immediately prompted to change the password.

  2. Apply the token to the installed sensor from the sensor CLI with the set token command using one of the options in the table below:

    You only need to use one of the options in the table below. These are just two different ways to do the same thing – apply the token.

    Option 1. Copy and Paste the Token String

    Copy the token string from the Tokens tab and paste it into the CLI command. The syntax is as follows:

    set token string <pasted string>

    Option 2. Host the Token on an HTTP Server

    Download the token as a file from the Tokens tab, upload it to an HTTP server, and reference it in the set token command. The syntax is as follows:

    set token url http://<url to token>

    You can also use an HTTPS server. In that case, the specified URL must also include the username and password for the server using the following syntax:

    set token url https://<user:password>@URL>

  3. The CLI reports that the Sensor token is successfully set.

    If you receive an error message instead, it's possible that the token has expired. Refer to the Tokens tab to see the expiration date. If you are using the File technique, it's also possible that an extra space or line may have crept into your text file – check the file to make sure it includes only the token text.

  4. Wait a minute or so. Then, verify that the token was successfully applied using any combination of the following techniques:

    • Check the System | Sensors tab in the user interface to see that the sensor has registered itself successfully.

    • Verify that the show system command shows all services as running.

    • Verify that the show receiver command displays a receiver.

    • Verify that the show json command reports some data sent in the BYTE_SENT column.

Configuring a Static IP Address (Optional)

By default, the sensor uses DHCP for the management port's IP address. For ease of troubleshooting, however, Stellar Cyber recommends that you reconfigure the management port to use a static IP address. The procedure is as follows:

  1. Log in to your sensor. The default username/password is aella/changeme, but you changed this when you applied the token in the previous section.

  2. You can set IP parameters manually using commands similar to the following (substitute your own IP parameters for the ones shown in bold below):

    set interface management ip 192.168.14.100/255.255.255.0

    set interface management gateway 192.168.14.1

    set interface management dns 8.8.8.8

  3. Verify the IP settings with the show interfaces command.

  4. Log out with the quit command.

Terminating an AWS Instance

If at some point you decide that you no longer need a particular sensor in AWS, you can always use the AWS documentation to terminate the sensor instance.