Yesod.Auth.OAuth2

Generic OAuth2 plugin for Yesod

See Yesod.Auth.OAuth2.GitHub for example usage.

Documentation

data OAuth2

Constructors

OAuth2

Fields

• oauth2ClientId :: Text
• oauth2ClientSecret :: Maybe Text
• oauth2AuthorizeEndpoint :: URIRef Absolute
• oauth2TokenEndpoint :: URIRef Absolute
• oauth2RedirectUri :: Maybe (URIRef Absolute)

type FetchCreds m = Manager -> OAuth2Token -> IO (Creds m)

How to take an OAuth2Token and retrieve user credentials

data Manager

Keeps track of open connections for keep-alive.

If possible, you should share a single Manager between multiple threads and requests.

Since 0.1.0

Instances

HasHttpManager Manager

Defined in Network.HTTP.Client.Types

Methods

getHttpManager :: Manager -> Manager

data OAuth2Token

The gained Access Token. Use Data.Aeson.decode to decode string to AccessToken. The refreshToken is special in some cases, e.g. https://developers.google.com/accounts/docs/OAuth2

Constructors

OAuth2Token

Fields

• accessToken :: AccessToken
• refreshToken :: Maybe RefreshToken
• expiresIn :: Maybe Int
• tokenType :: Maybe Text
• idToken :: Maybe IdToken

Instances

FromJSON OAuth2Token

Parse JSON data into OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

parseJSON :: Value -> Parser OAuth2Token

parseJSONList :: Value -> Parser [OAuth2Token]

ToJSON OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

toJSON :: OAuth2Token -> Value

toEncoding :: OAuth2Token -> Encoding

toJSONList :: [OAuth2Token] -> Value

toEncodingList :: [OAuth2Token] -> Encoding

Generic OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Associated Types

type Rep OAuth2Token :: Type -> Type

Methods

from :: OAuth2Token -> Rep OAuth2Token x

to :: Rep OAuth2Token x -> OAuth2Token

Show OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

showsPrec :: Int -> OAuth2Token -> ShowS

show :: OAuth2Token -> String

showList :: [OAuth2Token] -> ShowS

Binary OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

put :: OAuth2Token -> Put

get :: Get OAuth2Token

putList :: [OAuth2Token] -> Put

Eq OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

(==) :: OAuth2Token -> OAuth2Token -> Bool

(/=) :: OAuth2Token -> OAuth2Token -> Bool

type Rep OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

type Rep OAuth2Token = D1 ('MetaData "OAuth2Token" "Network.OAuth.OAuth2.Internal" "hoauth2-2.5.0-CyjZDD1s05h9ajPsddKh1H" 'False) (C1 ('MetaCons "OAuth2Token" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccessToken) :*: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RefreshToken))) :*: (S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "idToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe IdToken))))))

data Creds master

User credentials

Constructors

Creds

Fields

• credsPlugin :: Text

  How the user was authenticated

• credsIdent :: Text

  Identifier. Exact meaning depends on plugin.

• credsExtra :: [(Text, Text)]

Instances

Show (Creds master)

Defined in Yesod.Auth

Methods

showsPrec :: Int -> Creds master -> ShowS

show :: Creds master -> String

showList :: [Creds master] -> ShowS

oauth2Url :: Text -> AuthRoute

authOAuth2 :: YesodAuth m => Text -> OAuth2 -> FetchCreds m -> AuthPlugin m

Create an AuthPlugin for the given OAuth2 provider

Presents a generic "Login via #{name}" link

authOAuth2Widget :: YesodAuth m => WidgetFor m () -> Text -> OAuth2 -> FetchCreds m -> AuthPlugin m

Create an AuthPlugin for the given OAuth2 provider

Allows passing a custom widget for the login link. See oauth2Eve for an example.

Alternatives that use fetchAccessToken2

authOAuth2' :: YesodAuth m => Text -> OAuth2 -> FetchCreds m -> AuthPlugin m

A version of authOAuth2 that uses fetchAccessToken2

See https://github.com/thoughtbot/yesod-auth-oauth2/pull/129

authOAuth2Widget' :: YesodAuth m => WidgetFor m () -> Text -> OAuth2 -> FetchCreds m -> AuthPlugin m

A version of authOAuth2Widget that uses fetchAccessToken2

See https://github.com/thoughtbot/yesod-auth-oauth2/pull/129

Reading our credsExtra keys

getAccessToken :: Creds m -> Maybe AccessToken

Read the AccessToken from the values set via setExtra

getRefreshToken :: Creds m -> Maybe RefreshToken

Read the RefreshToken from the values set via setExtra

N.B. not all providers supply this value.

getUserResponse :: Creds m -> Maybe ByteString

Read the original profile response from the values set via setExtra

getUserResponseJSON :: FromJSON a => Creds m -> Either String a

getUserResponse, and decode as JSON