groundservices/oauth2-service

基于 Laravel 框架构建的 OAuth2 微服务

v1.1.2 2020-10-19 21:59 UTC

This package is auto-updated.

Last update: 2024-09-22 04:52:59 UTC


README


Build Status quality gate status quality gate status quality gate status GitHub Packagist Version

简介

groundservices OAuth2 是一个功能强大且可定制的基于 Laravel 框架的认证微服务。我们相信微服务的开发可以是有趣的,并且绝对不应该浪费时间。Groundservices OAuth2 服务通过搭建认证服务的基本组件来减轻认证开发中的痛苦,同时为额外功能留下定制空间。

设置指南

要求

安装

  1. 安装 OAuth2 项目
composer create-project groundservices/OAuth2 <project-name>
  1. 运行 composer install && composer update 命令以安装和更新依赖项
  2. 迁移数据库
php artisan migrate
  1. 创建生成安全访问令牌所需的加密密钥。此外,该命令还将创建用于生成访问令牌的 "个人访问" 和 "密码授权" 客户端
php artisan passport:install

-可选:如果您希望使用 UUID 而不是自增值。

php artisan passport:install --uuids
  1. 将个人访问客户端 ID 和密钥值添加到您的 .env 文件中(您可以在运行 STEP 4 中的命令后在终端中找到它们。您也可以在数据库中找到它们)
PASSPORT_PERSONAL_ACCESS_CLIENT_ID=client-id-value
PASSPORT_PERSONAL_ACCESS_CLIENT_SECRET=unhashed-client-secret-value

用法

OAuth2 服务通过从分离的前端(可能位于同一域名或完全不同的域名)对该服务进行 API 调用来使用。以下是与 OAuth2 服务交互的可用端点。请注意,强烈建议通过 API 网关而不是直接从前端应用程序发送请求。

  • 注册:/api/register
  • 登录:/api/login
  • 注销:/api/logout
  • 使用 GitHub 登录:/api/login/github

安全漏洞

如果您在 Groundservices 中发现安全漏洞,请通过 mcjohnsonlyndon@gmail.com 发送电子邮件给 Taylor Otwell。所有安全漏洞都将得到及时解决。

许可证

OAuth2 服务是开源软件,许可协议为 MIT 许可协议