Safe Haskell	None
Language	Haskell98

Happstack.Authenticate.Core

Synopsis

Documentation

data AuthenticateConfig Source #

Various configuration options that apply to all authentication methods

Constructors

AuthenticateConfig
Fields _isAuthAdmin :: UserId -> IO Bool can user administrate the authentication system? _usernameAcceptable :: Username -> Maybe CoreError enforce username policies, valid email, etc. `Nothing` == ok, 'Just Text' == error message _requireEmail :: Bool

Instances

Generic AuthenticateConfig Source #
Associated Types type Rep AuthenticateConfig :: * -> * # Methods from :: AuthenticateConfig -> Rep AuthenticateConfig x # to :: Rep AuthenticateConfig x -> AuthenticateConfig #
type Rep AuthenticateConfig Source #
type Rep AuthenticateConfig = D1 * (MetaData "AuthenticateConfig" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) (C1 * (MetaCons "AuthenticateConfig" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_isAuthAdmin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (UserId -> IO Bool))) ((::) (S1 * (MetaSel (Just Symbol "_usernameAcceptable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Username -> Maybe CoreError))) (S1 * (MetaSel (Just Symbol "_requireEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool)))))

isAuthAdmin :: Lens' AuthenticateConfig (UserId -> IO Bool) Source #

usernameAcceptable :: Lens' AuthenticateConfig (Username -> Maybe CoreError) Source #

requireEmail :: Lens' AuthenticateConfig Bool Source #

data HappstackAuthenticateI18N Source #

Constructors

HappstackAuthenticateI18N

Instances

RenderMessage HappstackAuthenticateI18N CoreError Source #
Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> CoreError -> Text #
RenderMessage HappstackAuthenticateI18N OpenIdError #
Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> OpenIdError -> Text #
RenderMessage HappstackAuthenticateI18N PartialMsgs #
Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> PartialMsgs -> Text #
RenderMessage HappstackAuthenticateI18N PasswordError #
Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> PasswordError -> Text #
RenderMessage HappstackAuthenticateI18N PartialMsgs #
Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> PartialMsgs -> Text #

newtype UserId :: * #

a UserId uniquely identifies a user.

Constructors

UserId
Fields _unUserId :: Integer

Instances

Enum UserId
Methods succ :: UserId -> UserId # pred :: UserId -> UserId # toEnum :: Int -> UserId # fromEnum :: UserId -> Int # enumFrom :: UserId -> [UserId] # enumFromThen :: UserId -> UserId -> [UserId] # enumFromTo :: UserId -> UserId -> [UserId] # enumFromThenTo :: UserId -> UserId -> UserId -> [UserId] #
Eq UserId
Methods (==) :: UserId -> UserId -> Bool # (/=) :: UserId -> UserId -> Bool #
Data UserId
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserId -> c UserId # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserId # toConstr :: UserId -> Constr # dataTypeOf :: UserId -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c UserId) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserId) # gmapT :: (forall b. Data b => b -> b) -> UserId -> UserId # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserId -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserId -> r # gmapQ :: (forall d. Data d => d -> u) -> UserId -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UserId -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserId -> m UserId # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserId -> m UserId # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserId -> m UserId #
Ord UserId
Methods compare :: UserId -> UserId -> Ordering # (<) :: UserId -> UserId -> Bool # (<=) :: UserId -> UserId -> Bool # (>) :: UserId -> UserId -> Bool # (>=) :: UserId -> UserId -> Bool # max :: UserId -> UserId -> UserId # min :: UserId -> UserId -> UserId #
Read UserId
Methods readsPrec :: Int -> ReadS UserId # readList :: ReadS [UserId] # readPrec :: ReadPrec UserId # readListPrec :: ReadPrec [UserId] #
Show UserId
Methods showsPrec :: Int -> UserId -> ShowS # show :: UserId -> String # showList :: [UserId] -> ShowS #
Generic UserId
Associated Types type Rep UserId :: * -> * # Methods from :: UserId -> Rep UserId x # to :: Rep UserId x -> UserId #
ToJSON UserId
Methods toJSON :: UserId -> Value # toEncoding :: UserId -> Encoding # toJSONList :: [UserId] -> Value # toEncodingList :: [UserId] -> Encoding #
FromJSON UserId
Methods parseJSON :: Value -> Parser UserId # parseJSONList :: Value -> Parser [UserId] #
Serialize UserId
Methods put :: Putter UserId # get :: Get UserId #
SafeCopy UserId
Methods version :: Version UserId # kind :: Kind UserId # getCopy :: Contained (Get UserId) # putCopy :: UserId -> Contained Put # internalConsistency :: Consistency UserId # objectProfile :: Profile UserId # errorTypeName :: Proxy UserId -> String #
PathInfo UserId
Methods toPathSegments :: UserId -> [Text] # fromPathSegments :: URLParser UserId #
Indexable UserIxs User #
Methods indices :: IxList UserIxs User #
type Rep UserId
type Rep UserId = D1 * (MetaData "UserId" "Data.UserId" "userid-0.1.3.1-AAV2AOqr9J78C3TOfK4Cvp" True) (C1 * (MetaCons "UserId" PrefixI True) (S1 * (MetaSel (Just Symbol "_unUserId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Integer)))

unUserId :: Functor f => (Integer -> f Integer) -> UserId -> f UserId #

rUserId :: Boomerang e tok ((:-) Integer r) ((:-) UserId r) #

succUserId :: UserId -> UserId #

get the next UserId

jsonOptions :: Options Source #

when creating JSON field names, drop the first character. Since we are using lens, the leading character should always be _.

toJSONResponse :: (RenderMessage HappstackAuthenticateI18N e, ToJSON a) => Either e a -> Response Source #

convert a value to a JSON encoded Response

toJSONSuccess :: ToJSON a => a -> Response Source #

convert a value to a JSON encoded Response

toJSONError :: forall e. RenderMessage HappstackAuthenticateI18N e => e -> Response Source #

convert an error to a JSON encoded Response

FIXME: I18N

newtype Username Source #

an arbitrary, but unique string that the user uses to identify themselves

Constructors

Username
Fields _unUsername :: Text

Instances

Eq Username Source #
Methods (==) :: Username -> Username -> Bool # (/=) :: Username -> Username -> Bool #
Data Username Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Username -> c Username # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Username # toConstr :: Username -> Constr # dataTypeOf :: Username -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Username) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Username) # gmapT :: (forall b. Data b => b -> b) -> Username -> Username # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Username -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Username -> r # gmapQ :: (forall d. Data d => d -> u) -> Username -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Username -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Username -> m Username # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Username -> m Username # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Username -> m Username #
Ord Username Source #
Methods compare :: Username -> Username -> Ordering # (<) :: Username -> Username -> Bool # (<=) :: Username -> Username -> Bool # (>) :: Username -> Username -> Bool # (>=) :: Username -> Username -> Bool # max :: Username -> Username -> Username # min :: Username -> Username -> Username #
Read Username Source #
Methods readsPrec :: Int -> ReadS Username # readList :: ReadS [Username] # readPrec :: ReadPrec Username # readListPrec :: ReadPrec [Username] #
Show Username Source #
Methods showsPrec :: Int -> Username -> ShowS # show :: Username -> String # showList :: [Username] -> ShowS #
Generic Username Source #
Associated Types type Rep Username :: * -> * # Methods from :: Username -> Rep Username x # to :: Rep Username x -> Username #
ToJSON Username Source #
Methods toJSON :: Username -> Value # toEncoding :: Username -> Encoding # toJSONList :: [Username] -> Value # toEncodingList :: [Username] -> Encoding #
FromJSON Username Source #
Methods parseJSON :: Value -> Parser Username # parseJSONList :: Value -> Parser [Username] #
SafeCopy Username Source #
Methods version :: Version Username # kind :: Kind Username # getCopy :: Contained (Get Username) # putCopy :: Username -> Contained Put # internalConsistency :: Consistency Username # objectProfile :: Profile Username # errorTypeName :: Proxy Username -> String #
PathInfo Username Source #
Methods toPathSegments :: Username -> [Text] # fromPathSegments :: URLParser Username #
Indexable UserIxs User Source #
Methods indices :: IxList UserIxs User #
type Rep Username Source #
type Rep Username = D1 * (MetaData "Username" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" True) (C1 * (MetaCons "Username" PrefixI True) (S1 * (MetaSel (Just Symbol "_unUsername") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

unUsername :: Iso' Username Text Source #

rUsername :: forall tok e r. Boomerang e tok ((:-) Text r) ((:-) Username r) Source #

usernamePolicy :: Username -> Maybe CoreError Source #

a very basic policy for userAcceptable

Enforces:

Username can not be empty

newtype Email Source #

an Email address. No validation in performed.

Constructors

Email
Fields _unEmail :: Text

Instances

Eq Email Source #
Methods (==) :: Email -> Email -> Bool # (/=) :: Email -> Email -> Bool #
Data Email Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Email -> c Email # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Email # toConstr :: Email -> Constr # dataTypeOf :: Email -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Email) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Email) # gmapT :: (forall b. Data b => b -> b) -> Email -> Email # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Email -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Email -> r # gmapQ :: (forall d. Data d => d -> u) -> Email -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Email -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Email -> m Email # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Email -> m Email # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Email -> m Email #
Ord Email Source #
Methods compare :: Email -> Email -> Ordering # (<) :: Email -> Email -> Bool # (<=) :: Email -> Email -> Bool # (>) :: Email -> Email -> Bool # (>=) :: Email -> Email -> Bool # max :: Email -> Email -> Email # min :: Email -> Email -> Email #
Read Email Source #
Methods readsPrec :: Int -> ReadS Email # readList :: ReadS [Email] # readPrec :: ReadPrec Email # readListPrec :: ReadPrec [Email] #
Show Email Source #
Methods showsPrec :: Int -> Email -> ShowS # show :: Email -> String # showList :: [Email] -> ShowS #
Generic Email Source #
Associated Types type Rep Email :: * -> * # Methods from :: Email -> Rep Email x # to :: Rep Email x -> Email #
ToJSON Email Source #
Methods toJSON :: Email -> Value # toEncoding :: Email -> Encoding # toJSONList :: [Email] -> Value # toEncodingList :: [Email] -> Encoding #
FromJSON Email Source #
Methods parseJSON :: Value -> Parser Email # parseJSONList :: Value -> Parser [Email] #
SafeCopy Email Source #
Methods version :: Version Email # kind :: Kind Email # getCopy :: Contained (Get Email) # putCopy :: Email -> Contained Put # internalConsistency :: Consistency Email # objectProfile :: Profile Email # errorTypeName :: Proxy Email -> String #
PathInfo Email Source #
Methods toPathSegments :: Email -> [Text] # fromPathSegments :: URLParser Email #
Indexable UserIxs User Source #
Methods indices :: IxList UserIxs User #
type Rep Email Source #
type Rep Email = D1 * (MetaData "Email" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" True) (C1 * (MetaCons "Email" PrefixI True) (S1 * (MetaSel (Just Symbol "_unEmail") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

unEmail :: Iso' Email Text Source #

data User Source #

A unique User

Constructors

User
Fields _userId :: UserId _username :: Username _email :: Maybe Email

Instances

Eq User Source #
Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Data User Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> User -> c User # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c User # toConstr :: User -> Constr # dataTypeOf :: User -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c User) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c User) # gmapT :: (forall b. Data b => b -> b) -> User -> User # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> User -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> User -> r # gmapQ :: (forall d. Data d => d -> u) -> User -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> User -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> User -> m User # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> User -> m User # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> User -> m User #
Ord User Source #
Methods compare :: User -> User -> Ordering # (<) :: User -> User -> Bool # (<=) :: User -> User -> Bool # (>) :: User -> User -> Bool # (>=) :: User -> User -> Bool # max :: User -> User -> User # min :: User -> User -> User #
Read User Source #
Methods readsPrec :: Int -> ReadS User # readList :: ReadS [User] # readPrec :: ReadPrec User # readListPrec :: ReadPrec [User] #
Show User Source #
Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
Generic User Source #
Associated Types type Rep User :: * -> * # Methods from :: User -> Rep User x # to :: Rep User x -> User #
ToJSON User Source #
Methods toJSON :: User -> Value # toEncoding :: User -> Encoding # toJSONList :: [User] -> Value # toEncodingList :: [User] -> Encoding #
FromJSON User Source #
Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
SafeCopy User Source #
Methods version :: Version User # kind :: Kind User # getCopy :: Contained (Get User) # putCopy :: User -> Contained Put # internalConsistency :: Consistency User # objectProfile :: Profile User # errorTypeName :: Proxy User -> String #
Indexable UserIxs User Source #
Methods indices :: IxList UserIxs User #
type Rep User Source #
type Rep User = D1 * (MetaData "User" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) (C1 * (MetaCons "User" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_userId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * UserId)) ((::) (S1 * (MetaSel (Just Symbol "_username") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Username)) (S1 * (MetaSel (Just Symbol "_email") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Email))))))

userId :: Lens' User UserId Source #

username :: Lens' User Username Source #

email :: Lens' User (Maybe Email) Source #

type UserIxs = '[UserId, Username, Email] Source #

type IxUser = IxSet UserIxs User Source #

newtype SharedSecret Source #

The shared secret is used to encrypt a users data on a per-user basis. We can invalidate a JWT value by changing the shared secret.

Constructors

SharedSecret
Fields _unSharedSecret :: Text

Instances

Eq SharedSecret Source #
Methods (==) :: SharedSecret -> SharedSecret -> Bool # (/=) :: SharedSecret -> SharedSecret -> Bool #
Data SharedSecret Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SharedSecret -> c SharedSecret # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SharedSecret # toConstr :: SharedSecret -> Constr # dataTypeOf :: SharedSecret -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c SharedSecret) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SharedSecret) # gmapT :: (forall b. Data b => b -> b) -> SharedSecret -> SharedSecret # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SharedSecret -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SharedSecret -> r # gmapQ :: (forall d. Data d => d -> u) -> SharedSecret -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SharedSecret -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SharedSecret -> m SharedSecret # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SharedSecret -> m SharedSecret # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SharedSecret -> m SharedSecret #
Ord SharedSecret Source #
Methods compare :: SharedSecret -> SharedSecret -> Ordering # (<) :: SharedSecret -> SharedSecret -> Bool # (<=) :: SharedSecret -> SharedSecret -> Bool # (>) :: SharedSecret -> SharedSecret -> Bool # (>=) :: SharedSecret -> SharedSecret -> Bool # max :: SharedSecret -> SharedSecret -> SharedSecret # min :: SharedSecret -> SharedSecret -> SharedSecret #
Read SharedSecret Source #
Methods readsPrec :: Int -> ReadS SharedSecret # readList :: ReadS [SharedSecret] # readPrec :: ReadPrec SharedSecret # readListPrec :: ReadPrec [SharedSecret] #
Show SharedSecret Source #
Methods showsPrec :: Int -> SharedSecret -> ShowS # show :: SharedSecret -> String # showList :: [SharedSecret] -> ShowS #
Generic SharedSecret Source #
Associated Types type Rep SharedSecret :: * -> * # Methods from :: SharedSecret -> Rep SharedSecret x # to :: Rep SharedSecret x -> SharedSecret #
SafeCopy SharedSecret Source #
Methods version :: Version SharedSecret # kind :: Kind SharedSecret # getCopy :: Contained (Get SharedSecret) # putCopy :: SharedSecret -> Contained Put # internalConsistency :: Consistency SharedSecret # objectProfile :: Profile SharedSecret # errorTypeName :: Proxy SharedSecret -> String #
type Rep SharedSecret Source #
type Rep SharedSecret = D1 * (MetaData "SharedSecret" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" True) (C1 * (MetaCons "SharedSecret" PrefixI True) (S1 * (MetaSel (Just Symbol "_unSharedSecret") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

unSharedSecret :: Iso' SharedSecret Text Source #

genSharedSecret :: MonadIO m => m SharedSecret Source #

Generate a Salt from 128 bits of data from /dev/urandom, with the system RNG as a fallback. This is the function used to generate salts by makePassword.

genSharedSecretDevURandom :: IO SharedSecret Source #

Generate a SharedSecret from /dev/urandom.

see: genSharedSecret

genSharedSecretSysRandom :: IO SharedSecret Source #

Generate a SharedSecret from Random.

see: genSharedSecret

type SharedSecrets = Map UserId SharedSecret Source #

A map which stores the SharedSecret for each UserId

initialSharedSecrets :: SharedSecrets Source #

An empty SharedSecrets

data CoreError Source #

the CoreError type is used to represent errors in a language agnostic manner. The errors are translated into human readable form via the I18N translations.

Constructors

HandlerNotFound
URLDecodeFailed
UsernameAlreadyExists
AuthorizationRequired
Forbidden
JSONDecodeFailed
InvalidUserId
UsernameNotAcceptable
InvalidEmail
TextError Text

Instances

Eq CoreError Source #
Methods (==) :: CoreError -> CoreError -> Bool # (/=) :: CoreError -> CoreError -> Bool #
Data CoreError Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoreError -> c CoreError # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoreError # toConstr :: CoreError -> Constr # dataTypeOf :: CoreError -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CoreError) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoreError) # gmapT :: (forall b. Data b => b -> b) -> CoreError -> CoreError # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoreError -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoreError -> r # gmapQ :: (forall d. Data d => d -> u) -> CoreError -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoreError -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoreError -> m CoreError # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoreError -> m CoreError # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoreError -> m CoreError #
Ord CoreError Source #
Methods compare :: CoreError -> CoreError -> Ordering # (<) :: CoreError -> CoreError -> Bool # (<=) :: CoreError -> CoreError -> Bool # (>) :: CoreError -> CoreError -> Bool # (>=) :: CoreError -> CoreError -> Bool # max :: CoreError -> CoreError -> CoreError # min :: CoreError -> CoreError -> CoreError #
Read CoreError Source #
Methods readsPrec :: Int -> ReadS CoreError # readList :: ReadS [CoreError] # readPrec :: ReadPrec CoreError # readListPrec :: ReadPrec [CoreError] #
Show CoreError Source #
Methods showsPrec :: Int -> CoreError -> ShowS # show :: CoreError -> String # showList :: [CoreError] -> ShowS #
Generic CoreError Source #
Associated Types type Rep CoreError :: * -> * # Methods from :: CoreError -> Rep CoreError x # to :: Rep CoreError x -> CoreError #
ToJSON CoreError Source #
Methods toJSON :: CoreError -> Value # toEncoding :: CoreError -> Encoding # toJSONList :: [CoreError] -> Value # toEncodingList :: [CoreError] -> Encoding #
FromJSON CoreError Source #
Methods parseJSON :: Value -> Parser CoreError # parseJSONList :: Value -> Parser [CoreError] #
ToJExpr CoreError Source #
Methods toJExpr :: CoreError -> JExpr # toJExprFromList :: [CoreError] -> JExpr #
SafeCopy CoreError Source #
Methods version :: Version CoreError # kind :: Kind CoreError # getCopy :: Contained (Get CoreError) # putCopy :: CoreError -> Contained Put # internalConsistency :: Consistency CoreError # objectProfile :: Profile CoreError # errorTypeName :: Proxy CoreError -> String #
RenderMessage HappstackAuthenticateI18N CoreError Source #
Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> CoreError -> Text #
type Rep CoreError Source #
type Rep CoreError = D1 * (MetaData "CoreError" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "HandlerNotFound" PrefixI False) (U1 )) (C1 (MetaCons "URLDecodeFailed" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "UsernameAlreadyExists" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "AuthorizationRequired" PrefixI False) (U1 )) (C1 (MetaCons "Forbidden" PrefixI False) (U1 ))))) ((:+:) ((:+:) * (C1 * (MetaCons "JSONDecodeFailed" PrefixI False) (U1 )) (C1 (MetaCons "InvalidUserId" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "UsernameNotAcceptable" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "InvalidEmail" PrefixI False) (U1 )) (C1 (MetaCons "TextError" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))))))

data NewAccountMode Source #

This value is used to configure the type of new user registrations permitted for this system.

Constructors

OpenRegistration	new users can create their own accounts
ModeratedRegistration	new users can apply to create their own accounts, but a moderator must approve them before they are active
ClosedRegistration	only the admin can create a new account

Instances

Eq NewAccountMode Source #
Methods (==) :: NewAccountMode -> NewAccountMode -> Bool # (/=) :: NewAccountMode -> NewAccountMode -> Bool #
Show NewAccountMode Source #
Methods showsPrec :: Int -> NewAccountMode -> ShowS # show :: NewAccountMode -> String # showList :: [NewAccountMode] -> ShowS #
Generic NewAccountMode Source #
Associated Types type Rep NewAccountMode :: * -> * # Methods from :: NewAccountMode -> Rep NewAccountMode x # to :: Rep NewAccountMode x -> NewAccountMode #
SafeCopy NewAccountMode Source #
Methods version :: Version NewAccountMode # kind :: Kind NewAccountMode # getCopy :: Contained (Get NewAccountMode) # putCopy :: NewAccountMode -> Contained Put # internalConsistency :: Consistency NewAccountMode # objectProfile :: Profile NewAccountMode # errorTypeName :: Proxy NewAccountMode -> String #
type Rep NewAccountMode Source #
type Rep NewAccountMode = D1 * (MetaData "NewAccountMode" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) ((:+:) * (C1 * (MetaCons "OpenRegistration" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "ModeratedRegistration" PrefixI False) (U1 )) (C1 (MetaCons "ClosedRegistration" PrefixI False) (U1 *))))

data AuthenticateState Source #

this acid-state value contains the state common to all authentication methods

Constructors

AuthenticateState
Fields _sharedSecrets :: SharedSecrets _users :: IxUser _nextUserId :: UserId _defaultSessionTimeout :: Int default session time out in seconds _newAccountMode :: NewAccountMode

Instances

Eq AuthenticateState Source #
Methods (==) :: AuthenticateState -> AuthenticateState -> Bool # (/=) :: AuthenticateState -> AuthenticateState -> Bool #
Show AuthenticateState Source #
Methods showsPrec :: Int -> AuthenticateState -> ShowS # show :: AuthenticateState -> String # showList :: [AuthenticateState] -> ShowS #
Generic AuthenticateState Source #
Associated Types type Rep AuthenticateState :: * -> * # Methods from :: AuthenticateState -> Rep AuthenticateState x # to :: Rep AuthenticateState x -> AuthenticateState #
IsAcidic AuthenticateState Source #
Methods acidEvents :: [Event AuthenticateState] #
SafeCopy AuthenticateState Source #
Methods version :: Version AuthenticateState # kind :: Kind AuthenticateState # getCopy :: Contained (Get AuthenticateState) # putCopy :: AuthenticateState -> Contained Put # internalConsistency :: Consistency AuthenticateState # objectProfile :: Profile AuthenticateState # errorTypeName :: Proxy AuthenticateState -> String #
type Rep AuthenticateState Source #
type Rep AuthenticateState = D1 * (MetaData "AuthenticateState" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) (C1 * (MetaCons "AuthenticateState" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_sharedSecrets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * SharedSecrets)) (S1 * (MetaSel (Just Symbol "_users") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * IxUser))) ((::) (S1 * (MetaSel (Just Symbol "_nextUserId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * UserId)) ((::) (S1 * (MetaSel (Just Symbol "_defaultSessionTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_newAccountMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * NewAccountMode))))))

sharedSecrets :: Lens' AuthenticateState SharedSecrets Source #

users :: Lens' AuthenticateState IxUser Source #

nextUserId :: Lens' AuthenticateState UserId Source #

defaultSessionTimeout :: Lens' AuthenticateState Int Source #

newAccountMode :: Lens' AuthenticateState NewAccountMode Source #

initialAuthenticateState :: AuthenticateState Source #

a reasonable initial AuthenticateState

data SetSharedSecret Source #

Constructors

SetSharedSecret UserId SharedSecret

Instances

UpdateEvent SetSharedSecret Source #

Method SetSharedSecret Source #
Associated Types type MethodResult SetSharedSecret :: * # type MethodState SetSharedSecret :: * # Methods methodTag :: SetSharedSecret -> Tag #
SafeCopy SetSharedSecret Source #
Methods version :: Version SetSharedSecret # kind :: Kind SetSharedSecret # getCopy :: Contained (Get SetSharedSecret) # putCopy :: SetSharedSecret -> Contained Put # internalConsistency :: Consistency SetSharedSecret # objectProfile :: Profile SetSharedSecret # errorTypeName :: Proxy SetSharedSecret -> String #
type MethodState SetSharedSecret Source #
type MethodState SetSharedSecret = AuthenticateState
type MethodResult SetSharedSecret Source #
type MethodResult SetSharedSecret = ()

newtype GetSharedSecret Source #

Constructors

GetSharedSecret UserId

Instances

QueryEvent GetSharedSecret Source #

Method GetSharedSecret Source #
Associated Types type MethodResult GetSharedSecret :: * # type MethodState GetSharedSecret :: * # Methods methodTag :: GetSharedSecret -> Tag #
SafeCopy GetSharedSecret Source #
Methods version :: Version GetSharedSecret # kind :: Kind GetSharedSecret # getCopy :: Contained (Get GetSharedSecret) # putCopy :: GetSharedSecret -> Contained Put # internalConsistency :: Consistency GetSharedSecret # objectProfile :: Profile GetSharedSecret # errorTypeName :: Proxy GetSharedSecret -> String #
type MethodState GetSharedSecret Source #
type MethodState GetSharedSecret = AuthenticateState
type MethodResult GetSharedSecret Source #
type MethodResult GetSharedSecret = Maybe SharedSecret

newtype SetDefaultSessionTimeout Source #

Constructors

SetDefaultSessionTimeout Int

Instances

UpdateEvent SetDefaultSessionTimeout Source #

Method SetDefaultSessionTimeout Source #
Associated Types type MethodResult SetDefaultSessionTimeout :: * # type MethodState SetDefaultSessionTimeout :: * # Methods methodTag :: SetDefaultSessionTimeout -> Tag #
SafeCopy SetDefaultSessionTimeout Source #
Methods version :: Version SetDefaultSessionTimeout # kind :: Kind SetDefaultSessionTimeout # getCopy :: Contained (Get SetDefaultSessionTimeout) # putCopy :: SetDefaultSessionTimeout -> Contained Put # internalConsistency :: Consistency SetDefaultSessionTimeout # objectProfile :: Profile SetDefaultSessionTimeout # errorTypeName :: Proxy SetDefaultSessionTimeout -> String #
type MethodState SetDefaultSessionTimeout Source #
type MethodState SetDefaultSessionTimeout = AuthenticateState
type MethodResult SetDefaultSessionTimeout Source #
type MethodResult SetDefaultSessionTimeout = ()

data GetDefaultSessionTimeout Source #

Constructors

GetDefaultSessionTimeout

Instances

QueryEvent GetDefaultSessionTimeout Source #

Method GetDefaultSessionTimeout Source #
Associated Types type MethodResult GetDefaultSessionTimeout :: * # type MethodState GetDefaultSessionTimeout :: * # Methods methodTag :: GetDefaultSessionTimeout -> Tag #
SafeCopy GetDefaultSessionTimeout Source #
Methods version :: Version GetDefaultSessionTimeout # kind :: Kind GetDefaultSessionTimeout # getCopy :: Contained (Get GetDefaultSessionTimeout) # putCopy :: GetDefaultSessionTimeout -> Contained Put # internalConsistency :: Consistency GetDefaultSessionTimeout # objectProfile :: Profile GetDefaultSessionTimeout # errorTypeName :: Proxy GetDefaultSessionTimeout -> String #
type MethodState GetDefaultSessionTimeout Source #
type MethodState GetDefaultSessionTimeout = AuthenticateState
type MethodResult GetDefaultSessionTimeout Source #
type MethodResult GetDefaultSessionTimeout = Int

newtype SetNewAccountMode Source #

Constructors

SetNewAccountMode NewAccountMode

Instances

UpdateEvent SetNewAccountMode Source #

Method SetNewAccountMode Source #
Associated Types type MethodResult SetNewAccountMode :: * # type MethodState SetNewAccountMode :: * # Methods methodTag :: SetNewAccountMode -> Tag #
SafeCopy SetNewAccountMode Source #
Methods version :: Version SetNewAccountMode # kind :: Kind SetNewAccountMode # getCopy :: Contained (Get SetNewAccountMode) # putCopy :: SetNewAccountMode -> Contained Put # internalConsistency :: Consistency SetNewAccountMode # objectProfile :: Profile SetNewAccountMode # errorTypeName :: Proxy SetNewAccountMode -> String #
type MethodState SetNewAccountMode Source #
type MethodState SetNewAccountMode = AuthenticateState
type MethodResult SetNewAccountMode Source #
type MethodResult SetNewAccountMode = ()

data GetNewAccountMode Source #

Constructors

GetNewAccountMode

Instances

QueryEvent GetNewAccountMode Source #

Method GetNewAccountMode Source #
Associated Types type MethodResult GetNewAccountMode :: * # type MethodState GetNewAccountMode :: * # Methods methodTag :: GetNewAccountMode -> Tag #
SafeCopy GetNewAccountMode Source #
Methods version :: Version GetNewAccountMode # kind :: Kind GetNewAccountMode # getCopy :: Contained (Get GetNewAccountMode) # putCopy :: GetNewAccountMode -> Contained Put # internalConsistency :: Consistency GetNewAccountMode # objectProfile :: Profile GetNewAccountMode # errorTypeName :: Proxy GetNewAccountMode -> String #
type MethodState GetNewAccountMode Source #
type MethodState GetNewAccountMode = AuthenticateState
type MethodResult GetNewAccountMode Source #
type MethodResult GetNewAccountMode = NewAccountMode

newtype CreateUser Source #

Constructors

CreateUser User

Instances

UpdateEvent CreateUser Source #

Method CreateUser Source #
Associated Types type MethodResult CreateUser :: * # type MethodState CreateUser :: * # Methods methodTag :: CreateUser -> Tag #
SafeCopy CreateUser Source #
Methods version :: Version CreateUser # kind :: Kind CreateUser # getCopy :: Contained (Get CreateUser) # putCopy :: CreateUser -> Contained Put # internalConsistency :: Consistency CreateUser # objectProfile :: Profile CreateUser # errorTypeName :: Proxy CreateUser -> String #
type MethodState CreateUser Source #
type MethodState CreateUser = AuthenticateState
type MethodResult CreateUser Source #
type MethodResult CreateUser = Either CoreError User

data CreateAnonymousUser Source #

Constructors

CreateAnonymousUser

Instances

UpdateEvent CreateAnonymousUser Source #

Method CreateAnonymousUser Source #
Associated Types type MethodResult CreateAnonymousUser :: * # type MethodState CreateAnonymousUser :: * # Methods methodTag :: CreateAnonymousUser -> Tag #
SafeCopy CreateAnonymousUser Source #
Methods version :: Version CreateAnonymousUser # kind :: Kind CreateAnonymousUser # getCopy :: Contained (Get CreateAnonymousUser) # putCopy :: CreateAnonymousUser -> Contained Put # internalConsistency :: Consistency CreateAnonymousUser # objectProfile :: Profile CreateAnonymousUser # errorTypeName :: Proxy CreateAnonymousUser -> String #
type MethodState CreateAnonymousUser Source #
type MethodState CreateAnonymousUser = AuthenticateState
type MethodResult CreateAnonymousUser Source #
type MethodResult CreateAnonymousUser = User

newtype UpdateUser Source #

Constructors

UpdateUser User

Instances

UpdateEvent UpdateUser Source #

Method UpdateUser Source #
Associated Types type MethodResult UpdateUser :: * # type MethodState UpdateUser :: * # Methods methodTag :: UpdateUser -> Tag #
SafeCopy UpdateUser Source #
Methods version :: Version UpdateUser # kind :: Kind UpdateUser # getCopy :: Contained (Get UpdateUser) # putCopy :: UpdateUser -> Contained Put # internalConsistency :: Consistency UpdateUser # objectProfile :: Profile UpdateUser # errorTypeName :: Proxy UpdateUser -> String #
type MethodState UpdateUser Source #
type MethodState UpdateUser = AuthenticateState
type MethodResult UpdateUser Source #
type MethodResult UpdateUser = ()

newtype DeleteUser Source #

Constructors

DeleteUser UserId

Instances

UpdateEvent DeleteUser Source #

Method DeleteUser Source #
Associated Types type MethodResult DeleteUser :: * # type MethodState DeleteUser :: * # Methods methodTag :: DeleteUser -> Tag #
SafeCopy DeleteUser Source #
Methods version :: Version DeleteUser # kind :: Kind DeleteUser # getCopy :: Contained (Get DeleteUser) # putCopy :: DeleteUser -> Contained Put # internalConsistency :: Consistency DeleteUser # objectProfile :: Profile DeleteUser # errorTypeName :: Proxy DeleteUser -> String #
type MethodState DeleteUser Source #
type MethodState DeleteUser = AuthenticateState
type MethodResult DeleteUser Source #
type MethodResult DeleteUser = ()

newtype GetUserByUsername Source #

Constructors

GetUserByUsername Username

Instances

QueryEvent GetUserByUsername Source #

Method GetUserByUsername Source #
Associated Types type MethodResult GetUserByUsername :: * # type MethodState GetUserByUsername :: * # Methods methodTag :: GetUserByUsername -> Tag #
SafeCopy GetUserByUsername Source #
Methods version :: Version GetUserByUsername # kind :: Kind GetUserByUsername # getCopy :: Contained (Get GetUserByUsername) # putCopy :: GetUserByUsername -> Contained Put # internalConsistency :: Consistency GetUserByUsername # objectProfile :: Profile GetUserByUsername # errorTypeName :: Proxy GetUserByUsername -> String #
type MethodState GetUserByUsername Source #
type MethodState GetUserByUsername = AuthenticateState
type MethodResult GetUserByUsername Source #
type MethodResult GetUserByUsername = Maybe User

newtype GetUserByUserId Source #

Constructors

GetUserByUserId UserId

Instances

QueryEvent GetUserByUserId Source #

Method GetUserByUserId Source #
Associated Types type MethodResult GetUserByUserId :: * # type MethodState GetUserByUserId :: * # Methods methodTag :: GetUserByUserId -> Tag #
SafeCopy GetUserByUserId Source #
Methods version :: Version GetUserByUserId # kind :: Kind GetUserByUserId # getCopy :: Contained (Get GetUserByUserId) # putCopy :: GetUserByUserId -> Contained Put # internalConsistency :: Consistency GetUserByUserId # objectProfile :: Profile GetUserByUserId # errorTypeName :: Proxy GetUserByUserId -> String #
type MethodState GetUserByUserId Source #
type MethodState GetUserByUserId = AuthenticateState
type MethodResult GetUserByUserId Source #
type MethodResult GetUserByUserId = Maybe User

newtype GetUserByEmail Source #

Constructors

GetUserByEmail Email

Instances

QueryEvent GetUserByEmail Source #

Method GetUserByEmail Source #
Associated Types type MethodResult GetUserByEmail :: * # type MethodState GetUserByEmail :: * # Methods methodTag :: GetUserByEmail -> Tag #
SafeCopy GetUserByEmail Source #
Methods version :: Version GetUserByEmail # kind :: Kind GetUserByEmail # getCopy :: Contained (Get GetUserByEmail) # putCopy :: GetUserByEmail -> Contained Put # internalConsistency :: Consistency GetUserByEmail # objectProfile :: Profile GetUserByEmail # errorTypeName :: Proxy GetUserByEmail -> String #
type MethodState GetUserByEmail Source #
type MethodState GetUserByEmail = AuthenticateState
type MethodResult GetUserByEmail Source #
type MethodResult GetUserByEmail = Maybe User

data GetAuthenticateState Source #

Constructors

GetAuthenticateState

Instances

QueryEvent GetAuthenticateState Source #

Method GetAuthenticateState Source #
Associated Types type MethodResult GetAuthenticateState :: * # type MethodState GetAuthenticateState :: * # Methods methodTag :: GetAuthenticateState -> Tag #
SafeCopy GetAuthenticateState Source #
Methods version :: Version GetAuthenticateState # kind :: Kind GetAuthenticateState # getCopy :: Contained (Get GetAuthenticateState) # putCopy :: GetAuthenticateState -> Contained Put # internalConsistency :: Consistency GetAuthenticateState # objectProfile :: Profile GetAuthenticateState # errorTypeName :: Proxy GetAuthenticateState -> String #
type MethodState GetAuthenticateState Source #
type MethodState GetAuthenticateState = AuthenticateState
type MethodResult GetAuthenticateState Source #
type MethodResult GetAuthenticateState = AuthenticateState

getOrGenSharedSecret :: MonadIO m => AcidState AuthenticateState -> UserId -> m SharedSecret Source #

get the SharedSecret for UserId. Generate one if they don't have one yet.

data Token Source #

The Token type represents the encrypted data used to identify a user.

Constructors

Token
Fields _tokenUser :: User _tokenIsAuthAdmin :: Bool

Instances

Eq Token Source #
Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Data Token Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Token -> c Token # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Token # toConstr :: Token -> Constr # dataTypeOf :: Token -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Token) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Token) # gmapT :: (forall b. Data b => b -> b) -> Token -> Token # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Token -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Token -> r # gmapQ :: (forall d. Data d => d -> u) -> Token -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Token -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Token -> m Token # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Token -> m Token # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Token -> m Token #
Ord Token Source #
Methods compare :: Token -> Token -> Ordering # (<) :: Token -> Token -> Bool # (<=) :: Token -> Token -> Bool # (>) :: Token -> Token -> Bool # (>=) :: Token -> Token -> Bool # max :: Token -> Token -> Token # min :: Token -> Token -> Token #
Read Token Source #
Methods readsPrec :: Int -> ReadS Token # readList :: ReadS [Token] # readPrec :: ReadPrec Token # readListPrec :: ReadPrec [Token] #
Show Token Source #
Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Generic Token Source #
Associated Types type Rep Token :: * -> * # Methods from :: Token -> Rep Token x # to :: Rep Token x -> Token #
ToJSON Token Source #
Methods toJSON :: Token -> Value # toEncoding :: Token -> Encoding # toJSONList :: [Token] -> Value # toEncodingList :: [Token] -> Encoding #
FromJSON Token Source #
Methods parseJSON :: Value -> Parser Token # parseJSONList :: Value -> Parser [Token] #
type Rep Token Source #
type Rep Token = D1 * (MetaData "Token" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) (C1 * (MetaCons "Token" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_tokenUser") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * User)) (S1 * (MetaSel (Just Symbol "_tokenIsAuthAdmin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool))))

tokenUser :: Lens' Token User Source #

tokenIsAuthAdmin :: Lens' Token Bool Source #

type TokenText = Text Source #

TokenText is the encrypted form of the Token which is passed between the server and the client.

issueToken Source #

Arguments

:: MonadIO m
=> AcidState AuthenticateState
-> AuthenticateConfig
-> User	the user
-> m TokenText

create a Token for User

The isAuthAdmin paramater is a function which will be called to determine if UserId is a user who should be given Administrator privileges. This includes the ability to things such as set the OpenId realm, change the registeration mode, etc.

decodeAndVerifyToken :: MonadIO m => AcidState AuthenticateState -> UTCTime -> TokenText -> m (Maybe (Token, JWT VerifiedJWT)) Source #

decode and verify the TokenText. If successful, return the Token otherwise Nothing.

authCookieName :: String Source #

name of the Cookie used to hold the TokenText

addTokenCookie :: Happstack m => AcidState AuthenticateState -> AuthenticateConfig -> User -> m TokenText Source #

create a Token for User and add a Cookie to the Response

Eq AuthenticationMethod Source #
Methods (==) :: AuthenticationMethod -> AuthenticationMethod -> Bool # (/=) :: AuthenticationMethod -> AuthenticationMethod -> Bool #
Data AuthenticationMethod Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AuthenticationMethod -> c AuthenticationMethod # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AuthenticationMethod # toConstr :: AuthenticationMethod -> Constr # dataTypeOf :: AuthenticationMethod -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c AuthenticationMethod) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AuthenticationMethod) # gmapT :: (forall b. Data b => b -> b) -> AuthenticationMethod -> AuthenticationMethod # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AuthenticationMethod -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AuthenticationMethod -> r # gmapQ :: (forall d. Data d => d -> u) -> AuthenticationMethod -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AuthenticationMethod -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AuthenticationMethod -> m AuthenticationMethod # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthenticationMethod -> m AuthenticationMethod # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthenticationMethod -> m AuthenticationMethod #
Ord AuthenticationMethod Source #
Methods compare :: AuthenticationMethod -> AuthenticationMethod -> Ordering # (<) :: AuthenticationMethod -> AuthenticationMethod -> Bool # (<=) :: AuthenticationMethod -> AuthenticationMethod -> Bool # (>) :: AuthenticationMethod -> AuthenticationMethod -> Bool # (>=) :: AuthenticationMethod -> AuthenticationMethod -> Bool # max :: AuthenticationMethod -> AuthenticationMethod -> AuthenticationMethod # min :: AuthenticationMethod -> AuthenticationMethod -> AuthenticationMethod #
Read AuthenticationMethod Source #
Methods readsPrec :: Int -> ReadS AuthenticationMethod # readList :: ReadS [AuthenticationMethod] # readPrec :: ReadPrec AuthenticationMethod # readListPrec :: ReadPrec [AuthenticationMethod] #
Show AuthenticationMethod Source #
Methods showsPrec :: Int -> AuthenticationMethod -> ShowS # show :: AuthenticationMethod -> String # showList :: [AuthenticationMethod] -> ShowS #
Generic AuthenticationMethod Source #
Associated Types type Rep AuthenticationMethod :: * -> * # Methods from :: AuthenticationMethod -> Rep AuthenticationMethod x # to :: Rep AuthenticationMethod x -> AuthenticationMethod #
ToJSON AuthenticationMethod Source #
Methods toJSON :: AuthenticationMethod -> Value # toEncoding :: AuthenticationMethod -> Encoding # toJSONList :: [AuthenticationMethod] -> Value # toEncodingList :: [AuthenticationMethod] -> Encoding #
FromJSON AuthenticationMethod Source #
Methods parseJSON :: Value -> Parser AuthenticationMethod # parseJSONList :: Value -> Parser [AuthenticationMethod] #
SafeCopy AuthenticationMethod Source #
Methods version :: Version AuthenticationMethod # kind :: Kind AuthenticationMethod # getCopy :: Contained (Get AuthenticationMethod) # putCopy :: AuthenticationMethod -> Contained Put # internalConsistency :: Consistency AuthenticationMethod # objectProfile :: Profile AuthenticationMethod # errorTypeName :: Proxy AuthenticationMethod -> String #
PathInfo AuthenticationMethod Source #
Methods toPathSegments :: AuthenticationMethod -> [Text] # fromPathSegments :: URLParser AuthenticationMethod #
type Rep AuthenticationMethod Source #
type Rep AuthenticationMethod = D1 * (MetaData "AuthenticationMethod" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" True) (C1 * (MetaCons "AuthenticationMethod" PrefixI True) (S1 * (MetaSel (Just Symbol "_unAuthenticationMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

Eq AuthenticateURL Source #
Methods (==) :: AuthenticateURL -> AuthenticateURL -> Bool # (/=) :: AuthenticateURL -> AuthenticateURL -> Bool #
Data AuthenticateURL Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AuthenticateURL -> c AuthenticateURL # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AuthenticateURL # toConstr :: AuthenticateURL -> Constr # dataTypeOf :: AuthenticateURL -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c AuthenticateURL) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AuthenticateURL) # gmapT :: (forall b. Data b => b -> b) -> AuthenticateURL -> AuthenticateURL # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AuthenticateURL -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AuthenticateURL -> r # gmapQ :: (forall d. Data d => d -> u) -> AuthenticateURL -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AuthenticateURL -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AuthenticateURL -> m AuthenticateURL # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthenticateURL -> m AuthenticateURL # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthenticateURL -> m AuthenticateURL #
Ord AuthenticateURL Source #
Methods compare :: AuthenticateURL -> AuthenticateURL -> Ordering # (<) :: AuthenticateURL -> AuthenticateURL -> Bool # (<=) :: AuthenticateURL -> AuthenticateURL -> Bool # (>) :: AuthenticateURL -> AuthenticateURL -> Bool # (>=) :: AuthenticateURL -> AuthenticateURL -> Bool # max :: AuthenticateURL -> AuthenticateURL -> AuthenticateURL # min :: AuthenticateURL -> AuthenticateURL -> AuthenticateURL #
Read AuthenticateURL Source #
Methods readsPrec :: Int -> ReadS AuthenticateURL # readList :: ReadS [AuthenticateURL] # readPrec :: ReadPrec AuthenticateURL # readListPrec :: ReadPrec [AuthenticateURL] #
Show AuthenticateURL Source #
Methods showsPrec :: Int -> AuthenticateURL -> ShowS # show :: AuthenticateURL -> String # showList :: [AuthenticateURL] -> ShowS #
Generic AuthenticateURL Source #
Associated Types type Rep AuthenticateURL :: * -> * # Methods from :: AuthenticateURL -> Rep AuthenticateURL x # to :: Rep AuthenticateURL x -> AuthenticateURL #
PathInfo AuthenticateURL Source #
Methods toPathSegments :: AuthenticateURL -> [Text] # fromPathSegments :: URLParser AuthenticateURL #
(Functor m, Monad m) => EmbedAsChild (Partial' m) PartialMsgs #
Methods asChild :: PartialMsgs -> GenChildList (Partial' m) #
(Functor m, Monad m) => EmbedAsChild (Partial' m) PartialMsgs #
Methods asChild :: PartialMsgs -> GenChildList (Partial' m) #
(Functor m, Monad m) => EmbedAsAttr (Partial' m) (Attr Text PartialMsgs) #
Methods asAttr :: Attr Text PartialMsgs -> GenAttributeList (Partial' m) #
(Functor m, Monad m) => EmbedAsAttr (Partial' m) (Attr Text PartialMsgs) #
Methods asAttr :: Attr Text PartialMsgs -> GenAttributeList (Partial' m) #
type Rep AuthenticateURL Source #
type Rep AuthenticateURL = D1 * (MetaData "AuthenticateURL" "Happstack.Authenticate.Core" "happstack-authenticate-2.3.4.10-KOaQ65BcddsFX2pXVA6rju" False) ((:+:) * (C1 * (MetaCons "AuthenticationMethods" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe (AuthenticationMethod, [Text]))))) (C1 * (MetaCons "Controllers" PrefixI False) (U1 *)))

AuthenticationMethods (Maybe (AuthenticationMethod, [Text]))
Controllers