Web.Authenticate.OAuth

Data types

data OAuth

Data type for OAuth client (consumer).

Constructors

OAuth

Fields

oauthServerName :: String

Service name

oauthRequestUri :: String

URI to request temporary credential

oauthAccessTokenUri :: String

Uri to obtain access token

oauthAuthorizeUri :: String

Uri to authorize

oauthSignatureMethod :: SignMethod

Signature Method

oauthConsumerKey :: ByteString

Consumer key

oauthConsumerSecret :: ByteString

Consumer Secret

oauthCallback :: Maybe ByteString

Callback uri to redirect after authentication

Instances

Eq OAuth

Data OAuth

Ord OAuth

Read OAuth

Show OAuth

Typeable OAuth

data SignMethod

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

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

Constructors

OAuthException String

Instances

Eq OAuthException

Data OAuthException

Show OAuthException

Typeable OAuthException

Exception OAuthException

Operations for credentials

emptyCredential :: Credential

Empty credential.

insert

Arguments

:: ByteString

Parameter Name

-> ByteString

Value

-> Credential

Credential

-> Credential

Result

Insert an oauth parameter into given Credential.

delete

Arguments

:: ByteString

Parameter name

-> Credential

Credential

-> Credential

Result

Remove an oauth parameter for key from given Credential.

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

Convenient method for inserting multiple parameters into credential.

Signature

signOAuth

Arguments

:: OAuth

OAuth Application

-> Credential

Credential

-> Request IO

Original Request

-> IO (Request IO)

Signed OAuth Request

Add OAuth headers & sign to Request.

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

Url & operation for authentication

authorizeUrl

Arguments

:: OAuth

OAuth Application

-> Credential

Temporary Credential (Request Token & Secret)

-> String

URL to authorize

URL to obtain OAuth verifier.

getAccessToken,getTokenCredential

Arguments

:: OAuth

OAuth Application

-> Credential

Temporary Credential with oauth_verifier

-> IO Credential

Token Credential (Access Token & Secret)

Get Access token.

getTemporaryCredential

Arguments

:: OAuth

OAuth Application

-> IO Credential

Temporary Credential (Request Token & Secret).

Get temporary credential for requesting acces token.

getTemporaryCredentialWithScope

Arguments

:: ByteString

Scope parameter string

-> OAuth

OAuth Application

-> IO Credential

Temporay Credential (Request Token & Secret).

Get temporary credential for requesting access token with Scope parameter.

getAccessTokenProxy,getTokenCredentialProxy

Arguments

:: Maybe Proxy

Proxy

-> OAuth

OAuth Application

-> Credential

Temporary Credential with oauth_verifier

-> IO Credential

Token Credential (Access Token & Secret)

Get Access token via the proxy.

getTemporaryCredentialProxy

Arguments

:: Maybe Proxy

Proxy

-> OAuth

OAuth Application

-> IO Credential

Temporary Credential (Request Token & Secret).

Get temporary credential for requesting access token via the proxy.

getAccessToken'

Arguments

:: (Request IO -> Request IO)

Request Hook

-> OAuth

OAuth Application

-> Credential

Temporary Credential with oauth_verifier

-> IO Credential

Token Credential (Access Token & Secret)

getTemporaryCredential'

Arguments

:: (Request IO -> Request IO)

Request Hook

-> OAuth

OAuth Application

-> IO Credential

Temporary Credential (Request Token & Secret).

Utility Methods

paramEncode :: ByteString -> ByteString

Encode a string using the percent encoding method for OAuth.

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

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