Kitura-CredentialsGitHub

使用 GitHub 进行身份验证的 Credentials 框架的插件

Kitura-Credentials 框架的插件，它使用 GitHub OAuth2 Web 登录 API 进行身份验证。

• Swift 版本
• GitHub Web 登录示例
• 许可证

最新版本的 Kitura-CredentialsGitHub 需要 Swift 4.0 或更高版本。 您可以按照此链接下载此版本的 Swift 二进制文件。 不保证与其他 Swift 版本的兼容性。

本指南假定您对 Kitura 应用程序路由有基本的了解。

首先，设置会话中间件

import KituraSession

router.all(middleware: Session(secret: "Very very secret..."))

创建 CredentialsGitHub 插件的实例，并将其注册到 Credentials 框架

import Credentials
import CredentialsGitHub

let credentials = Credentials()
let gitCredentials = CredentialsGitHub(clientId: gitClientId, clientSecret: gitClientSecret, callbackUrl: serverUrl + "/login/github/callback", userAgent: "my-kitura-app", options: ["scopes": ["user:email"]])
credentials.register(gitCredentials)

其中

• gitClientId 是您的应用程序在 GitHub 开发者应用程序设置中的客户端 ID
• gitClientSecret 是您的应用程序在 GitHub 开发者应用程序设置中的客户端密钥
• callbackUrl 用于告知 GitHub Web 登录页面，当用户成功登录后，用户的浏览器应重定向到哪里。 它应该是您正在编写的服务器处理的 URL。
• userAgent 是一个可选参数，它在针对 GitHub 的 API 调用中传递您选择的 User-Agent。 默认情况下，Kitura-CredentialsGitHub 设置为 User-Agent。 调用 GitHub API 时需要 User-Agent。
• options 是一个可选字典 ([String: Any])；允许的选项在 CredentialsGitHubOptions 中列出

接下来，指定将未经身份验证的请求重定向到哪里

credentials.options["failureRedirect"] = "/login/github"

连接 credentials 中间件以处理对服务器上的受保护路径的请求，例如 /private

router.all("/private", middleware: credentials)
router.get("/private/data", handler: { request, response, next in
  ...  
  next()
})

并调用 authenticate 以使用 GitHub 登录并处理成功登录后从 GitHub 登录网页的重定向（回调）

router.get("/login/github", handler: credentials.authenticate(gitCredentials.name))

router.get("/login/github/callback", handler: credentials.authenticate(gitCredentials.name))

此库在 Apache 2.0 许可证下获得许可。 完整的许可证文本可在 LICENSE 中找到。