adsy2010/laravel-api-credentials

This package is designed to provide an encrypted layer to API keys so they are not left exposed in env or config files directly

v1.0.0 2021-09-02 20:13 UTC

Requires

• php: ^7.2.5|^8.0
• ext-json: *
• guzzlehttp/guzzle: ^6.5 | ^7.0
• illuminate/database: 5.8.* | ^6.0 | ^7.0 | ^8.0
• illuminate/support: 5.8.* | ^6.0 | ^7.0 | ^8.0

Requires (Dev)

• orchestra/testbench: ^6.0

MIT

• adsy2010

README

This package is for use in conjunction with any service which uses public and secret api keys.

Optionally, some services have scopes that a key can be added to, the facility for this has been included.

For example, Stripe has two standard keys. A publishable key and a secret key. Additional secret restricted keys can be created to limit access to their API, so a list of scopes that the key applies to would be associated.

Getting started

To get started, add this packages service provider to your providers list in app.php or require the package if using as part of your own package.

    'providers' => [
        ...
        /*
         * Application Service Providers...
         */
        \Adsy2010\LaravelApiCredentials\LaravelApiCredentialServiceProvider::class,
        ... 
    ],

Now if using this package directly in Laravel, run a migration directly to set up the credential and scopes tables.

php artisan migrate

Optionally you can publish the service provider beforehand

php artisan vendor:publish --provider=Adsy2010\LaravelApiCredentials\LaravelApiCredentialServiceProvider

Usage

To add an api key to the database, provide a key, value, the service and any named scopes you wish to include.

$key = 'PUBLIC';
$value = 'TEST_VALUE_STRING';
$service = 'TEST_SERVICE';
$scopes = [];

$credentials = (new Credential)->store($key, $value, $service, $scopes);

The expected scopes array is an array of arrays comprising name and access keys. If the access key is not included, the default for access will be READ.

In the instance a scope is not provided, a default named scope of "Public" with read and write access will be created.

$scopes = [
    ['name' => 'Charges', 'access' => ScopeAccess::READ],
    ['name' => 'Payments', 'access' => ScopeAccess::WRITE],
    ['name' => 'Customers', 'access' => ScopeAccess::READ_AND_WRITE],
];

You decide you need to change providers and move from twitter to instagram so you choose to clean up your old access code.

Run the following against the required credentials. The delete method will remove any scopes attached.

//Load a credential and call delete. This will remove the credential and any scopes attached.
$credential->delete();

You need to use the key in your package or application, simply request the service, scope and access level, and the decrypted key will be returned, ready for use.

$service = 'Quickbooks';
$scopeName = 'Publishable';

(new Scope)->retrieveCredentialValue($service, $scopeName, ScopeAccess::READ_AND_WRITE);