meezaan/aescryptor

A library to encrypt / decrypt strings using the AES algorithm

v1.4 2024-05-29 18:03 UTC

Requires

• php: >=8.2
• ext-ctype: *
• ext-openssl: *

Requires (Dev)

• phpunit/phpunit: ^9.6

MIT

• security
• encryption
• decryption

README

A basic PHP package for encrypting and decrypting strings using an AES 256-bit key.

This library requires the PHP OpenSSL extension.

This package is based on https://gist.github.com/turret-io/957e82d44fd6f4493533.

Installation

The package can be installed via composer:

composer install neezaan\aescryptor

Usage

This package can generate a secure key and initialisation vector for you. You will need to store the key securely, but this package handles storing the IV itself with the encrypted string, so you don't have to store it elsewhere. Arguably this is less secure, but it makes the implementation simpler.

<?php 
use Meezaan\Aescryptor\Generate;
use Meezaan\Aescryptor\Aes;

// Generate a 256-bit key. Store this somewhere in a secure vault. You don't need this step as you can generate your own key elsewhere too.
$key = Generate::key();

// Our secret
$secret = 'A_Secret';

// Instantiate the Aes class.
$aes = new Aes($key);

// Encrypt your string
$encrypted = $aes->encrypt($secret);

// Decrypt your string
$decrypted = $aes->decrypt($encrypted);

// Note that $decrypted === $secret

Purpose

This library is built primarily for interoperability between applications and pipelines.

Interoperability via Bash

Results produced by this library are not interoperable with the openssl cli on Linux.

To get the same results with PHP, see https://stackoverflow.com/questions/71198954/openssl-aes-256-cbc-encryption-from-command-prompt-and-decryption-in-php-and-vi.

Credits

• https://gist.github.com/turret-io/957e82d44fd6f4493533

License

MIT