Categorygithub.com/macadmins/osquery-extension
modulepackage
1.2.0
Repository: https://github.com/macadmins/osquery-extension.git
Documentation: pkg.go.dev

# README

macadmins-extension

Usage

For testing, you can load the extension with osqueryi.

By default, osquery does not want to load extensions not owned by root. You can either change the ownership of macadmins_extension.ext to root, or run osquery with the --allow_unsafe flag.

osqueryi --extension /path/to/macadmins_extension.ext

For production deployment, you should refer to the osquery documentation.

Tables

TableDescriptionPlatformsNotes
authdbmacOS Authorization databasemacOSUse the constraint name to specify a right name to query, otherwise all rights will be returned.
file_linesRead an arbitrary fileLinux / macOS / WindowsUse the constraint path and last to specify the file to read lines from
filevault_usersInformation on the users able to unlock the current boot volume when encrypted with FilevaultmacOS
google_chrome_profilesProfiles configured in Google Chrome.Linux / macOS / Windows
macos_profilesHigh level information on installed profiles enrollmentmacOS
mdmInformation on the device's MDM enrollmentmacOSCode based on work by Kolide. Due to changes in macOS 12.3, the output of profiles show -type enrollment can only be generated once a day. If you are running this command with another tool, you should set the PROFILES_SHOW_ENROLLMENT_CACHE_PATH environment variable to the path you are caching this. The cache file should be json with the keys dep_capable and rate_limited present, both booleans representing whether the device is capable of DEP enrollment and whether the response from profiles show -type enrollment is being rate limited or not.
munki_infoInformation from the last Munki runmacOSCode based on work by Kolide
munki_installsItems Munki is managingmacOSCode based on work by Kolide
network_qualityOutput from the networkQuality binarymacOSThis binary is only present on macOS 12
puppet_factsPuppet factsLinux / macOS / Windows
puppet_infoInformation on the last Puppet runLinux / macOS / Windows
puppet_logsLogs from the last Puppet runLinux / macOS / Windows
puppet_stateState of every resource Puppet is managingLinux / macOS / Windows
sofa_security_release_infoThe information on the security release the device is running from SofamacOSUse the url constraint to specify a data source other than https://sofa.macadmins.io/v1/macos_data_feed.json . By default this table will return vulnerability data for the running operating system. For historical data, use the os_version predicate (e.g select * from sofa_security_release_info where os_version="14.4.0";)
sofa_unpatched_cvesThe CVEs that are unpatched on the device from SofamacOSUse the url constraint to specify a data source other than https://sofa.macadmins.io/v1/macos_data_feed.json. By default this table will return all unpatched vulnerability data. For historical data, use the os_version predicate (e.g select * from sofa_unpatched_cves where os_version="14.4.0";)
unified_logResults from macOS' Unified LogmacOSUse the constraints predicate and last to limit the number of results you pull, or this will not be very performant at all. Use level with a value of info to include info level messages. Use level with a value of debug to include info and debug level messages. (select * from unified_log where last="1h" and level="debug" and predicate='processImagePath contains "mdmclient"';)
wifi_networkTable to get the current wifi network name since the Osquery wifi_info table no longer does this. Includes the rest of the working fields in wifi_info.macOSSee osquery issue #8220

Development

  • Install Go 1.21 (either directly from go.dev or via GVM)
    • gvm install go1.21
  • Install Bazelisk

# Packages

No description provided by the author
No description provided by the author

# Variables

No description provided by the author