Documentation

Contents
Contents
Contents
Contents
!
This documentation applies to a beta version of uberAgent (docs for the latest official release)

Installing the macOS Endpoint Agent


The agent installer is available as a PKG file. It can either be installed manually or unattended through existing software deployment tools. Also, most device management solutions support the distribution of such packages natively.

Expected result after the installation: the launch daemon uberAgent is installed and running.

Requirements

uberAgent for macOS uses Apple’s EndpointSecurity framework (available since macOS 10.15), which requires explicit user authorization. Authorization is granted by adding /Library/uberAgent/uberAgent.app to System Preferences > Security & Privacy > Privacy > Full Disk Access. This can be done manually or by deploying a Privacy Preferences Policy Control Payload profile on managed devices. Either create the payload on your own, by following the instructions provided by Apple, or make use of tools like the PPPC-Utility. The excerpt from the following file must be part of your configuration.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
   <key>PayloadContent</key>
   <array>
      <dict>
         [...]
         <key>Services</key>
         <dict>
            <key>SystemPolicyAllFiles</key>
            <array>
               <dict>
                  <key>Allowed</key>
                  <true/>
                  <key>CodeRequirement</key>
                  <string> ... output of 'codesign --display -r - /Library/uberAgent/uberAgent.app' starting with 'anchor' ... </string>
                  <key>Comment</key>
                  <string></string>
                  <key>Identifier</key>
                  <string>com.vastlimits.uberAgent</string>
                  <key>IdentifierType</key>
                  <string>bundleID</string>
               </dict>
            </array>
         </dict>
      </dict>
   </array>
   [...]
   <key>PayloadType</key>
   <string>com.apple.TCC.configuration-profile-policy</string>
   <key>payloadScope</key>
   <string>system</string>
</dict>
</plist>

Installation method

Interactive

  • The installation of uberAgent can be started by opening uberAgent.pkg and following the instructions on the screen.
  • Since uberAgent is installed as a system-wide daemon, the installer will ask for a password for elevated access rights to install it.

Command Line

  • The Installer can also be used from the command line to install uberAgent using the command installer -pkg uberAgent.pkg -target /
  • This requires root privileges. A command line installation can be executed locally or remotely, e.g. using SSH.

Installation Through Splunk Deployment Server

Note: Deployment Server can only be used with Splunk Enterprise and requires Splunk Universal Forwarder on the endpoint as deployment client. Please make sure, that Splunk Universal Forwarder has sufficient privileges to perform system-wide installations, e.g. by enabling boot-start.

uberAgent

Copy the directory uberAgent_endpoint from the unzipped uberAgent download package to $SPLUNK_HOME/etc/deployment-apps on your deployment server. Please make sure to apply the executable flag to the installation script by executing chmod +x silent-install.sh. Besides that, the uberAgent_endpoint folder is ready to use for deployment on Windows as well as macOS operating systems.
Note: $SPLUNK_HOME refers to the base directory of the Splunk installation, typically /opt/splunk on Linux.

Configuration

To deploy a customized configuration file copy it into the directory $SPLUNK_HOME/etc/deployment-apps/uberAgent_endpoint/bin. This overwrites /Library/Application Support/uberAgent/uberAgent.conf.

Serverclass

Create a file called serverclass.conf in $SPLUNK_HOME/etc/system/local on your deployment server. serverclass.conf defines what to deploy where. For a quick start paste the following content into serverclass.conf to deploy uberAgent to all macOS machines. You may want to fine-tune this to suit your needs.

# [global]
# We cannot match by machine type here. We'll do that on the app level below.
whitelist.0 = *

# Define a serverclass 
[serverClass:macOS]
# Deploy only to macOS machines
machineTypesFilter = darwin-x86_64
 
# Define which apps to deploy to the serverclass
[serverClass:macOS:app:uberAgent_endpoint]
stateOnClient = enabled
restartSplunkd = true

To make Splunk read the new file serverclass.conf run the following command:

$SPLUNK_HOME/bin/splunk reload deploy-server

Available Source Types

The source types currently provided by the macOS agent can be found below. For a more detailed description of which fields are available for each source type, please have a look at the metrics documentation.

  • uberAgent:Application:ApplicationInventory
  • uberAgent:Process:ProcessDetail
  • uberAgent:System:DiskInventory
  • uberAgent:System:MachineInventory
  • uberAgent:System:MonitorInventory
  • uberAgent:System:NetworkConfigInformation
  • uberAgent:System:VolumeInventory

Configuration

uberAgent can be configured very flexibly. By editing the configuration you can switch metrics on or off, change the data collection frequency and significantly reduce the data volume.

Leave a Reply

Your email address will not be published. Required fields are marked *