COS301-SE-2024 / IoT-DIRfram

This project aims to develop software for a Raspberry Pi that automatically executes when connected via USB or UART to retrieve information from an IoT device. The software will gather details such as firmware version, chip model, and voltage usage, compiling them into an XML format.
0 stars 0 forks source link

Feature/uart #59

Closed u21513768 closed 1 month ago

u21513768 commented 1 month ago

Added all relevant python code, This includes the first draft of the user manual as well as the directory set up for the files, the udev rules and steps to configure the scripts to run automatically.

Users to review: @CarterShin

gitguardian[bot] commented 1 month ago

⚠️ GitGuardian has uncovered 5 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [11716218](https://dashboard.gitguardian.com/workspace/301252/incidents/11716218?occurrence=148474455) | Triggered | MongoDB Credentials | 4048f9558e1964549739d222d70fa76a79b64194 | src/upload_to_server.py | [View secret](https://github.com/COS301-SE-2024/IoT-DIRfram/commit/4048f9558e1964549739d222d70fa76a79b64194#diff-f56bd97d81a0c3dfd3ba734d6e588334a1a6921da5ffb5fc46861512928e8a8fR4) | | [11716218](https://dashboard.gitguardian.com/workspace/301252/incidents/11716218?occurrence=148474456) | Triggered | MongoDB Credentials | 3ab57a02bb4374a2e5c570664e1ebd730ec98155 | src/upload_to_server.py | [View secret](https://github.com/COS301-SE-2024/IoT-DIRfram/commit/3ab57a02bb4374a2e5c570664e1ebd730ec98155#diff-f56bd97d81a0c3dfd3ba734d6e588334a1a6921da5ffb5fc46861512928e8a8fR5) | | [11716218](https://dashboard.gitguardian.com/workspace/301252/incidents/11716218?occurrence=148474457) | Triggered | MongoDB Credentials | 20caddb3e5bfd534ee82905162f07d5f0cc7f3cf | src/upload_to_server.py | [View secret](https://github.com/COS301-SE-2024/IoT-DIRfram/commit/20caddb3e5bfd534ee82905162f07d5f0cc7f3cf#diff-f56bd97d81a0c3dfd3ba734d6e588334a1a6921da5ffb5fc46861512928e8a8fL4) | | [11716218](https://dashboard.gitguardian.com/workspace/301252/incidents/11716218?occurrence=148474458) | Triggered | MongoDB Credentials | 3ab57a02bb4374a2e5c570664e1ebd730ec98155 | src/upload_to_server.py | [View secret](https://github.com/COS301-SE-2024/IoT-DIRfram/commit/3ab57a02bb4374a2e5c570664e1ebd730ec98155#diff-f56bd97d81a0c3dfd3ba734d6e588334a1a6921da5ffb5fc46861512928e8a8fL5) | | [11716218](https://dashboard.gitguardian.com/workspace/301252/incidents/11716218?occurrence=148474459) | Triggered | MongoDB Credentials | 442f4f1206d55673c174fdd3d3e914cfaea8fdef | python/testing_functions/upload_to_server.py | [View secret](https://github.com/COS301-SE-2024/IoT-DIRfram/commit/442f4f1206d55673c174fdd3d3e914cfaea8fdef#diff-7a38226dd2874867b467d8e75cce2a337cf809aabdac33517d9787cbcb5c6053L5) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/specifics/mongo_uri#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

u21513768 commented 1 month ago

So the security is failing but that's not part of the commit, I tagged it as test credentials because some of those were for a test database. The build failed but i don't know anything about that, that comes from the dev branch side