{"id":18913535,"url":"https://github.com/complianceascode/auditree-arboretum","last_synced_at":"2025-04-15T08:30:51.972Z","repository":{"id":49958850,"uuid":"260063519","full_name":"ComplianceAsCode/auditree-arboretum","owner":"ComplianceAsCode","description":"The Auditree common fetchers, checks and harvest reports library.","archived":false,"fork":false,"pushed_at":"2023-11-09T05:07:14.000Z","size":247,"stargazers_count":17,"open_issues_count":7,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-14T10:05:19.961Z","etag":null,"topics":["compliance","compliance-as-code","compliance-automation","continuous-compliance","devops","devsecops","python"],"latest_commit_sha":null,"homepage":"https://auditree.github.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ComplianceAsCode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null}},"created_at":"2020-04-29T22:54:51.000Z","updated_at":"2024-10-30T17:59:53.000Z","dependencies_parsed_at":"2023-11-07T12:44:36.779Z","dependency_job_id":null,"html_url":"https://github.com/ComplianceAsCode/auditree-arboretum","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComplianceAsCode%2Fauditree-arboretum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComplianceAsCode%2Fauditree-arboretum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComplianceAsCode%2Fauditree-arboretum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ComplianceAsCode%2Fauditree-arboretum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ComplianceAsCode","download_url":"https://codeload.github.com/ComplianceAsCode/auditree-arboretum/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248860288,"owners_count":21173342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compliance","compliance-as-code","compliance-automation","continuous-compliance","devops","devsecops","python"],"created_at":"2024-11-08T10:08:12.289Z","updated_at":"2025-04-15T08:30:51.453Z","avatar_url":"https://github.com/ComplianceAsCode.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![OS Compatibility][platform-badge]](#prerequisites)\n[![Python Compatibility][python-badge]][python-dl]\n[![pre-commit][pre-commit-badge]][pre-commit]\n[![Code validation](https://github.com/ComplianceAsCode/auditree-arboretum/workflows/format%20%7C%20lint%20%7C%20test/badge.svg)][lint-test]\n[![Upload Python Package](https://github.com/ComplianceAsCode/auditree-arboretum/workflows/PyPI%20upload/badge.svg)][pypi-upload]\n\n# auditree-arboretum\n\nThe Auditree common fetchers, checks and [harvest][] reports library.\n\n## Introduction\n\nAuditree Arboretum is a Python library of common compliance fetchers, checks \u0026amp; harvest\nreports built upon the [Auditree compliance automation framework][auditree-framework].\n\n## Repo content\n\n### Functionality categorization\n\nArboretum fetchers, checks, and Harvest reports are organized into functional\ngrouping categories.  The following categories have either been contributed to\nor will be contributed to in the near future.  We anticipate that this list will\ngrow as arboretum matures.\n\n- [Ansible](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/ansible)\n- [Auditree](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/auditree)\n- [Chef](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/chef)\n- [IBM Cloud](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/ibm_cloud)\n- [Kubernetes](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/kubernetes)\n- [Object Storage](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/object_storage)\n- [Pager Duty](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/pager_duty)\n- [Splunk](https://github.com/ComplianceAsCode/auditree-arboretum/tree/main/arboretum/splunk)\n\n### Fetchers\n\nPlease read the framework documentation for [fetcher design principles][] before\ncontributing a fetcher.\n\nFetchers must apply no logic to the data they retrieve. They must write unadulterated\n(modulo sorting \u0026 de-duplication) into the `/raw` area of the locker via the\nframework-provided decorators or context managers.\n\nFetchers must be atomic - retrieving and creating the data they are responsible\nfor. Fetcher execution order is not guaranteed and so you must not assume that\nevidence already exists and is current in the locker.  Use\n[evidence dependency chaining][] if a fetcher depends on evidence gathered by another\nfetcher in order to gather its intended evidence.\n\nFetchers should be as fast as the API call allows. If a call is long running it\nshould be separated into a dedicated evidence providing tool, which places data\nwhere a fetcher can retrieve it easily \u0026 quickly.\n\n### Checks\n\nPlease read the framework documentation for [check design principles][] before\ncontributing a check.\n\nChecks should only use evidence from the evidence locker to perform check operations.\nAlso, checks **should not** write or change evidence from the evidence locker.  That\nis the job of a fetcher.\n\n[Jinja][] is used to produce reports from checks.  As such each check class must have\nat least one associated report template in order to produce a check report.  In keeping\nwith the \"DevSecOps\" theme, check reports are meant to provide details on violations\nidentified by checks.  These violations are in the form of failures and warnings.\n**They aren't meant to be used to format fetched raw evidence into a readable report.**\n[Harvest][harvest] reports should be used to satisfy that need.\n\n### Harvest Reports\n\nHarvest reports are hosted with the fetchers/checks that collect the evidence for\nthe reports process. Within `auditree-arboretum` this means the harvest report code\nlives in `reports` folders throughout this repository. For more details check out\n[harvest report development][harvest-rpt-dev] in the [harvest][harvest] README.\n\n## Usage\n\n`arboretum` is available for download from [PyPI](https://pypi.org/project/auditree-arboretum/).\n\n### Prerequisites\n\n- Supported for execution on OSX and LINUX.\n- Supported for execution with Python 3.6 and above.\n\n### Integration\n\nFollow these steps to integrate auditree-arboretum fetchers and checks into your project:\n\n* Add this `auditree-arboretum` package as a dependency in your Python project.\n* The following steps can be taken to import individual arboretum fetchers and checks.\n  * For a fetcher, add a `fetch_\u003ccategory\u003e_common.py` module, if one does not already\n  exist, in your project's `fetchers` path where the `\u003ccategory\u003e` is\n  the respective category folder within this repo of that fetcher.  Having a separate\n  common \"category\" module guards against name collisions across categories.\n  * For a check, add a `test_\u003ccategory\u003e_common.py` module, if one does not already exist,\n  in your project's `checks` path where the `\u003ccategory\u003e` is the respective category folder\n  within this repo of that check.  Having a separate common \"category\" module guards\n  against name collisions across providers and technologies.\n  * Import the desired fetcher or check class and the `auditree-framework` will handle\n  the rest.\n\n  For example to use the Abandoned Evidence fetcher from the `auditree` category, add\n  the following to your `fetch_auditree_common.py`:\n\n  ```python\n  from arboretum.auditree.fetchers.fetch_abandoned_evidence import AbandonedEvidenceFetcher\n  ```\n\n* `auditree-arboretum` fetchers and checks are designed to execute as part of a downstream\nPython project, so you may need to setup your project's configuration in order for the\nfetchers and checks to execute as desired.  Each category folder in this repository\nincludes a README.md that documents each fetcher's and check's configuration.\n  * In general `auditree-arboretum` fetchers and checks expect an `org` field with content\n  that captures each fetcher's and check's configuration settings.\n\n  For example:\n\n  ```json\n  {\n    \"org\": {\n      \"auditree\": {\n        \"abandoned_evidence\": {\n          \"threshold\": 1234567,\n          \"exceptions\": {\n          \"raw/path/to-evidence.json\": \"This is a good reason\",\n          \"raw/path/to-evidence-2.json\": \"This is also a good reason\"\n        }\n      }\n    }\n  }\n  ```\n\n* Finally, for a check, be sure to add the appropriate entry into your project's\n``controls.json`` file.  Doing this allows you to group checks together as a control\nset which is useful for organizing check notifications and targeted check execution.\n\n  For example to use the Abandoned Evidence check, add something similar to the\n  following to your project's `controls.json`:\n\n  ```json\n  {\n    \"arboretum.auditree.checks.test_abandoned_evidence.AbandonedEvidenceCheck\": {\n      \"auditree_evidence\": {\n        \"auditree_control\": [\"arboretum.auditree\"]\n      }\n    }\n  }\n  ```\n\n[platform-badge]: https://img.shields.io/badge/platform-osx%20|%20linux-orange.svg\n[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n[python-badge]: https://img.shields.io/badge/python-v3.6+-blue.svg\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[python-dl]: https://www.python.org/downloads/\n[lint-test]: https://github.com/ComplianceAsCode/auditree-arboretum/actions?query=workflow%3A%22format+%7C+lint+%7C+test%22\n[pypi-upload]: https://github.com/ComplianceAsCode/auditree-arboretum/actions?query=workflow%3A%22PyPI+upload%22\n[auditree-framework]: https://github.com/ComplianceAsCode/auditree-framework\n[harvest]: https://github.com/ComplianceAsCode/auditree-harvest\n[fetcher design principles]: https://complianceascode.github.io/auditree-framework/design-principles.html#compliance-fetchers\n[evidence dependency chaining]: https://complianceascode.github.io/auditree-framework/design-principles.html#evidence-dependency-chaining\n[check design principles]: https://complianceascode.github.io/auditree-framework/design-principles.html#compliance-checks\n[Jinja]: https://palletsprojects.com/p/jinja/\n[harvest-rpt-dev]: https://github.com/ComplianceAsCode/auditree-harvest#report-development\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomplianceascode%2Fauditree-arboretum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomplianceascode%2Fauditree-arboretum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomplianceascode%2Fauditree-arboretum/lists"}