{"id":41860412,"url":"https://github.com/affix/pentest-reporter","last_synced_at":"2026-01-25T11:15:28.826Z","repository":{"id":328712079,"uuid":"1115089242","full_name":"affix/pentest-reporter","owner":"affix","description":"A simple pentest report generator using Python, Pandoc and Angular","archived":false,"fork":false,"pushed_at":"2025-12-14T21:45:15.000Z","size":236,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-17T10:16:49.738Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/affix.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-12T10:21:36.000Z","updated_at":"2025-12-14T21:45:19.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/affix/pentest-reporter","commit_stats":null,"previous_names":["affix/pentest-reporter"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/affix/pentest-reporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fpentest-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fpentest-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fpentest-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fpentest-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/affix","download_url":"https://codeload.github.com/affix/pentest-reporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/affix%2Fpentest-reporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28752667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T10:25:12.305Z","status":"ssl_error","status_checked_at":"2026-01-25T10:25:11.933Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2026-01-25T11:15:27.886Z","updated_at":"2026-01-25T11:15:28.804Z","avatar_url":"https://github.com/affix.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pentest Report Generator Web Application\n\nA Flask + Angular web application for generating professional pentest reports from markdown files. Based on the note-to-report.py script logic.\n\n## Features\n\n- Upload multiple markdown files\n- Configurable report settings:\n  - Title and subtitle\n  - Author information (name, position, email)\n  - Title page colors (background, text, rule)\n  - Logo (file upload or remote URL)\n- Automatic CVSS vector parsing and severity table generation\n- PDF generation using Pandoc with the Eisvogel template\n- Modern, responsive Angular frontend\n\n## Prerequisites\n\n### Backend Requirements\n- Python 3.8+\n- Pandoc (with LaTeX support)\n- Eisvogel template for Pandoc\n\n### Frontend Requirements\n- Node.js 18+ and npm\n\n### Installing Pandoc and Eisvogel Template\n\n#### Ubuntu/Debian:\n```bash\nsudo apt-get update\nsudo apt-get install pandoc texlive-latex-base texlive-fonts-recommended texlive-extra-utils texlive-latex-extra\n```\n\n#### macOS:\n```bash\nbrew install pandoc\nbrew install basictex\n```\n\n#### Install Eisvogel Template:\n```bash\nmkdir -p ~/.pandoc/templates\ncd ~/.pandoc/templates\nwget https://raw.githubusercontent.com/enhuiz/eisvogel/refs/heads/master/eisvogel.tex\n```\n\n## Installation\n\n### Backend Setup\n\n1. Navigate to the backend directory:\n```bash\ncd backend\n```\n\n2. Create a virtual environment:\n```bash\npython3 -m venv venv\nsource venv/bin/activate  # On Windows: venv\\Scripts\\activate\n```\n\n3. Install Python dependencies:\n```bash\npip install -r requirements.txt\n```\n\n4. Run the Flask server:\n```bash\npython app.py\n```\n\nThe backend will start on `http://localhost:5000`\n\n### Frontend Setup\n\n1. Navigate to the frontend directory:\n```bash\ncd frontend\n```\n\n2. Install npm dependencies:\n```bash\nnpm install\n```\n\n3. Start the Angular development server:\n```bash\nnpm start\n```\n\nThe frontend will start on `http://localhost:4200`\n\n## Usage\n\n1. Open your browser and navigate to `http://localhost:4200`\n\n2. Upload one or more markdown files (.md)\n\n3. Configure your report settings:\n   - Enter a title and subtitle\n   - Add author information\n   - Customize title page colors (use hex color picker or enter hex codes)\n   - Add a logo (upload a file or provide a URL)\n\n4. Click \"Generate Report\"\n\n5. The PDF will be automatically downloaded when ready\n\n## Markdown File Format\n\nYour markdown files can include YAML frontmatter with CVSS vectors:\n\n```markdown\n---\ncvss: AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\nseverity: [High]\n---\n\n## Vulnerability Title\n\nDescription of the vulnerability...\n\n### Impact\n\nImpact details...\n\n### Remediation\n\nRemediation steps...\n```\n\nIf a CVSS vector is provided, the application will automatically generate a severity table in the report.\n\n## API Endpoints\n\n### Health Check\n```\nGET /api/health\n```\n\nReturns the health status of the API.\n\n### Generate Report\n```\nPOST /api/generate-report\n```\n\n**Form Data:**\n- `files`: Multiple markdown files\n- `config`: JSON configuration object\n- `logo`: (Optional) Logo image file\n\n**Config Object:**\n```json\n{\n  \"title\": \"Report Title\",\n  \"subtitle\": \"Report Subtitle\",\n  \"author\": [\"Name\", \"Position\", \"Email\"],\n  \"titlepage_color\": \"241C3A\",\n  \"titlepage_text_color\": \"FFFAFA\",\n  \"titlepage_rule_color\": \"FFFAFA\",\n  \"logo_url\": \"https://example.com/logo.png\"\n}\n```\n\n**Response:**\n- Content-Type: `application/pdf`\n- Binary PDF file\n\n## Project Structure\n\n```\n.\n├── backend/\n│   ├── app.py              # Flask application\n│   ├── requirements.txt    # Python dependencies\n│   ├── uploads/            # Temporary file uploads (created at runtime)\n│   └── temp/               # Temporary processing directory (created at runtime)\n│\n├── frontend/\n│   ├── src/\n│   │   ├── app/\n│   │   │   ├── app.component.ts      # Main component\n│   │   │   ├── app.component.html    # Component template\n│   │   │   ├── app.component.css     # Component styles\n│   │   │   ├── app.module.ts         # App module\n│   │   │   └── report.service.ts     # API service\n│   │   ├── index.html      # Main HTML file\n│   │   ├── main.ts         # Bootstrap file\n│   │   └── styles.css      # Global styles\n│   ├── angular.json        # Angular configuration\n│   ├── package.json        # npm dependencies\n│   └── tsconfig.json       # TypeScript configuration\n│\n└── README.md               # This file\n```\n\n## Development\n\n### Backend Development\n\nThe Flask app runs in debug mode by default. Any changes to `app.py` will automatically reload the server.\n\n### Frontend Development\n\nThe Angular development server supports hot module replacement. Any changes to the TypeScript, HTML, or CSS files will automatically refresh the browser.\n\n## Production Deployment\n\n### Backend\n\nFor production, use a WSGI server like Gunicorn:\n\n```bash\npip install gunicorn\ngunicorn -w 4 -b 0.0.0.0:5000 app:app\n```\n\n### Frontend\n\nBuild the Angular app for production:\n\n```bash\ncd frontend\nnpm run build\n```\n\nThe built files will be in `frontend/dist/`. Serve them with a web server like Nginx.\n\n### CORS Configuration\n\nFor production, update the CORS settings in `backend/app.py` to only allow your frontend domain:\n\n```python\nCORS(app, resources={r\"/api/*\": {\"origins\": \"https://yourdomain.com\"}})\n```\n\n## Troubleshooting\n\n### Pandoc Not Found\nEnsure Pandoc is installed and in your PATH. Test with:\n```bash\npandoc --version\n```\n\n### Eisvogel Template Not Found\nVerify the template is in the correct location:\n```bash\nls ~/.pandoc/templates/eisvogel.tex\n```\n\n### LaTeX Errors\nMake sure you have a complete LaTeX distribution installed. The Eisvogel template requires several LaTeX packages.\n\n### CORS Errors\nIf you see CORS errors in the browser console, ensure the Flask backend is running and Flask-CORS is properly configured.\n\n## License\n\nMIT License. See LICENSE file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit issues or pull requests.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faffix%2Fpentest-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faffix%2Fpentest-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faffix%2Fpentest-reporter/lists"}