Covert

Plain text field type for Craft that encrypts and encodes data when saved to the database

Requirements

Covert requires PHP 8.0.2 or greater and Craft CMS 4.0.0 or 5.0.0 or greater.

Installation

COMMAND LINE

1. Open your terminal and go to your Craft project:

cd /path/to/project

2. Then tell Composer to load the plugin:

composer require jrrdnx/craft-covert

3. In the Control Panel, go to Settings -> Plugins and click the "Install" button for Covert.

CONTROL PANEL

Visit the Covert page in the Plugin Store in your control panel and click the Install button.

Field Settings

When adding a new field, choose Covert from the Field Type dropdown. Covert is based on Craft's first-party Plain Text field type, so most of the options should look familiar.

Additionally, Covert adds a Show field value by default option. When toggled ON, any entries containing this field will have their values shown instead of hidden. This setting only affects the Edit Entry screens containing this field and has no effect on how data is saved.

Entry Edit Screens

Covert fields will be displayed with an "eye" icon which toggles whether its value is shown or hidden, similar to many password fields. This value can be shown or hidden by default using the field's Show field value by default option (see Field Settings).

Database & Encryption

When entries are saved, data entered in any Covert fields is automatically encrypted and encoded before being saved to the database. Encryption is handled using your project's own Security Key

WARNING! As noted in the Craft documentation, if this key changes all data that has been encrypted with it (including all Covert fields!) will be inaccessible.