Safe Haskell	Safe-Infered

Web.Authenticate.OAuth

Contents

Data types
Operations for credentials
Signature
Url & operation for authentication
Utility Methods

Synopsis

Data types

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

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.

oauthServerName :: OAuth -> String Source

Service name (default: "")

oauthRequestUri :: OAuth -> String Source

URI to request temporary credential (default: ""). You MUST specify if you use getTemporaryCredential', getTemporaryCredentialProxy or getTemporaryCredential; otherwise you can just leave this empty.

oauthAccessTokenUri :: OAuth -> String Source

Uri to obtain access token (default: ""). You MUST specify if you use getAcessToken or getAccessToken'; otherwise you can just leave this empty.

oauthAuthorizeUri :: OAuth -> String Source

Uri to authorize (default: ""). You MUST specify if you use authorizeUrl or authorizeZUrl'; otherwise you can just leave this empty.

oauthSignatureMethod :: OAuth -> SignMethod Source

Signature Method (default: HMACSHA1)

oauthConsumerKey :: OAuth -> ByteString Source

Consumer key (You MUST specify)

oauthConsumerSecret :: OAuth -> ByteString Source

Consumer Secret (You MUST specify)

oauthCallback :: OAuth -> Maybe ByteString Source

Callback uri to redirect after authentication (default: Nothing)

oauthRealm :: OAuth -> Maybe ByteString Source

Optional authorization realm (default: Nothing)

oauthVersion :: OAuth -> OAuthVersion Source

OAuth spec version (default: OAuth10a)

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

Eq OAuthVersion
Data OAuthVersion
Ord OAuthVersion
Read OAuthVersion
Show OAuthVersion
Typeable OAuthVersion

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.

injectVerifier :: ByteString -> Credential -> Credential Source

Signature

signOAuth Source

Arguments

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

Add OAuth headers & sign to Request.

genSign :: MonadUnsafeIO m => OAuth -> Credential -> Request m -> 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 authorize. This takes function to choice parameter to pass to the server other than oauth_callback or oauth_token.

getAccessToken,getTokenCredential Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> OAuth	OAuth Application
-> Credential	Temporary Credential (with oauth_verifier if >= 1.0a)
-> Manager
-> m Credential	Token Credential (Access Token & Secret)

Get Access token.

getTemporaryCredential Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> OAuth	OAuth Application
-> Manager
-> m Credential	Temporary Credential (Request Token & Secret).

Get temporary credential for requesting acces token.

getTemporaryCredentialWithScope Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> ByteString	Scope parameter string
-> OAuth	OAuth Application
-> Manager
-> m Credential	Temporay Credential (Request Token & Secret).

Get temporary credential for requesting access token with Scope parameter.

getAccessTokenProxy,getTokenCredentialProxy Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> Maybe Proxy	Proxy
-> OAuth	OAuth Application
-> Credential	Temporary Credential (with oauth_verifier if >= 1.0a)
-> Manager
-> m Credential	Token Credential (Access Token & Secret)

Get Access token via the proxy.

getTemporaryCredentialProxy Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> Maybe Proxy	Proxy
-> OAuth	OAuth Application
-> Manager
-> m Credential	Temporary Credential (Request Token & Secret).

Get temporary credential for requesting access token via the proxy.

getAccessToken'Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> (Request m -> Request m)	Request Hook
-> OAuth	OAuth Application
-> Credential	Temporary Credential (with oauth_verifier if >= 1.0a)
-> Manager
-> m Credential	Token Credential (Access Token & Secret)

getTemporaryCredential'Source

Arguments

:: (MonadResource m, MonadBaseControl IO m)
=> (Request m -> Request m)	Request Hook
-> OAuth	OAuth Application
-> Manager
-> 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