| CMake | ||
| lib@e163809165 | ||
| osquery | ||
| package | ||
| third-party@4dac47d96d | ||
| tools | ||
| .clang-format | ||
| .gitignore | ||
| .gitmodules | ||
| CMakeLists.txt | ||
| Makefile | ||
| osquery.supp | ||
| README.md | ||
| requirements.txt | ||
osquery
Building on OS X
To build osquery on OS X, all you need installed is pip and brew.
make deps will take care of installing the appropriate library
dependencies, but I recommend taking a look at the Makefile, just in case
you see something that might conflict with your personal setup.
Anything that doesn't have a homebrew package is built from source from
https://github.com/osquery/third-party, which is a git submodule of this
repository which is set up by make deps.
The complete installation/build steps are as follows:
git clone git@github.com:facebook/osquery.git
cd osquery
make deps
make
Once the project is built, try running the project's unit tests:
make runtests
Developing on OS X
make deps will take care of installing everything you need to compile osquery
but to properly develop and contribute code, you'll need to install two additional
programs:
- clang-format: we use clang-format to format all code in osquery
- valgrind: performance is a top priority for osquery, so all code should be thouroughly tested with valgrind
Table Development
Top easy virtual tables
High impact virtual tables
- Installed browser plugins virtual table
- System-trusted root certificated virtual table
- Startup items virtual table
Testing your table for memory leaks
Use valgrind to test your table for memory leaks before you commit it. The osqueryd daemon is a very long running processes, so avoiding memory leaks is critical. The "run" tool is useful for testing a specific query. From the root of the osquery repository, run the following (substitute your table name in the query):
valgrind --tool=memcheck --leak-check=yes --suppressions=osquery.supp ./build/tools/run --query="select * from time;"