Safe Haskell	None
Language	Haskell98

Web.Authenticate.OAuth

Contents

Data types
- Access token request
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 Source #
Methods (==) :: OAuth -> OAuth -> Bool # (/=) :: OAuth -> OAuth -> Bool #
Data OAuth Source #
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 Source #
Methods readsPrec :: Int -> ReadS OAuth # readList :: ReadS [OAuth] # readPrec :: ReadPrec OAuth # readListPrec :: ReadPrec [OAuth] #
Show OAuth Source #
Methods showsPrec :: Int -> OAuth -> ShowS # show :: OAuth -> String # showList :: [OAuth] -> ShowS #
Default OAuth Source #
Methods def :: 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' or getAccessTokenWith; 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

Enum OAuthVersion Source #
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 Source #
Methods (==) :: OAuthVersion -> OAuthVersion -> Bool # (/=) :: OAuthVersion -> OAuthVersion -> Bool #
Data OAuthVersion Source #
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 Source #
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 Source #
Methods readsPrec :: Int -> ReadS OAuthVersion # readList :: ReadS [OAuthVersion] # readPrec :: ReadPrec OAuthVersion # readListPrec :: ReadPrec [OAuthVersion] #
Show OAuthVersion Source #
Methods showsPrec :: Int -> OAuthVersion -> ShowS # show :: OAuthVersion -> String # showList :: [OAuthVersion] -> ShowS #

data SignMethod Source #

Data type for signature method.

Constructors

PLAINTEXT
HMACSHA1
RSASHA1 PrivateKey

Instances

Eq SignMethod Source #
Methods (==) :: SignMethod -> SignMethod -> Bool # (/=) :: SignMethod -> SignMethod -> Bool #
Data SignMethod Source #
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 Source #
Methods readsPrec :: Int -> ReadS SignMethod # readList :: ReadS [SignMethod] # readPrec :: ReadPrec SignMethod # readListPrec :: ReadPrec [SignMethod] #
Show SignMethod Source #
Methods showsPrec :: Int -> SignMethod -> ShowS # show :: SignMethod -> String # showList :: [SignMethod] -> ShowS #

newtype Credential Source #

Data type for redential.

Constructors

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

Instances

Eq Credential Source #
Methods (==) :: Credential -> Credential -> Bool # (/=) :: Credential -> Credential -> Bool #
Data Credential Source #
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 Source #
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 Source #
Methods readsPrec :: Int -> ReadS Credential # readList :: ReadS [Credential] # readPrec :: ReadPrec Credential # readListPrec :: ReadPrec [Credential] #
Show Credential Source #
Methods showsPrec :: Int -> Credential -> ShowS # show :: Credential -> String # showList :: [Credential] -> ShowS #

newtype OAuthException Source #

Constructors

OAuthException String

Instances

Eq OAuthException Source #
Methods (==) :: OAuthException -> OAuthException -> Bool # (/=) :: OAuthException -> OAuthException -> Bool #
Data OAuthException Source #
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 Source #
Methods showsPrec :: Int -> OAuthException -> ShowS # show :: OAuthException -> String # showList :: [OAuthException] -> ShowS #
Exception OAuthException Source #
Methods toException :: OAuthException -> SomeException # fromException :: SomeException -> Maybe OAuthException # displayException :: OAuthException -> String #

Access token request

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

accessTokenAddAuth :: AccessTokenRequest -> ByteString -> Credential -> Request -> Request Source #

add auth hook.

Default: addAuthHeader

Since 1.5.1

accessTokenRequestHook :: AccessTokenRequest -> Request -> Request Source #

Request Hook.

Default: id

Since 1.5.1

accessTokenOAuth :: AccessTokenRequest -> OAuth Source #

OAuth Application

Since 1.5.1

accessTokenTemporaryCredential :: AccessTokenRequest -> Credential Source #

Temporary Credential (with oauth_verifier if >= 1.0a)

Since 1.5.1

accessTokenManager :: AccessTokenRequest -> Manager Source #

Manager

Since 1.5.1

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 #

Insert oauth-verifier on a Credential.

Signature

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 :: MonadIO m => OAuth -> Credential -> Request -> ExceptT OAuthException m Request Source #

Test existing OAuth signature. Since 1.5.2

Url & operation for authentication

Temporary credentials

getTemporaryCredential Source #

Arguments

:: MonadIO m
=> OAuth	OAuth Application
-> Manager
-> 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
-> Manager
-> 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
-> Manager
-> 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
-> Manager
-> m Credential	Temporary Credential (Request Token & Secret).

Authorization URL

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.

Attaching auth to requests

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

Finishing authentication

getAccessToken Source #

Arguments

:: MonadIO m
=> OAuth	OAuth Application
-> Credential	Temporary Credential (with oauth_verifier if >= 1.0a)
-> Manager
-> 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 if >= 1.0a)
-> Manager
-> m Credential	Token Credential (Access Token & Secret)

Get Access token via the proxy.

getTokenCredential Source #

Arguments

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

Get Access token.

getTokenCredentialProxy Source #

Arguments

:: MonadIO 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.

getAccessToken' Source #

Arguments

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

getAccessTokenWith Source #

Arguments

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

Utility Methods

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 #