smskin/laravel-identity-service

There is no license information available for the latest version (dev-main) of this package.

dev-main 2022-06-10 19:53 UTC

Requires

• php: ^8.1
• ext-sync: *
• laravel/framework: ^8 || ^9
• laravel/socialite: ^5.5
• miladrahimi/php-jwt: ^2.1
• smskin/laravel-identity-service-client: dev-main
• smskin/laravel-support: ^1.0
• zircote/swagger-php: ^4.4

Unknown License

• SMSkin

README

Identity service is a service that allows you to organize authorization in a laravel application through a common remote server. This allows you to organize a multi-service architecture with end-to-end authorization.

Identity service library consists of 2 parts:

• identity service - this package. Master auth service.
• identity service client - a client that allows application users to log in through a shared service (https://github.com/smskin/laravel-identity-service-client)

Installation

1. Run composer require smskin/laravel-identity-service
2. Run php artisan vendor:publish --tag=identity-service
3. Run php artisan vendor:publish --tag=identity-service-client
4. Configure identity service with identity-service.php in config folder and environments
5. Configure identity service client with identity-service-client.php in config folder and environments (read more in client readme file - https://github.com/smskin/laravel-identity-service-client/blob/main/README.md)

Customization

This library support replacing default User model to your. For this you need update your User model and change config file (identity-service.php).

1. In User model you need implement HasIdentity interface and add IdentityTrait trait
2. Change path to User model in config file

Example of config file

...
'classes' => [
    'models' => [
        'user' => User::class,
    ]
],
...

Example of User model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use SMSkin\IdentityService\Models\Contracts\HasIdentity;
use SMSkin\IdentityService\Models\Traits\IdentityTrait;

class User extends Authenticatable implements HasIdentity
{
    use HasFactory, Notifiable, IdentityTrait;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'identity_uuid',
        'name',
    ];
}

Environments

• IDENTITY_SERVICE_NAME - uses in iss claim of jwt
• IDENTITY_SERVICE_MODULE_AUTH_REGISTRATION_ACTIVE - allows registration of new users
• IDENTITY_SERVICE_SECURITY_API_TOKEN - secret key for admin functionality (admin api)
• IDENTITY_SERVICE_MODULE_JWT_TTL_ACCESS - ttl of access token (in seconds)
• IDENTITY_SERVICE_MODULE_JWT_TTL_REFRESH - ttl of refresh token (in seconds)
• IDENTITY_SERVICE_MODULE_JWT_SECRET - secret key for signing jwt
• IDENTITY_SERVICE_MODULE_SIGNATURE_TOKEN - secret key for signing interservice requests

Documentation

Controllers are described to maintain the swagger documentation. You can render documentation with darkaonline/l5-swagger package.

Steps for render documentation:

1. Run composer require darkaonline/l5-swagger
2. Run php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
3. Open l5-swagger.php in config folder
4. Add in annotations section (line 41 in default config file) after base_path('app') new elements of array

...
base_path('vendor/smskin/laravel-identity-service/src/Http'), 
base_path('vendor/smskin/laravel-support/src/Resources')
...

1. Add swagger info section to any base http controller (example below)
2. Run php artisan l5-swagger:generate
3. Open swagger documentation page (by default: http://localhost/api/documentation)

Example of swagger info section in base controller:

<?php

namespace App\Http\Controllers;

use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Routing\Controller as BaseController;
use OpenApi\Annotations\Contact;
use OpenApi\Annotations\Info;

/**
 * @Info(
 *     version="1.0.0",
 *     title="Identity service",
 *     @Contact(email="[e-mail]")
 * )
 *
 */
class Controller extends BaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}