<p align="center"> <img src="https://user-images.githubusercontent.com/74055102/154795300-93829a7f-5859-4450-be20-8bd28ea4bcca.png#gh-light-mode-only"/> <img src="https://user-images.githubusercontent.com/74055102/154795225-d439004c-267e-4d96-91c1-ffd9213eddbe.png#gh-dark-mode-only"/> </p>

ChaoticEncryption.jl

|Type|Badge/Status| |-|-| |CI| | |CD/Documentation| | |Version| | |Statistics| | |Community| |

<!-- <div align="center"> --> <!-- [](https://github.com/Saransh-cpp/ChaoticEncryption.jl/actions/workflows/CI.yml?query=branch%3Amaster) --> <!-- [](https://github.com/Saransh-cpp/ChaoticEncryption.jl/actions/workflows/documentation.yml) --> <!-- [](https://juliahub.com/ui/Packages/ChaoticEncryption/dtMkN) --> <!-- [](https://julialang.org) --> <!-- [](https://pkgs.genieframework.com?packages=ChaoticEncryption) --> <!-- [](https://saransh-cpp.github.io/ChaoticEncryption.jl/dev/) --> <!-- [](https://codecov.io/gh/Saransh-cpp/ChaoticEncryption.jl) [](https://gitter.im/ChaoticEncryption-jl/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- [](#contributors-) --> <!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- </div> -->

Encrypt and decrypt image files using Pseudo-Random Number Generators and various encryption techniques! ChaoticEncryption.jl comes loaded with Pseudo-Random Number Generators and various encryption techniques, which can be used to encrypt and decrypt any image file. The package is under active development, but the existing API is stable and might not change significantly.

Installation

This package is available on Julia's Registry!

julia> using Pkg
julia> Pkg.add("ChaoticEncryption")

or

julia> ] add ChaoticEncryption

For developer installation or installation from source, refer here.

Examples

The example for a particular function is available in the function's docstring itself. These docstrings or the API documentation is also available here.

Other than the docstrings, comprehensive Jupyter notebooks displaying the features of ChaoticEncryption.jl are available in the examples directory.

Testing

To run the tests, execute the following in your Julia REPL -

julia> ] test ChaoticEncryption

More information on tests is available here.

To run calculate coverage while running tests, execute the following in your Julia REPL -

julia> using Pkg
julia> Pkg.add("Coverage")
julia> Pkg.test("ChaoticEncryption"; coverage=true)

More information on coverage is available here.

Documentation

The documentation is available here - https://saransh-cpp.github.io/ChaoticEncryption.jl/dev/

The documentation can be built locally by executing -

julia docs/make.jl

The deployment will be visible on the webpage served at http://127.0.0.1:8000.

More information on documentation is available here.

Infrastructure

A detailed guide on ChaoticEncryption.jl's infrastructure is available here.

Results

|S.No. | Original Image | Image Dimensions | Encrypted Image | Decrypted Image | PRNG used | Algorithm used | |:----:|:--------------:|:----------------:|:---------------:|:---------------:|:---------:|:--------------:| |1|| (225, 225) | | | Logistic Map (logistic_key) | Substitution (substitution_encryption, substitution_decryption)| |2|| (512, 512) | | | Logistic Map (logistic_key) | Substitution (substitution_encryption, substitution_decryption)| |3|| (300, 451) | | | Logistic Map (logistic_key) | Substitution (substitution_encryption, substitution_decryption)| |4|| (512, 768) | | | Logistic Map (logistic_key) | Substitution (substitution_encryption, substitution_decryption)|

Contributing to ChaoticEncryption.jl

All contributions to this repository are welcome. Please go through our contribution guidelines to make the whole process smoother.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/Saransh-cpp"><img src="https://avatars.githubusercontent.com/u/74055102?v=4?s=100" width="100px;" alt=""/><br />_{<b>Saransh</b>}</a><br /><a href="https://github.com/Saransh-cpp/ChaoticEncryption.jl/commits?author=Saransh-cpp" title="Code">💻</a> <a href="https://github.com/Saransh-cpp/ChaoticEncryption.jl/issues?q=author%3ASaransh-cpp" title="Bug reports">🐛</a> <a href="#design-Saransh-cpp" title="Design">🎨</a> <a href="#example-Saransh-cpp" title="Examples">💡</a> <a href="#infra-Saransh-cpp" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-Saransh-cpp" title="Maintenance">🚧</a> <a href="https://github.com/Saransh-cpp/ChaoticEncryption.jl/pulls?q=is%3Apr+reviewed-by%3ASaransh-cpp" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/Saransh-cpp/ChaoticEncryption.jl/commits?author=Saransh-cpp" title="Tests">⚠️</a> <a href="https://github.com/Saransh-cpp/ChaoticEncryption.jl/commits?author=Saransh-cpp" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/Muthukumar-Muthu"><img src="ht