{"id":29720970,"url":"https://github.com/issg-upat/fileagent-sand5g","last_synced_at":"2026-05-18T06:42:27.562Z","repository":{"id":289871687,"uuid":"965741117","full_name":"ISSG-UPAT/FileAgent-SAND5G","owner":"ISSG-UPAT","description":"A simple fileagent with fastapi ","archived":false,"fork":false,"pushed_at":"2025-07-18T13:05:43.000Z","size":121,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-18T17:48:09.797Z","etag":null,"topics":["fastapi","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/fileagent/","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/ISSG-UPAT.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}},"created_at":"2025-04-13T20:03:28.000Z","updated_at":"2025-06-03T07:57:18.000Z","dependencies_parsed_at":"2025-04-25T14:31:06.074Z","dependency_job_id":"0b7cff59-11a9-42a4-8080-a7b3e2b14703","html_url":"https://github.com/ISSG-UPAT/FileAgent-SAND5G","commit_stats":null,"previous_names":["issg-upat/fileagent-sand5g"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ISSG-UPAT/FileAgent-SAND5G","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ISSG-UPAT%2FFileAgent-SAND5G","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ISSG-UPAT%2FFileAgent-SAND5G/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ISSG-UPAT%2FFileAgent-SAND5G/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ISSG-UPAT%2FFileAgent-SAND5G/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ISSG-UPAT","download_url":"https://codeload.github.com/ISSG-UPAT/FileAgent-SAND5G/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ISSG-UPAT%2FFileAgent-SAND5G/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266854699,"owners_count":23995489,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["fastapi","python"],"created_at":"2025-07-24T14:14:35.343Z","updated_at":"2026-05-18T06:42:27.512Z","avatar_url":"https://github.com/ISSG-UPAT.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FileAgent\n\n## About\n\nThis repository is part of the SAND5G project, which aims to enhance security in 5G networks. FileAgent is a tool designed to facilitate the management of Snort rules in a containerized environment.\n\n5G -and beyond- networks provide a strong foundation for EU’s digital transformation and are becoming one of the Union’s key assets to compete in the global market.\n\nSecuring 5G networks and the services running on top of them requires high quality technical security solutions and also strong collaboration at the operational level.\n\nhttps://sand5g-project.eu\n\n![SAND5G](https://sand5g-project.eu/wp-content/uploads/2024/06/SAND5G-logo-600x137.png)\n\n## Overview\n\nFileAgent is a Python-based application designed to accompany Snort in a containerized environment. It provides a FastAPI-based interface for uploading and managing custom rules for Snort. The application supports JSON and plain text file uploads, translates the content into Snort-compatible rules, and appends them to a rules file while ensuring backups and avoiding duplicates.\n\n## Features\n\n- Upload JSON or plain text files containing IP addresses or URLs.\n- Automatically translate uploaded content into Snort-compatible rules.\n- Append rules to a custom rules file (`mock.local.rules` by default).\n- Backup the rules file before appending new rules.\n- Avoid duplicate rule entries.\n\n## Requirements\n\n- Python 3.11 or higher\n- Dependencies listed in `pyproject.toml`:\n  - `fastapi`\n  - `uvicorn`\n  - `requests`\n  - `python-multipart`\n\n## Installation\n\n### Clone from github\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/ISSG-Projects/FileAgentSAND5G.git\n   cd FileAgentSAND5G\n   ```\n\n2. Create a virtual environment\n\n   ```bash\n   python -m venv venv\n   ```\n\n3. Activate the virtual environment:\n\n   - On Windows:\n\n     ```bash\n     venv\\Scripts\\activate\n     ```\n\n   - On macOS/Linux:\n     ```bash\n     source venv/bin/activate\n     ```\n\n4. Install the required dependencies:\n\n   ```bash\n   pip install .\n   ```\n\n### pip install from github\n\n```bash\npip install git+ssh://git@github.com/ISSG-Projects/FileAgentSAND5G.git\n```\n\n## API Endpoints\n\n- POST /upload: Upload a JSON or plain text file containing IP addresses or URLs. The content is translated into Snort rules and appended to the rules file.\n\n## Documentation\n\nThe project documentation is generated using pdoc3. To generate and view the documentation:\n\nOpen the generated HTML files in the `docs` directory.\n\nMore information at [docs/pdoc/README.md](docs/pdoc/README.md).\n\nAdditionally the FastAPI framework provides an interactive API documentation at `http://localhost:8000/docs` when the application is running. This allows you to test the API endpoints directly from your browser.\n\n## Future Implementations\n\n\u003cinput disabled=\"\" type=\"checkbox\"\u003e Add support for additional file formats (e.g., XML, CSV).\n\u003cinput disabled=\"\" type=\"checkbox\"\u003e Implement rule validation against a predefined schema.\n\u003cinput disabled=\"\" type=\"checkbox\"\u003e Add logging for better traceability.\n\u003cinput disabled=\"\" type=\"checkbox\"\u003e Create a web-based dashboard for managing rules.\n\u003cinput disabled=\"\" type=\"checkbox\"\u003e Integrate with external threat intelligence feeds.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fissg-upat%2Ffileagent-sand5g","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fissg-upat%2Ffileagent-sand5g","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fissg-upat%2Ffileagent-sand5g/lists"}