Skip to content
PHP
Pull request Compare This branch is 27 commits ahead of djpate:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
class
client
interfaces
oauth
sql
.gitignore
README.md

README.md

OAuth Provider Example

本项目来自djpate/OAuthProviderExample, 以PHP官方的oauth扩展包为基础,实现了一个 OAuth Provider 原型(不能直接用于生产环境)。

除此以外,项目中还提供了一个简单的oauth客户端( OAuth 1.0 RFC 5849 中称为Client/Consumer)的代码示例。

参考资料

  1. PHP oauth官方手册,可以获得Oauth与OAuthProvider 的API指南;
  2. djpate的博客 How to write a complete OAuth Provider in PHP5
  3. OAuth的官方网站
  4. OAuth RFC 5859 & 2.0 draft & mail list

运行说明

运行该示例代码,以站外应用为例,假设Provider和API是同一域名主机(例如新浪微博), 站外应用是另外一台独立主机。在示例部署时,仅需将源码中client目录部署在站外 应用所在服务器上(访问地址是http://192.168.100.100/client), Provider和API服务部署在另外一台服务器上(访问地址是http://192.168.100.120)。

按照OAuth 1.0 规范中规定的protocol endpoints,本例中分别是:

因此,按照具体的部署环境,更改client目录下的config.php; Provider端需要首先通过sql/schema.sql建立相应的库表,并配置class/Db.class.php。 然后通过访问client的首页,例如http://192.168.100.100/client/即可开始测试。

如果在测试过程中发现问题,请注意分析两个web服务器的日志信息,以帮助定位。

代码说明

下面按照代码的目录和文件结构进行简单说明

  • class 针对interfaces目录下的接口的具体实现
    • Consumer.class.php
      • Consumer/Client的操作实现, 含Consumer的创建,状态设置/查询,单次值处理等, 通过Db.class.php实现存储和查询。
    • Db.class.php
      • OAuth相关的consumer、token信息的数据库操作。在新环境试验该原型,需要修改相应的数据库参数。
    • Provider.class.php
      • 实现自定义的Provider的关键,主要是要实现PHP oauth库中要求至少实现的三个handler方法,见本文件 中的构造方法和注释。
    • Token.class.php
      • 令牌的操作实现。
    • User.class.php
      • 自定义API的一个示例,这里实现了获取用户基本信息的方法。依此类推,还可以实现自身平台的特殊数据服务。
  • client 一个纯粹使用php oauth方法的client示例,client部署时仅需该文件夹内容
    • apicall.php 示例流程中完成Access Token 获取后进行的API调用例子,获取用户的ID
    • callback.php 站外应用在SP中指定的回调URI
    • config.php 部署的时候,需要修改该配置文件中的参数
    • getgpa.php 一个扩展示例,模拟CLIENT得到Access Token之后,在token有效期内随时获得用户的最新GPA数据
    • getuid.php 同上,获取用户id数据。注意,在新的部署环境中,需要修改这两个文件中的token和secret值
    • index.php client的index首页,试验也是从该文件开始
  • favicon.ico
  • interfaces 接口定义文件夹
    • IConsumer.php 定义Client/Consumer的基本操作接口,与Consumer实现相关的持久化操作由具体的实现决定
    • IToken.php 定义Token的基本操作,具体token的存储持久化由具体实现决定
    • IUser.php 定义User的基本操作,与API设计相关
  • oauth SP对外服务接口
    • index.php 控制器脚本,实现对URL请求的解析调度
    • login.php 授权与登录页面
  • README.md 本文件
  • sql 数据库建库脚本文件
    • schema.sql 同上
Something went wrong with that request. Please try again.