How to install Lumen Passport in an existing Lumen project?

Install via Composer with 'composer require dusterio/lumen-passport', then modify bootstrap/app.php to register service providers and configure auth.php as detailed in the README. Ensure you run migrations and passport:install after setup.

Lumen Passport vs JWT for Lumen authentication?

Lumen Passport provides a full OAuth2 server with client management and scopes, ideal for API security compliance. JWT is lighter and simpler for basic token auth without OAuth overhead, so choose based on your need for OAuth features.

How to allow multiple access tokens per user in Lumen Passport?

Call LumenPassport::allowMultipleTokens() in your service provider's boot method. This enables users to have simultaneous tokens from different devices, a feature not available in standard Laravel Passport.

Can I use Lumen Passport with Lumen 8 or newer?

The README mentions Lumen 7.x, so check the package's GitHub or Packagist for compatibility updates. You may need to adapt the bootstrap modifications or use a different application class for newer Lumen versions.

How to set different token expiration times for mobile and web clients?

Use LumenPassport::tokensExpireIn() with a client ID parameter in your service provider. For example, specify a Carbon date for a specific client to define custom TTLs, as shown in the README's extended features section.

Is Lumen Passport suitable for microservices?

Yes, it's designed for Lumen-based microservices needing OAuth2 authentication, but consider the overhead of managing OAuth servers across services. It allows token-based security with minimal framework bloat.

Open-Awesome

Lumen Passport

MITPHP0.3.8

A service provider that enables Laravel Passport OAuth2 server functionality in Lumen micro-framework applications.

GitHub

651 stars137 forks0 contributors

What is Lumen Passport?

Lumen Passport is a PHP package that adapts Laravel Passport to work with the Lumen micro-framework. It solves the problem of adding OAuth2-based API authentication to lightweight Lumen applications by providing a service provider that bridges the two systems. This allows developers to use Laravel Passport's full token-based authentication system without migrating to the heavier Laravel framework.

Target Audience

PHP developers building RESTful APIs with Lumen who need OAuth2 authentication capabilities. It's particularly useful for teams committed to Lumen's micro-framework architecture but requiring enterprise-grade API security.

Value Proposition

Developers choose Lumen Passport because it provides the complete Laravel Passport OAuth2 implementation in Lumen with minimal configuration. Its unique value lies in extending Laravel Passport with Lumen-specific features like route prefixing and multiple tokens per client while maintaining compatibility with existing Laravel Passport documentation and workflows.

Overview

Making Laravel Passport work with Lumen

Use Cases

Best For

Adding OAuth2 authentication to existing Lumen API projects
Building microservices with Lumen that require token-based security
Migrating from Laravel to Lumen while keeping Passport authentication
Creating lightweight APIs that need full OAuth2 client management
Implementing password grant authentication in Lumen applications
Developing API gateways with Lumen that require token issuance

Not Ideal For

Applications requiring OAuth2 web authorization flows with user consent pages
Projects already built on the full Laravel framework
Teams needing a minimal authentication solution without OAuth2 server overhead
Environments where database migrations and key management are restrictive

Pros & Cons

Pros

Full OAuth2 Implementation

Brings Laravel Passport's complete token-based authentication to Lumen, including token issuance, client management, and scopes without switching frameworks.

Extended Functionality

Adds features not in standard Laravel Passport, such as multiple tokens per client and client-specific TTLs, enhancing flexibility for simultaneous logins.

Route Prefix Support

Allows custom prefixes for OAuth routes, enabling better API versioning and organization, as shown in the prefix configuration example.

Maintenance Tools

Includes an artisan command (passport:purge) to remove expired tokens, aiding database efficiency and cleanup.

Cons

Setup Complexity

Requires manual modifications to bootstrap files, configuration loading, and service provider registration, increasing initial setup time and error risk.

Compatibility Risks

Breaking changes in Laravel Passport, like version 7.3.2, necessitate workarounds such as using a custom Lumen7Application class, adding maintenance burden.

Limited Web OAuth Support

Omits web-related routes for OAuth authorization pages, making it unsuitable for applications needing interactive user consent flows.

Frequently Asked Questions

Related Projects

Dingo API

A RESTful API package for the Laravel and Lumen frameworks.

Stars9,356

Forks1,269

Last commit4 years ago

Facebook SDK

Fully unit tested Facebook SDK v5 integration for Laravel & Lumen

Stars689

Forks196

Last commit5 years ago

REST API With Lumen

Rest API boilerplate for Lumen micro-framework.

Stars486

Forks136

Last commit8 years ago

Lumen Generators

A collection of generators for Lumen and Laravel 5.

Stars350

Forks92