zekreto/zekreto-client

Client library for the zekreto encryption service

v1.0.0 2023-12-13 17:46 UTC

Requires

• guzzlehttp/guzzle: ^7.0
• monolog/monolog: ^2.9
• phpunit/phpunit: ^9.6

Requires (Dev)

• vlucas/phpdotenv: ^5.6

MIT

• Roderick Smith

README

A PHP class to encrypt or decrypt secrets using the Zekreto.com Encryption-as-a-Service

Installation

This package requires PHP 7.4 or newer and can be installed via composer with:

composer require zekreto/zekreto-client

Usage

1. Create an account on zekreto.com and generate a token
2. Install the package
3. Instantiate the ZekretoClient class using the API key provided
4. Use the object's encrypt and decrypt methods to handle your secrets as required

Configuration

The client uses environment variables (via the vlucas/phpdotenv package) to read settings, as of now the following can be controlled:

• ZEKRETO_API_KEY (str): A string containing the Token provided by the server
• ZEKRETO_API_URL (str): A URI pointing to a custom instance of Zekreto
• ZEKRETO_EMPTYSTR_ON_ERROR (bool): If true it will silence any errors and just return an empty string