{"id":23100427,"url":"https://github.com/marksowell/caldera-report-generator","last_synced_at":"2025-04-03T20:43:57.538Z","repository":{"id":242603931,"uuid":"810023436","full_name":"marksowell/caldera-report-generator","owner":"marksowell","description":"Generate PDF reports from JSON files exported from Caldera using the ReportLab library","archived":false,"fork":false,"pushed_at":"2024-06-04T00:21:49.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-09T08:45:57.877Z","etag":null,"topics":["adversary-emulation","caldera","report-generator","reportlab"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marksowell.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":"2024-06-03T22:49:48.000Z","updated_at":"2024-06-04T00:27:09.000Z","dependencies_parsed_at":"2024-06-11T01:04:21.050Z","dependency_job_id":null,"html_url":"https://github.com/marksowell/caldera-report-generator","commit_stats":null,"previous_names":["marksowell/caldera-reports"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2Fcaldera-report-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2Fcaldera-report-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2Fcaldera-report-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marksowell%2Fcaldera-report-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marksowell","download_url":"https://codeload.github.com/marksowell/caldera-report-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247078799,"owners_count":20879950,"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":["adversary-emulation","caldera","report-generator","reportlab"],"created_at":"2024-12-16T23:32:37.513Z","updated_at":"2025-04-03T20:43:57.514Z","avatar_url":"https://github.com/marksowell.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Caldera Report Generator\n\nThis Python script allows users to convert JSON reports downloaded from Caldera into readable, formatted PDF documents. The script uses the ReportLab library to generate the reports.\n\n## Prerequisites\n- Python 3.x\n- Access to Caldera JSON reports\n\n## Installation\n1. ### Clone the Repository  \n    First, clone this repository to your local machine using:\n \n    ```bash\n    git clone https://github.com/marksowell/caldera-report-generator.git\n    cd caldera-report-generator\n    ```\n2. ### Install Dependencies  \n    Install the required Python package ReportLab which is used for generating PDF files:  \n    ```bash\n    pip install reportlab\n    ```\n## Usage\nTo generate a PDF report from a Caldera JSON report:\n1. **Prepare Your JSON File**: Ensure that you have a Caldera JSON report saved locally. For example, `report.json`.\n2. **Run the Script**: Use the following command to generate a PDF report. Replace `/path/to/your/report.json` with the path to your Caldera JSON report.\n     \n    ```bash\n    python generate_report.py /path/to/your/report.json\n    ```\n    The script will generate a uniquely named PDF file in the current directory, incorporating the operation's name with the report generation's date and time.\n\n## Output\nThe script dynamically creates a PDF document with a filename in the format `operation_name_caldera_report_YYYY_MM_DD_HHMMSS.pdf`. Each report includes:\n- Host information such as hostname, username, and IP addresses.\n- Details of executed commands, their status, and timings.\n\n## Troubleshooting\n- **Dependency Errors**: If you encounter errors related to missing packages, make sure you have run the `pip install reportlab` command correctly.\n- **File Not Found**: Ensure the JSON path is correct and accessible to the script.\n\n## Contributing\nContributions are welcome! Feel free to fork the repository and submit pull requests.\n- **Bug Reports**: Issues are tracked as GitHub issues. Tag it as a bug and include as much detail as possible to replicate the issue.\n- **Feature Requests**: Feel free to add feature requests by opening an issue. Tag it as a feature request.\n## License\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/marksowell/caldera-report-generator/blob/main/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksowell%2Fcaldera-report-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarksowell%2Fcaldera-report-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarksowell%2Fcaldera-report-generator/lists"}