Web.Authenticate.OAuth

Contents

Synopsis

Data types

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
Data OAuth
Ord OAuth
Read OAuth
Show OAuth
Typeable OAuth
Default OAuth

def :: Default a => a

The default value for this type.

newOAuth :: OAuth Source

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

data SignMethod Source

Data type for signature method.

Constructors

PLAINTEXT
HMACSHA1
RSASHA1 PrivateKey

Instances

Eq SignMethod
Data SignMethod
Ord SignMethod
Read SignMethod
Show SignMethod
Typeable SignMethod

data Credential Source

Data type for redential.

Constructors

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

Instances

Eq Credential
Data Credential
Ord Credential
Read Credential
Show Credential
Typeable Credential

data OAuthException Source

Constructors

OAuthException String

Instances

Eq OAuthException
Data OAuthException
Show OAuthException
Typeable OAuthException
Exception OAuthException

Operations for credentials

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.

insert Source

Arguments

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

Insert an oauth parameter into given Credential.

delete Source

Arguments

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

Remove an oauth parameter for key from given Credential.

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

Convenient method for inserting multiple parameters into credential.

Signature

signOAuth Source

Arguments

:: ResourceIO m
=> OAuth	OAuth Application
-> Credential	Credential
-> Request m	Original Request
-> ResourceT m (Request m)	Signed OAuth Request

Add OAuth headers & sign to Request.

genSign :: ResourceIO m => OAuth -> Credential -> Request m -> ResourceT m ByteString Source

Url & operation for authentication

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 obatin OAuth Verifier. This takes function to choice parameter to pass to the server other than oauth_callback or oauth_token.

getAccessToken,getTokenCredential Source

Arguments

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

Get Access token.

getTemporaryCredential Source

Arguments

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

Get temporary credential for requesting acces token.

getTemporaryCredentialWithScope Source

Arguments

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

Get temporary credential for requesting access token with Scope parameter.

getAccessTokenProxy,getTokenCredentialProxy Source

Arguments

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

Get Access token via the proxy.

getTemporaryCredentialProxy Source

Arguments

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

Get temporary credential for requesting access token via the proxy.

getAccessToken'Source

Arguments

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

getTemporaryCredential'Source

Arguments

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

Utility Methods

paramEncode :: ByteString -> ByteString Source

Encode a string using the percent encoding method for OAuth.

addScope :: MonadIO m => ByteString -> Request m -> Request mSource

addMaybeProxy :: Maybe Proxy -> Request m -> Request mSource