Introduction

This document aims to furnish detailed instructions on installing the GYTPOL Validator Sensor across different operating systems, including Windows, Linux, and macOS.

GYTPOL Sensor location

1. Navigate to the System Health located in the "Settings" section:

Open

2. Download the GYTPOL Sensor for your respective operating system using the download icon.

Supported Operating Systems

Open

Microsoft

Endpoints: Windows 7 (x32/x64) and newer

Servers: Windows Server 2008 and newer

Microsoft OS support matrix

Important Note: Remediation functionality is supported on older versions of Microsoft Windows and Servers as long as Powershell v5.1 and newer are installed.

Linux

Linux distribution matrix, supporting both detection, remediation and revert:

macOS

macOS versions, supporting both detection, remediation and revert:

Supported Network devices (coming soon):

Windows OS

Pre-Installation

Ports to open:

GYTPOL Sensor to GYTPOL SaaS - port 443

Does the Endpoint or Server need to be a member of the domain?

No

Installation

Open elevated CMD (r. click on CMD > Run as Administrator).

Once opened, please go to the MSI file you wish to install > hold L. Shift > r. click it > click “Copy as Path”.

Go to the elevated CMD you opened in step 1 and paste the path into the CMD window > Enter.

Once finished, the progress window will be disappeared.

Post-Installation

To verify the successful installation of the Sensor, follow these steps:

1. Open Task Scheduler as an Administrator.

2. Check for the gytpol folder under the main Library.

3. Expand the folder, and you should observe three tasks, as exemplified below:

Where will I see the scanned machine?

Navigate to the System Health located in the "Settings" section.

Select Windows OS

Where is the installation path?

C:\Program Files\WindowsPowerShell\Modules\gytpol

Where are the logs?

C:\Program Files\WindowsPowerShell\Modules\gytpol\log

Log retention policy

Every Windows Sensor is configured to retain up to 10 log files, with each file being 5MB in size. Once the 10-file limit is reached, the oldest log files are automatically deleted to make room for new ones, ensuring efficient log management.

This behavior can be observed in any installed Windows Sensor under the log directory C:\Program Files\WindowsPowerShell\Modules\gytpol\log.

How to check the sensor version

Open Control Panel > Programs > Programs and Features to see the gytpolClient version in a list.

Uninstalling

To uninstall the GYTPOL Sensor

1. Open "Programs and Features".

2. Locate "gytpolClient" in the list of installed programs.

3. Right-click on "gytpolClient" and select "Uninstall".

Linux

Pre-Installation

Ports to open:

GYTPOL Sensor to GYTPOL SaaS - port 443

Does the device need to be a member of the domain?

No

Installation

Command to run:

• Debian (Ubuntu):

  sudo dpkg -i <gytpol-Sensor-path>

• RPM (RHEL, centOS, SUSE etc.):

  sudo rpm -ivh <gytpol-Sensor-path>

Post-Installation

Where will I see the scanned machine?

Navigate to the System Health located in the "Settings" section.

Select Linux OS

How do I see and change the service status?

Where is the installation path?

/opt/gytpol

Where are the logs?

/opt/gytpol/logs

Log retention policy

The Sensor is configured to retain logs for a period of 10 days. Each day may generate one or more log files, depending on the number of actions performed (e.g., scans, service logs, remediations). After 10 days, older log files are automatically deleted to maintain efficient log management.

This behavior can be observed in any installed Linux Sensor under the directory /opt/gytpol/log.

Sensor version check

To check the Linux sensor version, run the following commands:

The output should show the version number:

Where are the configuration folder?

/opt/gytpol/config

config.json file example:

Uninstalling

Debian:

RPM:

Both rpm and dpkg commands listed above may remove certain configuration files associated with GYTPOL. Deleting files that may result in loss is at your own risk, so ensure that no critical data is being removed before proceeding.

It is highly recommended to take a backup of important data before making any changes to the system to mitigate any potential data loss. Always exercise caution when executing commands that may impact system configurations.

Configuring an Internal Proxy Server for a Linux Sensor

To set up an internal proxy server for a Linux Sensor, follow these steps.

On the Linux Operating System:

1. Open Terminal

Access the terminal on your Linux Sensor.

2. Run the Command

Enter the following command to create a configuration file with your organization's proxy server details:

3. Verify the Configuration

The command will create a file located at /opt/gytpol/environ containing the proxy server settings.

Outcome

A file named environ will be created in the /opt/gytpol/ directory. This file will contain the configuration for your internal proxy server.

macOS

Pre-Installation:

Ports to open:

GYTPOL Sensor to GYTPOL SaaS - port 443

Does the Endpoint need to be a member of the domain?

No

Installation:

Before proceeding with the installation, determine the platform architecture by checking the "About this Mac." This information will help ensure that the correct version of the software is installed for your system.

To identify the platform architecture through a terminal command, you can use uname -p command.

Identify and choose the right package according to the table below:

Command to run:

example:

To check that the launch daemon is running run:

If the daemon is currently running, you can identify its process by checking the process ID (PID) on the left side of the output. The PID is typically highlighted in red for easy identification:

For further information run:

If you are using an Intel processor, ensure that you run the correct binary with the "_amd64" designation (e.g., gytpol-client-1.2.1.2-28_amd64.pkg).

Your output should look like this:

Post-Installation

Where will I see the scanned machine?

Navigate to the System Health located in the "Settings" section.

Select macOS

How do I see and change the service status?

Where is the installation path?

/opt/gytpol

Where are the logs?

/opt/gytpol/logs

Log retention policy

The Sensor is configured to retain logs for a period of 10 days. Each day may generate one or more log files, depending on the number of actions performed (e.g., scans, service logs, remediations). After 10 days, older log files are automatically deleted to maintain efficient log management.

This behavior can be observed in any installed macOS Sensor under the directory /opt/gytpol/log.

Sensor version check

To check the macOS sensor version, run the following commands:

The output should show the version number:

Where are the configuration folder?

“config.json ” for Sensor’s configuration to a dedicated server

“metrics.json” for metrics configuration.

config.json

This file contains Sensor’s configuration:

Fields explanations:

HttpVerifyCert - Indicate whether to validate the server’s certificate when using HTTP requests.

HttpTimeout - Determine the timeout (in Nano Seconds) for HTTP requests.

ServerAddress - The address of the GYTPOL server.

ArchiveFolderPath - Folder (relative to /opt/gytpol) in which reports are being saved to before sending them to the server.

Uninstalling

1. Stop the launch daemon.

sudo launchctl stop com.gytpol.gytmac

2. Unload the launch daemon from launchctl.

sudo launchctl unload -w /Library/LaunchDaemons/com.gytpol.gytmac.plist

3. Delete the lauanch daemon configuration plist file.

sudo rm -rf /Library/LaunchDaemons/com.gytpol.gytmac.plist

4. Remove folder (including all sub-directories & sub-files).

sudo rm -rf /opt/gytpol

5. Discard receipt data.

sudo pkgutil --forget com.gytpol.gytmac