Open-OAuth2Playground

Open-OAuth2Playground

Open-OAuth2Playground 是一个仿 Google OAuth 2.0 Playground 的开源版 OAuth2.0 Playground

支持本地开箱即用，适合 OAuth2.0 的学习者测试学习 OAuth2.0 协议。

当运用于服务端部署时，也非常适合与 OAuth2 的接口文档配合同步发布，方便第三方调用者快速的开发调试。

English | 中文

• Open-OAuth2Playground
  • 安装运行
    • 二进制直接运行
      • Linux
      • Windows
    • systemctl 托管
    • 编译打包
      • 后端编译
      • 前端编译
      • 统一打包
    • 配置
      • 后端配置
        • 后端配置说明
      • 前端配置
        • 前端配置说明
        • 前端部署
        • 定制化前端菜单
    • API
    • 鸣谢

安装运行

二进制直接运行

Linux

在 release 中下载最新的 [release] 包，解压后直接运行即可。

mkdir Open-OAuth2Playground
cd Open-OAuth2Playground/
wget https://github.com/ECNU/Open-OAuth2Playground/releases/download/v0.1.1/Open-OAuth2Playground-linux-0.1.1.tar.gz
tar -zxvf Open-OAuth2Playground-0.1.1-linux-amd64.tar.gz
./control start

访问你服务器的 80 端口即可使用。

Windows

如果只需要在 Windows 上运行测试，可以直接下载 [release] 中的 Open-OAuth2Playground-windows-0.1.1.zip，解压后运行 Open-OAuth2Playground.exe 即可。

systemctl 托管

假定部署在 /opt/Open-OAuth2Playground 目录下，如果部署在其他目录修改 playground.service 中的 WorkingDirectory 和 ExecStart 两个字段即可。

cp playground.service /etc/systemd/system/
systemctl daemon-reload
systemctl enable playground
systemctl start playground

编译打包

获取项目源码

git clone https://github.com/ECNU/Open-OAuth2Playground.git

后端编译

cd Open-OAuth2Playground/
go mod tidy
go build

前端编译

cd front-standalone/
pnpm install
pnpm build

统一打包

cd ..
chmod +x control
./control pack

配置

后端配置

参考 cfg.json.example, 创建 cfg.jon 配置文件，修改配置即可

{
	"logger": {
		"dir": "logs/",
		"level": "DEBUG",
		"keepHours": 24
	},
	"endpoints": {
		"authorization": "http://cas.example.org/cas/oauth2.0/authorize",
		"token": "http://cas.example.org/cas/oauth2.0/accessToken",
		"userinfo": "http://cas.example.org/cas/oauth2.0/profile"
	},
	"iplimit": {
		"enable": false,
		"trust_ip": ["127.0.0.1","::1"]
	},
	"http": {
		"route_base":"/",
		"trust_proxy": ["127.0.0.1", "::1"],
		"cors": ["http://127.0.0.1:8080","http://localhost:8080"],
		"listen": "0.0.0.0:80"
	},
	"trust_domain": ["cas.example.org", "localhost"],
	"default_scope": "Basic",
	"timeout": 10
}

前端配置

修改 .env.production

# Router path
VUE_APP_ROUTER_BASE=/
# Api Config
VUE_APP_API_PROTO=http
VUE_APP_API_HOST=localhost
VUE_APP_API_PORT=
VUE_APP_API_VERSION=v1

项目的前端部分可以独立部署单独发布，也可以由后端来发布。

默认由后端发布，此时前端的 VUE_APP_API_HOST,VUE_APP_API_PROTO, VUE_APP_API_PORT 等配置项可以忽略。此时编译打包后的前端代码应该部署相对后端二进制文件的 front-standalone/dist 目录下。

如果前端独立部署，则需要在编译时，配置好 VUE_APP_API_HOST,VUE_APP_API_PROTO, VUE_APP_API_PORT 等配置项，并确保前端的域名在后端的跨域列表内。

项目的菜单部分，对应 front-standalone/src/views/Layourt.vue 文件，可以根据需要修改 el-menu-item 的内容，然后编译打包即可。

API

todo

鸣谢

本项目受 Google 的 OAuth 2.0 Playground 启发

感谢 Google 提供的优秀的工具。