Safe Haskell	None
Language	Haskell2010

Network.OAuth.OAuth2.Compat

Synopsis

data OAuth2 = OAuth2 {
- oauth2ClientId :: Text
- oauth2ClientSecret :: Maybe Text
- oauth2AuthorizeEndpoint :: URIRef Absolute
- oauth2TokenEndpoint :: URIRef Absolute
- oauth2RedirectUri :: Maybe (URIRef Absolute)
}
authorizationUrl :: OAuth2 -> URI
fetchAccessToken :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token)
fetchAccessToken2 :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token)
authRequest :: Request -> (Request -> Request) -> Manager -> IO (Either ByteString ByteString)
authPostBS3 :: Manager -> AccessToken -> URI -> IO (Either ByteString ByteString)
authPostBS2 :: Manager -> AccessToken -> URI -> PostBody -> IO (Either ByteString ByteString)
authPostBS :: Manager -> AccessToken -> URI -> PostBody -> IO (Either ByteString ByteString)
authPostJSON :: FromJSON b => Manager -> AccessToken -> URI -> PostBody -> IO (Either ByteString b)
authGetBS2 :: Manager -> AccessToken -> URI -> IO (Either ByteString ByteString)
authGetBS :: Manager -> AccessToken -> URI -> IO (Either ByteString ByteString)
authGetJSON :: FromJSON b => Manager -> AccessToken -> URI -> IO (Either ByteString b)
doSimplePostRequest :: FromJSON err => Manager -> OAuth2 -> URI -> PostBody -> IO (OAuth2Result err ByteString)
refreshAccessToken2 :: Manager -> OAuth2 -> RefreshToken -> IO (OAuth2Result Errors OAuth2Token)
refreshAccessToken :: Manager -> OAuth2 -> RefreshToken -> IO (OAuth2Result Errors OAuth2Token)
portLens :: Lens' Request Int
hostLens :: Lens' Request ByteString
requestToUri :: Request -> URI
uriToRequest :: MonadThrow m => URI -> m Request
appendQueryParams :: [(ByteString, ByteString)] -> URIRef a -> URIRef a
accessTokenToParam :: AccessToken -> [(ByteString, ByteString)]
appendAccessToken :: URIRef a -> AccessToken -> URIRef a
refreshAccessTokenUrl :: OAuth2 -> RefreshToken -> (URI, PostBody)
accessTokenUrl' :: OAuth2 -> ExchangeToken -> Maybe Text -> (URI, PostBody)
accessTokenUrl :: OAuth2 -> ExchangeToken -> (URI, PostBody)
mkDecodeOAuth2Error :: ByteString -> String -> OAuth2Error err
parseOAuth2Error :: FromJSON err => ByteString -> OAuth2Error err
parseIntFlexible :: Value -> Parser Int
data OAuth2 = OAuth2 {
- oauth2ClientId :: Text
- oauth2ClientSecret :: Maybe Text
- oauth2AuthorizeEndpoint :: URIRef Absolute
- oauth2TokenEndpoint :: URIRef Absolute
- oauth2RedirectUri :: Maybe (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
}
data OAuth2Error a = OAuth2Error {
- error :: Either Text a
- errorDescription :: Maybe Text
- errorUri :: Maybe (URIRef Absolute)
}
type OAuth2Result err a = Either (OAuth2Error err) a
type PostBody = [(ByteString, ByteString)]
type QueryParams = [(ByteString, ByteString)]

Documentation

data OAuth2 #

Query Parameter Representation TODO: fix typo in OAuthorizeEndpoint rename AccessToken to TokenEndpoint rename callback to redirectUri

Constructors

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

Instances

Instances details

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

authorizationUrl :: OAuth2 -> URI Source #

fetchAccessToken :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token) Source #

fetchAccessToken2 :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token) Source #

authRequest #

Arguments

:: Request	Request to perform
-> (Request -> Request)	Modify request before sending
-> Manager	HTTP connection manager.
-> IO (Either ByteString ByteString)

Send an HTTP request including the Authorization header with the specified access token.

authPostBS3 #

Arguments

:: Manager	HTTP connection manager.
-> AccessToken
-> URI
-> IO (Either ByteString ByteString)	Response as ByteString

Conduct POST request with access token in the header and null in body

authPostBS2 #

Arguments

:: Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> IO (Either ByteString ByteString)	Response as ByteString

Conduct POST request with access token in the request body rather header

authPostBS #

Arguments

:: Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> IO (Either ByteString ByteString)	Response as ByteString

Conduct POST request.

authPostJSON #

Arguments

:: FromJSON b
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> PostBody
-> IO (Either ByteString b)	Response as JSON

Conduct POST request and return response as JSON.

authGetBS2 #

Arguments

:: Manager	HTTP connection manager.
-> AccessToken
-> URI
-> IO (Either ByteString ByteString)	Response as ByteString

same to authGetBS but set access token to query parameter rather than header

authGetBS #

Arguments

:: Manager	HTTP connection manager.
-> AccessToken
-> URI
-> IO (Either ByteString ByteString)	Response as ByteString

Conduct an authorized GET request.

authGetJSON #

Arguments

:: FromJSON b
=> Manager	HTTP connection manager.
-> AccessToken
-> URI
-> IO (Either ByteString b)	Response as JSON

Conduct an authorized GET request and return response as JSON.

doSimplePostRequest #

Arguments

:: FromJSON err
=> Manager	HTTP connection manager.
-> OAuth2	OAuth options
-> URI	URL
-> PostBody	Request body.
-> IO (OAuth2Result err ByteString)	Response as ByteString

Conduct post request.

refreshAccessToken2 #

Arguments

:: Manager	HTTP connection manager.
-> OAuth2	OAuth context
-> RefreshToken	refresh token gained after authorization
-> IO (OAuth2Result Errors OAuth2Token)

Please read the docs of refreshAccessToken.

refreshAccessToken #

Arguments

:: Manager	HTTP connection manager.
-> OAuth2	OAuth context
-> RefreshToken	refresh token gained after authorization
-> IO (OAuth2Result Errors OAuth2Token)

Fetch a new AccessToken with the Refresh Token with authentication in request header. OAuth2 spec allows client_id and client_secret to either be sent in the header (as basic authentication) OR as form/url params. The OAuth server can choose to implement only one, or both. Unfortunately, there is no way for the OAuth client (i.e. this library) to know which method to use. Please take a look at the documentation of the service that you are integrating with and either use refreshAccessToken or refreshAccessToken2

portLens :: Lens' Request Int #

hostLens :: Lens' Request ByteString #

requestToUri :: Request -> URI #

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

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

accessTokenToParam :: AccessToken -> [(ByteString, ByteString)] #

Create QueryParams with given access token value.

appendAccessToken #

Arguments

:: URIRef a	Base URI
-> AccessToken	Authorized Access Token
-> URIRef a	Combined Result

For GET method API.

refreshAccessTokenUrl #

Arguments

:: OAuth2
-> RefreshToken	refresh token gained via authorization URL
-> (URI, PostBody)	refresh token request URL plus the request body.

Using a Refresh Token. Obtain a new access token by sending a refresh token to the Authorization server.

accessTokenUrl' #

Arguments

:: OAuth2
-> ExchangeToken	access code gained via authorization URL
-> Maybe Text	Grant Type
-> (URI, PostBody)	access token request URL plus the request body.

Prepare the URL and the request body query for fetching an access token, with optional grant type.

accessTokenUrl #

Arguments

:: OAuth2
-> ExchangeToken	access code gained via authorization URL
-> (URI, PostBody)	access token request URL plus the request body.

Prepare the URL and the request body query for fetching an access token.

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

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

parseIntFlexible :: Value -> Parser Int #

data OAuth2 #

Query Parameter Representation TODO: fix typo in OAuthorizeEndpoint rename AccessToken to TokenEndpoint rename callback to redirectUri

Constructors

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

Instances

Instances details

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

newtype AccessToken #

Constructors

AccessToken
Fields atoken :: Text

Instances

Instances details

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

newtype RefreshToken #

Constructors

RefreshToken
Fields rtoken :: Text

Instances

Instances details

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

newtype IdToken #

Constructors

IdToken
Fields idtoken :: Text

Instances

Instances details

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

newtype ExchangeToken #

Constructors

ExchangeToken
Fields extoken :: Text

Instances

Instances details

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

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

Instances details

Eq OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Token -> OAuth2Token -> Bool # (/=) :: OAuth2Token -> OAuth2Token -> Bool #
Show OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods showsPrec :: Int -> OAuth2Token -> ShowS # show :: OAuth2Token -> String # showList :: [OAuth2Token] -> ShowS #
Generic OAuth2Token
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
Instance details Defined in Network.OAuth.OAuth2.Internal Methods toJSON :: OAuth2Token -> Value # toEncoding :: OAuth2Token -> Encoding # toJSONList :: [OAuth2Token] -> Value # toEncodingList :: [OAuth2Token] -> Encoding #
FromJSON OAuth2Token	Parse JSON data into `OAuth2Token`
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser OAuth2Token # parseJSONList :: Value -> Parser [OAuth2Token] #
Binary OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal Methods put :: OAuth2Token -> Put # get :: Get OAuth2Token # putList :: [OAuth2Token] -> Put #
type Rep OAuth2Token
Instance details Defined in Network.OAuth.OAuth2.Internal type Rep OAuth2Token = D1 ('MetaData "OAuth2Token" "Network.OAuth.OAuth2.Internal" "hoauth2-2.0.0-DY5jodbUcC4AiL00MUihEx" '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 OAuth2Error a #

Constructors

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

Instances

Instances details

Eq a => Eq (OAuth2Error a)
Instance details Defined in Network.OAuth.OAuth2.Internal Methods (==) :: OAuth2Error a -> OAuth2Error a -> Bool # (/=) :: OAuth2Error a -> OAuth2Error a -> Bool #
Show a => Show (OAuth2Error a)
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)
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)
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)
Instance details Defined in Network.OAuth.OAuth2.Internal Methods parseJSON :: Value -> Parser (OAuth2Error err) # parseJSONList :: Value -> Parser [OAuth2Error err] #
type Rep (OAuth2Error a)
Instance details Defined in Network.OAuth.OAuth2.Internal type Rep (OAuth2Error a) = D1 ('MetaData "OAuth2Error" "Network.OAuth.OAuth2.Internal" "hoauth2-2.0.0-DY5jodbUcC4AiL00MUihEx" '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))))))

type OAuth2Result err a = Either (OAuth2Error err) a #

Is either Left containing an error or Right containg a result

type PostBody = [(ByteString, ByteString)] #

type synonym of post body content

type QueryParams = [(ByteString, ByteString)] #