esit/cryptography

Es handelt sich um eine Erweiterung für das Open Source CMS Contao, die es ermöglicht, Werte zu ver- und entschlüsseln.

1.0.5 2023-04-11 14:07 UTC

Requires

• php: ~8.0
• ext-openssl: *
• contao/core-bundle: ~4.9|^5.1

Requires (Dev)

• contao/test-case: ~4.9|^5.1
• phpunit/phpunit: ^9.5

LGPL-3.0-or-later

• Patrick Froch

README

Beschreibung

Bei dieser Software handelt es sich um eine Erweiterung für das Open Source CMS Contao, mit der Werte ver- und entschlüsselt werden können.

Autor

e@sy Solutions IT: Patrick Froch [e-mail]

Lizenz

Die Software wird unter LGPL veröffentlicht. Details sind in der Datei LICENSE zu finden.

Voraussetzungen

• php: ~8.0
• contao/core-bundle: ~4.9|^5.1

Installation

Die Installation geschieht über den ContaoManager. Einfach nach esit/cryptography suchen und installieren. Aleternativ kann die Erweiterung mit folgendem Befehl über Composer installiert werden:

composer require esit/cryptography

Einrichtung

In die .env-Datei müssen zwei Werte eingetragen werden, das Passwort (CRYPTOGRAPHY_SECRECT) und die Verschlüsselungsmethode (CRYPTOGRAPHY_CIPHER). Ein Beispiel sieht so aus:

CRYPTOGRAPHY_SECRECT="bhjRHnqCpgjqW3w94t34FjLnXCWvrhpJqsvN7VNfH9qHPKsm"
CRYPTOGRAPHY_CIPHER="aes-256-cbc"

Verwendung

Der Helper kann einfach in eigene Klassen injected werden.

MyClass
{

    private CryptographyHelper $cryptoHelper;

    public function __construct(CryptographyHelper $cryptoHelper)
    {
        $this->cryptoHelper = $cryptoHelper;
    }

    public function myTest(): void
    {
        $value      = 'Mein geheimer Teststring!';
        $encrypted  = $this->cryptoHelper->encrypt($value);
        $decrypted  = $this->cryptoHelper->decrypt($encrypted); // $value === $decrypted
    }
}

Beide Methoden nehmen als zweiten Parameter das Passwort entgegen. So können Werte mit unterschiedlichen Passwörtern verschlüsselt werden, falls nicht das in der .env-Datei hinterlegte Standardpasswort (CRYPTOGRAPHY_SECRECT) verwendet werden soll.