Download the PHP package bytesfield/key-manager without Composer

On this page you can find all versions of the php package bytesfield/key-manager. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of bytesfield/key-manager

Informations about the package key-manager

Key Manager

StyleCI Scrutinizer Code Quality Build Status

Key Manager is a Laravel Package for generating public and private key pairs storing, retrieving and authenticating requests using the private key value.

Installation

PHP 7.4+ and Composer are required.

To get the latest version of Key Manager, simply require it

Or add the following line to the require block of your composer.json file.

You'll then need to run composer install or composer update to download it and have the autoloader updated.

Once KeyManager is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

If you use Laravel >= 5.5 you can skip this step and go to configuration

Also, register the Facade like so:

Configuration

You can publish the configuration file using this command:

This publishes a configuration-file named keymanager.php with some sensible defaults will be placed in your config directory and two migration files create_key_clients_table and create_key_api_credentials_table placed in your database\migrations directory:

Then run this command to migrate your database

Usage

Generate API Encryption Key by running this command on your terminal

This will generate an encryption key in your .env:

If you are using a hosting service like heroku, ensure to add the above details to your configuration variables.

Using KeyManager Facade

Import the KeyManager Facade

Create a Key Client

This creates a client with public and private keys pairs

Note : $status param can either be active or suspended while $type is dependent on what you want e.g user or admin.

Get Private Key

Change Key Pairs

Suspend a client

Activate a Client

Suspend an API Credential

Activate an API Credential

Injecting KeyManager or KeyManagerInterface in a constructor

Import the KeyManager or KeyManagerInterface

Or

Create a Key Client

This creates a client with public and private keys pairs

Note : $status param can either be active or suspended while $type is dependent on what you want e.g user or admin.

Get Private Key

Change Key Pairs

Suspend a Client

Activate a Client

Suspend an API Credential

Activate an API Credential

Using Commands

You can use commands to perform these actions too.

Create a Key Client

Or

This creates a client with public and private keys pairs

Note : $status param can either be active or suspended while $type is dependent on what you want e.g user or admin.

Get Private Key

Change Key Pairs

Suspend a client

Activate a Client

Suspend an API Credential

Activate an API Credential

Using the middleware to protect your routes.

In your route add auth.client middleware

Or

In your controller add auth.client

This Middleware Authenticates a client's request with a valid private key value api-auth-key which is to be passed to the request header.

Testing

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email abrahamudele@gmail instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of key-manager with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
paragonie/ciphersweet Version ^2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bytesfield/key-manager contains the following files

Loading the files please wait ...