RoamSafe Agent for Windows

The RoamSafe Windows Agent is designed to complement the CyberEdge web filtering appliance, offering enhanced security and web filtering capabilities for Windows devices. This guide provides step-by-step instructions for installing and deploying the software to ensure a simple setup for administrators.

Prerequisites

Before proceeding with the installation, ensure the following:

System Requirements: - Operating System: Windows 10 Release 21H2/22H2 or greater - Processor: 4-core CPU minimum - RAM: 8 GB minimum - Disk Space: 200 MB free space

Network Requirements: - Access to the CyberEdge appliance - Outbound connectivity to required filtering and monitoring servers

Administrator Rights: - Ensure you have local administrative privileges on the target devices.

Files and Credentials: - The RoamSafe Windows Agent MSI installer file (available for download from the CyberEdge appliance). - Deployment license key or authentication token (provided by your school IT department or CyberEdge support).

Manual Installation Steps

Download the Installer: Log in to the CyberEdge appliance and navigate to RoamSafe > Agents. Click the RoamSafe Windows Agent 1.0.0 (Latest) button to download the MSI installer.
Run the Installer: Double-click the MSI file to launch the installer. Note that the installer is non-interactive and will only display a progress bar.
Post-Installation: If the SERVICE_ID, USERNAME, and DEPLOYMENT_PASSWORD parameters were supplied during installation, the installer will automatically connect to the specified CyberEdge appliance, log in, and download necessary certificates. If these parameters were not supplied, you will need to open the RoamSafe Login application after installation to enter the Service ID, Username, and Password manually.
Complete Installation: Ensure the RoamSafe Agent is active and communicating with the CyberEdge appliance. This can be achieved by testing the device, and viewing the RoamSafe Agent event logs under Status > Log Viewer > RoamSafe Agent

Deployment Guide

Bulk Deployment via Group Policy (GPO)

Prepare the MSI Package: - Place the MSI installer on a shared network location accessible by all target devices.

Create a GPO for Software Deployment: - Open the Group Policy Management Console (GPMC). - Right-click your domain or Organizational Unit (OU) and select Create a GPO in this domain, and Link it here. - Name the GPO (e.g., "RoamSafe Deployment").

Configure Software Installation: - Right-click the new GPO and select Edit. - Navigate to Computer Configuration > Policies > Software Settings > Software Installation. - Right-click and choose New > Package. - Select the network path of the MSI file (e.g., \Server\Share\winAgent-1.0.0.msi). - Choose Assigned and click OK.

Apply the GPO: - Link the GPO to the appropriate OU containing target devices. - Ensure devices are restarted or run gpupdate /force to apply the policy.

Deployment via Endpoint Management Tools: - Microsoft Intune: Upload the MSI package and configure deployment policies. - SCCM: Add the package and create a deployment collection.

Command Line Parameters

The RoamSafe Windows Agent MSI installer supports several parameters to streamline deployment, especially for bulk or scripted installations. The following options allow pre-configuration of the agent to minimize post-installation interaction.

Scenario 1: Pre-Configured Deployment:

Parameters to Supply:
SERVICE_ID: The unique identifier for the CyberEdge appliance.
USERNAME: The user account for authenticating the device with the CyberEdge.
DEPLOYMENT_PASSWORD: The shared secret for agent deployment, as configured in the CyberEdge appliance.

Command Example:

msiexec /i winAgent-1.0.0.msi SERVICE_ID="<YourServiceID>" USERNAME="<YourUsername>" DEPLOYMENT_PASSWORD="<YourPassword>" /qn

Scenario 2: Minimal Configuration Deployment:

If you prefer to install the agent without supplying parameters, the installer will proceed with a basic setup. Post-installation, you will need to open the RoamSafe Login application to manually provide the required details:

Service ID
Username
Deployment Password

Command Example:

msiexec /i winAgent-1.0.0.msi /qn

Silent Installation:

Add /qn to suppress all UI prompts during installation, ensuring a seamless and silent deployment process.

Key Points:

Ensure that the target machines have network access to the CyberEdge appliance during installation.
For pre-configured deployments, verify that all parameter values are correct to avoid post-installation reconfiguration.

Troubleshooting

Common Issues and Solutions:

Installation Fails: Ensure the user has administrative privileges and verify the MSI file's integrity.
Connection to CyberEdge Fails: Check network connectivity and appliance configuration.

Logs

The RoamSafe Agent client device logs are stored in the C:\ProgramData\RoamSafe\roamsafe.log file.

Error Codes and Resolutions

Error Codes:

999: Unexpected Error experienced during login. Check the RoamSafe logs for the 'Unexpected error during login' text for further details.
3010: Login Failed due to server error. Check logs for 'Server error during login' for more details.
4000: Login Failed due to unresolved Service ID. The Service was not discoverable over the internet.
4010: Login Failed due to invalid Service ID. Confirm the Service ID entered is valid.
5010: SSL certificate failed to download. This is the process of downloading and installing the certificates. Check for log messages after 'Downloading SSL certificates' and verify network access.
5050: Login Failed due to SSL certificates errors in communication. Verify the installation of SSL certificates on the client machine.
6010: Login Failed due to the RSAgent service being unreachable from the login application. Close the login application and restart the RSAgent service.

Uninstallation

To uninstall the agent, complete the following

Open Control Panel > Programs and Features.
Locate RoamSafe Windows Agent in the list.
Select Uninstall and follow the on-screen instructions.

Defining Agent Policies on the CyberEdge

Agent policies are defined on the CyberEdge appliance and are retrieved by the RoamSafe Agent to filter and monitor device traffic. For more details on configuring policies, refer to the CyberEdge documentation on creating Access Policies.

RoamSafe for Windows Overview

The supported Windows versions for the RoamSafe Agent are listed below.

Feature	Availability
Windows 10 (22H2)	✅
Windows 11	✅
x86-64 Bit CPU	✅
ARM (RISC) CPU	❌ (In Development)
MSI installer	✅

Note

Supported Windows Release build 21H2/22H2 or greater. Older versions of Windows are not supported
Support for ARM processors is in active development

RoamSafe for Windows Feature Matrix

The matrix below outlines the features and functionalities of the CyberEdge RoamSafe Agent for Windows.

Feature	Availability	Description
Category Web Filtering	✅	Domain/DNS-based web filtering.
Group based Policies	✅	Manage content access by user group, enabling different controls based on a user's age or grade level.
IP/Port Based Filtering	✅	Enable or restrict access to specific IP addresses or ports.
Protocol Based Filtering	✅	Enable or restrict access to specific protocols.
Time of Day Controls	✅	Controls to regulate content access based on specific days and times, commonly used to restrict Internet access outside of permitted hours.
Date Range Controls	✅	Specifically designed to support custom date ranges, ideal for managing content access during school holiday periods.
Safe Search Protection	✅	Enforces safe search settings for Google, Bing, DuckDuckGo, and Wikipedia, blocking access to inappropriate content.
Content Scanning	✅	Keyword and content control scanning for Google, Bing, DuckDuckGo, and Wikipedia search.
HTTPS Inspection	✅	Utilised by content scanned applications only.
Certificate Installer	✅	Client certificate installer for Google Chrome and Microsoft Edge browsers.
User Based Authentication	✅	User-based authentication, utilized for group policies and reporting data.
Off Network Reporting	✅	User based reporting for Internet/network access, Block activity and Content Scanning matches.
Agent Updates (Manual)	✅	Allows administrators can manually update the RoamSafe Agent via an MDM solution, GPO or manual local installation.
Agent Updates (Automatic)	❌ (In Development)	Allows administrators to automatically update the RoamSafe Agent.