Plugin for the Credentials framework that authenticate using GitHub
Plugin for Kitura-Credentials framework that authenticates using the GitHub web login with OAuth2 API.
The latest version of Kitura-CredentialsGitHub requires Swift 4.0 or newer. You can download this version of the Swift binaries by following this link. Compatibility with other Swift versions is not guaranteed.
This guide assumes basic knowledge of Kitura
app routing.
First, set up the session middleware:
import KituraSession
router.all(middleware: Session(secret: "Very very secret..."))
Create an instance of CredentialsGitHub
plugin and register it with Credentials
framework:
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)
Where:
Kitura-CredentialsGitHub
is set as the User-Agent. User-Agent is required when invoking GitHub APIs.[String: Any]
); the allowable options are listed in CredentialsGitHubOptions
Next, specify where to redirect non-authenticated requests:
credentials.options["failureRedirect"] = "/login/github"
Connect credentials
middleware to handle requests to a protected path on the server, such as /private
:
router.all("/private", middleware: credentials)
router.get("/private/data", handler: { request, response, next in
...
next()
})
And call authenticate
to login with GitHub and to handle the redirect (callback) from the GitHub login web page after a successful login:
router.get("/login/github", handler: credentials.authenticate(gitCredentials.name))
router.get("/login/github/callback", handler: credentials.authenticate(gitCredentials.name))
This library is licensed under Apache 2.0. Full license text is available in LICENSE.
link |
Stars: 4 |
Last commit: 3 years ago |
Relax minor version constraint (#37) Support Swift 5 (#39)
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics