macOS clients

Prev Next

Client types

There are three types of macOS client. For a quick overview of the differences, see the Client compatibility matrix.

Type

Designed for

Full

Normal enterprise usage, including pre-installation as part of standard builds

Headless

Installation on unattended machines such as servers.

Always-On

Normal enterprise usage where an always-on connection to certain protected hosts is required.

Confirm that the client version is compatible with the associated operating system version. See Downloads for more information.

NOTE

When macOS FileVault is enabled, the operating system does not start the headless client at boot until a user with permission to decrypt the drive signs in. This affects both headless and always-on clients.


Installing macOS clients

The standard installer file installs all elements that the full, headless, and always-on clients require. Each type of macOS client has a page with specific installation details. The default installation operates as a full client. Configuring headless or always-on mode requires additional manual configuration. See macOS headless client for details.

NOTE

Endpoint protection software sometimes interferes with client installation. You may need to allow several client components and executables within the endpoint protection software.


Uninstalling macOS clients

Run the AppGate SDP Uninstaller script in the .dmg file used to install the client. You can choose to keep saved configurations and credentials in the Keychain. The uninstaller removes all other configurations.

NOTE

Never partially uninstall the client—for example, do not remove only the AppGate ZTNA driver.

To manually uninstall the client, run as root:

sudo /Library/Application\ Support/Appgate/interactive-uninstall

To uninstall and remove all secrets stored in the Keychain, run as root:

sudo /Library/Application\ Support/Appgate/interactive-uninstall --clear-settings

Components and executables

Upgraded clients may retain some existing paths even when new paths are used. The following table shows only the paths new installations use:

Location

Component/Executable

Description

/Applications/

Appgate SDP.app

Contains the Appgate SDP executable. Runs as USER and handles the UI process.

/Library/Application Support/Appgate/

Appgate Driver

The virtual network adapter that handles connections to the Gateways.

Appgate Service.app

Contains the AppGate Service executable. Runs as USER and handles business logic.

appgate-updater

Runs with root privileges. Handles auto-update of the client.

headless-installer

Used for headless and always-on clients.

appgate_service_configurator

Tool to control the headless client. Requires the AppGate Service to be running.

interactive-uninstall

The uninstall script.

appgate-starter

Runs with root privileges and full disk access rights.

/etc/

appgate.conf

The configuration file containing the parameters required for the headless client to sign in.


Setting defaults

The following table lists the commands that set default options:

Option

Command

Skip the data usage approval screen

defaults write com.appgate.sdp.service user_approval -bool YES

Prevent device claim scripts from running

CAUTION

These scripts run with full administrator privileges and present a security risk.

defaults write com.appgate.sdp.service scripts_disabled -bool true

Set multiple default profiles after a fresh install

Separate profiles with a semicolon inside quotes, for example": ["profile1;profile2"]

defaults write com.appgate.sdp.service default_profiles "appgate://profile1.com/foo;appgate://profile2.com/bar"

Set the default attention mode

defaults write com.appgate.sdp attention_mode [ATTENTION_VALUE] where ATTENTION_VALUE can be 0-2

Prevent the full client from auto-starting at boot

defaults write com.appgate.sdp.service autostart 0


Configuration settings

The following table lists common configuration tasks:

Task

Details

List local firewall rules

sudo pfctl -a com.appgate -sr

Clean all client settings

  1. Delete: ~/Library/Preferences/com.appgate.sdp.plis

    ~/Library/Preferences/com.appgate.sdp.service.plist

  2. Reboot the computer.

Remove a profile link

  1. Open the Keychain Access application.

  2. Search for “appgate” and find entries of the kind “Profile”.

  3. Show the password to see the profile name.

  4. Delete the required profile.

Remove all stored passwords and certificates

  1. Open the Keychain Access application.

  2. Search for “appgate”.

  3. Delete all related passwords.

The following image shows typical AppGate Keychain entries:

List of Appgate SDP Client activities with timestamps and login details.


DNS configuration

The client includes the option to run a custom DNS script. The script tries to change the network configuration when connecting so that AppGate ZTNA domains use AppGate ZTNA DNS while regular DNS continues to resolve everything else. Legacy applications that rely on /etc/resolv.conf for name resolution may require this.

To use a custom DNS script:

  1. Create your script and save it: for example, at /etc/custom_dns_script.sh  

  2. Create a new file containing the line: dns_script=/etc/custom_dns_script.sh

  3. Save this file as /etc/appgate.conf

When the client connects, the script is called with --servers <dns-server-ips> --domains <dns-domains>. On disconnect, the script is called with --reset.