uac

Unix-like Artifacts Collector

Documentation • Main Features • Supported Operating Systems • Using UAC • Contributing • Support • License

? About UAC

UAC is a Live Response collection script for Incident Response that makes use of native binaries and tools to automate the collection of AIX, ESXi, FreeBSD, Linux, macOS, NetBSD, NetScaler, OpenBSD and Solaris systems artifacts. It was created to facilitate and speed up data collection, and depend less on remote support during incident response engagements.

UAC reads YAML files on the fly and, based on their contents, collects relevant artifacts. This makes UAC very customizable and extensible.

? Documentation

Project documentation page: https://tclahr.github.io/uac-docs

? Main Features

• Run everywhere with no dependencies (no installation required).
• Customizable and extensible collections and artifacts.
• Respect the order of volatility during artifact collection.
• Collect information about current running processes (including processes without a binary on disk).
• Hash running processes and executable files.
• Extract files and directories status to create a bodyfile.
• Collect system and user-specific data, configuration files and logs.
• Acquire volatile memory from Linux systems using different methods and tools.

? Supported Operating Systems

UAC runs on any Unix-like system, regardless of the processor architecture. All UAC needs is shell :)

Note that UAC even runs on systems like Network Attached Storage (NAS) devices, Network devices such as OpenWrt, and IoT devices.

? Usage

UAC does not need to be installed on the target system. Simply download the latest version from the releases page, uncompress it, and launch. It's that simple!

Full Disk Access permission is a privacy feature introduced in macOS Mojave (10.14) that prevents some applications from accessing important data, such as Mail, Messages, and Safari files. So it is strongly recommended that you manually grant permission for Terminal application before running UAC from the terminal, or grant permission for remote users before running UAC via ssh.

To execute a collection, you must supply at least a profile and/or a list of artifacts, and specify the destination directory. Any additional parameters are optional.

Examples:

Collect all artifacts based on the ir_triage profile, and save the output file to /tmp.

./uac -p ir_triage /tmp

Collect all artifacts located in the artifacts/live_response directory, and save the output file to /tmp.

./uac -a ./artifacts/live_response/* /tmp

Collect all artifacts based on the ir_triage profile, along with all artifacts located in the /my_custom_artifacts directory, and save the output file to /mnt/sda1.

./uac -p ir_triage -a /my_custom_artifacts/* /mnt/sda1

Collect a memory dump and all artifacts based on the full profile.

./uac -a ./artifacts/memory_dump/avml.yaml -p full /tmp

Collect all artifacts based on the ir_triage profile excluding the bodyfile/bodyfile.yaml artifact.

./uac -p ir_triage -a !artifacts/bodyfile/bodyfile.yaml /tmp

? Contributing

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Have you created any artifacts? Please share them with us!

You can contribute with new artifacts, profiles, bug fixes or even propose new features. Please read our Contributing Guide before submitting a Pull Request to the project.

?‍ Community Support

For general help using UAC, please refer to the project documentation page. For additional help, you can use one of the channels to ask a question:

• Discord (For live discussion with the community and UAC team)
• GitHub (Bug reports and contributions)
• Twitter (Get the news fast)

? License

The UAC project uses the Apache License Version 2.0 software license.