{"id":21601533,"url":"https://github.com/vmware-samples/tau-clients","last_synced_at":"2025-04-11T02:13:38.610Z","repository":{"id":40425442,"uuid":"388421653","full_name":"vmware-samples/tau-clients","owner":"vmware-samples","description":"A set of clients that can be used to programmatically interface with various VMware products and/or external services or resources, with a focus on threat analysis and intelligence collection.","archived":false,"fork":false,"pushed_at":"2024-10-15T12:22:03.000Z","size":168,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-11T02:13:32.947Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vmware-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-22T10:26:48.000Z","updated_at":"2024-10-15T12:21:52.000Z","dependencies_parsed_at":"2023-01-29T19:15:50.316Z","dependency_job_id":null,"html_url":"https://github.com/vmware-samples/tau-clients","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-samples%2Ftau-clients","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-samples%2Ftau-clients/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-samples%2Ftau-clients/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-samples%2Ftau-clients/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vmware-samples","download_url":"https://codeload.github.com/vmware-samples/tau-clients/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248328163,"owners_count":21085261,"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":[],"created_at":"2024-11-24T19:09:47.272Z","updated_at":"2025-04-11T02:13:38.587Z","avatar_url":"https://github.com/vmware-samples.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/vmware-samples/tau-clients)\n![GitHub](https://img.shields.io/pypi/l/tau-clients)\n![GitHub issues](https://img.shields.io/github/issues/vmware-samples/tau-clients)\n\n# Threat Analysis Unit Clients\n\n## Overview\n\nThreat Analysis Unit Clients (shortened as `tau-clients`) is a set of clients that can be used\nto programmatically interface with various VMware products and/or external services or\nresources, with a focus on threat analysis and intelligence collection.\n\n## Try it out\n\n### Notes\n\n* A client might require a specific and valid license; for example, both `PortalClient` and\n  `AnalysisClient` require a valid NSX Defender license.\n* Support and bug reports are exclusively handled via GitHub.\n* A fully supported commercial implementation of `AnalysisClient` is available here:\n  https://analysis.lastline.com/analysis/api-docs/html/analysis_client.html\n\n### Build \u0026 Run\n\nThis package can be installed via pip, just run `pip install tau-clients` or `pip install -e .`\n\nTo run a simple example just create a valid configuration file using `data/tau_clients.ini.template`.\n```python\nimport configparser\nfrom tau_clients import nsx_defender\n\nconf = configparser.ConfigParser()\nconf.read(\"./data/tau_clients.ini\")\nportal_client = nsx_defender.PortalClient.from_conf(conf, \"portal\")\nresult = portal_client.get_tasks_from_knowledgebase(\n    query_string=\"file_sha1: 'ba81b98f00168b86578e5f5de93d26ed83769432'\",\n)\n```\n\n### Scripts\n\nThis package includes the following console scripts ready to be used (assuming a valid\nconfiguration file is also provided):\n\n* `download_artifacts.py`: download all the available analysis artifacts given a file has or\n  task uuid.\n* `submit_samples.py`: submit the samples contained in the provided directory; if a file hash is\n  provided download the sample from VirusTotal.\n\n## Contributing\n\nThe tau-clients project team welcomes contributions from the community. Before you start working with tau-clients, please\nread our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be\nsigned as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on\nas an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Development\n\nCreate the virtual env:\n\n`python3 -m venv venv`\n\nActivate the virtual env:\n\n`source ./venv/bin/activate`\n\nInstall `tox`:\n\n`pip install tox`\n\nRun tests:\n\n`tox`\n\nDue to a bug in `tox` if you update the dependencies in `setup.cfg` the environments will not be\nre-created, leading to errors when running the tests\n(see https://github.com/tox-dev/tox/issues/93).\nAs workaround, pass the `--recreate` flag after updating the dependencies.\n\nBefore committing, install the package in dev mode (needed by `pylint`):\n\n`pip install -e .`\n\nInstall `pylint` and `pre-commit`:\n\n`pip install pylint pre-commit`\n\nInstall the hook:\n\n`pre-commit install`\n\nIf you want to run pre-commit on all files use the following command:\n\n`pre-commit run --all-files`\n\n## License\n[BSD 2-Clause](https://spdx.org/licenses/BSD-2-Clause.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-samples%2Ftau-clients","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvmware-samples%2Ftau-clients","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-samples%2Ftau-clients/lists"}