Network.OAuth.OAuth2

A lightweight oauth2 Haskell binding. See Readme for more details

OAuth2 Configuration

data OAuth2

Query Parameter Representation

Constructors

OAuth2

Fields

• oauth2ClientId :: Text
• oauth2ClientSecret :: Text
• oauth2AuthorizeEndpoint :: URIRef Absolute
• oauth2TokenEndpoint :: URIRef Absolute
• oauth2RedirectUri :: URIRef Absolute

Instances

Show OAuth2

Defined in Network.OAuth.OAuth2.Internal

Methods

showsPrec :: Int -> OAuth2 -> ShowS

show :: OAuth2 -> String

showList :: [OAuth2] -> ShowS

Default OAuth2

Defined in Network.OAuth.OAuth2.Internal

Methods

def :: OAuth2

Eq OAuth2

Defined in Network.OAuth.OAuth2.Internal

Methods

(==) :: OAuth2 -> OAuth2 -> Bool

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

Tokens

newtype AccessToken

Constructors

AccessToken

Fields

• atoken :: Text

Instances

FromJSON AccessToken

Defined in Network.OAuth.OAuth2.Internal

Methods

parseJSON :: Value -> Parser AccessToken

parseJSONList :: Value -> Parser [AccessToken]

omittedField :: Maybe AccessToken

ToJSON AccessToken

Defined in Network.OAuth.OAuth2.Internal

Methods

toJSON :: AccessToken -> Value

toEncoding :: AccessToken -> Encoding

toJSONList :: [AccessToken] -> Value

toEncodingList :: [AccessToken] -> Encoding

omitField :: AccessToken -> Bool

Show AccessToken

Defined in Network.OAuth.OAuth2.Internal

Methods

showsPrec :: Int -> AccessToken -> ShowS

show :: AccessToken -> String

showList :: [AccessToken] -> ShowS

Binary AccessToken

Defined in Network.OAuth.OAuth2.Internal

Methods

put :: AccessToken -> Put

get :: Get AccessToken

putList :: [AccessToken] -> Put

Eq AccessToken

Defined in Network.OAuth.OAuth2.Internal

Methods

(==) :: AccessToken -> AccessToken -> Bool

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

newtype RefreshToken

Constructors

RefreshToken

Fields

• rtoken :: Text

Instances

FromJSON RefreshToken

Defined in Network.OAuth.OAuth2.Internal

Methods

parseJSON :: Value -> Parser RefreshToken

parseJSONList :: Value -> Parser [RefreshToken]

omittedField :: Maybe RefreshToken

ToJSON RefreshToken

Defined in Network.OAuth.OAuth2.Internal

Methods

toJSON :: RefreshToken -> Value

toEncoding :: RefreshToken -> Encoding

toJSONList :: [RefreshToken] -> Value

toEncodingList :: [RefreshToken] -> Encoding

omitField :: RefreshToken -> Bool

Show RefreshToken

Defined in Network.OAuth.OAuth2.Internal

Methods

showsPrec :: Int -> RefreshToken -> ShowS

show :: RefreshToken -> String

showList :: [RefreshToken] -> ShowS

Binary RefreshToken

Defined in Network.OAuth.OAuth2.Internal

Methods

put :: RefreshToken -> Put

get :: Get RefreshToken

putList :: [RefreshToken] -> Put

Eq RefreshToken

Defined in Network.OAuth.OAuth2.Internal

Methods

(==) :: RefreshToken -> RefreshToken -> Bool

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

ToQueryParam RefreshToken

Defined in Network.OAuth2.Experiment.Types

Methods

toQueryParam :: RefreshToken -> Map Text Text

newtype IdToken

Constructors

IdToken

Fields

• idtoken :: Text

Instances

FromJSON IdToken

Defined in Network.OAuth.OAuth2.Internal

Methods

parseJSON :: Value -> Parser IdToken

parseJSONList :: Value -> Parser [IdToken]

omittedField :: Maybe IdToken

ToJSON IdToken

Defined in Network.OAuth.OAuth2.Internal

Methods

toJSON :: IdToken -> Value

toEncoding :: IdToken -> Encoding

toJSONList :: [IdToken] -> Value

toEncodingList :: [IdToken] -> Encoding

omitField :: IdToken -> Bool

Show IdToken

Defined in Network.OAuth.OAuth2.Internal

Methods

showsPrec :: Int -> IdToken -> ShowS

show :: IdToken -> String

showList :: [IdToken] -> ShowS

Binary IdToken

Defined in Network.OAuth.OAuth2.Internal

Methods

put :: IdToken -> Put

get :: Get IdToken

putList :: [IdToken] -> Put

Eq IdToken

Defined in Network.OAuth.OAuth2.Internal

Methods

(==) :: IdToken -> IdToken -> Bool

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

newtype ExchangeToken

Authorization Code

Constructors

ExchangeToken

Fields

• extoken :: Text

Instances

FromJSON ExchangeToken

Defined in Network.OAuth.OAuth2.Internal

Methods

parseJSON :: Value -> Parser ExchangeToken

parseJSONList :: Value -> Parser [ExchangeToken]

omittedField :: Maybe ExchangeToken

ToJSON ExchangeToken

Defined in Network.OAuth.OAuth2.Internal

Methods

toJSON :: ExchangeToken -> Value

toEncoding :: ExchangeToken -> Encoding

toJSONList :: [ExchangeToken] -> Value

toEncodingList :: [ExchangeToken] -> Encoding

omitField :: ExchangeToken -> Bool

Show ExchangeToken

Defined in Network.OAuth.OAuth2.Internal

Methods

showsPrec :: Int -> ExchangeToken -> ShowS

show :: ExchangeToken -> String

showList :: [ExchangeToken] -> ShowS

ToQueryParam ExchangeToken

Defined in Network.OAuth2.Experiment.Types

Methods

toQueryParam :: ExchangeToken -> Map Text Text

data OAuth2Token

https://www.rfc-editor.org/rfc/rfc6749#section-4.1.4

Constructors

OAuth2Token

Fields

• accessToken :: AccessToken
• refreshToken :: Maybe RefreshToken

  Exists when offline_access scope is in the Authorization Request and the provider supports Refresh Access Token.

• expiresIn :: Maybe Int
• tokenType :: Maybe Text

  See https://www.rfc-editor.org/rfc/rfc6749#section-5.1. It's required per spec. But OAuth2 provider implementation are vary. Maybe will remove Maybe in future release.

• idToken :: Maybe IdToken

  Exists when openid scope is in the Authorization Request and the provider supports OpenID protocol.

Instances

FromJSON OAuth2Token

Parse JSON data into OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

parseJSON :: Value -> Parser OAuth2Token

parseJSONList :: Value -> Parser [OAuth2Token]

omittedField :: Maybe OAuth2Token

ToJSON OAuth2Token

Defined in Network.OAuth.OAuth2.Internal

Methods

toJSON :: OAuth2Token -> Value

toEncoding :: OAuth2Token -> Encoding

toJSONList :: [OAuth2Token] -> Value

toEncodingList :: [OAuth2Token] -> Encoding

omitField :: OAuth2Token -> Bool

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.14.1-Fx0swksAMJ84ZO9pAUaUZM" '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))))))

Client Authentication methods

data ClientAuthenticationMethod

https://www.rfc-editor.org/rfc/rfc6749#section-2.3 According to spec:

The client MUST NOT use more than one authentication method in each request.

Which means use Authorization header or Post body.

However, I found I have to include authentication in the header all the time in real world.

In other words, ClientSecretBasic is always assured. ClientSecretPost is optional.

Maybe consider an alternative implementation that boolean kind of data type is good enough.

Constructors

ClientSecretBasic

ClientSecretPost

ClientAssertionJwt

Instances

Eq ClientAuthenticationMethod

Defined in Network.OAuth.OAuth2.Internal

Methods

(==) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool

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

Utilies for Request and URI

type PostBody = [(ByteString, ByteString)]

Type synonym of post body content

type QueryParams = [(ByteString, ByteString)]

Type sysnonym of request query params

defaultRequestHeaders :: [(HeaderName, ByteString)]

appendQueryParams :: [(ByteString, ByteString)] -> URIRef a -> URIRef a

uriToRequest :: MonadThrow m => URI -> m Request

requestToUri :: Request -> URI

hostLens :: Lens' Request ByteString

portLens :: Lens' Request Int

Authorization Requset

authorizationUrl :: OAuth2 -> URI

See authorizationUrlWithParams

authorizationUrlWithParams :: QueryParams -> OAuth2 -> URI

Prepare the authorization URL. Redirect to this URL asking for user interactive authentication.

Since: 2.6.0

Token Request

module Network.OAuth.OAuth2.TokenRequest

OAuth'ed http client utilities

module Network.OAuth.OAuth2.HttpClient