欢迎各位兄弟 发布技术文章

这里的技术是共享的

You are here

Laravel5框架使用Oauth2.0

Laravel5:一款享誉国内外的PHP框架。

Oauth2.0 : 一款耳熟能详的作为令牌验证机制的开源软件。
为什么会将这两者搭配起来?
主要的动机是我需要做一个Android客户端,这必然涉及到与服务器的交互,虽然自己去完成Oauth的Token验证功能并不是太难,但是既然人家Oauth已经这么成熟了,何苦去自己写呢?另外,因为我的Web项目就是使用Laravel5开发的,所以也就出现了我现在需要将Oauth融入到我的Laravel框架中。
如何实现?
其实如果单纯的将Oauth2.0融入到Laravel中其实并没有直接的途径,比如框架千千万万,而Oauth也并不会为每一种框架都准备使用教程对吧?所以只能去github上找找出路。
解决方案在此 : https://bshaffer.github.io/oauth2-server-php-docs/cookbook/laravel/

 

==================================================================================================================================

华丽丽的分割线

你可以按照上面链接按照步骤一步一步安装,也可以跟着我往下走。但还是墙裂推荐跟着我往下走噢!

 

==================================================================================================================================

1.使用composer安装oauth2-server-php

 

[php] view plain copy
 
  1. composer require bshaffer/oauth2-server-php   
  2. composer require bshaffer/oauth2-server-httpfoundation-bridge  

由于国外镜像被墙,国内镜像还不稳定,据我所知国内现在有两个镜像可以用,如果一个不行用另一个。

 

 

2.创建Oauth相关的表迁移

在项目根目录下执行

[html] view plain copy

 
  1. php artisan db:migrate create_oauth_tables  

执行完该命令后,会在database/migrations/目录下生成一个以当前日期为开头的以create_oauth_tables结尾的.php文件,打开它,输入以下代码,并保存。


[php] view plain copy
 
  1. <?php  
  2.   
  3. use Illuminate\Database\Schema\Blueprint;  
  4. use Illuminate\Database\Migrations\Migration;  
  5.   
  6. class CreateOauthTables extends Migration {  
  7.   
  8.     /** 
  9.      * Run the migrations. 
  10.      * 
  11.      * @return void 
  12.      */  
  13.     public function up()  
  14.     {  
  15.         //  
  16.     $schema = <<<SCHEMA  
  17. CREATE TABLE oauth_clients (client_id VARCHAR(80) NOT NULL, client_secret VARCHAR(80) NOT NULL, redirect_uri VARCHAR(2000) NOT NULL, grant_types VARCHAR(80), scope VARCHAR(100), user_id VARCHAR(80), CONSTRAINT client_id_pk PRIMARY KEY (client_id));  
  18. CREATE TABLE oauth_access_tokens (access_token VARCHAR(40) NOT NULL, client_id VARCHAR(80) NOT NULL, user_id VARCHAR(255), expires TIMESTAMP NOT NULL, scope VARCHAR(2000), CONSTRAINT access_token_pk PRIMARY KEY (access_token));  
  19. CREATE TABLE oauth_authorization_codes (authorization_code VARCHAR(40) NOT NULL, client_id VARCHAR(80) NOT NULL, user_id VARCHAR(255), redirect_uri VARCHAR(2000), expires TIMESTAMP NOT NULL, scope VARCHAR(2000), CONSTRAINT auth_code_pk PRIMARY KEY (authorization_code));  
  20. CREATE TABLE oauth_refresh_tokens (refresh_token VARCHAR(40) NOT NULL, client_id VARCHAR(80) NOT NULL, user_id VARCHAR(255), expires TIMESTAMP NOT NULL, scope VARCHAR(2000), CONSTRAINT refresh_token_pk PRIMARY KEY (refresh_token));  
  21. CREATE TABLE oauth_users (username VARCHAR(255) NOT NULL, password VARCHAR(2000), first_name VARCHAR(255), last_name VARCHAR(255), CONSTRAINT username_pk PRIMARY KEY (username));  
  22. CREATE TABLE oauth_scopes (scope TEXT, is_default BOOLEAN);  
  23. CREATE TABLE oauth_jwt (client_id VARCHAR(80) NOT NULL, subject VARCHAR(80), public_key VARCHAR(2000), CONSTRAINT client_id_pk PRIMARY KEY (client_id));  
  24. SCHEMA;  
  25.  
  26.       
  27.         foreach (explode("\n"$schemaas $statement) {  
  28.             DB::statement($statement);  
  29.         }  
  30.     }  
  31.   
  32.     /** 
  33.      * Reverse the migrations. 
  34.      * 
  35.      * @return void 
  36.      */  
  37.     public function down()  
  38.     {  
  39.         //  
  40.         DB::statement('DROP TABLE oauth_clients, oauth_access_tokens, oauth_authorization_codes, oauth_refresh_tokens, oauth_users, oauth_scopes, oauth_jwt');  
  41.     }  
  42.   
  43. }  

解决方案在此 : https://bshaffer.github.io/oauth2-server-php-docs/cookbook/laravel/

 

==================================================================================================================================

华丽丽的分割线

你可以按照上面链接按照步骤一步一步安装,也可以跟着我往下走。但还是墙裂推荐跟着我往下走噢!

==================================================================================================================================

 

保存后,terminal切换到项目根目录,执行如下命令。

 

[html] view plain copy
 
  1. php artisan migrate  

执行完命令后会发现,数据库中会出现好多oauth开头的数据表。

 

 

3.新建seeds

在database/seeds/目录下新建两个文件,分别命名为OAuthClientsSeeder.php 和 OAuthUsersSeeder.php文件,写入如下代码

OAuthClientsSeeder.php
 

[php] view plain copy
 

 

  1. <?php  
  2. use Illuminate\Database\Seeder;  
  3. class OAuthClientsSeeder extends Seeder  
  4. {  
  5.     public function run()  
  6.     {  
  7.         DB::table('oauth_clients')->insert(array(  
  8.             'client_id' => "testclient",  
  9.             'client_secret' => "testpass",  
  10.             'redirect_uri' => "http://fake/",  
  11.         ));  
  12.     }  
  13. }  
 

OAuthUsersSeeder.php

 

[php] view plain copy
 
  1. <?php  
  2. use Illuminate\Database\Seeder;  
  3. class OAuthUsersSeeder extends Seeder  
  4. {  
  5.     public function run()  
  6.     {  
  7.         DB::table('oauth_users')->insert(array(  
  8.             'username' => "bshaffer",  
  9.             'password' => sha1("brent123"),  
  10.             'first_name' => "Brent",  
  11.             'last_name' => "Shaffer",  
  12.         ));  
  13.     }  
  14. }  


 

保存退出后,切换到项目根目录,执行以下命令,自动加载下composer的配置
 

[php] view plain copy
 
  1. composer dump-autoload  


再执行下面这条命令,将刚刚新建的两个种子OAuthClientsSeeder.php 和 OAuthUsersSeeder.php插入一些数据进入数据库

 

 

[php] view plain copy
 
  1. php artisan db:seed  


这是会发现oauth_users和oauth_clients这两个表各插入了一条数据。

 

 

 

4.routeMiddleware配置
 

打开app/Http/Kernel.php,将'App\Http\Middleware\VerifyCsrfToken',这一行注释,原因在于客户端是无状态的,也没有HTML表单中的_token变量,所以需要禁用掉Csrf的验证。

在$routeMiddleware增加一行,'oauth'=> 'App\Http\Middleware\OauthMiddleware',因为本教程实现的就是希望能够在request和controller中间加一层middleware来实现Token的验证机制,所以当我们新增了这一行之后,下面还需要添加OauthMiddleware这个中间件才行。

 

修改后的Kernel.php文件为:
 

[php] view plain copy
 
  1. <?php namespace App\Http;  
  2.   
  3. use Illuminate\Foundation\Http\Kernel as HttpKernel;  
  4.   
  5. class Kernel extends HttpKernel {  
  6.   
  7.     /** 
  8.      * The application's global HTTP middleware stack. 
  9.      * 
  10.      * @var array 
  11.      */  
  12.     protected $middleware = [  
  13.         'Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode',  
  14.         'Illuminate\Cookie\Middleware\EncryptCookies',  
  15.         'Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse',  
  16.         'Illuminate\Session\Middleware\StartSession',  
  17.         'Illuminate\View\Middleware\ShareErrorsFromSession',  
  18.         //'App\Http\Middleware\VerifyCsrfToken',  
  19.     ];  
  20.   
  21.     /** 
  22.      * The application's route middleware. 
  23.      * 
  24.      * @var array 
  25.      */  
  26.     protected $routeMiddleware = [  
  27.         'auth' => 'App\Http\Middleware\Authenticate',  
  28.         'auth.basic' => 'Illuminate\Auth\Middleware\AuthenticateWithBasicAuth',  
  29.         'guest' => 'App\Http\Middleware\RedirectIfAuthenticated',  
  30.         'csrf' => 'App\Http\Middleware\VerifyCsrfToken',  
  31.         'oauth'=> 'App\Http\Middleware\OauthMiddleware',  
  32.     ];  
  33.   
  34. }  


添加中间件 OauthMiddleware

在app/Http/Middleware目录下新建OauthMiddleware.php文件,保存以下代码。

 

[php] view plain copy
 
  1. <?php namespace App\Http\Middleware;  
  2. use Closure;  
  3. use Illuminate\Support\Facades\App;  
  4. use Illuminate\Support\Facades\Log;  
  5. use OAuth2\HttpFoundationBridge\Request as OAuthRequest;  
  6.   
  7. class OauthMiddleware{  
  8.     public function handle($request, Closure $next){  
  9.         if(!$request->input('access_token')){  
  10.             return response( 'Token not found', 422);  
  11.         }  
  12.         $req = \Symfony\Component\HttpFoundation\Request::createFromGlobals();  
  13.         $bridgeRequest = OAuthRequest::createFromRequest($req);  
  14.         $bridgeResponse = new \OAuth2\HttpFoundationBridge\Response();  
  15.           
  16.         if(!$token = App::make('oauth2')->getAccessTokenData($bridgeRequest$bridgeResponse)){  
  17.             $response = App::make('oauth2')->getResponse();  
  18.             if($response -> getParameter('error') == 'expired_token'){  
  19.                 return response('The access token provided has expired', 401);  
  20.             }  
  21.             return response('Invalid Token.', 422);  
  22.         } else {  
  23.             $request['user_id'] = $token['user_id'];  
  24.         }  
  25.         return $next($request);  
  26.     }  
  27. }  


 

 

5.route路由配置

 

打开app.Http/routes.php中新增如下代码,注意更改Pdo连接数据库的username和password
 

[php] view plain copy
 
  1. App::singleton('oauth2'function() {  
  2.      $storage = new OAuth2\Storage\Pdo(array(  
  3.         'dsn' => 'mysql:dbname=ishare_school;host=localhost''username' => 'root''password' => env('DB_PASSWORD''')));  
  4.      $server = new OAuth2\Server($storage);  
  5.      $server->addGrantType(new OAuth2\GrantType\ClientCredentials($storage));  
  6.      $server->addGrantType(new OAuth2\GrantType\UserCredentials($storage));  
  7.      return $server;  
  8. });  
  9. Route::get('oauth/token'function()  
  10. {     
  11.     $bridgedRequest  = OAuth2\HttpFoundationBridge\Request::createFromRequest(Request::instance());  
  12.     $bridgedResponse = new OAuth2\HttpFoundationBridge\Response();  
  13.       
  14.     $bridgedResponse = App::make('oauth2')->handleTokenRequest($bridgedRequest$bridgedResponse);  
  15.     return $bridgedResponse;  
  16. });  


 

 

 

==================================================================================================================================

 

又是华丽丽的分割线
 

OK,上面就是基本的配置了,下面就需要来使用了。

==================================================================================================================================

 

1.获取Token

  请求服务器,路由为oauth/token来获得Token

 

2.有些API需要验证Token,有些API不需要验证Token怎么办?

别忘了我们新增了一个middleware啊。

不需要验证Token的路由怎么写?

 

[php] view plain copy
 
  1. Route::post('veirfycode''Api\UserController@veirfyCode');  


需要验证Token的路由怎么写?
 

[php] view plain copy
 
  1. Route::post('addpasswd'  , ['middleware' => 'oauth''uses'=>'Api\UserController@addPassword']);  


 

 

 

 

 

==================================================================================================================================

又是华丽丽的分割线

缺点!!!!!请注意!!!!!

==================================================================================================================================

 

1.毕竟这个Oauth2.0是个国外的产品,有许多提示信息还是英文,需要做的可能是要更改oauth2-server-php的源码

2.除了语言层面,还有一点是Oauth2.0的验证方式并非很适合已经有一定用户的情况,所以需要将网站已有用户的数据同步到oauth_access等数据表中才可以。

 

 

 

若转载,请注明出处,谢谢配合。


普通分类: