Safe Haskell	None
Language	Haskell2010

Network.OAuth.OAuth2

Contents

Authorization Requset
Token Request
OAuth'ed http client utilities

Description

A lightweight oauth2 Haskell binding. See Readme for more details

Synopsis

portLens :: Lens' Request Int
data OAuth2 = OAuth2 {
- oauth2ClientId :: Text
- oauth2ClientSecret :: Text
- oauth2AuthorizeEndpoint :: URIRef Absolute
- oauth2TokenEndpoint :: URIRef Absolute
- oauth2RedirectUri :: URIRef Absolute
}
data ClientAuthenticationMethod
newtype RefreshToken = RefreshToken {
- rtoken :: Text
}
data OAuth2Token = OAuth2Token {
- accessToken :: AccessToken
- refreshToken :: Maybe RefreshToken
- expiresIn :: Maybe Int
- tokenType :: Maybe Text
- idToken :: Maybe IdToken
- scope :: Maybe Text
- rawResponse :: Object
}
type PostBody = [(ByteString, ByteString)]
uriToRequest :: MonadThrow m => URI -> m Request
newtype ExchangeToken = ExchangeToken {
- extoken :: Text
}
newtype AccessToken = AccessToken {
- atoken :: Text
}
newtype IdToken = IdToken {
- idtoken :: Text
}
type QueryParams = [(ByteString, ByteString)]
defaultRequestHeaders :: [(HeaderName, ByteString)]
appendQueryParams :: [(ByteString, ByteString)] -> URIRef a -> URIRef a
hostLens :: Lens' Request ByteString
requestToUri :: Request -> URI
authorizationUrl :: OAuth2 -> URI
authorizationUrlWithParams :: QueryParams -> OAuth2 -> URI
module Network.OAuth.OAuth2.TokenRequest
module Network.OAuth.OAuth2.HttpClient

Documentation

portLens :: Lens' Request Int Source #

data OAuth2 Source #

Query Parameter Representation

Constructors

OAuth2
Fields oauth2ClientId :: Text oauth2ClientSecret :: Text oauth2AuthorizeEndpoint :: URIRef Absolute oauth2TokenEndpoint :: URIRef Absolute oauth2RedirectUri :: URIRef Absolute

Instances

Instances details

Default OAuth2 Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods def :: OAuth2 #
Show OAuth2 Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2 -> ShowS # show :: OAuth2 -> String # showList :: [OAuth2] -> ShowS #
Eq OAuth2 Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2 -> OAuth2 -> Bool # (/=) :: OAuth2 -> OAuth2 -> Bool #

data ClientAuthenticationMethod Source #

How would the Client (RP) authenticate itself?

The client MUST NOT use more than one authentication method in each request. Means use Authorization header or Post body.

See more details

https://www.rfc-editor.org/rfc/rfc6749#section-2.3 https://oauth.net/private-key-jwt/ https://www.rfc-editor.org/rfc/rfc7523.html

Constructors

ClientSecretBasic
ClientSecretPost
ClientAssertionJwt

Instances

Instances details

Show ClientAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> ClientAuthenticationMethod -> ShowS # show :: ClientAuthenticationMethod -> String # showList :: [ClientAuthenticationMethod] -> ShowS #
Eq ClientAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool # (/=) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool #

newtype RefreshToken Source #

Constructors

RefreshToken
Fields rtoken :: Text

Instances

Instances details

FromJSON RefreshToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser RefreshToken # parseJSONList :: Value -> Parser [RefreshToken] # omittedField :: Maybe RefreshToken #
ToJSON RefreshToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: RefreshToken -> Value # toEncoding :: RefreshToken -> Encoding # toJSONList :: [RefreshToken] -> Value # toEncodingList :: [RefreshToken] -> Encoding # omitField :: RefreshToken -> Bool #
Show RefreshToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> RefreshToken -> ShowS # show :: RefreshToken -> String # showList :: [RefreshToken] -> ShowS #
Eq RefreshToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: RefreshToken -> RefreshToken -> Bool # (/=) :: RefreshToken -> RefreshToken -> Bool #
ToQueryParam RefreshToken Source #
Instance details Defined in Network.OAuth2.Experiment.Types Methods toQueryParam :: RefreshToken -> Map Text Text Source #

data OAuth2Token Source #

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.
scope :: Maybe Text
rawResponse :: Object

Instances

Instances details

FromJSON OAuth2Token Source #	Parse JSON data into `OAuth2Token`
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser OAuth2Token # parseJSONList :: Value -> Parser [OAuth2Token] # omittedField :: Maybe OAuth2Token #
ToJSON OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: OAuth2Token -> Value # toEncoding :: OAuth2Token -> Encoding # toJSONList :: [OAuth2Token] -> Value # toEncodingList :: [OAuth2Token] -> Encoding # omitField :: OAuth2Token -> Bool #
Binary OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: OAuth2Token -> Put # get :: Get OAuth2Token # putList :: [OAuth2Token] -> Put #
Show OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2Token -> ShowS # show :: OAuth2Token -> String # showList :: [OAuth2Token] -> ShowS #
Eq OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Token -> OAuth2Token -> Bool # (/=) :: OAuth2Token -> OAuth2Token -> Bool #

type PostBody = [(ByteString, ByteString)] Source #

Type synonym of post body content

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

newtype ExchangeToken Source #

Authorization Code

Constructors

ExchangeToken
Fields extoken :: Text

Instances

Instances details

FromJSON ExchangeToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser ExchangeToken # parseJSONList :: Value -> Parser [ExchangeToken] # omittedField :: Maybe ExchangeToken #
ToJSON ExchangeToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: ExchangeToken -> Value # toEncoding :: ExchangeToken -> Encoding # toJSONList :: [ExchangeToken] -> Value # toEncodingList :: [ExchangeToken] -> Encoding # omitField :: ExchangeToken -> Bool #
Show ExchangeToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> ExchangeToken -> ShowS # show :: ExchangeToken -> String # showList :: [ExchangeToken] -> ShowS #
ToQueryParam ExchangeToken Source #
Instance details Defined in Network.OAuth2.Experiment.Types Methods toQueryParam :: ExchangeToken -> Map Text Text Source #

newtype AccessToken Source #

Constructors

AccessToken
Fields atoken :: Text

Instances

Instances details

FromJSON AccessToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser AccessToken # parseJSONList :: Value -> Parser [AccessToken] # omittedField :: Maybe AccessToken #
ToJSON AccessToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: AccessToken -> Value # toEncoding :: AccessToken -> Encoding # toJSONList :: [AccessToken] -> Value # toEncodingList :: [AccessToken] -> Encoding # omitField :: AccessToken -> Bool #
Show AccessToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> AccessToken -> ShowS # show :: AccessToken -> String # showList :: [AccessToken] -> ShowS #
Eq AccessToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: AccessToken -> AccessToken -> Bool # (/=) :: AccessToken -> AccessToken -> Bool #

newtype IdToken Source #

Constructors

IdToken
Fields idtoken :: Text

Instances

Instances details

FromJSON IdToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser IdToken # parseJSONList :: Value -> Parser [IdToken] # omittedField :: Maybe IdToken #
ToJSON IdToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: IdToken -> Value # toEncoding :: IdToken -> Encoding # toJSONList :: [IdToken] -> Value # toEncodingList :: [IdToken] -> Encoding # omitField :: IdToken -> Bool #
Show IdToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> IdToken -> ShowS # show :: IdToken -> String # showList :: [IdToken] -> ShowS #
Eq IdToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: IdToken -> IdToken -> Bool # (/=) :: IdToken -> IdToken -> Bool #

type QueryParams = [(ByteString, ByteString)] Source #

Type sysnonym of request query params

defaultRequestHeaders :: [(HeaderName, ByteString)] Source #

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

hostLens :: Lens' Request ByteString Source #

requestToUri :: Request -> URI Source #

Authorization Requset

authorizationUrl :: OAuth2 -> URI Source #

See authorizationUrlWithParams

authorizationUrlWithParams :: QueryParams -> OAuth2 -> URI Source #

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