Skip to main content

Zenarmor - MS Active Directory Integration for OPNsense platforms - Displaying Users in Reports

Zenarmor supports Active Directory (AD) and OPNsense Captive Portal for username resolution. You can quickly integrate your Active Directory with Zenarmor running on the OPNsense firewall to display usernames and groups in analytics if you have Active Directory. Using Zenarmor AD agent you can define custom policies for your specific AD groups and users and empower your network security with User/Group based filtering.

To start to get the benefit of user-based filtering, you can easily integrate your Active Directory with Zenarmor by following the 3 steps explained below:

  1. Download Zenarmor AD Agent

  2. Install Zenarmor AD Agent to Domain Controller (DC)

  3. Configure Zenarmor AD Agent

note

To take advantage of user-based filtering, you must upgrade to one of the premium editions. You must have a Zenarmor Business Edition subscription for AD integration.

tip

You may need to install NoMAD tool on your MacOS clients from https://nomad.menu/ if you encounter name resolution problems for them.

1. Download Zenarmor AD Agent​

To download the latest Zenarmor Active Directory Agent installation file, you may follow the next steps:

  1. Connect to the Zenarmor Active Directory Agent Download page via your favorite browser on your Domain Controller (DC).

  2. Click the Download Now button on the download page.

    Zenarmor AD Agent Download Page

    Figure 1. Zenarmor AD Agent Download Page

  3. Click on the Save button in the dialog box to start downloading the compressed installation file, like adagent-1.3.8.zip.

    Downloading Zenarmor AD Agent (adagent-1.3.8.zip)

    Figure 2. Downloading Zenarmor AD Agent (adagent-1.3.8.zip)

2. Install Zenarmor AD Agent​

After downloading the Zenarmor AD Agent installation file on your Domain Controller (DC), you may follow the instructions given below to install the Zenarmor AD Agent:

  1. Extract the compressed installation file, adagent-1.3.8.zip, on your Domain Controller (DC).

  2. Navigate to the extracted directory, such as adagent-1.3.8.

  3. Click on the setup installation file with the right mouse button. This will open a dropdown menu.

  4. Click on the Run as administrator. This will start Zenarmor AD Agent Setup Wizard.

    Running setup as administrator

    Figure 3. Running setup as administrator

  5. Click on the Next button to proceed with the installation wizard.

    Zenarmor AD Agent Setup Wizard

    Figure 4. Zenarmor AD Agent Setup Wizard

  6. You can select the installation path and user permissions or you can proceed with the default preferences. You may click the Browse... button to change the installation folder. The default installation folder is C:\Program Files (x86)\Zenarmor\Zenarmor Active Directory Agent\.

    Zenarmor AD Agent Setup Wizard

    Figure 5. Selecting Zenarmor AD Agent Installation Folder

  7. You may check the available disk space on your server by clicking on the Disk Cost... button. This will list the available disk partitions on your Domain Controller (DC) along with available and required disk space.

    Zenarmor AD AgentAvailable Disk Space

    Figure 6. Zenarmor AD Agent Wizard - Viewing Available Disk Space

  8. You may leave other settings as default to install the Zenarmor AD agent for Everyone.

  9. Click Next to proceed the wizard.

  10. Click Next to confirm the installation.

    Confirm Zenarmor AD Agent Setup

    Figure 7. Confirming Zenarmor AD Agent Setup

  11. Click Close after the installation is complete. This will automatically launch the Zenarmor Active Directory Agent application for configuration.

    Zenarmor AD Agent Setup Completed

    Figure 8. Zenarmor AD Agent Setup Wizard- Installation Completed

3. Configuring Zenarmor AD Agent​

You may easily configure the Zenarmor AD Agent by following the steps below:

  1. You may leave the Platform option as default, OPNsense, for your OPNsense node or select Other Platforms (Linux, FreeBSD, pfSense) option depending on your Zenarmor platform.

    Zenarmor AD Agent Configuration

    Figure 9. Zenarmor AD Agent Configuration

  2. Set Host IP by typing the IP address of your Zenarmor platform, such as OPNSense Software firewall, with https:// prefix. For example, you may type https://10.10.10.1 if your Zenarmor firewall IP address is 10.10.10.1.

  3. You may leave the Port option as default which is 443.

  4. Connect your OPNsensefirewall via Web UI. Since you must enable API and generate a Zenarmor AD Agent Authentication Token for your firewall.

  5. Navigate to the Settings > Active Directory Integration.

  6. Click on the +Generate API key button to generate an API key. This will automatically create a new Zenarmor AD Agent authentication token.

    Creating Zenarmor AD Agent Authentication Token

    Figure 10. Creating Zenarmor AD Agent Authentication Token

  7. Copy the newly created Zenarmor AD Agent authentication token.

    Zenarmor AD Agent Authentication Token List

    Figure 11. Zenarmor AD Agent Authentication Token List

    tip

    If you need to remove or disable/enable the created Zenarmor AD Agent authentication token, you may easily perform these tasks using the related button on Active Directory Integration pane.

    To disable the Zenarmor AD Agent authentication token, click the Enabled button in the Token pane.

    To enable the Zenarmor AD Agent authentication token, click the Disabled button in the Token pane.

    To delete the Zenarmor AD Agent authentication token, click the Revoke button in the Token pane. This will open a dialog box for confirmation. Click the Revoke button to confirm token removal.

  8. Return back to the Zenarmor AD Agent Configuration window and fill in the API Token field by entering the newly created Zenarmor AD Agent authentication token.

  9. Click the Add Host to List button to add your Zenarmor host URL and token to the list. This will pop up a notification window.

  10. Click OK to close the notification window and proceed with the configuration.

    tip

    If you need to remove or change the Zenarmor platform settings from your Active Directory Agent configuration, you may easily delete host settings by following the next steps:

    1. Right-click on the Host in the list. This will open a toolbox.
    2. Click on the Remove Record button. This will open a dialog box.
    3. Click Yes in the dialog box to confirm the Host removal.

  11. You may enter one IP address per line in the Exclude Hosts pane. Zenarmor will not perform username resolution for the IP addresses in the Exclude Hosts list.

  12. You may set Log Level or leave it as default, INFO. Available Log Level options are as follows:

    • ALL
    • DEBUG
    • INFO
    • WARN
    • ERROR
    • FATAL
    • OFF

  13. Click on the Service Status button to enable the service.

    Enabling Zenarmor AD Agent Configuration

    Figure 12. Enabling Zenarmor AD Agent Configuration

  14. Click Save to activate the settings. This will popup a notification window.

  15. Click OK to close the notification window.

    Notification for Zenarmor AD Agent Configuration Save

    Figure 13. Notification for Zenarmor AD Agent Configuration Save

Now, you can configure user-based filtering policies and view usernames in Zenarmor reports.

Hands-on video for Downloading-Installing-Configuring Zenarmor AD Agent​

You can access the hands-on installation and configuration steps from next video.

Video on Zenarmor User-based Filtering and Reporting Capabilities​

Here is a video about the Zenarmor User-based Filtering and Reporting Capabilities.

Last updated on by Zenarmor