skim / auth

v0.1.1 2026-10-01 07:22 UTC

Requires

• php: ^8.5
• league/oauth2-client: ^2.7
• skim/framework: ^0.1

Requires (Dev)

• pestphp/pest: ^3.0

Suggests

• league/oauth2-facebook: Facebook social login
• league/oauth2-github: GitHub social login
• league/oauth2-google: Google social login
• skim/mailer: Required for email verification and password reset

MIT

Published on Packagist.org on 2026-10-01 07:48 UTC

README

skim/auth provides authentication, email verification, password reset, and social logins (Google, GitHub, Facebook) for SKIM applications.

Integration & Installation

To install the extension, add it to your SKIM application's composer.json or require it:

composer require skim/auth

Because of SKIM Framework's automatic discovery, the framework will detect the extension, perform dependency validation (session capability must be active), and boot the authentication services automatically.

Configuration

Publish the configuration file using the built-in SKIM CLI:

php skim auth:publish all

This will copy the default auth configuration to your application's config/auth.php and set up any default database migrations. Run the database migrations using:

php skim migrate:status
php skim migrate

Configure your environment variables in .env for OAuth providers if social login is enabled:

GOOGLE_CLIENT_ID=your-client-id
GOOGLE_CLIENT_SECRET=your-client-secret
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret

Code Examples & Usage

1. Registering/Logging In Users

use Skim\Auth\AuthService;

// Obtain the authentication service from the app DI container
$auth = app()->make(auth_service::class);

// Or retrieve via the bound shorthand
$auth = app('auth');

// Attempt credentials login
try {
    $session = $auth->attempt([
        'email'    => '[e-mail]',
        'password' => 'secret-password'
    ]);
    
    // User is now authenticated
    $user = $auth->user();
} catch (\Exception $e) {
    // Handle invalid credentials
}

2. Guarding Routes via Middleware

Secure your routes using the built-in auth_middleware (provided by the auth capability):

// routes/web.php or inside boot()
$app->router->get('/dashboard', [dashboard_controller::class, 'show'])
    ->middleware(\Skim\Auth\Middleware\AuthMiddleware::class);

3. Social OAuth Authentication

The extension automatically exposes routes for OAuth redirection and callbacks based on configuration:

// Redirect to Github
return response()->redirect(app('auth')->oauth('github')->get_redirect_url());