{"id":25911393,"url":"https://github.com/copyleftdev/5l4pp3r","last_synced_at":"2025-03-03T09:17:24.587Z","repository":{"id":268017539,"uuid":"903035171","full_name":"copyleftdev/5l4pp3r","owner":"copyleftdev","description":"forensic snapshot tool designed to capture a comprehensive view of your system's configuration environment. It's like a high-resolution camera for your system's state, providing IT professionals and forensic analysts with a powerful lens to examine system configurations at any given point in time.","archived":false,"fork":false,"pushed_at":"2024-12-13T19:51:57.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-13T20:32:04.048Z","etag":null,"topics":["admin","change-detection","forensics","it","system"],"latest_commit_sha":null,"homepage":"https://5l4pp3r.vercel.app/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/copyleftdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-12-13T19:40:58.000Z","updated_at":"2024-12-13T19:53:31.000Z","dependencies_parsed_at":"2024-12-13T20:32:12.394Z","dependency_job_id":null,"html_url":"https://github.com/copyleftdev/5l4pp3r","commit_stats":null,"previous_names":["copyleftdev/5l4pp3r"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copyleftdev%2F5l4pp3r","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copyleftdev%2F5l4pp3r/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copyleftdev%2F5l4pp3r/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/copyleftdev%2F5l4pp3r/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/copyleftdev","download_url":"https://codeload.github.com/copyleftdev/5l4pp3r/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241637277,"owners_count":19994946,"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":["admin","change-detection","forensics","it","system"],"created_at":"2025-03-03T09:17:24.006Z","updated_at":"2025-03-03T09:17:24.556Z","avatar_url":"https://github.com/copyleftdev.png","language":"Go","readme":"# 5l4pp3r\n\n\u003e 📸 Your system's configuration, frozen in time.\n\n\n\n## 🚀 High-Level Purpose\n\n5l4pp3r is a forensic snapshot tool designed to capture a comprehensive view of your system's configuration environment. It's like a high-resolution camera for your system's state, providing IT professionals and forensic analysts with a powerful lens to examine system configurations at any given point in time.\n\n## 🔍 What It Does\n\n5l4pp3r meticulously collects and stores:\n\n- 🖥️ **System Information**: Hostname and timestamp\n- 🌐 **Network Details**: IP addresses, MAC addresses, interface names\n- 📁 **Configuration Files**: From standard system directories and user-specific locations\n\n\nAll this data is compressed and stored in a structured database (SQLite or PostgreSQL), creating a space-optimized, point-in-time record of your system's state.\n\n## 🏗️ Architectural Overview\n\n### Key Components:\n\n1. **Configuration Loading** (`internal/config`)\n\n1. Reads `config.toml` for flexible customization\n2. Defines database settings, compression algorithms, scan directories, and more\n\n\n\n2. **Logging and Instrumentation**\n\n1. Utilizes `zerolog` for structured, timestamped logs\n\n\n\n3. **Storage Setup** (`internal/storage`)\n\n1. Supports SQLite (local) and PostgreSQL (centralized)\n2. Ensures proper schema creation and verification\n\n\n\n4. **Data Gathering** (`internal/gatherer`)\n\n1. Collects system info, network details, and configuration files\n2. Compresses file contents for space efficiency\n\n\n\n\n\n## 💾 Data Ingestion and Persistence Flow\n\n1. Insert System Info (creates `system_id`)\n2. Assign `system_id` to Config Files\n3. Insert Network Interfaces (linked to `system_id`)\n4. Insert Config Files (compressed, with metadata)\n5. Commit the Transaction\n\n\n## 🕵️ Forensic and IT Professional Value\n\n- **Immutable Point-in-Time State**: Reconstruct system settings at snapshot time\n- **Relational Data Model**: Powerful querying capabilities\n- **Repeatable and Extensible**: Track configuration evolution over time\n- **Centralization and Aggregation**: Create a global forensic data lake (with PostgreSQL)\n\n\n## 🚀 Getting Started\n\n1. Clone the repository:\n\n```plaintext\ngit clone https://github.com/copyleftdev/5l4pp3r.git\n```\n\n\n2. Configure `config.toml` with your desired settings\n3. Build and run:\n\n```plaintext\ngo build\n./5l4pp3r\n```\n\n\n\n\n## 📊 Example Output\n\n```plaintext\n11:25AM INF Starting 5l4pp3r...\n11:26AM INF Snapshot completed successfully.\n```\n\n## 🛠️ Possible Enhancements\n\n- Filtering and Exclusions\n- Extended Metadata and Integrity Checks\n- Integration with CI/CD and Automation Tools\n\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details.\n\n## 📜 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- All the amazing open-source libraries that made this project possible\n- The forensic IT community for inspiration and use cases\n\n\n---\n\nRemember: With great power comes great responsibility. Use 5l4pp3r ethically and legally! 🦸‍♂️🦸‍♀️\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcopyleftdev%2F5l4pp3r","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcopyleftdev%2F5l4pp3r","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcopyleftdev%2F5l4pp3r/lists"}