Adding a new dependency

Romain Gayon edited this page Jul 5, 2018 · 30 revisions
Clone this wiki locally

There are several steps involved for getting a new dependency added to plaso.

Before you begin checklist

If the answer on any of the questions below is no the dependency is not suitable for plaso. In that case see: Alternatives

Code licensed under a GPL, AGPL or BSD 4-clause cannot be integrated in a binary build, hence these licenses are deemed incompatible. Note that this could also apply to other source code licenses.

  • Does the dependency support Linux, Mac OS X and Windows?

Automated testing

The automated testing relies on having the dependencies available. We deliberately limit the usage of pip (or equivalent) in the automated testing scripts, mainly because pip distributed builds change continuously. We want to have a more stable set of dependencies on dependencies and limit the amount of troubleshooting due breakage caused by a dependency.

Getting a dependency in l2tdevtools

Plaso uses l2tdevtools to limit the amount of manual effort required in maintaining dependencies.

If the build process of the dependency is similar enough what is currently supported then adding a new dependency should be relative straight forward by adding it to data/projects.ini. If not reach out to discuss how we can get support into l2tdevtools for the specific dependency.

Make sure the dependency is added to the plaso dependencies preset for update.py.

Getting a dependency in GIFT COPR

Once the dependency has been added to l2tdevtools it can be added to the GIFT COPR. Ask one of the log2timeline maintainers to upload your package.

Notes for maintainers: https://github.com/log2timeline/l2tdocs/blob/master/process/GIFT%20COPR.md

Getting a dependency in GIFT PPA

Once the dependency has been added to l2tdevtools it can be added to the GIFT PPA. Ask one of the log2timeline maintainers to upload your package.

Notes for maintainers: https://github.com/log2timeline/l2tdocs/blob/master/process/GIFT%20PPA.md

Getting a dependency in l2tbinaries

Once the dependency has been added to l2tdevtools it can be added to l2tbinaries. Ask one of the log2timeline maintainers to upload your package.

Notes for maintainers: https://github.com/log2timeline/l2tdocs/blob/master/process/l2tbinaries.md

Source changes

Dependencies are defined in multiple different configuration files and scripts in the plaso source tree. To keep them consistent plaso uses l2tdevtools update-dependencies.py to generate these configuration files and scripts based on dependencies.ini.

PYTHONPATH=../l2tdevtools ../l2tdevtools/tools/update-dependencies.py

Documentation

TODO: describe

Update the following wiki pages:

Alternatives

TODO: describe