Skip to main content

BlastShield Documentation

Containerized Gateway deployment

This article explains how to install the BlastShield™ Gateway in a containerized environment.

A Gateway deployed as a container can be configured to support either of the following addressing modes:

  1. Source+Destination NAT

  2. Destination NAT

Gateway addressing modes are explained in more detail here: Gateway Addressing Modes

Gateway use cases are described here: Gateway types and their use cases

Prerequisites

  1. A BlastShield™ Orchestrator with administrator access.

  2. An appliance running 32-bit arm, 64-bit arm or x86_64 Linux with at least one physical NIC and a container environment installed.

  3. The BlastShield™ Gateway requires outbound UDP ports to all required destinations.

Gateway connectivity requirements

  1. Outbound UDP ports to all required destinations.

  2. Resolution of DNS requests must be supported by the network.

Create a Gateway in the Orchestrator and run it as a container

  1. Connect to the Orchestrator and select Gateways from the left Menu.

  2. Select Add New Gateway.

  3. Enter a name for the new Gateway.

  4. Set the Addressing Mode for the Gateway. Choose from the following options:

    1. For Destination NAT addressing mode, click on IP Address (Destination NAT).

    2. For Source and Destination NAT addressing mode, click on IP Address (Source+Destination NAT).

      Screenshot_2023-09-12_at_16_57_19.png

  5. If you are using the Gateway in a single NIC configuration, leave the Endpoint Interface Settings as default.

  6. If you are using the Gateway in a dual NIC configuration, then configure the Endpoint Interface Settings:

    1. If you want the endpoint interface to get it's IP address via DHCP, then leave the configure using DHCP box checked.

    2. If you want to manually set the endpoint interface IP address , then un-check the configure using DHCP box.

      1. Set the Interface address with prefix field to the same IP address as the router which the Gateway is replacing. Use CIDR format.

      2. If you will be onboarding endpoints which are not within the subnet you specified with the interface address above, then enter the IP address of the gateway required to reach the endpoints in the Gateway (optional) field.

      3. If you do not have a route on your internet router to the protected endpoint network, then enable NAT external connections by checking the box.

      4. To enable the Gateway to forward non-endpoint connections from the protected network to the public side of the Gateway, check the Forward connections for non-endpoint addresses box. This will allow devices which are situated on the protected network side of the Gateway, which are not provisioned as endpoints on the Gateway, to forward traffic out through the Gateway.

  7. Select Save and Download Invitation and copy the invitation contents to clipboard. Keep the invitation data as you will need it later.

    Screenshot_2023-09-12_at_17_29_16.png

  8. Using one of the templates below, create a Docker compose file. There are different templates for Destination NAT and Source+Destination NAT addressing modes.

    1. Set the image to match the release version you want to use.

    2. Add the invitation text to the compose file as the value of the INVITATION variable to replace where it says "REPLACE_ME".

    3. For Destination NAT mode, add the name of the interface on the Gateway appliance which the endpoints can be accessed from as the value of the ENDPOINT_IFACE variable.

  9. Copy the Docker compose file to a new directory on the host appliance.

  10. From that directory, run the command: docker-compose up.

Example yaml files for Source+Destination NAT and Destination NAT are given below.

docker-compose.yml - Source+Destinatinon NAT

version:  "3.8"
services:
    blastshield-gw:
        image: public.ecr.aws/blastwave/blastshield-gw:1.7
        volumes:
            - blastshield-private:/data
        environment:
            INVITATION: 'REPLACE_ME'
        restart: unless-stopped
        cap_add:
            - NET_ADMIN
        sysctls:
            - net.ipv4.ip_local_port_range=16384 32767


volumes:
    blastshield-private:

docker-compose.yml - Destination NAT

version:  "3.8"
services:
    blastshield-gw:
        image: public.ecr.aws/blastwave/blastshield-gw:1.7
        volumes:
            - blastshield-private:/data
        environment:
            INVITATION: 'REPLACE_ME'
            ENDPOINT_IFACE: PUT_THE_ENDPOINT_INTERFACE_NAME_HERE
            LEGACY_IPTABLES: 1
        restart: unless-stopped
        cap_add:
            - NET_ADMIN
        network_mode: host



volumes:
    blastshield-private:
Create Endpoints on the Gateway

For each of the devices that you want to securely access via the BlastShield™ Gateway, you must create a corresponding Endpoint for it on the Gateway.

Follow this procedure to learn how to create an Endpoint on the Gateway.

  1. In the Orchestrator, select the Gateway and click on the Endpoints tab.

  2. Click the 'Add New Endpoint' button and click on the 'Endpoint Enabled' button.

  3. Enter a name for the Endpoint in the Name field.

  4. In the DNS Hostname field, enter a hostname.

  5. In the Destination field, enter the device's Private IPv4 address or hostname.

  6. For a Gateway using Destination NAT addressing mode, If you want the endpoint to be able to communicate out through the Gateway (e.g. for transferring log files or making software updates) then check the box marked Allow outbound external network connectivity. If you are using a Gateway in Source + Destination NAT you can skip this step.

  7. Click on 'Save Changes'.

  8. The status of the Endpoint will show as 'Online'.

    endpoint-gw-container-arm32-linux.png

  9. For endpoints on Gateways which use destination NAT addressing mode only, modify the endpoint's route table so that the endpoint may connect out over the BlastShield™ network. If you are using a Gateway which is set to Source + Destination NAT you can skip this step.

Configure an access policy and microsegmentation groups
About Groups

Groups allow you to micro-segment users and endpoints. A group is a logical collection of endpoints and/or users that are grouped together. Groups are connected via policies, which form the foundation for BlastShield access control and segmentation management.

  • Any combination of endpoints and/or users can be grouped together.

  • There is no limit to the number of endpoints and/or users that can be in a group.

  • Endpoints and users can be in one or multiple groups simultaneously.

  • Groups are linked together via policies to provide access between endpoints.

  • By default, endpoints/users cannot access or have visibility to other endpoints/users unless they are granted access via a policy

About Policies

A policy defines how groups can interact. Groups are connected via policies, which form the foundation for BlastShield access control and segmentation management.

  • Each policy will have two sets of groups - "From" and "To".

  • The "From" set is one or more source groups.

  • The "To" set is one or more destination groups.

  • There is no limit to the number of groups in a given policy.

  • "From" Groups will have access to "To" Groups within the policy.

  • "To" Groups will not have access to "From" Groups within the policy.

  • Groups can be in one or multiple policies simultaneously.

groups1.png

Create Groups

  1. From the Orchestrator, select "Groups" from the left menu.

  2. Select "Add New Group" from the Group List.

  3. Enter a name for the new Group.

  4. To add members to the new group, click the "Add Members" button.

    1. If you adding users to the group then select the desired Users which you want to be associated with the Group from the "Users" box.

    2. If you are adding Agents to the group then select the desired Agents which you want to be associated with the Group from the "Agents" box.

    3. If you are adding Gateway Endpoints then select the desired Endpoints from the "Endpoints" box.

    4. Alternatively, you can leave the members list empty and add/modify new members later.

  5. Click "Add Members" to save the members.

  6. Click "Save" to save the new group.

  7. Repeat, if required, to ensure you have one group for your endpoints and one group for your users, which is the minimum you will need in order to define the access policy.

Please refer to the following video, which is an example of creating one group for your users and one group for Host Agents.

Create a Policy to link your Groups
To connect your user groups and protected servers groups, you must link them with a policy as described here:

Note

Users and Agents must be a member of a group for them to be used in a policy.

  1. Select "Policies" from the left menu.

  2. Select "Add New Policy" from the Policy List.

  3. Enter a name for the new Policy.

  4. Select desired "From" Groups to be associated with the new Policy.

  5. Select desired "To" Groups to be associated with the new Policy.

  6. Save the new Policy.

Policies are directional, so that you can control the direction in which connections may be initiated. Typically for remote access use-cases your policy would be from the "user group" to the "server group" so that users may start connections to the servers, but servers cannot start connections to users. You can create bi-directional permissions by using two policies.

The following video shows an example of creating an access Policy between a group of remote workers and a group of servers. The policy gives the remote workers authorisation to access the server group.

Upgrading the Gateway.

When running as a container, the Gateway must be upgraded by modifying the container to use a newer image.

In this section: