Web.Rails.Session

Decoding

decode :: Maybe Salt -> SecretKeyBase -> Cookie -> Maybe RubyObject

Decode a cookie encrypted by Rails.

decodeEither :: Maybe Salt -> SecretKeyBase -> Cookie -> Either String RubyObject

Decode a cookie encrypted by Rails and retain some error information on failure.

Decrypting

decrypt :: Maybe Salt -> SecretKeyBase -> Cookie -> Either String DecryptedData

Decrypts a cookie encrypted by Rails. Use this if you are using a serialisation format other than Ruby's Marshal format.

Utilities

csrfToken :: RubyObject -> Maybe ByteString

Helper function for looking up the csrf token in a cooie.

sessionId :: RubyObject -> Maybe ByteString

Helper function for looking up the session id in a cookie.

lookupString :: ByteString -> RubyStringEncoding -> RubyObject -> Maybe ByteString

Lookup string for a given key and throw away encoding information.

lookupFixnum :: ByteString -> RubyStringEncoding -> RubyObject -> Maybe Int

Lookup integer for a given key.

Lifting weaker types into stronger types

data Cookie

Wrapper around raw cookie.

Instances

Eq Cookie

Methods

(==) :: Cookie -> Cookie -> Bool

(/=) :: Cookie -> Cookie -> Bool

Ord Cookie

Methods

compare :: Cookie -> Cookie -> Ordering

(<) :: Cookie -> Cookie -> Bool

(<=) :: Cookie -> Cookie -> Bool

(>) :: Cookie -> Cookie -> Bool

(>=) :: Cookie -> Cookie -> Bool

max :: Cookie -> Cookie -> Cookie

min :: Cookie -> Cookie -> Cookie

Show Cookie

Methods

showsPrec :: Int -> Cookie -> ShowS

show :: Cookie -> String

showList :: [Cookie] -> ShowS

mkCookie :: ByteString -> Cookie

Lift a cookie into a richer type.

data Salt

Wrapper around salt.

Instances

Eq Salt

Methods

(==) :: Salt -> Salt -> Bool

(/=) :: Salt -> Salt -> Bool

Ord Salt

Methods

compare :: Salt -> Salt -> Ordering

(<) :: Salt -> Salt -> Bool

(<=) :: Salt -> Salt -> Bool

(>) :: Salt -> Salt -> Bool

(>=) :: Salt -> Salt -> Bool

max :: Salt -> Salt -> Salt

min :: Salt -> Salt -> Salt

Show Salt

Methods

showsPrec :: Int -> Salt -> ShowS

show :: Salt -> String

showList :: [Salt] -> ShowS

mkSalt :: ByteString -> Salt

Lift salt into a richer type.

data SecretKeyBase

Wrapper around secret key base.

Instances

Eq SecretKeyBase

Methods

(==) :: SecretKeyBase -> SecretKeyBase -> Bool

(/=) :: SecretKeyBase -> SecretKeyBase -> Bool

Ord SecretKeyBase

Methods

compare :: SecretKeyBase -> SecretKeyBase -> Ordering

(<) :: SecretKeyBase -> SecretKeyBase -> Bool

(<=) :: SecretKeyBase -> SecretKeyBase -> Bool

(>) :: SecretKeyBase -> SecretKeyBase -> Bool

(>=) :: SecretKeyBase -> SecretKeyBase -> Bool

max :: SecretKeyBase -> SecretKeyBase -> SecretKeyBase

min :: SecretKeyBase -> SecretKeyBase -> SecretKeyBase

Show SecretKeyBase

Methods

showsPrec :: Int -> SecretKeyBase -> ShowS

show :: SecretKeyBase -> String

showList :: [SecretKeyBase] -> ShowS

mkSecretKeyBase :: ByteString -> SecretKeyBase

Lifts secret into a richer type.

data DecryptedData

Wrapper around data after it has been decrypted.

Instances

Eq DecryptedData

Methods

(==) :: DecryptedData -> DecryptedData -> Bool

(/=) :: DecryptedData -> DecryptedData -> Bool

Ord DecryptedData

Methods

compare :: DecryptedData -> DecryptedData -> Ordering

(<) :: DecryptedData -> DecryptedData -> Bool

(<=) :: DecryptedData -> DecryptedData -> Bool

(>) :: DecryptedData -> DecryptedData -> Bool

(>=) :: DecryptedData -> DecryptedData -> Bool

max :: DecryptedData -> DecryptedData -> DecryptedData

min :: DecryptedData -> DecryptedData -> DecryptedData

Show DecryptedData

Methods

showsPrec :: Int -> DecryptedData -> ShowS

show :: DecryptedData -> String

showList :: [DecryptedData] -> ShowS

unwrapDecryptedData :: DecryptedData -> ByteString