Laravel5框架使用Oauth2.0

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

Oauth2.0 : 一款耳熟能详的作为令牌验证机制的开源软件。


为什么会将这两者搭配起来?

主要的动机是我需要做一个Android客户端,这必然涉及到与服务器的交互,虽然自己去完成Oauth的Token验证功能并不是太难,但是既然人家Oauth已经这么成熟了,何苦去自己写呢?另外,因为我的Web项目就是使用Laravel5开发的,所以也就出现了我现在需要将Oauth融入到我的Laravel框架中。


如何实现?

其实如果单纯的将Oauth2.0融入到Laravel中其实并没有直接的途径,比如框架千千万万,而Oauth也并不会为每一种框架都准备使用教程对吧?所以只能去github上找找出路。


好在github上真的有解决方案,当然方案还不止一种,但我以我的亲身经历证明,这一款比较牛逼,提前声明的是这一款是使用Laravel5内置的Middleware来实现的,当然我认为这样的话会更加灵活。

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


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

华丽丽的分割线

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

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


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

composer require bshaffer/oauth2-server-php 
composer require bshaffer/oauth2-server-httpfoundation-bridge

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


2.创建Oauth相关的表迁移

在项目根目录下执行

php artisan db:migrate create_oauth_tables

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



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

php artisan migrate

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


3.新建seeds

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

OAuthClientsSeeder.php

insert(array(
			'client_id' => "testclient",
			'client_secret' => "testpass",
			'redirect_uri' => "http://fake/",
		));
	}
}


OAuthUsersSeeder.php

insert(array(
			'username' => "bshaffer",
			'password' => sha1("brent123"),
			'first_name' => "Brent",
			'last_name' => "Shaffer",
		));
	}
}


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

composer dump-autoload

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

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文件为:

 'App\Http\Middleware\Authenticate',
		'auth.basic' => 'Illuminate\Auth\Middleware\AuthenticateWithBasicAuth',
		'guest' => 'App\Http\Middleware\RedirectIfAuthenticated',
		'csrf' => 'App\Http\Middleware\VerifyCsrfToken',
		'oauth'=> 'App\Http\Middleware\OauthMiddleware',
	];

}

添加中间件 OauthMiddleware

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

input('access_token')){
			return response( 'Token not found', 422);
		}
		$req = \Symfony\Component\HttpFoundation\Request::createFromGlobals();
		$bridgeRequest = OAuthRequest::createFromRequest($req);
		$bridgeResponse = new \OAuth2\HttpFoundationBridge\Response();
		
		if(!$token = App::make('oauth2')->getAccessTokenData($bridgeRequest, $bridgeResponse)){
			$response = App::make('oauth2')->getResponse();
			if($response -> getParameter('error') == 'expired_token'){
				return response('The access token provided has expired', 401);
			}
			return response('Invalid Token.', 422);
		} else {
			$request['user_id'] = $token['user_id'];
		}
		return $next($request);
	}
}


5.route路由配置

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

App::singleton('oauth2', function() {
	 $storage = new OAuth2\Storage\Pdo(array(
		'dsn' => 'mysql:dbname=ishare_school;host=localhost', 'username' => 'root', 'password' => env('DB_PASSWORD', '')));
	 $server = new OAuth2\Server($storage);
	 $server->addGrantType(new OAuth2\GrantType\ClientCredentials($storage));
	 $server->addGrantType(new OAuth2\GrantType\UserCredentials($storage));
	 return $server;
});
Route::get('oauth/token', function()
{	
    $bridgedRequest  = OAuth2\HttpFoundationBridge\Request::createFromRequest(Request::instance());
    $bridgedResponse = new OAuth2\HttpFoundationBridge\Response();
    
    $bridgedResponse = App::make('oauth2')->handleTokenRequest($bridgedRequest, $bridgedResponse);
    return $bridgedResponse;
});


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

又是华丽丽的分割线

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

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


1.获取Token

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


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

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

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

Route::post('veirfycode', 'Api\UserController@veirfyCode');

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

Route::post('addpasswd'  , ['middleware' => 'oauth', 'uses'=>'Api\UserController@addPassword']);




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

又是华丽丽的分割线

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

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


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

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




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


你可能感兴趣的:(Oauth,Laravel,PHP)