yesod-auth-oauth2 alternatives and similar packages
Based on the "yesod" category.
Alternatively, view yesod-auth-oauth2 alternatives based on common mentions on social networks and blogs.
-
yesod-persistent
Some helpers for using Persistent from Yesod. -
yesod-markdown
Tools for using markdown in a yesod application -
yesod-recaptcha
Dead simple support for reCAPTCHA on Yesod applications. -
yesod-auth-fb
Authentication backend for Yesod using Facebook. -
yesod-text-markdown
Yesod support for Text.Markdown. -
yesod-routes-typescript
generate TypeScript routes for Yesod -
yesod-session-redis
Redis-Powered Sessions for Haskell -
yesod-comments
A generic comments interface for a Yesod application -
yesod-goodies
A collection of various small helpers useful in any yesod application. -
yesod-auth-account-fork
An account authentication plugin for Yesod -
yesod-crud-persist
Flexible CRUD subsite usable with Yesod and Persistent. -
yesod-auth-kerberos
Kerberos Authentication for Yesod. -
yesod-auth-smbclient
Authentication plugin for Yesod using smbclient -
yesod-auth-bcrypt
BCrypt salted and hashed passwords in a database as auth for yesod -
yesod-auth-deskcom
Desk.com remote authentication support for Yesod apps. -
yesod-datatables
Yesod plugin for DataTables (jQuery grid plugin) -
yesod-auth-ldap-native
Yesod LDAP authentication plugin -
yesod-auth-zendesk
Zendesk remote authentication support for Yesod apps. -
yesod-auth-hmac-keccak
An account authentication plugin for yesod with encrypted token transfer. -
yesod-paypal-rest
Yesod plugin to use PayPal with the paypal-rest-client library. -
yesod-pnotify
Yet another getMessage/setMessage using pnotify jquery plugins -
yesod-test-json
Utility functions for testing JSON web services written in Yesod -
yesod-auth-bcryptdb
Authentication plugin for Yesod. -
yesod-articles
Automatically generate article previews for a yesod site -
yesod-s3
Simple Helper Library for using Amazon's Simple Storage Service (S3) with Yesod
Get performance insights in less than 4 minutes
Do you think we are missing an alternative of yesod-auth-oauth2 or a related project?
README
Yesod.Auth.OAuth2
OAuth2 AuthPlugin
s 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
{ oauthClientId = clientId
, oauthClientSecret = Just clientSecret
, oauthOAuthorizeEndpoint = "https://mysite.com/oauth/authorize"
, oauthAccessTokenEndpoint = "https://mysite.com/oauth/token"
, oauthCallback = 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.
[CHANGELOG](./CHANGELOG.md) | [LICENSE](./LICENSE)
*Note that all licence references and agreements mentioned in the yesod-auth-oauth2 README section above
are relevant to that project's source code only.