Detailed introduction to the process, configuration and use of Laravel Passport

Laravel Passport is a complete OAuth2 server implementation under the Laravel framework. It allows you to authenticate and authorize user identities through APIs, so that API services can be accessed without exposing user credentials, which greatly reduces the cost. The difficulty of client development improves the security of the application.

The OAuth2 protocol behind Laravel Passport is an industry standard, so you can easily integrate OAuth2 authentication and authorization in other languages ​​and frameworks using the same tools and processes. Below, this article will introduce the process, configuration and use of Laravel Passport in detail.

Install Passport

Before using Laravel Passport, you need to install it first. We can use the composer command to install Passport, the command is as follows:

composer require laravel/passport

Enable Passport

After Laravel Passport is installed, you need to add its service provider to the providers in the config/app.php file array, open the file, find the providers array and add the service provider of Laravel Passport, as shown below:

'providers' => [
    // Other Service Providers...
    Laravel\Passport\PassportServiceProvider::class,
],

Create database table

Before using Laravel Passport, you also need to create a new Passport. For the required database tables, you can use the following artisan command to generate the migration file:

php artisan migrate

After executing the above command, Laravel Passport will create several new tables in your database to save the OAuth2 client, Access Token and Refresh Token and other data.

Publish configuration file

Execute the following artisan command to publish the Passport configuration file to the config directory of the Laravel project:

php artisan vendor:publish --tag=passport-config

Create key

At this point, we have completed the prerequisites required to use Laravel Passport. Next, we need to use the following artisan command to generate encryption keys:

php artisan passport:keys

The above command will generate encryption keys for signing data such as cookies and access tokens.

Configuring Passport

After completing the above steps, we next need to configure Passport so that it can run. In the config/auth.php configuration file, change the driver of the api driver to passport, and set guards and providers as follows:

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],
    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
    ],
],

Configure providers in the same file as follows:

'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => App\Models\User::class,
    ],
],

Once the configuration file is completed, API authentication is ready.

Create Route

Next, we need to create the API route in the app/Http routing file as follows:

Route::middleware('auth:api')->get('/user', function (Request $request) {
    return $request->user();
});

In the above routing example, auth is defined :api middleware, used to verify whether the request comes from an authenticated user. If it is not an authenticated user, a 401 status code will be returned when the verification fails.

Create Client

Now that we have completed the application configuration and API routing settings, we need to create the API client. In Laravel Passport, the artisan command passport:client is provided for creating a new OAuth2 client. Execute the command as shown below:

php artisan passport:client --client

After executing the command, we need to enter the client name and authorization redirect URI as shown below:

php artisan passport:client --client
Which user ID should the client be assigned to? [0]:
 > 1
What should we name the client?
 > Test
Where should we redirect the request after authorization?
 > http://example.com/callback

The above command will create a new OAuth2 Client used to send requests to this application's API. We will get a client ID and client secret to use in subsequent API requests.

Get authorization

The client has been created and obtained the authorization redirect URI. Now we need to send a request to the URI to obtain authorization. Afterwards, Passport will generate an access token for the client and return it to the client. Use the URL shown below, replacing the Client ID and Redirect URI:

http://your-app.com/oauth/authorize?client_id={client-id}&redirect_uri={redirect-uri} &response_type=code&scope=

After entering the URL, the OAuth2 authorization screen shown below will be displayed:

After clicking the 'Authorize' button, authorization will occur and redirect to the redirect URI.

Get Access Token

Now, we have obtained authorization and the client has been granted access to the API. We need to use the OAuth2 authorization code to exchange the client key for the access token. We can use the curl command as shown below to obtain the access token from the API authorization server:

$ curl -X POST -H "Accept: application/json" -F "client_id={client-id}" -F "client_secret={client-secret}" -F "grant_type=authorization_code" -F "code={code}" -F "redirect_uri={redirect-uri}" http://your-app.com/oauth/token

After executing the above command, you will get A JSON object as shown below, which contains information such as access_token and refresh_token:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "{access-token}",
    "refresh_token": "{refresh-token}",
}

Using access token for API requests

Now that we have obtained the access token, we can use the access token Make requests with the API. We need to add the Authorization header to the API request header and set up the Bearer authentication scheme to use the access token as the token content, as shown below:

$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'http://your-app.com/api/user', [
    'headers' => [
        'Authorization' => 'Bearer '.$accessToken,
        'Accept' => 'application/json',
    ],
]);

In the above code, we will use the access token The token is submitted to the API server in the format of Bearer TOKEN for verification. If successful, the API response result will be obtained.

Summary

In this article, we describe the process, configuration and use of Laravel Passport. Using Laravel Passport, we can quickly add secure authentication and authorization to API applications, while supporting the OAuth2 protocol and interoperating with applications that implement OAuth2 authorization in other programming languages ​​and frameworks, allowing developers to quickly build security High, easy-to-use API applications.

The above is the detailed content of Detailed introduction to the process, configuration and use of Laravel Passport. For more information, please follow other related articles on the PHP Chinese website!