{"id":16828447,"url":"https://github.com/vletoux/cyrating2th","last_synced_at":"2025-04-11T03:51:20.770Z","repository":{"id":107042984,"uuid":"263918617","full_name":"vletoux/Cyrating2TH","owner":"vletoux","description":"Cyrating Reputation alert importer for TheHive, an Open Source and Free Security Incident Response Platform","archived":false,"fork":false,"pushed_at":"2020-10-09T12:25:09.000Z","size":19,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T01:51:11.561Z","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":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vletoux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-14T13:11:05.000Z","updated_at":"2021-10-11T03:34:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"6f196859-0834-41fd-8a5c-91b1d475313a","html_url":"https://github.com/vletoux/Cyrating2TH","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vletoux%2FCyrating2TH","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vletoux%2FCyrating2TH/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vletoux%2FCyrating2TH/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vletoux%2FCyrating2TH/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vletoux","download_url":"https://codeload.github.com/vletoux/Cyrating2TH/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248339262,"owners_count":21087214,"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-10-13T11:26:41.695Z","updated_at":"2025-04-11T03:51:20.764Z","avatar_url":"https://github.com/vletoux.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cyrating2TH: Cyrating case Feeder for TheHive\n[Cyrating](https://www.cyrating.com/) is a commercial cyber rating company.\nIt allows businesses to be rated regarding their cyber exposure and compare themselves with their peers.\n\nCyrating2TH is a free, open source Cyrating case feeder for TheHive.\nIt is used to track the reputation problem and track them as case.\nBecause the scan occurs weekly, we choose to create directly the case and avoiding using alerts.\n\nCyrating2TH is written in Python 3.\n\n## Overview\nCyrating2TH is made of several parts:\n\n - `config.py.template` : a configuration template which contains all the \nnecessary information to connect to the APIs of Cyrating and TheHive. \nAll information is required.\n- `cyrating2TH.py` : the main program. It gets Cyrating reputation problem and feed them to \nTheHive with a description containing all relevant information, and observables if any.\n\n## Prerequisites\nYou'll need Python 3, the `cyrating` and `arrow` libraries as well as \n[TheHive4py](https://github.com/CERT-BDF/TheHive4py), a Python client for TheHive.\n\nClone the repository then copy the `config.py.template` file as `config.py` \nand fill in the blanks: proxies if applicable, API keys, URLs, accounts \npertaining to your Cyrating subscription and your instance of TheHive.\n\n**Note**: you need a valid API subscription to the Cyrating platform as \nwell as TheHive 2.13 or better and an account with the ability to create alerts.\n\nThen install the Python requirements:\n\n`$ pip3 install -r requirements.txt`\n\n\n## Usage\nOnce your configuration file `config.py` is ready, use the main program to \nfetch or find Cyrating alerts:\n\n\n```\n./cyrating2th.py -h\nusage: cyrating2th.py [-h] [-d] {alerts} ...\n\nRetrieve Cyrating alerts and nd feed them to TheHive\n\npositional arguments:\n  {api,alerts,find}  subcommand help\n    alerts           fetch reputation problem\n\noptional arguments:\n  -h, --help         show this help message and exit\n  -d, --debug        generate a log file and active debug logging\n```\n\nThe program has 3 options:\n- `alerts` to process Cyrating reputation problems.\n\nIf you need debugging information, add the `d`switch and the program will \ncreate a file called `cyrating2th.log`. It will be created in the same folder as the \nmain program.\n\n### Get the API key\nThe first step consist of retrieving the Cyrating API key associated with your\n account.\n\nNow update your `config.py` file with the `key`.\n\n\n### Retrieve alerts specified by their ID\n\n```\n./cyrating2th.py alerts -h\nusage: cyrating2th.py alerts [-h]\n\noptional arguments:\n  -h, --help  show this help message and exit\n```\n\n- `./cyrating2th.py alerts` : fetch alerts .\n\n\n### Use cases\n\n- Add a cron job to check for newly published reputation problem every week:\n\n```\n0 8 * * 1 /opt/Cyrating2TH/cyrating2th.py alerts \u003e/dev/null 2\u003e\u00261\n```\n\nWhen enabled, logs are written in the program's folder, in a file named `cyrating2th.log`.\n\n# License\nCyrating2TH is an open source and free software released under the \n[AGPL](LICENSE) \n(Affero General Public License). We are committed to ensure\nthat Cyrating2TH will remain a free and open source project on the \nlong-run.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvletoux%2Fcyrating2th","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvletoux%2Fcyrating2th","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvletoux%2Fcyrating2th/lists"}