Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saransh-cpp/chaoticencryption.jl
Fast image encryption and decryption algorithms in Julia!
https://github.com/saransh-cpp/chaoticencryption.jl
encryption-decryption julia julia-package pseudo-random-generator
Last synced: 9 days ago
JSON representation
Fast image encryption and decryption algorithms in Julia!
- Host: GitHub
- URL: https://github.com/saransh-cpp/chaoticencryption.jl
- Owner: Saransh-cpp
- License: mit
- Created: 2022-02-15T14:58:41.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T10:31:44.000Z (7 months ago)
- Last Synced: 2024-10-16T13:27:39.246Z (21 days ago)
- Topics: encryption-decryption, julia, julia-package, pseudo-random-generator
- Language: Julia
- Homepage: https://saransh-cpp.github.io/ChaoticEncryption.jl/
- Size: 4.9 MB
- Stars: 29
- Watchers: 1
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ChaoticEncryption.jl
|Type|Badge/Status|
|-|-|
|CI|[](https://github.com/Saransh-cpp/ChaoticEncryption.jl/actions/workflows/CI.yml?query=branch%3Amaster) [](https://codecov.io/gh/Saransh-cpp/ChaoticEncryption.jl) [](https://juliahub.com/ui/Packages/ChaoticEncryption/dtMkN)|
|CD/Documentation|[](https://github.com/Saransh-cpp/ChaoticEncryption.jl/actions/workflows/documentation.yml) [](https://saransh-cpp.github.io/ChaoticEncryption.jl/dev/)|
|Version|[](https://julialang.org) [](https://juliahub.com/ui/Packages/ChaoticEncryption/dtMkN)|
|Statistics|[](https://pkgs.genieframework.com?packages=ChaoticEncryption) |
|Community|[](https://gitter.im/ChaoticEncryption-jl/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](#contributors-)|
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
julia> using Pkg
julia> Pkg.add("ChaoticEncryption")
```
or
```julia
julia> ] add ChaoticEncryption
```
For developer installation or installation from source, refer [here](https://github.com/Saransh-cpp/ChaoticEncryption.jl/blob/master/CONTRIBUTING.md#local-installation).
## 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](https://saransh-cpp.github.io/ChaoticEncryption.jl/dev/).
Other than the docstrings, comprehensive `Jupyter` notebooks displaying the features of `ChaoticEncryption.jl` are available in the [`examples`](https://github.com/Saransh-cpp/ChaoticEncryption.jl/tree/master/examples) directory.
## Testing
To run the tests, execute the following in your `Julia REPL` -
```julia
julia> ] test ChaoticEncryption
```
More information on tests is available [here](https://github.com/Saransh-cpp/ChaoticEncryption.jl/blob/master/CONTRIBUTING.md#testing).
To run calculate coverage while running tests, execute the following in your `Julia REPL` -
```julia
julia> using Pkg
julia> Pkg.add("Coverage")
julia> Pkg.test("ChaoticEncryption"; coverage=true)
```
More information on coverage is available [here](https://github.com/Saransh-cpp/ChaoticEncryption.jl/blob/master/CONTRIBUTING.md#coverage).
## 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](https://github.com/Saransh-cpp/ChaoticEncryption.jl/blob/master/CONTRIBUTING.md#documentation).
## Infrastructure
A detailed guide on `ChaoticEncryption.jl`'s infrastructure is available [here](https://github.com/Saransh-cpp/ChaoticEncryption.jl/blob/master/CONTRIBUTING.md#infrastructure).
## 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](https://github.com/Saransh-cpp/ChaoticEncryption.jl/blob/master/CONTRIBUTING.md) to make the whole process smoother.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Saransh
💻 🐛 🎨 💡 🚇 🚧 👀 ⚠️ 📖
Muthukumar M
📖
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!