{"id":24719314,"url":"https://github.com/simon-gardier/image-encryption","last_synced_at":"2025-09-13T07:35:28.776Z","repository":{"id":203838954,"uuid":"710511904","full_name":"simon-gardier/image-encryption","owner":"simon-gardier","description":"🛡️Image encryption tool written in C","archived":false,"fork":false,"pushed_at":"2024-05-25T18:07:11.000Z","size":39853,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-01T10:59:21.848Z","etag":null,"topics":["c","command-line","command-line-tool","doxygen","makefile"],"latest_commit_sha":null,"homepage":"https://en.wikipedia.org/wiki/Linear-feedback_shift_register","language":"C","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/simon-gardier.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":"2023-10-26T21:07:03.000Z","updated_at":"2024-05-25T18:07:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"f6057195-ec12-4372-806e-bfd5944dfec4","html_url":"https://github.com/simon-gardier/image-encryption","commit_stats":null,"previous_names":["sgardier/cryptlfsr","sgardier/image_encryption","simon-gardier/image-encryption"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/simon-gardier/image-encryption","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simon-gardier%2Fimage-encryption","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simon-gardier%2Fimage-encryption/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simon-gardier%2Fimage-encryption/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simon-gardier%2Fimage-encryption/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simon-gardier","download_url":"https://codeload.github.com/simon-gardier/image-encryption/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simon-gardier%2Fimage-encryption/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274935492,"owners_count":25376830,"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-09-13T02:00:10.085Z","response_time":70,"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":["c","command-line","command-line-tool","doxygen","makefile"],"created_at":"2025-01-27T11:17:28.031Z","updated_at":"2025-09-13T07:35:28.748Z","avatar_url":"https://github.com/simon-gardier.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🛡️ Command Line Tool for PNM Images Encryption\n![Release](https://img.shields.io/badge/Release-v1.0-blueviolet?style=for-the-badge)\n![Language](https://img.shields.io/badge/c-%2300599C.svg?style=for-the-badge)\n\n\u003cdiv style=\"display: flex; justify-content: space-around; align-items: center;\"\u003e\n  \u003cimg src=\"img/decrypted.png\" alt=\"Pixel art of a city\" style=\"width: 40%;\"/\u003e\n  \u003cimg src=\"img/left.png\" alt=\"Arrow poiting from left to right\" style=\"width: 10%;\"/\u003e\n  \u003cimg src=\"img/encrypted.png\" alt=\"Encrypted pixel art of a city, noisy image\" style=\"width: 40%;\"/\u003e\n\u003c/div\u003e\n\n\nTool to encrypt/decrypt images of type PNM (PBM · PGM · PPM). The encryption is done using LFSR techniques (XOR encryption).\u003cbr\u003e\nSee : https://en.wikipedia.org/wiki/Linear-feedback_shift_register\u003cbr\u003e\nThis project was made in the context of the \"Complement to programming\" course (INFO0947) given by Pr. Donnet at University of Liège.\n\nMain points of this project :\n\nC-Language, Makefile, static libraries, encryption methods, image processing, unit testing, documentation tool (doxygen) and custom structures.\n\n## Summary\n1. [Setup](#setup)\n2. [Parameters](#parameters)\n3. [Forbidden file name](#forbidden-file-name-for--o)\n4. [Usage example](#usage-example)\n5. [Documentation](#documentation)\n6. [Used resources](#used-resources)\n7. [Future improvements](#future-improvements)\n8. [Credits](#credits)\n\n## Setup\n- Install gcc ([https://gcc.gnu.org/install/])\n\n- Clone the repository\n```console\ngit clone git@github.com:sgardier/CryptLFSR.git locationOfTheProgram\n```\n- Go to the folder of the projet\n```console\ncd locationOfTheProgram\n```\n- Run the ```make``` command at the root of the directory\n```console\nmake\n```\n\n## Parameters\n\n`-i` the path of the image you want to encrypt / decrypt\n\n`-o` the path for the encrypted/decrypted image, can not contain `/\\\\:*?\\\"\u003c\u003e|`\n\n`-p` a password (e.g., myPassword@!)\n\n`-t` the tap value for the LFSR encryption (see : https://en.wikipedia.org/wiki/Linear-feedback_shift_register)\n\nNote : \n- Only images of type P1, P2 and P3 (ppm, pnm, pgm) are supported\n- All parameters are mandatory\n\n## Forbidden file name for -o\nA file name can not contain any of the following characters : `/\\\\:*?\\\"\u003c\u003e|`\n\n## Usage example\nEncrypt an image using password \"secretpassword123\"\n\n```console\n./CryptLFSR -i img/city.ppm -o city_encrypted.ppm -p veryGoodPassword -t 5\n```\n\nDecrypt the image using the encryption password \n```console\n./CryptLFSR -i city_encrypted.ppm -o city_decrypted.ppm -p veryGoodPassword -t 5\n```\n\n## Documentation\nRun the command\n```console\nmake doc\n```\nThen open doc/html/index.html\n```console\nopen doc/html/index.html\n```\n\n## Used resources\n- Seatest : https://code.google.com/archive/p/seatest/\n- Arrow image of this README : https://www.deviantart.com/s-a-r-c/art/Right-Arrow-Sticker-823590894\n- DALL-E for the pixel art illustration on this README\n\n## Future improvements\n- Multithreading for the processing of the pixels matrix\n- Support of the other types of pnm images\n\n## Credits\n- [Simon Gardier](https://github.com/simon-gardier) (Author)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimon-gardier%2Fimage-encryption","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimon-gardier%2Fimage-encryption","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimon-gardier%2Fimage-encryption/lists"}