Safe Haskell	None
Language	Haskell2010

Network.OAuth.OAuth2.Internal

Contents

Data Types
Types Synonym
Utilies

Description

A simple OAuth2 Haskell binding. (This is supposed to be independent of the http client used.)

Synopsis

data OAuth2 = OAuth2 {
- oauth2ClientId :: Text
- oauth2ClientSecret :: Text
- oauth2AuthorizeEndpoint :: URIRef Absolute
- oauth2TokenEndpoint :: URIRef Absolute
- oauth2RedirectUri :: URIRef Absolute
}
newtype AccessToken = AccessToken {
- atoken :: Text
}
newtype RefreshToken = RefreshToken {
- rtoken :: Text
}
newtype IdToken = IdToken {
- idtoken :: Text
}
newtype ExchangeToken = ExchangeToken {
- extoken :: Text
}
data OAuth2Token = OAuth2Token {
- accessToken :: AccessToken
- refreshToken :: Maybe RefreshToken
- expiresIn :: Maybe Int
- tokenType :: Maybe Text
- idToken :: Maybe IdToken
}
parseIntFlexible :: Value -> Parser Int
data OAuth2Error a = OAuth2Error {
- error :: Either Text a
- errorDescription :: Maybe Text
- errorUri :: Maybe (URIRef Absolute)
}
parseOAuth2Error :: FromJSON err => ByteString -> OAuth2Error err
mkDecodeOAuth2Error :: ByteString -> String -> OAuth2Error err
data APIAuthenticationMethod
- = AuthInRequestHeader
- | AuthInRequestBody
- | AuthInRequestQuery
data ClientAuthenticationMethod
- = ClientSecretBasic
- | ClientSecretPost
type PostBody = [(ByteString, ByteString)]
type QueryParams = [(ByteString, ByteString)]
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

Data Types

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

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

newtype AccessToken Source #

Constructors

AccessToken
Fields atoken :: Text

Instances

Instances details

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

newtype RefreshToken Source #

Constructors

RefreshToken
Fields rtoken :: Text

Instances

Instances details

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

newtype IdToken Source #

Constructors

IdToken
Fields idtoken :: Text

Instances

Instances details

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

newtype ExchangeToken Source #

Constructors

ExchangeToken
Fields extoken :: Text

Instances

Instances details

Show ExchangeToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> ExchangeToken -> ShowS # show :: ExchangeToken -> String # showList :: [ExchangeToken] -> ShowS #
ToJSON ExchangeToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: ExchangeToken -> Value # toEncoding :: ExchangeToken -> Encoding # toJSONList :: [ExchangeToken] -> Value # toEncodingList :: [ExchangeToken] -> Encoding #
FromJSON ExchangeToken Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser ExchangeToken # parseJSONList :: Value -> Parser [ExchangeToken] #

data OAuth2Token Source #

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

Instances details

Eq OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Token -> OAuth2Token -> Bool # (/=) :: OAuth2Token -> OAuth2Token -> Bool #
Show OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2Token -> ShowS # show :: OAuth2Token -> String # showList :: [OAuth2Token] -> ShowS #
Generic OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Associated Types type Rep OAuth2Token :: Type -> Type # Methods from :: OAuth2Token -> Rep OAuth2Token x # to :: Rep OAuth2Token x -> 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 #
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] #
Binary OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: OAuth2Token -> Put # get :: Get OAuth2Token # putList :: [OAuth2Token] -> Put #
type Rep OAuth2Token Source #
Instance details Defined in Network.OAuth.OAuth2.Internal type Rep OAuth2Token = D1 ('MetaData "OAuth2Token" "Network.OAuth.OAuth2.Internal" "hoauth2-2.4.0-D3H2H2D9un18t2jhuBxW56" '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))))))

parseIntFlexible :: Value -> Parser Int Source #

data OAuth2Error a Source #

Constructors

OAuth2Error
Fields error :: Either Text a errorDescription :: Maybe Text errorUri :: Maybe (URIRef Absolute)

Instances

Instances details

Eq a => Eq (OAuth2Error a) Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Error a -> OAuth2Error a -> Bool # (/=) :: OAuth2Error a -> OAuth2Error a -> Bool #
Show a => Show (OAuth2Error a) Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2Error a -> ShowS # show :: OAuth2Error a -> String # showList :: [OAuth2Error a] -> ShowS #
Generic (OAuth2Error a) Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Associated Types type Rep (OAuth2Error a) :: Type -> Type # Methods from :: OAuth2Error a -> Rep (OAuth2Error a) x # to :: Rep (OAuth2Error a) x -> OAuth2Error a #
ToJSON err => ToJSON (OAuth2Error err) Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: OAuth2Error err -> Value # toEncoding :: OAuth2Error err -> Encoding # toJSONList :: [OAuth2Error err] -> Value # toEncodingList :: [OAuth2Error err] -> Encoding #
FromJSON err => FromJSON (OAuth2Error err) Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser (OAuth2Error err) # parseJSONList :: Value -> Parser [OAuth2Error err] #
type Rep (OAuth2Error a) Source #
Instance details Defined in Network.OAuth.OAuth2.Internal type Rep (OAuth2Error a) = D1 ('MetaData "OAuth2Error" "Network.OAuth.OAuth2.Internal" "hoauth2-2.4.0-D3H2H2D9un18t2jhuBxW56" 'False) (C1 ('MetaCons "OAuth2Error" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either Text a)) :: (S1 ('MetaSel ('Just "errorDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "errorUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (URIRef Absolute))))))

parseOAuth2Error :: FromJSON err => ByteString -> OAuth2Error err Source #

mkDecodeOAuth2Error :: ByteString -> String -> OAuth2Error err Source #

data APIAuthenticationMethod Source #

Constructors

AuthInRequestHeader	Provides in Authorization header
AuthInRequestBody	Provides in request body
AuthInRequestQuery	Provides in request query parameter

Instances

Instances details

Eq APIAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (/=) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool #
Ord APIAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods compare :: APIAuthenticationMethod -> APIAuthenticationMethod -> Ordering # (<) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (<=) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (>) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # (>=) :: APIAuthenticationMethod -> APIAuthenticationMethod -> Bool # max :: APIAuthenticationMethod -> APIAuthenticationMethod -> APIAuthenticationMethod # min :: APIAuthenticationMethod -> APIAuthenticationMethod -> APIAuthenticationMethod #

data ClientAuthenticationMethod Source #

Constructors

ClientSecretBasic
ClientSecretPost

Instances

Instances details

Eq ClientAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool # (/=) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool #
Ord ClientAuthenticationMethod Source #
Instance details Defined in Network.OAuth.OAuth2.Internal Methods compare :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Ordering # (<) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool # (<=) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool # (>) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool # (>=) :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> Bool # max :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> ClientAuthenticationMethod # min :: ClientAuthenticationMethod -> ClientAuthenticationMethod -> ClientAuthenticationMethod #

Types Synonym

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

type synonym of post body content

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

Utilies

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

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

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

requestToUri :: Request -> URI Source #

hostLens :: Lens' Request ByteString Source #

portLens :: Lens' Request Int Source #