Thick Wrappers

thick-wrappers/.github/workflows/lint.yaml

@@ -0,0 +1,36 @@
+# GitHub Action Workflow enforcing our code style.
+
+name: Lint
+
+# Trigger the workflow on both push (to the main repository, on the main branch)
+# and pull requests (against the main repository, but from any repo, from any branch).
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+# Brand new concurrency setting! This ensures that not more than one run can be triggered for the same commit.
+# It is useful for pull requests coming from the main repository since both triggers will match.
+concurrency: lint-${{ github.sha }}
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    env:
+      # The Python version your project uses. Feel free to change this if required.
+      PYTHON_VERSION: "3.11"
+
+    steps:
+      # Checks out the repository in the current folder.
+      - name: Checks out repository
+        uses: actions/checkout@v3
+
+      # Set up the right version of Python
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Run pre-commit hooks
+        uses: pre-commit/[email protected]

thick-wrappers/.gitignore

@@ -0,0 +1,37 @@
+# Files generated by the interpreter
+__pycache__/
+*.py[cod]
+
+# Environment specific
+.venv
+venv
+.env
+env
+
+# Unittest reports
+.coverage*
+
+# Logs
+*.log
+
+# PyEnv version selector
+.python-version
+
+# Built objects
+*.so
+dist/
+build/
+
+# IDEs
+# PyCharm
+.idea/
+# VSCode
+.vscode/
+# MacOS
+.DS_Store
+
+# Custom
+.test_folder
+
+# Image folder
+static/

thick-wrappers/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+## Pre-commit setup
+# See https://github.com/python-discord/code-jam-template/tree/main#pre-commit-run-linting-before-committing
+
+# Make sure to edit the `additional_dependencies` list if you want to add plugins
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.5.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.5.1
+    hooks:
+      - id: python-check-blanket-noqa
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-docstrings~=1.6.0

thick-wrappers/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 The Thick Wrappers(DavidLlanio, maxence-glt, jaavv, standard-affect, Robin5605)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

thick-wrappers/README.md

@@ -0,0 +1,71 @@
+# In Plain Pixel
+Created by "The Thick Wrappers" (github: DavidLlanio, maxence-glt, standard-affect, Jaavv, Robin5605) for the Python Discord 2023 CodeJam
+
+## In Brief
+In Plain Pixel is a Steganogrpahy application built completely with Python. Through this application, you are able to encrypt a valid input method (see below) into an image of your choice, or decrypt an image created through this application by simply inputting your decrypted image.
+
+The following input types are supported for encryption:
+- Typed Text
+- Text File (*.txt)
+- Image File (*.jpg, *.jpeg, *.png)
+
+## What is Steganography?
+Imagine you want to pass a note to your friend in a crowded library, but don't want to draw attention to the contents of the note or the note itself. Maybe you hide the message you want to pass in something inconspicuous like in the margins of a book or between the lines of sentences. In essence, you're hiding your message in plain sight.
+
+[Steganography](https://en.wikipedia.org/wiki/Steganography) is similar to this concept, but with digital media, like pictures!
+
+With steganography, you can hide something like a text message in a picture. You can even hide a picture in another picture!
+
+### How does it work?
+
+Computers only understand ones and zeros. Let's say a pixel in an RGB digital image has the integer values of [255, 255, 255], representing white.
+
+255 in binary is 11111111
+So the entire pixel is: [11111111, 11111111, 11111111]
+
+With steganography, you can hide something in the [least significant bits](https://www.analog.com/en/design-center/glossary/lsb.html#:~:text=Least%2Dsignificant%20bit.,is%20the%20furthest%2Dright%20bit.) of this pixel. For example, let's hide the letter "H" in this pixel.
+
+The [ASCII](https://www.asciitable.com/) code of the letter "H" is: 72 (decimal) or 1001000 (binary)
+
+We can split up the binary of the ASCII for "H" into 3 parts:
+- 1
+- 001
+- 000
+
+Then clear and set the least significant bits of the pixel RGB values:
+- R: 11111111 -> 11111000
+- G: 11111111 -> 11111001
+- B: 11111111 -> 11111111 (Last bit stays the same)
+
+With these changes, the letter "H" is now hidden in the image with little impact to the image itself.
+
+### How are we using Steganography?
+The previous example features our method of hiding text in an image. We split the character's binary into 3 parts and hide the most significant bit in the lease significant bit of the blue channel, the 3 middle bits in the 3 least significant bits of the green channel, and the 3 least significant bits in the 3 least significant bits of the red channel.
+
+We do this process for every character in the word, sentence, or paragraph.
+
+For image inputs, we place the 4 most significant bits of the RGB channels of every pixel of the image you want to hide into the 4 least significant bits of the RGB channels of every pixel of the image you want to use as the cover.
+
+When you decrypt an image inside of another image, you will get a lower quality version of the original image you wanted to hide because we cannot reproduce the least significant bits of the original image.
+
+## How to Set up
+- Download and unzip the repository, or clone it
+- Use the change directory command into the repository at the level of main.py
+```
+cd cj10_the_thick_wrappers
+```
+- Install the dependencies:
+```
+python3 -m pip install -r dev-requirements.txt
+```
+## How to Start and Use GUI
+After setup, run the main.py file to start the GUI:
+```
+python3 main.py
+```
+
+Sample use of GUI:
+
+Encrypting text into an image
+
+![In Plain Pixel](https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExenhtZHU1cGp2MmExZnk4NmZqcHV0ZHhmNHQ2ZWFsNWozdmFzbGJ4OCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/O7yq741e0EFZ4lLxpW/giphy.gif)

thick-wrappers/conftest.py

@@ -0,0 +1,9 @@
+import pytest
+
+from helper.utility import list_images
+
+
+@pytest.fixture
+def all_images():
+    """Lists all images for testing"""
+    return list_images("static")

thick-wrappers/dev-requirements.txt

@@ -0,0 +1,16 @@
+# This file contains all the development requirements for our linting toolchain.
+# Don't forget to pin your dependencies!
+# This list will have to be migrated if you wish to use another dependency manager.
+
+# Base tools
+flake8~=4.0.1
+isort~=5.10.1
+pre-commit~=2.17.0
+
+# Flake8 plugins, see https://github.com/python-discord/code-jam-template/tree/main#plugin-list
+flake8-docstrings~=1.6.0
+
+# Core tools
+nicegui~=1.3.13
+Pillow~=10.0.0
+numpy~=1.25.2

thick-wrappers/helper/constant.py

@@ -0,0 +1,46 @@
+from enum import Enum
+
+SOFTWARE_TITLE = "In Plain Pixel"
+TEAM_MEMBERS = "Davr, Jaavv, maxence, standard_affect"
+DESCRIPTION = "Python Discord Summer Code Jam 2023 - The Thick Wrappers Project"
+EXIF_MAKE = "IPP"
+STARTING_X = 0
+STARTING_Y = 0
+BITS_4 = 4
+# R, G, B
+N_PLANES = 3
+
+
+class ResizeMode(Enum):
+    """Enumeration for flag to shrink or leave image as is"""
+
+    DEFAULT = 0
+    SHRINK_TO_SCALE = 1
+
+
+class Sizing(Enum):
+    """Enumeration for flags on difference in secret image and cover image"""
+
+    SMALLER = 0
+    BIGGER = 1
+    TALLER = 2
+    WIDER = 3
+
+
+class Direction(Enum):
+    """Enumeration for direction of bit shift"""
+
+    LEFT = 0
+    RIGHT = 1
+    UP = 2
+    DOWN = 3
+
+
+class ExifData(Enum):
+    """Enumeration for metadata locations"""
+
+    MAKE = 271
+    MODEL = 272
+    ARTIST = 315
+    SOFTWARE = 305
+    DESCRIPTION = 270

thick-wrappers/helper/decrypt.py

@@ -0,0 +1,57 @@
+from PIL.Image import Image
+
+from .constant import BITS_4, N_PLANES
+from .utility import parse_exif, pixels_to_binary
+
+
+def decrypt_text_from_image(img: Image) -> tuple[str, bool]:
+    """
+    Decrypts an image encoded with text.
+
+    param img: A Pillow Image object containing message
+    This function iterates over an image's pixels and extracts the three least
+    significant bits of each color plane. These values are summed and converted
+    to the corresponding ASCII character. The function scans until it finds
+    the message delimiter ",,,.." or it processes all pixels. It returns
+    a tuple of the decrypted message and a bool indicating whether the
+    delimiter (present in all valid messages) was found.
+    """
+    delimiter = False
+    pixel_list, word_total = [], ""
+    RGB_binary_list = pixels_to_binary(img)
+
+    # Iterates through each pixel's binary values and concatenates the least significant bits into decoded code
+    for pixel in RGB_binary_list:
+        output = "0"
+        r, g, b = pixel[0][-N_PLANES:], pixel[1][-N_PLANES:], pixel[2][-1]
+        output += f"{b}{g}{r}"
+        pixel_list.append(int(output, 2))
+
+    # Iterates through each binary output and converts each binary to ASCII, simultaneously checking for the delimiter
+    for binary in pixel_list:
+        if word_total[-5:] == ",,,..":
+            delimiter = True
+            break
+        word_total += format(binary, "c")
+    return word_total[:-5], delimiter
+
+
+def decrypt_image_from_image(image: Image) -> Image:
+    """
+    Decrypts the secret image from the given input image.
+
+    This function attempts to read the size data embedded in
+    a cover image's metadata. Failing that, it decrypts the whole image.
+    It should recover the four most significant bits of each pixel of the
+    original image.
+
+    :param image: Pillow image containing encrypted image.
+    :return: The reconstruction of the original image.
+    """
+    if size := parse_exif(image.getexif()):
+        width, height = size
+        image = image.crop((0, 0, width, height))
+    else:
+        print("WARNING: Could not parse size from EXIF metadata. Falling back to decrypting whole image")
+
+    return image.point(lambda byte: (byte & 0b00001111) << BITS_4)