yesod-auth-oauth2
OAuth 2.0 authentication plugins
http://github.com/freckle/yesod-auth-oauth2
| LTS Haskell 22.39: | 0.7.2.0 |
| Stackage Nightly 2024-10-31: | 0.7.3.0 |
| Latest on Hackage: | 0.7.3.0 |
yesod-auth-oauth2-0.7.3.0@sha256:3bf6417dc2447999efd4c24ebcb5f48c12c5471897f641af198d6f87031e8ce9,3471Module documentation for 0.7.3.0
- Network
- Network.OAuth
- Network.OAuth.OAuth2
- Network.OAuth
- URI
- URI.ByteString
- UnliftIO
- Yesod
- Yesod.Auth
- Yesod.Auth.OAuth2
- Yesod.Auth.OAuth2.Auth0
- Yesod.Auth.OAuth2.AzureAD
- Yesod.Auth.OAuth2.AzureADv2
- Yesod.Auth.OAuth2.BattleNet
- Yesod.Auth.OAuth2.Bitbucket
- Yesod.Auth.OAuth2.ClassLink
- Yesod.Auth.OAuth2.Dispatch
- Yesod.Auth.OAuth2.DispatchError
- Yesod.Auth.OAuth2.ErrorResponse
- Yesod.Auth.OAuth2.EveOnline
- Yesod.Auth.OAuth2.Exception
- Yesod.Auth.OAuth2.GitHub
- Yesod.Auth.OAuth2.GitLab
- Yesod.Auth.OAuth2.Google
- Yesod.Auth.OAuth2.Nylas
- Yesod.Auth.OAuth2.ORCID
- Yesod.Auth.OAuth2.Prelude
- Yesod.Auth.OAuth2.Random
- Yesod.Auth.OAuth2.Salesforce
- Yesod.Auth.OAuth2.Slack
- Yesod.Auth.OAuth2.Spotify
- Yesod.Auth.OAuth2.Twitch
- Yesod.Auth.OAuth2.Upcase
- Yesod.Auth.OAuth2.WordPressDotCom
- Yesod.Auth.OAuth2
- Yesod.Auth
Yesod.Auth.OAuth2
OAuth2 AuthPlugins for Yesod.
Usage
import Yesod.Auth
import Yesod.Auth.OAuth2.GitHub
instance YesodAuth App where
-- ...
authPlugins _ = [oauth2GitHub clientId clientSecret]
clientId :: Text
clientId = "..."
clientSecret :: Text
clientSecret = "..."
Some plugins, such as GitHub and Slack, have scoped functions for requesting additional information:
oauth2SlackScoped [SlackBasicScope, SlackEmailScope] clientId clientSecret
Working with Extra Data
We put the minimal amount of user data possible in credsExtra – just enough
to support you parsing or fetching additional data yourself.
For example, if you work with GitHub and GitHub user profiles, you likely
already have a model and a way to parse the /user response. Rather than
duplicate all that in our library, we try to make it easy for you to re-use that
code yourself:
authenticate creds = do
let
-- You can run your own FromJSON parser on the response we already have
eGitHubUser :: Either String GitHubUser
eGitHubUser = getUserResponseJSON creds
-- Avert your eyes, simplified example
Just accessToken = getAccessToken creds
Right githubUser = eGitHubUser
-- Or make followup requests using our access token
runGitHub accessToken $ userRepositories githubUser
-- Or store it for later
insert User
{ userIdent = credsIdent creds
, userAccessToken = accessToken
}
NOTE: Avoid looking up values in credsExtra yourself; prefer the provided
get functions. The data representation itself is no longer considered public
API.
Local Providers
If we don’t supply a “Provider” (e.g. GitHub, Google, etc) you need, you can
write your own using our provided Prelude:
import Yesod.Auth.OAuth2.Prelude
pluginName :: Text
pluginName = "mysite"
oauth2MySite :: YesodAuth m => Text -> Text -> AuthPlugin m
oauth2MySite clientId clientSecret =
authOAuth2 pluginName oauth2 $ \manager token -> do
-- Fetch a profile using the manager and token, leave it a ByteString
userResponse <- -- ...
-- Parse it to your preferred identifier, e.g. with Data.Aeson
userId <- -- ...
-- See authGetProfile for the typical case
pure Creds
{ credsPlugin = pluginName
, credsIdent = userId
, credsExtra = setExtra token userResponse
}
where
oauth2 = OAuth2
{ oauth2ClientId = clientId
, oauth2ClientSecret = Just clientSecret
, oauth2AuthorizeEndpoint = "https://mysite.com/oauth/authorize"
, oauth2TokenEndpoint = "https://mysite.com/oauth/token"
, oauth2RedirectUri = Nothing
}
The Prelude module is considered public API, though we may build something
higher-level that is more convenient for this use-case in the future.
Development & Tests
stack setup
stack build --dependencies-only
stack build --pedantic --test
Please also run HLint and Weeder before submitting PRs.
Example
This project includes an executable that runs a server with (almost) all supported providers present.
To use:
-
cp .env.example .envand edit in secrets for providers you wish to testBe sure to include
http://localhost:3000/auth/page/{plugin}/callbackas a valid Redirect URI when configuring the OAuth application. -
Build with the example:
stack build ... --flag yesod-auth-oauth2:example -
Run the example
stack exec yesod-auth-oauth2-example -
Visit the example:
$BROWSER http://localhost:3000 -
Click the log-in link for the provider you configured
If successful, you will be presented with a page that shows the credential and User response value.