empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 08:55:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
09b88d0341
fleet/docs/01-Using-Fleet/standard-query-library
History
Eric 09b88d0341
Website: Add "Requires MDM" badge to /queries page (#9296) 
Changes:
- Added a "MDM required" tag to the queries in the standard query
library that use the `managed_policies` table.
- Updated the build script to add a `requiresMdm` value to queries added
to `builtStaticContent.queries`, and to set it to true if a query has
the "MDM required" tags
- Updated the `/queries` page to add a "Requires MDM" badge to queries
that have `requiresMdm: true`
 . . .

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-01-12 10:05:03 -06:00
..
README.md change relative links in documentation (#8441) 2022-10-26 18:26:49 -05:00
standard-query-library.yml Website: Add "Requires MDM" badge to /queries page (#9296) 2023-01-12 10:05:03 -06:00

README.md

Standard query library

Fleet's standard query library includes a growing collection of useful policies and miscellaneous queries for organizations deploying Fleet and osquery.

Importing the queries in Fleet

After cloning the fleetdm/fleet repo, import the queries and policies found in docs/01-Using-Fleet/standard-query-library/standard-query-library.yml using fleetctl:

fleetctl apply -f docs/01-Using-Fleet/standard-query-library/standard-query-library.yml

Contributors

Do you want to add your own query?

  1. Please copy the following YAML section and paste it at the bottom of the standard-query-library.yml file.
---
apiVersion: v1
kind: query
spec:
  name: What is your query called? Please use a human-readable query name.
  platforms: What operating systems support your query? This can usually be determined by the osquery tables included in your query. Heading to the https://osquery.io/schema webpage to see which operating systems are supported by the tables you include.
  description: Describe your query. What information does your query reveal? (optional)
  query: Insert query here
  purpose: What is the goal of running your query? Ex. Detection
  remediation: Are there any remediation steps to resolve the detection triggered by your query? If not, insert "N/A."
  contributors: zwass,mike-j-thomas
  tags: Keywords that can help users find other relevant queries; a comma should separate each tag. (e.g., "foo, bar")

  1. Replace each field and submit a pull request to the fleetdm/fleet GitHub repository.

  2. If you want to contribute multiple queries, please open one pull request that includes all your queries.

For instructions on submitting pull requests to Fleet, check out the Committing Changes section in the Contributors documentation.

Additional resources

Listed below are great resources that contain additional queries.