Safe Haskell	None
Language	Haskell2010

Web.Authenticate.OAuth.IO

Description

Deprecated: This module is deprecated; rewrite your code using MonadResource

This Module provides interface for the instance of MonadIO instead of MonadIO. What this module do is just adding withManager or runResourceT.

Synopsis

delete :: ByteString -> Credential -> Credential
insert :: ByteString -> ByteString -> Credential -> Credential
def :: Default a => a
data OAuth
newOAuth :: OAuth
data OAuthVersion
- = OAuth10
- | OAuth10a
data SignMethod
- = PLAINTEXT
- | HMACSHA1
- | HMACSHA256
- | HMACSHA512
- | RSASHA1 PrivateKey
- | RSASHA256 PrivateKey
- | RSASHA512 PrivateKey
newtype Credential = Credential {
- unCredential :: [(ByteString, ByteString)]
}
newtype OAuthException = OAuthException String
data AccessTokenRequest
defaultAccessTokenRequest :: OAuth -> Credential -> Manager -> AccessTokenRequest
newCredential :: ByteString -> ByteString -> Credential
emptyCredential :: Credential
inserts :: [(ByteString, ByteString)] -> Credential -> Credential
injectVerifier :: ByteString -> Credential -> Credential
signOAuth :: MonadIO m => OAuth -> Credential -> Request -> m Request
genSign :: MonadIO m => OAuth -> Credential -> Request -> m ByteString
checkOAuth :: forall (m :: Type -> Type). MonadIO m => OAuth -> Credential -> Request -> ExceptT OAuthException m Request
authorizeUrl :: OAuth -> Credential -> String
authorizeUrl' :: (OAuth -> Credential -> SimpleQuery) -> OAuth -> Credential -> String
addAuthBody :: a -> Credential -> Request -> Request
getAccessTokenWith :: MonadIO m => AccessTokenRequest -> m (Either (Response ByteString) Credential)
paramEncode :: ByteString -> ByteString
addScope :: ByteString -> Request -> Request
addMaybeProxy :: Maybe Proxy -> Request -> Request
getAccessToken :: MonadIO m => OAuth -> Credential -> m Credential
getTemporaryCredential :: MonadIO m => OAuth -> m Credential
getTemporaryCredentialWithScope :: MonadIO m => ByteString -> OAuth -> m Credential
getTemporaryCredentialProxy :: MonadIO m => Maybe Proxy -> OAuth -> m Credential
getTemporaryCredential' :: MonadIO m => (Request -> Request) -> OAuth -> m Credential
getTokenCredential :: MonadIO m => OAuth -> Credential -> m Credential
getAccessTokenProxy :: MonadIO m => Maybe Proxy -> OAuth -> Credential -> m Credential
getTokenCredentialProxy :: MonadIO m => Maybe Proxy -> OAuth -> Credential -> m Credential
getAccessToken' :: MonadIO m => (Request -> Request) -> OAuth -> Credential -> m Credential

Documentation

delete Source #

Arguments

:: ByteString	Parameter name
-> Credential	Credential
-> Credential	Result

Remove an oauth parameter for key from given Credential.

insert Source #

Arguments

:: ByteString	Parameter Name
-> ByteString	Value
-> Credential	Credential
-> Credential	Result

Insert an oauth parameter into given Credential.

def :: Default a => a #

The default value for this type.

data OAuth Source #

Data type for OAuth client (consumer).

The constructor for this data type is not exposed. Instead, you should use the def method or newOAuth function to retrieve a default instance, and then use the records below to make modifications. This approach allows us to add configuration options without breaking backwards compatibility.

Instances

Instances details

Default OAuth Source #
Instance details Defined in Web.Authenticate.OAuth Methods def :: OAuth #
Data OAuth Source #
Instance details Defined in Web.Authenticate.OAuth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuth -> c OAuth # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuth # toConstr :: OAuth -> Constr # dataTypeOf :: OAuth -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuth) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuth) # gmapT :: (forall b. Data b => b -> b) -> OAuth -> OAuth # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuth -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuth -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuth -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuth -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuth -> m OAuth # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth -> m OAuth # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuth -> m OAuth #
Read OAuth Source #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS OAuth # readList :: ReadS [OAuth] # readPrec :: ReadPrec OAuth # readListPrec :: ReadPrec [OAuth] #
Show OAuth Source #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> OAuth -> ShowS # show :: OAuth -> String # showList :: [OAuth] -> ShowS #
Eq OAuth Source #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: OAuth -> OAuth -> Bool # (/=) :: OAuth -> OAuth -> Bool #

newOAuth :: OAuth Source #

Default value for OAuth datatype. You must specify at least oauthServerName, URIs and Tokens.

data OAuthVersion Source #

Constructors

OAuth10	OAuth protocol ver 1.0 (no oauth_verifier; differs from RFC 5849).
OAuth10a	OAuth protocol ver 1.0a. This corresponds to community's 1.0a spec and RFC 5849.

Instances

Instances details

Data OAuthVersion Source #
Instance details Defined in Web.Authenticate.OAuth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuthVersion -> c OAuthVersion # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuthVersion # toConstr :: OAuthVersion -> Constr # dataTypeOf :: OAuthVersion -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuthVersion) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuthVersion) # gmapT :: (forall b. Data b => b -> b) -> OAuthVersion -> OAuthVersion # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuthVersion -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuthVersion -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuthVersion -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuthVersion -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuthVersion -> m OAuthVersion # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuthVersion -> m OAuthVersion # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuthVersion -> m OAuthVersion #
Enum OAuthVersion Source #
Instance details Defined in Web.Authenticate.OAuth Methods succ :: OAuthVersion -> OAuthVersion # pred :: OAuthVersion -> OAuthVersion # toEnum :: Int -> OAuthVersion # fromEnum :: OAuthVersion -> Int # enumFrom :: OAuthVersion -> [OAuthVersion] # enumFromThen :: OAuthVersion -> OAuthVersion -> [OAuthVersion] # enumFromTo :: OAuthVersion -> OAuthVersion -> [OAuthVersion] # enumFromThenTo :: OAuthVersion -> OAuthVersion -> OAuthVersion -> [OAuthVersion] #
Read OAuthVersion Source #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS OAuthVersion # readList :: ReadS [OAuthVersion] # readPrec :: ReadPrec OAuthVersion # readListPrec :: ReadPrec [OAuthVersion] #
Show OAuthVersion Source #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> OAuthVersion -> ShowS # show :: OAuthVersion -> String # showList :: [OAuthVersion] -> ShowS #
Eq OAuthVersion Source #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: OAuthVersion -> OAuthVersion -> Bool # (/=) :: OAuthVersion -> OAuthVersion -> Bool #
Ord OAuthVersion Source #
Instance details Defined in Web.Authenticate.OAuth Methods compare :: OAuthVersion -> OAuthVersion -> Ordering # (<) :: OAuthVersion -> OAuthVersion -> Bool # (<=) :: OAuthVersion -> OAuthVersion -> Bool # (>) :: OAuthVersion -> OAuthVersion -> Bool # (>=) :: OAuthVersion -> OAuthVersion -> Bool # max :: OAuthVersion -> OAuthVersion -> OAuthVersion # min :: OAuthVersion -> OAuthVersion -> OAuthVersion #

data SignMethod Source #

Data type for signature method.

Constructors

PLAINTEXT
HMACSHA1
HMACSHA256
HMACSHA512
RSASHA1 PrivateKey
RSASHA256 PrivateKey
RSASHA512 PrivateKey

Instances

Instances details

Data SignMethod Source #
Instance details Defined in Web.Authenticate.OAuth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SignMethod -> c SignMethod # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SignMethod # toConstr :: SignMethod -> Constr # dataTypeOf :: SignMethod -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SignMethod) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SignMethod) # gmapT :: (forall b. Data b => b -> b) -> SignMethod -> SignMethod # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SignMethod -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SignMethod -> r # gmapQ :: (forall d. Data d => d -> u) -> SignMethod -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SignMethod -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SignMethod -> m SignMethod # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SignMethod -> m SignMethod # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SignMethod -> m SignMethod #
Read SignMethod Source #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS SignMethod # readList :: ReadS [SignMethod] # readPrec :: ReadPrec SignMethod # readListPrec :: ReadPrec [SignMethod] #
Show SignMethod Source #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> SignMethod -> ShowS # show :: SignMethod -> String # showList :: [SignMethod] -> ShowS #
Eq SignMethod Source #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: SignMethod -> SignMethod -> Bool # (/=) :: SignMethod -> SignMethod -> Bool #

newtype Credential Source #

Data type for credential.

Constructors

Credential
Fields unCredential :: [(ByteString, ByteString)]

Instances

Instances details

Data Credential Source #
Instance details Defined in Web.Authenticate.OAuth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Credential -> c Credential # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Credential # toConstr :: Credential -> Constr # dataTypeOf :: Credential -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Credential) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Credential) # gmapT :: (forall b. Data b => b -> b) -> Credential -> Credential # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Credential -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Credential -> r # gmapQ :: (forall d. Data d => d -> u) -> Credential -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Credential -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Credential -> m Credential # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Credential -> m Credential # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Credential -> m Credential #
Read Credential Source #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS Credential # readList :: ReadS [Credential] # readPrec :: ReadPrec Credential # readListPrec :: ReadPrec [Credential] #
Show Credential Source #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> Credential -> ShowS # show :: Credential -> String # showList :: [Credential] -> ShowS #
Eq Credential Source #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: Credential -> Credential -> Bool # (/=) :: Credential -> Credential -> Bool #
Ord Credential Source #
Instance details Defined in Web.Authenticate.OAuth Methods compare :: Credential -> Credential -> Ordering # (<) :: Credential -> Credential -> Bool # (<=) :: Credential -> Credential -> Bool # (>) :: Credential -> Credential -> Bool # (>=) :: Credential -> Credential -> Bool # max :: Credential -> Credential -> Credential # min :: Credential -> Credential -> Credential #

newtype OAuthException Source #

Constructors

OAuthException String

Instances

Instances details

Data OAuthException Source #
Instance details Defined in Web.Authenticate.OAuth Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OAuthException -> c OAuthException # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OAuthException # toConstr :: OAuthException -> Constr # dataTypeOf :: OAuthException -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OAuthException) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OAuthException) # gmapT :: (forall b. Data b => b -> b) -> OAuthException -> OAuthException # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OAuthException -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OAuthException -> r # gmapQ :: (forall d. Data d => d -> u) -> OAuthException -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OAuthException -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OAuthException -> m OAuthException # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuthException -> m OAuthException # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OAuthException -> m OAuthException #
Exception OAuthException Source #
Instance details Defined in Web.Authenticate.OAuth Methods toException :: OAuthException -> SomeException # fromException :: SomeException -> Maybe OAuthException # displayException :: OAuthException -> String # backtraceDesired :: OAuthException -> Bool #
Show OAuthException Source #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> OAuthException -> ShowS # show :: OAuthException -> String # showList :: [OAuthException] -> ShowS #
Eq OAuthException Source #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: OAuthException -> OAuthException -> Bool # (/=) :: OAuthException -> OAuthException -> Bool #

data AccessTokenRequest Source #

Data type for getAccessTokenWith method.

You can create values of this type using defaultAccessTokenRequest.

Since 1.5.1

defaultAccessTokenRequest :: OAuth -> Credential -> Manager -> AccessTokenRequest Source #

Create a value of type AccessTokenRequest with default values filled in.

Note that this is a settings type. More information on usage can be found at: http://www.yesodweb.com/book/settings-types.

Since 1.5.1

newCredential Source #

Arguments

:: ByteString	value for oauth_token
-> ByteString	value for oauth_token_secret
-> Credential

Convenient function to create Credential with OAuth Token and Token Secret.

emptyCredential :: Credential Source #

Empty credential.

inserts :: [(ByteString, ByteString)] -> Credential -> Credential Source #

Convenient method for inserting multiple parameters into credential.

injectVerifier :: ByteString -> Credential -> Credential Source #

Insert oauth-verifier on a Credential.

signOAuth Source #

Arguments

:: MonadIO m
=> OAuth	OAuth Application
-> Credential	Credential
-> Request	Original Request
-> m Request	Signed OAuth Request

Add OAuth headers & sign to Request.

genSign :: MonadIO m => OAuth -> Credential -> Request -> m ByteString Source #

Generate OAuth signature. Used by signOAuth.

checkOAuth :: forall (m :: Type -> Type). MonadIO m => OAuth -> Credential -> Request -> ExceptT OAuthException m Request Source #

Test existing OAuth signature. Since 1.5.2

authorizeUrl Source #

Arguments

:: OAuth	OAuth Application
-> Credential	Temporary Credential (Request Token & Secret)
-> String	URL to authorize

URL to obtain OAuth verifier.

authorizeUrl' Source #

Arguments

:: (OAuth -> Credential -> SimpleQuery)
-> OAuth	OAuth Application
-> Credential	Temporary Credential (Request Token & Secret)
-> String	URL to authorize

Convert OAuth and Credential to URL to authorize. This takes function to choice parameter to pass to the server other than oauth_callback or oauth_token.

addAuthBody :: a -> Credential -> Request -> Request Source #

Place the authentication information in a URL encoded body instead of the Authorization header.

Note that the first parameter is used for realm in addAuthHeader, and this function needs the same type. The parameter, however, is unused.

Since 1.5.1

getAccessTokenWith Source #

Arguments

:: MonadIO m
=> AccessTokenRequest	extensible parameters
-> m (Either (Response ByteString) Credential)	Token Credential (Access Token & Secret) or the conduit response on failures

paramEncode :: ByteString -> ByteString Source #

Encode a string using the percent encoding method for OAuth.

addScope :: ByteString -> Request -> Request Source #

addMaybeProxy :: Maybe Proxy -> Request -> Request Source #

getAccessToken Source #

Arguments

:: MonadIO m
=> OAuth	OAuth Application
-> Credential	Temporary Credential with oauth_verifier
-> m Credential	Token Credential (Access Token & Secret)

Get Access token.

getTemporaryCredential Source #

Arguments

:: MonadIO m
=> OAuth	OAuth Application
-> m Credential	Temporary Credential (Request Token & Secret).

Get temporary credential for requesting acces token.

getTemporaryCredentialWithScope Source #

Arguments

:: MonadIO m
=> ByteString	Scope parameter string
-> OAuth	OAuth Application
-> m Credential	Temporay Credential (Request Token & Secret).

Get temporary credential for requesting access token with Scope parameter.

getTemporaryCredentialProxy Source #

Arguments

:: MonadIO m
=> Maybe Proxy	Proxy
-> OAuth	OAuth Application
-> m Credential	Temporary Credential (Request Token & Secret).

Get temporary credential for requesting access token via the proxy.

getTemporaryCredential' Source #

Arguments

:: MonadIO m
=> (Request -> Request)	Request Hook
-> OAuth	OAuth Application
-> m Credential	Temporary Credential (Request Token & Secret).

getTokenCredential Source #

Arguments

:: MonadIO m
=> OAuth	OAuth Application
-> Credential	Temporary Credential with oauth_verifier
-> m Credential	Token Credential (Access Token & Secret)

Get Access token.

getAccessTokenProxy Source #

Arguments

:: MonadIO m
=> Maybe Proxy	Proxy
-> OAuth	OAuth Application
-> Credential	Temporary Credential with oauth_verifier
-> m Credential	Token Credential (Access Token & Secret)

Get Access token via the proxy.

getTokenCredentialProxy Source #

Arguments

:: MonadIO m
=> Maybe Proxy	Proxy
-> OAuth	OAuth Application
-> Credential	Temporary Credential with oauth_verifier
-> m Credential	Token Credential (Access Token & Secret)

Get Access token via the proxy.

getAccessToken' Source #

Arguments

:: MonadIO m
=> (Request -> Request)	Request Hook
-> OAuth	OAuth Application
-> Credential	Temporary Credential with oauth_verifier
-> m Credential	Token Credential (Access Token & Secret)