|Number of watchers on Github||1461|
|Number of open issues||16|
|Average time to close an issue||2 months|
|Average time to merge a PR||2 days|
|Open pull requests||4+|
|Closed pull requests||5+|
|Last commit||about 2 years ago|
|Repo Created||over 5 years ago|
|Repo Last Updated||over 1 year ago|
|Organization / Author||yelp|
|Do you use osxcollector? Leave a review!|
|View open issues (16)|
|View osxcollector activity|
|View on github|
|Fresh, new opensource launches 🚀🚀🚀|
Trendy new open source projects in your inbox! View examples
OSXCollector is a forensic evidence collection & analysis toolkit for OSX.
The collection script runs on a potentially infected machine and outputs a JSON file that describes the target machine. OSXCollector gathers information from plists, SQLite databases and the local file system.
Armed with the forensic collection, an analyst can answer the question like:
Yelp automates the analysis of most OSXCollector runs converting its output into an easily readable and actionable summary of just the suspicious stuff. Check out OSXCollector Output Filters project to learn how to make the most of the automated OSXCollector output analysis.
osxcollector.py is a single Python file that runs without any dependencies on a standard OSX machine. This makes it really easy to run collection on any machine - no fussing with brew, pip, config files, or environment variables. Just copy the single file onto the machine and run it:
sudo osxcollector.py is all it takes.
$ sudo osxcollector.py Wrote 35394 lines. Output in osxcollect-2014_12_21-08_49_39.tar.gz
If you have just cloned the GitHub repository,
osxcollector.py is inside
osxcollector/ directory, so you need to run it as:
$ sudo osxcollector/osxcollector.py
IMPORTANT: please make sure that
python command on your Mac OS X machine uses the default Python interpreter shipped with the system and is not overridden, e.g. by the Python version installed through brew. OSXCollector relies on a couple of native Python bindings for OS X libraries, which might be not available in other Python versions than the one originally installed on your system.
Alternatively, you can run
osxcollector.py explicitly specifying the Python version you would like to use:
$ sudo /usr/bin/python2.7 osxcollector/osxcollector.py
The JSON output of the collector, along with some helpful files like system logs, has been bundled into a .tar.gz for hand-off to an analyst.
osxcollector.py also has a lot of useful options to change how collection works:
Sets an identifier which is used as the prefix of the output file. The default value is
$ sudo osxcollector.py -i IncontinentSealord Wrote 35394 lines. Output in IncontinentSealord-2014_12_21-08_49_39.tar.gz
Get creative with incident names, it makes it easier to laugh through the pain.
Sets the path to the root of the filesystem to run collection on. The default value is
/. This is great for running collection on the image of a disk.
$ sudo osxcollector.py -p '/mnt/powned'
Runs only a portion of the full collection. Can be specified more than once. The full list of sections and subsections is:
$ sudo osxcollector.py -s 'startup' -s 'downloads'
Collect cookies' value.
By default OSXCollector does not dump the value of a cookie, as it may contain sensitive information (e.g. session id).
Collect the values stored in web browsers' local storage.
By default OSXCollector does not dump the values as they may contain sensitive information.
Enables verbose output and python breakpoints. If something is wrong with OSXCollector, try this.
$ sudo osxcollector.py -d
The collector outputs a
.tar.gz containing all the collected artifacts. The archive contains a JSON file with the majority of information. Additionally, a set of useful logs from the target system logs are included.
Each line of the JSON file records 1 piece of information. There are some common keys that appear in every JSON record:
osxcollector_incident_id: A unique ID shared by every record.
osxcollector_section: The section or type of data this record holds.
osxcollector_subsection: The subsection or more detailed descriptor of the type of data this record holds.
For records representing files there are a bunch of useful keys:
ctime: The file creation time.
mtime: The file modified time.
file_path: The absolute path to the file.
md5: MD5 hash of the file contents.
sha1: SHA1 hash of the file contents.
sha2: SHA2 hash of the file contents.
signature_chain: The common names of the certs in the file's signing chain
For records representing downloaded files:
xattr-wherefrom: A list containing the source and referrer URLs for the downloaded file.
xattr-quarantines: A string describing which application downloaded the file.
For records representing a row of a SQLite database:
osxcollector_table_name: The table name the row comes from.
osxcollector_db_path: The absolute path to the SQLite file.
For records that represent data associated with a specific user:
osxcollector_username: The name of the user
OSXCollector attempts to convert timestamps to human readable date/time strings in the format
YYYY-mm-dd hh:MM:ss. It uses heuristics to automatically identify various timestamps:
The current version of OSXCollector.
Collects basic information about the system:
Collects the Kernel extensions from:
More information about the Max OS X startup can be found here: http://www.malicious-streams.com/article/Mac_OSX_Startup.pdf
Hashes installed applications and gathers install history from:
Quarantines are basically the info necessary to show the 'Are you sure you wanna run this?' when a user is trying to open a file downloaded from the Internet. For some more details, checkout the Apple Support explanation of Quarantines: http://support.apple.com/kb/HT3662
This section collects also information from XProtect hash-based malware check
for quarantines files. The plist is at:
XProtect also add minimum versions for Internet Plugins. That plist is at:
Hashes all users' downloaded files from:
Collects following information from Google Chrome web browser:
This data is extracted from
Collects information from the different SQLite databases in a Firefox profile:
This information is extracted from
For more details about Firefox profile folder see http://kb.mozillazine.org/Profile_folder_-_Firefox
Collects information from the different plists and SQLite databases in a Safari profile:
Collects information about users' accounts:
Hashes files in the mail app directories:
Hashes all the files on disk. All of 'em. This does not run by default. It must be triggered with:
$ sudo osxcollector.py -s full_hash
Forensic analysis is a bit of art and a bit of science. Every analyst will see a bit of a different story when reading the output from OSXCollector. That's part of what makes analysis fun.
Generally, collection is performed on a target machine because something is hinky: anti-virus found a file it doesn't like, deep packet inspect observed a callout, endpoint monitoring noticed a new startup item. The details of this initial alert - a file path, a timestamp, a hash, a domain, an IP, etc. - that's enough to get going.
Simply greping a few minutes before and after a timestamp works great:
$ cat INCIDENT32.json | grep '2014-01-01 11:3[2-8]'
It's in there. A tool like jq can be very helpful to do some fancy output:
$ cat INCIDENT32.json | grep '2014-01-01 11:3[2-8]' | jq 'select(has("url"))|.url'
$ cat INCIDENT32.json | jq 'select(.osxcollector_username=="ivanlei")|.'
The OSXCollector Output Filters project contains filters that process and transform the output of OSXCollector. The goal of filters is to make it easy to analyze OSXCollector output.
The functionality of OSXCollector is stored in a single file:
osxcollector.py. The collector should run on a naked install of OS X without any additional packages or dependencies.
Ensure that all of the OSXCollector tests pass before editing the source code. You can run the tests using:
After making changes to the source code, run
make test again to verify that your changes did not break any of the tests.
This work is licensed under the GNU General Public License and a derivation of https://github.com/jipegit/OSXAuditor
Want to learn more about OS X forensics?
A couple of other interesting tools: