Giter VIP home page Giter VIP logo

imagecipher's Introduction

Image Cipher

ImageCipher is a Python library for encoding and decoding messages in images using steganography and optional encryption.
Supported python versions PEP8 License Run Pytest

Installation ๐Ÿš€

You can install ImageCipher using pip:

pip install imagecipher

Features โœจ

  • Encode text messages into images
  • Decode messages from encoded images
  • Optional encryption of messages before encoding
  • Support for various image formats

Usage ๐Ÿ“

Here's a quick example of how to use ImageCipher:

from image_cipher import ImageCipher

# Create an instance of ImageCipher
cipher = ImageCipher()

# Encode a message
encoded_image_path = cipher.encode("original_image.png", "Secret message", encrypt=True)

# Decode a message
decoded_message = cipher.decode(encoded_image_path, key=cipher.key)

print(decoded_message)  # Output: Secret message

API Reference ๐Ÿ“˜

ImageCipher class

encode(image_path, message, encrypt=True)

Encodes a message into an image.

  • image_path (str): The path to the input image file.
  • message (str): The message to be encoded.
  • encrypt (bool, optional): Whether to encrypt the message. Defaults to True.

Returns:

  • str: The path to the output encoded image file.

decode(image_path, key=None)

Decodes a message from an encoded image.

  • image_path (str): The path to the input encoded image file.
  • key (str, optional): The encryption key for decryption. Required if the message was encrypted.

Returns:

  • str: The decoded message.

Requirements ๐Ÿ› ๏ธ

  • Python 3.6+
  • Pillow (PIL)
  • cryptography

Contributing ๐Ÿ™Œ

Contributions are welcome! Please feel free to submit a Pull Request.

imagecipher's People

Contributors

myrausman avatar samadpls avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

imagecipher's Issues

Deleted package detected

I'm a Cyber Security researcher and developer of PackjGuard [1] to address open-source software supply chain attacks.

Issue

During my research, I detected a deleted package in this repository.

Details

Specifically, the package ImageCipherLib mentioned in file README at line 14 does not exist on the public PyPI registry. A bad actor can hijack this package to propagate malicious code.

Impact

Not only your apps/services using https://github.com/samadpls/ImageCipherLib repo code are vulnerable to this attack, but the users of your open-source Github repo could also fall victim.

You could read more about such attacks here: https://medium.com/@alex.birsan/dependency-confusion-4a5d60fec610

Remediation

Please highlight this in file README and register a placeholder package for ImageCipherLib on public PyPI soon to remediate.

To automatically fix such issues in future, please install PackjGuard Github app [1].

Thanks!

  1. PackjGuard is a Github app that monitors your repos 24x7, detects vulnerable/malicious/risky open-source dependencies, and creates pull requests for auto remediation: https://github.com/marketplace/packjguard

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.