savannabits/sucipher

AES encryption / Decryption tool that works with javax.crypto

v1.0.0 2023-05-17 07:20 UTC

This package is auto-updated.

Last update: 2024-10-17 10:39:23 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

A simple tool to manage AES encryption using openssl. This is designed to gain compatibility with Java's javax.crypto package.

Installation

You can install the package via composer:

composer require savannabits/sucipher

Usage

Config:

Add the following keys to your .env file:

SUCIPHER_IV="" #Your Initialization vector
SUCIPHER_SECRET_KEY="" #16, 24 or 32 chars depending on the CIPHER used
SUCIPHER_CIPHER="" # e.g aes-128-cbc
// Encrypt A Plain String:
$data = "Test Message"
$encrypted = app('sucipher')->encrypt($data); // The output is base64 encoded

// Decrypt an encrypted string: (The input should be a base64-encoded decrypted string
$decrypted = app('sucipher')->decrypt($encrypted); // Output: 'Test Message'

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email smaosa@savannabits.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.