Safe Haskell	None
Language	Haskell98

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

def :: Default a => a
newtype Credential = Credential {
- unCredential :: [(ByteString, ByteString)]
}
data AccessTokenRequest
newtype OAuthException = OAuthException String
data SignMethod
- = PLAINTEXT
- | HMACSHA1
- | RSASHA1 PrivateKey
data OAuthVersion
- = OAuth10
- | OAuth10a
data OAuth
newOAuth :: OAuth
defaultAccessTokenRequest :: OAuth -> Credential -> Manager -> AccessTokenRequest
newCredential :: ByteString -> ByteString -> Credential
emptyCredential :: Credential
insert :: ByteString -> ByteString -> Credential -> Credential
inserts :: [(ByteString, ByteString)] -> Credential -> Credential
delete :: ByteString -> Credential -> Credential
injectVerifier :: ByteString -> Credential -> Credential
signOAuth :: MonadIO m => OAuth -> Credential -> Request -> m Request
genSign :: MonadIO m => OAuth -> Credential -> Request -> m ByteString
checkOAuth :: MonadIO m => OAuth -> Credential -> Request -> ExceptT OAuthException m Request
authorizeUrl :: OAuth -> Credential -> String
authorizeUrl' :: (OAuth -> Credential -> SimpleQuery) -> OAuth -> Credential -> String
getAccessTokenWith :: MonadIO m => AccessTokenRequest -> m (Either (Response ByteString) Credential)
addAuthBody :: a -> Credential -> Request -> Request
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

def :: Default a => a #

The default value for this type.

newtype Credential #

Data type for redential.

Constructors

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

Instances

Eq Credential #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: Credential -> Credential -> Bool # (/=) :: Credential -> Credential -> Bool #
Data Credential #
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 :: (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 #
Ord Credential #
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 #
Read Credential #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS Credential # readList :: ReadS [Credential] # readPrec :: ReadPrec Credential # readListPrec :: ReadPrec [Credential] #
Show Credential #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> Credential -> ShowS # show :: Credential -> String # showList :: [Credential] -> ShowS #

data AccessTokenRequest #

Data type for getAccessTokenWith method.

You can create values of this type using defaultAccessTokenRequest.

Since 1.5.1

newtype OAuthException #

Constructors

OAuthException String

Instances

Eq OAuthException #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: OAuthException -> OAuthException -> Bool # (/=) :: OAuthException -> OAuthException -> Bool #
Data OAuthException #
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 :: (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 #
Show OAuthException #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> OAuthException -> ShowS # show :: OAuthException -> String # showList :: [OAuthException] -> ShowS #
Exception OAuthException #
Instance details Defined in Web.Authenticate.OAuth Methods toException :: OAuthException -> SomeException # fromException :: SomeException -> Maybe OAuthException # displayException :: OAuthException -> String #

data SignMethod #

Data type for signature method.

Constructors

PLAINTEXT
HMACSHA1
RSASHA1 PrivateKey

Instances

Eq SignMethod #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: SignMethod -> SignMethod -> Bool # (/=) :: SignMethod -> SignMethod -> Bool #
Data SignMethod #
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 :: (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 #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS SignMethod # readList :: ReadS [SignMethod] # readPrec :: ReadPrec SignMethod # readListPrec :: ReadPrec [SignMethod] #
Show SignMethod #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> SignMethod -> ShowS # show :: SignMethod -> String # showList :: [SignMethod] -> ShowS #

data OAuthVersion #

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

Enum OAuthVersion #
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] #
Eq OAuthVersion #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: OAuthVersion -> OAuthVersion -> Bool # (/=) :: OAuthVersion -> OAuthVersion -> Bool #
Data OAuthVersion #
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 :: (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 #
Ord OAuthVersion #
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 #
Read OAuthVersion #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS OAuthVersion # readList :: ReadS [OAuthVersion] # readPrec :: ReadPrec OAuthVersion # readListPrec :: ReadPrec [OAuthVersion] #
Show OAuthVersion #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> OAuthVersion -> ShowS # show :: OAuthVersion -> String # showList :: [OAuthVersion] -> ShowS #

data OAuth #

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

Eq OAuth #
Instance details Defined in Web.Authenticate.OAuth Methods (==) :: OAuth -> OAuth -> Bool # (/=) :: OAuth -> OAuth -> Bool #
Data OAuth #
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 :: (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 #
Instance details Defined in Web.Authenticate.OAuth Methods readsPrec :: Int -> ReadS OAuth # readList :: ReadS [OAuth] # readPrec :: ReadPrec OAuth # readListPrec :: ReadPrec [OAuth] #
Show OAuth #
Instance details Defined in Web.Authenticate.OAuth Methods showsPrec :: Int -> OAuth -> ShowS # show :: OAuth -> String # showList :: [OAuth] -> ShowS #
Default OAuth #
Instance details Defined in Web.Authenticate.OAuth Methods def :: OAuth #

newOAuth :: OAuth #

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

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

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 #

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 #

Empty credential.

insert #

Arguments

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

Insert an oauth parameter into given Credential.

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

Convenient method for inserting multiple parameters into credential.

delete #

Arguments

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

Remove an oauth parameter for key from given Credential.

injectVerifier :: ByteString -> Credential -> Credential #

Insert oauth-verifier on a Credential.

signOAuth #

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 #

Generate OAuth signature. Used by signOAuth.

checkOAuth :: MonadIO m => OAuth -> Credential -> Request -> ExceptT OAuthException m Request #

Test existing OAuth signature. Since 1.5.2

authorizeUrl #

Arguments

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

URL to obtain OAuth verifier.

authorizeUrl' #

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.

getAccessTokenWith #

Arguments

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

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

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

paramEncode :: ByteString -> ByteString #

Encode a string using the percent encoding method for OAuth.

addScope :: ByteString -> Request -> Request #

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

getAccessToken #

Arguments

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

Get Access token.

getTemporaryCredential #

Arguments

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

Get temporary credential for requesting acces token.

getTemporaryCredentialWithScope #

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 #

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' #

Arguments

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

getTokenCredential #

Arguments

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

Get Access token.

getAccessTokenProxy #

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 #

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' #

Arguments

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