Notices: This section not yet converted to new layout. Download stats are rolling back out.

This is not the latest version of osquery available.

osquery

2.6.0

Package test results are passing.

This package was approved as a trusted package on 7/28/2017.

osquery allows you to easily ask questions about your Linux, OSX, and
Windows infrastructure. Whether your goal is intrusion detection,
infrastructure reliability, or compliance, osquery gives you the ability
to empower and inform a broad set of organizations within your company.

### Package Parameters
* /InstallService - This creates a new windows service that will auto-start the daemon.

These parameters can be passed to the installer with the user of -params.
For example: -params '"/InstallService"'.

To install osquery, run the following command from the command line or from PowerShell:

C:\> choco install osquery --version 2.6.0

To upgrade osquery, run the following command from the command line or from PowerShell:

C:\> choco upgrade osquery --version 2.6.0

Files

Hide
  • tools\bin\osquery.zip Show
    md5: 7A6CE2DFAD743EA799820F39FDE822C9 | sha1: 910948BA86479C459DD62209C4FBF4DAECDBD50F | sha256: AB4FE3E289A8106672858E29A176DAB26C4A4FA9F20F927EFCAEFA70CBE9846D | sha512: B201363524B69BE5F7A5FF01BDB130DB7E176D0851551405D3C26F8769E6CAB5C784E3B5A1F65281D0CBE6888A3A0C4CB457D9992231085CB2E6333B89AA44F7
  • tools\chocolateyBeforeModify.ps1 Show
    #  Copyright (c) 2014-present, Facebook, Inc.
    #  All rights reserved.
    #
    #  This source code is licensed under the BSD-style license found in the
    #  LICENSE file in the root directory of this source tree. An additional grant
    #  of patent rights can be found in the PATENTS file in the same directory.
    . "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\osquery_utils.ps1"
    
    $serviceName = 'osqueryd'
    $progData =  [System.Environment]::GetEnvironmentVariable('ProgramData')
    $targetFolder = Join-Path $progData "osquery"
    $daemonFolder = Join-Path $targetFolder $serviceName
    
    # Before modifying we ensure to stop the service, if it exists
    if ((Get-Service $serviceName -ErrorAction SilentlyContinue) -and (Get-Service $serviceName).Status -eq 'Running') {
      Stop-Service $serviceName
    }
    
    # Lastly, ensure that the Deny Write ACLs have been removed before modifying
    if (Test-Path $daemonFolder) {
      Set-DenyWriteAcl $daemonFolder 'Remove'
    }
    
  • tools\chocolateyinstall.ps1 Show
    #  Copyright (c) 2014-present, Facebook, Inc.
    #  All rights reserved.
    #
    #  This source code is licensed under the BSD-style license found in the
    #  LICENSE file in the root directory of this source tree. An additional grant
    #  of patent rights can be found in the PATENTS file in the same directory.
    . "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\osquery_utils.ps1"
    
    $serviceName = 'osqueryd'
    $serviceDescription = 'osquery daemon service'
    $progData =  [System.Environment]::GetEnvironmentVariable('ProgramData')
    $targetFolder = Join-Path $progData 'osquery'
    $daemonFolder = Join-Path $targetFolder 'osqueryd'
    $logFolder = Join-Path $targetFolder 'log'
    $targetDaemonBin = Join-Path $targetFolder 'osqueryd.exe'
    $destDaemonBin = Join-Path $daemonFolder 'osqueryd.exe'
    $packageParameters = $env:chocolateyPackageParameters
    $arguments = @{}
    
    # Before modifying we ensure to stop the service, if it exists
    if ((Get-Service $serviceName -ErrorAction SilentlyContinue) -and (Get-Service $serviceName).Status -eq 'Running') {
      Stop-Service $serviceName
    }
    
    # Lastly, ensure that the Deny Write ACLs have been removed before modifying
    if (Test-Path $daemonFolder) {
      Set-DenyWriteAcl $daemonFolder 'Remove'
    }
    
    # Now parse the packageParameters using good old regular expression
    if ($packageParameters) {
      $match_pattern = "\/(?<option>([a-zA-Z]+)):(?<value>([`"'])?([a-zA-Z0-9- _\\:\.]+)([`"'])?)|\/(?<option>([a-zA-Z]+))"
      $option_name = 'option'
      $value_name = 'value'
    
      if ($packageParameters -match $match_pattern ) {
        $results = $packageParameters | Select-String $match_pattern -AllMatches
        $results.matches | ForEach-Object {
          $arguments.Add(
            $_.Groups[$option_name].Value.Trim(),
            $_.Groups[$value_name].Value.Trim())
        }
      } else {
        Throw "Package Parameters were found but were invalid (REGEX Failure)"
      }
      if ($arguments.ContainsKey("InstallService")) {
        $installService = $true
      }
    } else {
      Write-Debug "No Package Parameters Passed in"
    }
    
    New-Item -Force -Type directory -Path $daemonFolder
    New-Item -Force -Type directory -Path $logFolder
    $packagePath = "$(Split-Path -Parent $MyInvocation.MyCommand.Definition)\\bin\\osquery.zip"
    Get-ChocolateyUnzip -FileFullPath $packagePath -Destination $targetFolder
    
    # In order to run osqueryd as a service, we need to have a folder that has a
    # Deny Write ACL to everyone.
    Move-Item -Force -Path $targetDaemonBin -Destination $destDaemonBin
    Set-DenyWriteAcl $daemonFolder 'Add'
    
    if ($installService) {
      if (-not (Get-Service $serviceName -ErrorAction SilentlyContinue)) {
        Write-Debug '[+] Installing osquery daemon service.'
        # If the 'install' parameter is passed, we create a Windows service with
        # the flag file in the default location in \ProgramData\osquery\
        New-Service -Name $serviceName -BinaryPathName "$destDaemonBin --flagfile=\ProgramData\osquery\osquery.flags" -DisplayName $serviceName -Description $serviceDescription -StartupType Automatic
    
        # If the osquery.flags file doesn't exist, we create a blank one.
        if (-not (Test-Path "$targetFolder\osquery.flags")) {
          Add-Content "$targetFolder\osquery.flags" $null
        }
      }
      Start-Service $serviceName
    }
    
    # Add osquery binary path to machines path for ease of use.
    $oldPath = [System.Environment]::GetEnvironmentVariable('Path', 'Machine')
    if (-not ($oldPath -imatch [regex]::escape($targetFolder))) {
      $newPath = $oldPath
      if ($oldPath[-1] -eq ';') {
        $newPath = $newPath + $targetFolder
      } else {
        $newPath = $newPath + ';' + $targetFolder
      }
      [System.Environment]::SetEnvironmentVariable('Path', $newPath, 'Machine')
    }
    
    if (Test-Path $targetFolder) {
      Write-Output "osquery was successfully installed to $targetFolder."
    } else {
      Write-Output 'There was an error installing osquery.'
    }
    
  • tools\chocolateyuninstall.ps1 Show
    #  Copyright (c) 2014-present, Facebook, Inc.
    #  All rights reserved.
    #
    #  This source code is licensed under the BSD-style license found in the
    #  LICENSE file in the root directory of this source tree. An additional grant
    #  of patent rights can be found in the PATENTS file in the same directory.
    $progData =  [System.Environment]::GetEnvironmentVariable('ProgramData')
    $targetFolder = Join-Path $progData "osquery"
    $serviceName = 'osqueryd'
    
    # Remove the osquery path from the System PATH variable. Note: Here
    # we don't make use of our local vars, as Regex requires escaping the '\'
    $oldPath = [System.Environment]::GetEnvironmentVariable('Path', 'Machine')
    if ($oldPath -imatch [regex]::escape($targetFolder)) {
      $newPath = $oldPath -replace [regex]::escape($targetFolder),$NULL
      [System.Environment]::SetEnvironmentVariable('Path', $newPath, 'Machine')
    }
    
    if ((Get-Service $serviceName -ErrorAction SilentlyContinue)) {
      Stop-Service $serviceName
      Set-Service $serviceName -startuptype 'manual'
      Get-CimInstance -ClassName Win32_Service -Filter "Name='osqueryd'" | Invoke-CimMethod -methodName Delete
    }
    
    if (Test-Path $targetFolder) {
      Remove-Item -Force -Recurse $targetFolder
      if (Test-Path $targetFolder) {
        Write-Output 'osquery uninstallation was unsuccessful.'
      } else {
        Write-Output 'osquery was uninstalled successfully.'
      }
    } else {
      Write-Output 'osquery was not found on the system. Nothing to do.'
    }
    
  • tools\osquery_utils.ps1 Show
    #  Copyright (c) 2014-present, Facebook, Inc.
    #  All rights reserved.
    #
    #  This source code is licensed under the BSD-style license found in the
    #  LICENSE file in the root directory of this source tree. An additional grant
    #  of patent rights can be found in the PATENTS file in the same directory.
    
    # Helper function to toggle the Deny-Write ACL placed on the
    # osqueryd parent folder for 'safe' execution on Windows.
    function Set-DenyWriteAcl {
      [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = "Medium")]
      [OutputType('System.Boolean')]
      param(
        [string] $targetDir = '',
        [string] $action = ''
      )
      if (($action -ine 'Add') -and ($action -ine 'Remove')) {
        Write-Debug '[-] Invalid action in Set-DenyWriteAcl.'
        return $false
      }
      if ($PSCmdlet.ShouldProcess($targetDir)) {
        $acl = Get-Acl $targetDir
        $inheritanceFlag = [System.Security.AccessControl.InheritanceFlags]::ContainerInherit -bor [System.Security.AccessControl.InheritanceFlags]::ObjectInherit
        $propagationFlag = [System.Security.AccessControl.PropagationFlags]::None
        $permType = [System.Security.AccessControl.AccessControlType]::Deny
    
        $worldSIDObj = New-Object System.Security.Principal.SecurityIdentifier ('S-1-1-0')
        $worldUser = $worldSIDObj.Translate( [System.Security.Principal.NTAccount])
        $permission = $worldUser.Value, "write", $inheritanceFlag, $propagationFlag, $permType
        $accessRule = New-Object System.Security.AccessControl.FileSystemAccessRule $permission
        # We only support adding or removing the ACL
        if ($action -ieq 'add') {
          $acl.SetAccessRule($accessRule)
        }
        else {
          $acl.RemoveAccessRule($accessRule)
        }
        $acl | Set-Acl $targetDir
        return $true
      }
      return $false
    }
    
    # Helper function for running a .bat file from powershell
    function Invoke-BatchFile {
      param(
        [string]$path,
        [string]$parameters
      )
      $tempFile = [IO.Path]::GetTempFileName()
      cmd.exe /c " `"$path`" $parameters && set > `"$tempFile`" "
      Get-Content $tempFile | Foreach-Object {
        if ($_ -match '^(.*?)=(.*)$') {
          Set-Content "env:\$($matches[1])" $matches[2]
        }
      }
      Remove-Item $tempFile
    }
    
    # Constructs a chocolatey .nuspec file in the current directory
    function Write-NuSpec {
      param(
        [string] $packageName,
        [string] $version,
        [string] $authors,
        [string] $owners,
        [string] $projectSource,
        [string] $packageSourceUrl,
        [string] $copyright,
        [string] $license
      )
      $nuspec = @"
    <?xml version="1.0" encoding="utf-8"?>
    <!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
    <package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
      <metadata>
        <id>$packageName</id>
        <title>$packageName</title>
        <version>$version</version>
        <authors>$authors</authors>
        <owners>$owners</owners>
        <summary>$packageName</summary>
        <description>$packageName</description>
        <projectUrl>$projectSource</projectUrl>
        <packageSourceUrl>$packageSourceUrl</packageSourceUrl>
        <tags>$packageName</tags>
        <copyright>$copyright</copyright>
        <licenseUrl>$license</licenseUrl>
        <requireLicenseAcceptance>false</requireLicenseAcceptance>
      </metadata>
      <files>
        <file src="local\**" target="local" />
      </files>
    </package>
    "@
      Out-File -Encoding "UTF8" -FilePath "$packageName.nuspec" -InputObject $nuspec
    }
    
    # Derive the location of the osquery build location
    function Get-OsqueryBuildPath {
      [OutputType('System.String')]
      param()
      $loc = Get-Location
      $toks = $loc -Split '\\'
      $ret = ''
      0..$toks.length | ForEach-Object {
        if (Test-Path "$($toks[0..$_] -Join '\')\tools\provision.ps1") {
          $ret = "$($toks[0..$_] -Join '\')\build"
        }
      }
      return $ret
    }
    

Virus Scan Results

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Dependencies

This package has no dependencies.

Package Maintainer(s)

Software Author(s)

  • Facebook

Copyright

Copyright (c) 2014-present, Facebook, Inc. All rights reserved.

Tags

Release Notes

https://github.com/facebook/osquery/releases/tag/2.6.0

Version History

Version Downloads Last updated Status
osquery 3.3.2 5476 Monday, January 28, 2019 approved
osquery 3.3.1 43403 Tuesday, October 2, 2018 approved
osquery 3.3.0 2969 Monday, August 20, 2018 approved
osquery 3.2.9 74568 Monday, July 2, 2018 approved
osquery 3.2.6 49896 Monday, July 2, 2018 approved
osquery 3.2.4 2897 Friday, May 4, 2018 approved
osquery 2.11.2 5504 Monday, February 5, 2018 approved
osquery 2.11.0 1839 Friday, January 12, 2018 approved
osquery 2.10.4 1648 Sunday, December 3, 2017 approved
Show More

Discussion for the osquery Package

Ground rules:

  • This discussion is only about osquery and the osquery package. If you have feedback for Chocolatey, please contact the google group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or osquery, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

comments powered by Disqus
Chocolatey.org uses cookies to enhance the user experience of the site.
Ok