Safe Haskell	None
Language	Haskell2010

Happstack.Authenticate.Core

Synopsis

data AuthenticateConfig = AuthenticateConfig {
- _isAuthAdmin :: UserId -> IO Bool
- _usernameAcceptable :: Username -> Maybe CoreError
- _requireEmail :: Bool
- _systemFromAddress :: Maybe SimpleAddress
- _systemReplyToAddress :: Maybe SimpleAddress
- _systemSendmailPath :: Maybe FilePath
- _postLoginRedirect :: Maybe Text
- _createUserCallback :: Maybe (User -> IO ())
}
isAuthAdmin :: Lens' AuthenticateConfig (UserId -> IO Bool)
usernameAcceptable :: Lens' AuthenticateConfig (Username -> Maybe CoreError)
requireEmail :: Lens' AuthenticateConfig Bool
systemFromAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress)
systemReplyToAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress)
systemSendmailPath :: Lens' AuthenticateConfig (Maybe FilePath)
postLoginRedirect :: Lens' AuthenticateConfig (Maybe Text)
createUserCallback :: Lens' AuthenticateConfig (Maybe (User -> IO ()))
data HappstackAuthenticateI18N = HappstackAuthenticateI18N
newtype UserId = UserId {
- _unUserId :: Integer
}
unUserId :: Functor f => (Integer -> f Integer) -> UserId -> f UserId
rUserId :: forall tok e r. Boomerang e tok (Integer :- r) (UserId :- r)
succUserId :: UserId -> UserId
jsonOptions :: Options
toJSONResponse :: (RenderMessage HappstackAuthenticateI18N e, ToJSON a) => Either e a -> Response
toJSONSuccess :: ToJSON a => a -> Response
toJSONError :: forall e. RenderMessage HappstackAuthenticateI18N e => e -> Response
newtype Username = Username {
- _unUsername :: Text
}
unUsername :: Iso' Username Text
rUsername :: forall tok e r. Boomerang e tok ((:-) Text r) ((:-) Username r)
usernamePolicy :: Username -> Maybe CoreError
newtype Email = Email {
- _unEmail :: Text
}
unEmail :: Iso' Email Text
data User = User {
- _userId :: UserId
- _username :: Username
- _email :: Maybe Email
}
userId :: Lens' User UserId
username :: Lens' User Username
email :: Lens' User (Maybe Email)
type UserIxs = '[UserId, Username, Email]
type IxUser = IxSet UserIxs User
newtype SharedSecret = SharedSecret {
- _unSharedSecret :: Text
}
unSharedSecret :: Iso' SharedSecret Text
data SimpleAddress = SimpleAddress {
- _saName :: Maybe Text
- _saEmail :: Email
}
genSharedSecret :: MonadIO m => m SharedSecret
genSharedSecretDevURandom :: IO SharedSecret
genSharedSecretSysRandom :: IO SharedSecret
type SharedSecrets = Map UserId SharedSecret
initialSharedSecrets :: SharedSecrets
data CoreError
- = HandlerNotFound
- | URLDecodeFailed
- | UsernameAlreadyExists
- | AuthorizationRequired
- | Forbidden
- | JSONDecodeFailed
- | InvalidUserId
- | UsernameNotAcceptable
- | InvalidEmail
- | TextError Text
data NewAccountMode
- = OpenRegistration
- | ModeratedRegistration
- | ClosedRegistration
data AuthenticateState = AuthenticateState {
- _sharedSecrets :: SharedSecrets
- _users :: IxUser
- _nextUserId :: UserId
- _defaultSessionTimeout :: Int
- _newAccountMode :: NewAccountMode
}
sharedSecrets :: Lens' AuthenticateState SharedSecrets
users :: Lens' AuthenticateState IxUser
nextUserId :: Lens' AuthenticateState UserId
defaultSessionTimeout :: Lens' AuthenticateState Int
newAccountMode :: Lens' AuthenticateState NewAccountMode
initialAuthenticateState :: AuthenticateState
data SetSharedSecret = SetSharedSecret UserId SharedSecret
newtype GetSharedSecret = GetSharedSecret UserId
newtype SetDefaultSessionTimeout = SetDefaultSessionTimeout Int
data GetDefaultSessionTimeout = GetDefaultSessionTimeout
newtype SetNewAccountMode = SetNewAccountMode NewAccountMode
data GetNewAccountMode = GetNewAccountMode
newtype CreateUser = CreateUser User
data CreateAnonymousUser = CreateAnonymousUser
newtype UpdateUser = UpdateUser User
newtype DeleteUser = DeleteUser UserId
newtype GetUserByUsername = GetUserByUsername Username
newtype GetUserByUserId = GetUserByUserId UserId
newtype GetUserByEmail = GetUserByEmail Email
data GetUsers = GetUsers
newtype GetUsersByEmail = GetUsersByEmail Email
data GetAuthenticateState = GetAuthenticateState
getOrGenSharedSecret :: MonadIO m => AcidState AuthenticateState -> UserId -> m SharedSecret
data Token = Token {
- _tokenUser :: User
- _tokenIsAuthAdmin :: Bool
}
tokenUser :: Lens' Token User
tokenIsAuthAdmin :: Lens' Token Bool
type TokenText = Text
issueToken :: MonadIO m => AcidState AuthenticateState -> AuthenticateConfig -> User -> m TokenText
decodeAndVerifyToken :: MonadIO m => AcidState AuthenticateState -> UTCTime -> TokenText -> m (Maybe (Token, JWT VerifiedJWT))
authCookieName :: String
addTokenCookie :: Happstack m => AcidState AuthenticateState -> AuthenticateConfig -> User -> m TokenText
deleteTokenCookie :: Happstack m => m ()
getTokenCookie :: Happstack m => AcidState AuthenticateState -> m (Maybe (Token, JWT VerifiedJWT))
getTokenHeader :: Happstack m => AcidState AuthenticateState -> m (Maybe (Token, JWT VerifiedJWT))
getToken :: Happstack m => AcidState AuthenticateState -> m (Maybe (Token, JWT VerifiedJWT))
getUserId :: Happstack m => AcidState AuthenticateState -> m (Maybe UserId)
newtype AuthenticationMethod = AuthenticationMethod {
- _unAuthenticationMethod :: Text
}
unAuthenticationMethod :: Iso' AuthenticationMethod Text
rAuthenticationMethod :: forall tok e r. Boomerang e tok ((:-) Text r) ((:-) AuthenticationMethod r)
type AuthenticationHandler = [Text] -> RouteT AuthenticateURL (ServerPartT IO) Response
type AuthenticationHandlers = Map AuthenticationMethod AuthenticationHandler
data AuthenticateURL
- = AuthenticationMethods (Maybe (AuthenticationMethod, [Text]))
- | Controllers
rAuthenticationMethods :: forall tok e r. Boomerang e tok ((:-) (Maybe (AuthenticationMethod, [Text])) r) ((:-) AuthenticateURL r)
rControllers :: forall tok e r. Boomerang e tok r ((:-) AuthenticateURL r)
systemFromAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress)
systemReplyToAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress)
systemSendmailPath :: Lens' AuthenticateConfig (Maybe FilePath)
authenticateURL :: Router () (AuthenticateURL :- ())
nestAuthenticationMethod :: PathInfo methodURL => AuthenticationMethod -> RouteT methodURL m a -> RouteT AuthenticateURL m a

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
require use to supply an email address when creating an account
_systemFromAddress :: Maybe SimpleAddress
From: line for emails sent by the server
_systemReplyToAddress :: Maybe SimpleAddress
Reply-To: line for emails sent by the server
_systemSendmailPath :: Maybe FilePath
path to sendmail if it is not /usr/sbin/sendmail
_postLoginRedirect :: Maybe Text
path to redirect to after a successful login
_createUserCallback :: Maybe (User -> IO ())
a function to call when a new user is created. Useful for adding them to mailing lists or other stuff

Instances

Instances details

Generic AuthenticateConfig Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep AuthenticateConfig :: Type -> Type # Methods from :: AuthenticateConfig -> Rep AuthenticateConfig x # to :: Rep AuthenticateConfig x -> AuthenticateConfig #
type Rep AuthenticateConfig Source #
Instance details Defined in Happstack.Authenticate.Core type Rep AuthenticateConfig = D1 ('MetaData "AuthenticateConfig" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (C1 ('MetaCons "AuthenticateConfig" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_isAuthAdmin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UserId -> IO Bool)) :: S1 ('MetaSel ('Just "_usernameAcceptable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Username -> Maybe CoreError))) :: (S1 ('MetaSel ('Just "_requireEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "_systemFromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SimpleAddress)))) :: ((S1 ('MetaSel ('Just "_systemReplyToAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SimpleAddress)) :: S1 ('MetaSel ('Just "_systemSendmailPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 ('MetaSel ('Just "_postLoginRedirect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_createUserCallback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (User -> IO ())))))))

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

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

requireEmail :: Lens' AuthenticateConfig Bool Source #

systemFromAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress) Source #

systemReplyToAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress) Source #

systemSendmailPath :: Lens' AuthenticateConfig (Maybe FilePath) Source #

postLoginRedirect :: Lens' AuthenticateConfig (Maybe Text) Source #

createUserCallback :: Lens' AuthenticateConfig (Maybe (User -> IO ())) Source #

data HappstackAuthenticateI18N Source #

Constructors

HappstackAuthenticateI18N

Instances

Instances details

RenderMessage HappstackAuthenticateI18N CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> CoreError -> Text #
RenderMessage HappstackAuthenticateI18N OpenIdError Source #
Instance details Defined in Happstack.Authenticate.OpenId.Core Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> OpenIdError -> Text #
RenderMessage HappstackAuthenticateI18N PartialMsgs Source #
Instance details Defined in Happstack.Authenticate.OpenId.Partials Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> PartialMsgs -> Text #
RenderMessage HappstackAuthenticateI18N PasswordError Source #
Instance details Defined in Happstack.Authenticate.Password.Core Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> PasswordError -> Text #
RenderMessage HappstackAuthenticateI18N PartialMsgs Source #
Instance details Defined in Happstack.Authenticate.Password.Partials Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> PartialMsgs -> Text #

newtype UserId #

a UserId uniquely identifies a user.

Constructors

UserId
Fields _unUserId :: Integer

Instances

Instances details

Enum UserId
Instance details Defined in Data.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
Instance details Defined in Data.UserId Methods (==) :: UserId -> UserId -> Bool # (/=) :: UserId -> UserId -> Bool #
Data UserId
Instance details Defined in 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 :: forall r r'. (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
Instance details Defined in Data.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
Instance details Defined in Data.UserId Methods readsPrec :: Int -> ReadS UserId # readList :: ReadS [UserId] # readPrec :: ReadPrec UserId # readListPrec :: ReadPrec [UserId] #
Show UserId
Instance details Defined in Data.UserId Methods showsPrec :: Int -> UserId -> ShowS # show :: UserId -> String # showList :: [UserId] -> ShowS #
Generic UserId
Instance details Defined in Data.UserId Associated Types type Rep UserId :: Type -> Type # Methods from :: UserId -> Rep UserId x # to :: Rep UserId x -> UserId #
SafeCopy UserId
Instance details Defined in Data.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 #
ToJSON UserId
Instance details Defined in Data.UserId Methods toJSON :: UserId -> Value # toEncoding :: UserId -> Encoding # toJSONList :: [UserId] -> Value # toEncodingList :: [UserId] -> Encoding #
FromJSON UserId
Instance details Defined in Data.UserId Methods parseJSON :: Value -> Parser UserId # parseJSONList :: Value -> Parser [UserId] #
Serialize UserId
Instance details Defined in Data.UserId Methods put :: Putter UserId # get :: Get UserId #
PathInfo UserId
Instance details Defined in Data.UserId Methods toPathSegments :: UserId -> [Text] # fromPathSegments :: URLParser UserId #
Indexable UserIxs User Source #
Instance details Defined in Happstack.Authenticate.Core Methods indices :: IxList UserIxs User #
type Rep UserId
Instance details Defined in Data.UserId type Rep UserId = D1 ('MetaData "UserId" "Data.UserId" "userid-0.1.3.6-JcFBnIuavOjCPWw8Cc2pFu" 'True) (C1 ('MetaCons "UserId" 'PrefixI 'True) (S1 ('MetaSel ('Just "_unUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

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

rUserId :: forall tok e r. 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

Instances details

Eq Username Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: Username -> Username -> Bool # (/=) :: Username -> Username -> Bool #
Data Username Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS Username # readList :: ReadS [Username] # readPrec :: ReadPrec Username # readListPrec :: ReadPrec [Username] #
Show Username Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> Username -> ShowS # show :: Username -> String # showList :: [Username] -> ShowS #
Generic Username Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep Username :: Type -> Type # Methods from :: Username -> Rep Username x # to :: Rep Username x -> Username #
SafeCopy Username Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
ToJSON Username Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJSON :: Username -> Value # toEncoding :: Username -> Encoding # toJSONList :: [Username] -> Value # toEncodingList :: [Username] -> Encoding #
FromJSON Username Source #
Instance details Defined in Happstack.Authenticate.Core Methods parseJSON :: Value -> Parser Username # parseJSONList :: Value -> Parser [Username] #
PathInfo Username Source #
Instance details Defined in Happstack.Authenticate.Core Methods toPathSegments :: Username -> [Text] # fromPathSegments :: URLParser Username #
Indexable UserIxs User Source #
Instance details Defined in Happstack.Authenticate.Core Methods indices :: IxList UserIxs User #
type Rep Username Source #
Instance details Defined in Happstack.Authenticate.Core type Rep Username = D1 ('MetaData "Username" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'True) (C1 ('MetaCons "Username" 'PrefixI 'True) (S1 ('MetaSel ('Just "_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

Instances details

Eq Email Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: Email -> Email -> Bool # (/=) :: Email -> Email -> Bool #
Data Email Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS Email # readList :: ReadS [Email] # readPrec :: ReadPrec Email # readListPrec :: ReadPrec [Email] #
Show Email Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> Email -> ShowS # show :: Email -> String # showList :: [Email] -> ShowS #
Generic Email Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep Email :: Type -> Type # Methods from :: Email -> Rep Email x # to :: Rep Email x -> Email #
SafeCopy Email Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
ToJSON Email Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJSON :: Email -> Value # toEncoding :: Email -> Encoding # toJSONList :: [Email] -> Value # toEncodingList :: [Email] -> Encoding #
FromJSON Email Source #
Instance details Defined in Happstack.Authenticate.Core Methods parseJSON :: Value -> Parser Email # parseJSONList :: Value -> Parser [Email] #
PathInfo Email Source #
Instance details Defined in Happstack.Authenticate.Core Methods toPathSegments :: Email -> [Text] # fromPathSegments :: URLParser Email #
Indexable UserIxs User Source #
Instance details Defined in Happstack.Authenticate.Core Methods indices :: IxList UserIxs User #
type Rep Email Source #
Instance details Defined in Happstack.Authenticate.Core type Rep Email = D1 ('MetaData "Email" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'True) (C1 ('MetaCons "Email" 'PrefixI 'True) (S1 ('MetaSel ('Just "_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

Instances details

Eq User Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Data User Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS User # readList :: ReadS [User] # readPrec :: ReadPrec User # readListPrec :: ReadPrec [User] #
Show User Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
Generic User Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep User :: Type -> Type # Methods from :: User -> Rep User x # to :: Rep User x -> User #
SafeCopy User Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
ToJSON User Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJSON :: User -> Value # toEncoding :: User -> Encoding # toJSONList :: [User] -> Value # toEncodingList :: [User] -> Encoding #
FromJSON User Source #
Instance details Defined in Happstack.Authenticate.Core Methods parseJSON :: Value -> Parser User # parseJSONList :: Value -> Parser [User] #
Indexable UserIxs User Source #
Instance details Defined in Happstack.Authenticate.Core Methods indices :: IxList UserIxs User #
type Rep User Source #
Instance details Defined in Happstack.Authenticate.Core type Rep User = D1 ('MetaData "User" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (C1 ('MetaCons "User" 'PrefixI 'True) (S1 ('MetaSel ('Just "_userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: (S1 ('MetaSel ('Just "_username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Username) :: S1 ('MetaSel ('Just "_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

Instances details

Eq SharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: SharedSecret -> SharedSecret -> Bool # (/=) :: SharedSecret -> SharedSecret -> Bool #
Data SharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS SharedSecret # readList :: ReadS [SharedSecret] # readPrec :: ReadPrec SharedSecret # readListPrec :: ReadPrec [SharedSecret] #
Show SharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> SharedSecret -> ShowS # show :: SharedSecret -> String # showList :: [SharedSecret] -> ShowS #
Generic SharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep SharedSecret :: Type -> Type # Methods from :: SharedSecret -> Rep SharedSecret x # to :: Rep SharedSecret x -> SharedSecret #
SafeCopy SharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core type Rep SharedSecret = D1 ('MetaData "SharedSecret" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'True) (C1 ('MetaCons "SharedSecret" 'PrefixI 'True) (S1 ('MetaSel ('Just "_unSharedSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

unSharedSecret :: Iso' SharedSecret Text Source #

data SimpleAddress Source #

Constructors

SimpleAddress
Fields _saName :: Maybe Text _saEmail :: Email

Instances

Instances details

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

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

Instances details

Eq CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: CoreError -> CoreError -> Bool # (/=) :: CoreError -> CoreError -> Bool #
Data CoreError Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS CoreError # readList :: ReadS [CoreError] # readPrec :: ReadPrec CoreError # readListPrec :: ReadPrec [CoreError] #
Show CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> CoreError -> ShowS # show :: CoreError -> String # showList :: [CoreError] -> ShowS #
Generic CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep CoreError :: Type -> Type # Methods from :: CoreError -> Rep CoreError x # to :: Rep CoreError x -> CoreError #
SafeCopy CoreError Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
ToJSON CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJSON :: CoreError -> Value # toEncoding :: CoreError -> Encoding # toJSONList :: [CoreError] -> Value # toEncodingList :: [CoreError] -> Encoding #
FromJSON CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods parseJSON :: Value -> Parser CoreError # parseJSONList :: Value -> Parser [CoreError] #
ToJExpr CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJExpr :: CoreError -> JExpr # toJExprFromList :: [CoreError] -> JExpr #
RenderMessage HappstackAuthenticateI18N CoreError Source #
Instance details Defined in Happstack.Authenticate.Core Methods renderMessage :: HappstackAuthenticateI18N -> [Lang] -> CoreError -> Text #
type Rep CoreError Source #
Instance details Defined in Happstack.Authenticate.Core type Rep CoreError = D1 ('MetaData "CoreError" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (((C1 ('MetaCons "HandlerNotFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "URLDecodeFailed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UsernameAlreadyExists" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AuthorizationRequired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Forbidden" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "JSONDecodeFailed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidUserId" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UsernameNotAcceptable" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InvalidEmail" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TextError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe 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

Instances details

Eq NewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: NewAccountMode -> NewAccountMode -> Bool # (/=) :: NewAccountMode -> NewAccountMode -> Bool #
Show NewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> NewAccountMode -> ShowS # show :: NewAccountMode -> String # showList :: [NewAccountMode] -> ShowS #
Generic NewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep NewAccountMode :: Type -> Type # Methods from :: NewAccountMode -> Rep NewAccountMode x # to :: Rep NewAccountMode x -> NewAccountMode #
SafeCopy NewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core type Rep NewAccountMode = D1 ('MetaData "NewAccountMode" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (C1 ('MetaCons "OpenRegistration" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ModeratedRegistration" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ClosedRegistration" 'PrefixI 'False) (U1 :: Type -> Type)))

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

Instances details

Eq AuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: AuthenticateState -> AuthenticateState -> Bool # (/=) :: AuthenticateState -> AuthenticateState -> Bool #
Show AuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> AuthenticateState -> ShowS # show :: AuthenticateState -> String # showList :: [AuthenticateState] -> ShowS #
Generic AuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep AuthenticateState :: Type -> Type # Methods from :: AuthenticateState -> Rep AuthenticateState x # to :: Rep AuthenticateState x -> AuthenticateState #
SafeCopy AuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
IsAcidic AuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core Methods acidEvents :: [Event AuthenticateState] #
type Rep AuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core type Rep AuthenticateState = D1 ('MetaData "AuthenticateState" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (C1 ('MetaCons "AuthenticateState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_sharedSecrets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SharedSecrets) :: S1 ('MetaSel ('Just "_users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IxUser)) :: (S1 ('MetaSel ('Just "_nextUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: (S1 ('MetaSel ('Just "_defaultSessionTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "_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

Instances details

SafeCopy SetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent SetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core
Method SetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult SetSharedSecret # type MethodState SetSharedSecret # Methods methodTag :: SetSharedSecret -> Tag #
type MethodState SetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState SetSharedSecret = AuthenticateState
type MethodResult SetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult SetSharedSecret = ()

newtype GetSharedSecret Source #

Constructors

GetSharedSecret UserId

Instances

Instances details

SafeCopy GetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetSharedSecret # type MethodState GetSharedSecret # Methods methodTag :: GetSharedSecret -> Tag #
type MethodState GetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetSharedSecret = AuthenticateState
type MethodResult GetSharedSecret Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetSharedSecret = Maybe SharedSecret

newtype SetDefaultSessionTimeout Source #

Constructors

SetDefaultSessionTimeout Int

Instances

Instances details

SafeCopy SetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent SetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core
Method SetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult SetDefaultSessionTimeout # type MethodState SetDefaultSessionTimeout # Methods methodTag :: SetDefaultSessionTimeout -> Tag #
type MethodState SetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState SetDefaultSessionTimeout = AuthenticateState
type MethodResult SetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult SetDefaultSessionTimeout = ()

data GetDefaultSessionTimeout Source #

Constructors

GetDefaultSessionTimeout

Instances

Instances details

SafeCopy GetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetDefaultSessionTimeout # type MethodState GetDefaultSessionTimeout # Methods methodTag :: GetDefaultSessionTimeout -> Tag #
type MethodState GetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetDefaultSessionTimeout = AuthenticateState
type MethodResult GetDefaultSessionTimeout Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetDefaultSessionTimeout = Int

newtype SetNewAccountMode Source #

Constructors

SetNewAccountMode NewAccountMode

Instances

Instances details

SafeCopy SetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent SetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core
Method SetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult SetNewAccountMode # type MethodState SetNewAccountMode # Methods methodTag :: SetNewAccountMode -> Tag #
type MethodState SetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState SetNewAccountMode = AuthenticateState
type MethodResult SetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult SetNewAccountMode = ()

data GetNewAccountMode Source #

Constructors

GetNewAccountMode

Instances

Instances details

SafeCopy GetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetNewAccountMode # type MethodState GetNewAccountMode # Methods methodTag :: GetNewAccountMode -> Tag #
type MethodState GetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetNewAccountMode = AuthenticateState
type MethodResult GetNewAccountMode Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetNewAccountMode = NewAccountMode

newtype CreateUser Source #

Constructors

CreateUser User

Instances

Instances details

SafeCopy CreateUser Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent CreateUser Source #
Instance details Defined in Happstack.Authenticate.Core
Method CreateUser Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult CreateUser # type MethodState CreateUser # Methods methodTag :: CreateUser -> Tag #
type MethodState CreateUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState CreateUser = AuthenticateState
type MethodResult CreateUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult CreateUser = Either CoreError User

data CreateAnonymousUser Source #

Constructors

CreateAnonymousUser

Instances

Instances details

SafeCopy CreateAnonymousUser Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent CreateAnonymousUser Source #
Instance details Defined in Happstack.Authenticate.Core
Method CreateAnonymousUser Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult CreateAnonymousUser # type MethodState CreateAnonymousUser # Methods methodTag :: CreateAnonymousUser -> Tag #
type MethodState CreateAnonymousUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState CreateAnonymousUser = AuthenticateState
type MethodResult CreateAnonymousUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult CreateAnonymousUser = User

newtype UpdateUser Source #

Constructors

UpdateUser User

Instances

Instances details

SafeCopy UpdateUser Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent UpdateUser Source #
Instance details Defined in Happstack.Authenticate.Core
Method UpdateUser Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult UpdateUser # type MethodState UpdateUser # Methods methodTag :: UpdateUser -> Tag #
type MethodState UpdateUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState UpdateUser = AuthenticateState
type MethodResult UpdateUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult UpdateUser = ()

newtype DeleteUser Source #

Constructors

DeleteUser UserId

Instances

Instances details

SafeCopy DeleteUser Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
UpdateEvent DeleteUser Source #
Instance details Defined in Happstack.Authenticate.Core
Method DeleteUser Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult DeleteUser # type MethodState DeleteUser # Methods methodTag :: DeleteUser -> Tag #
type MethodState DeleteUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState DeleteUser = AuthenticateState
type MethodResult DeleteUser Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult DeleteUser = ()

newtype GetUserByUsername Source #

Constructors

GetUserByUsername Username

Instances

Instances details

SafeCopy GetUserByUsername Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetUserByUsername Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetUserByUsername Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetUserByUsername # type MethodState GetUserByUsername # Methods methodTag :: GetUserByUsername -> Tag #
type MethodState GetUserByUsername Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetUserByUsername = AuthenticateState
type MethodResult GetUserByUsername Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetUserByUsername = Maybe User

newtype GetUserByUserId Source #

Constructors

GetUserByUserId UserId

Instances

Instances details

SafeCopy GetUserByUserId Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetUserByUserId Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetUserByUserId Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetUserByUserId # type MethodState GetUserByUserId # Methods methodTag :: GetUserByUserId -> Tag #
type MethodState GetUserByUserId Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetUserByUserId = AuthenticateState
type MethodResult GetUserByUserId Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetUserByUserId = Maybe User

newtype GetUserByEmail Source #

Constructors

GetUserByEmail Email

Instances

Instances details

SafeCopy GetUserByEmail Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetUserByEmail Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetUserByEmail Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetUserByEmail # type MethodState GetUserByEmail # Methods methodTag :: GetUserByEmail -> Tag #
type MethodState GetUserByEmail Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetUserByEmail = AuthenticateState
type MethodResult GetUserByEmail Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetUserByEmail = Maybe User

data GetUsers Source #

Constructors

GetUsers

Instances

Instances details

SafeCopy GetUsers Source #
Instance details Defined in Happstack.Authenticate.Core Methods version :: Version GetUsers # kind :: Kind GetUsers # getCopy :: Contained (Get GetUsers) # putCopy :: GetUsers -> Contained Put # internalConsistency :: Consistency GetUsers # objectProfile :: Profile GetUsers # errorTypeName :: Proxy GetUsers -> String #
QueryEvent GetUsers Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetUsers Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetUsers # type MethodState GetUsers # Methods methodTag :: GetUsers -> Tag #
type MethodState GetUsers Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetUsers = AuthenticateState
type MethodResult GetUsers Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetUsers = Set User

newtype GetUsersByEmail Source #

Constructors

GetUsersByEmail Email

Instances

Instances details

SafeCopy GetUsersByEmail Source #
Instance details Defined in Happstack.Authenticate.Core Methods version :: Version GetUsersByEmail # kind :: Kind GetUsersByEmail # getCopy :: Contained (Get GetUsersByEmail) # putCopy :: GetUsersByEmail -> Contained Put # internalConsistency :: Consistency GetUsersByEmail # objectProfile :: Profile GetUsersByEmail # errorTypeName :: Proxy GetUsersByEmail -> String #
QueryEvent GetUsersByEmail Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetUsersByEmail Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetUsersByEmail # type MethodState GetUsersByEmail # Methods methodTag :: GetUsersByEmail -> Tag #
type MethodState GetUsersByEmail Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetUsersByEmail = AuthenticateState
type MethodResult GetUsersByEmail Source #
Instance details Defined in Happstack.Authenticate.Core type MethodResult GetUsersByEmail = Set User

data GetAuthenticateState Source #

Constructors

GetAuthenticateState

Instances

Instances details

SafeCopy GetAuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
QueryEvent GetAuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core
Method GetAuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type MethodResult GetAuthenticateState # type MethodState GetAuthenticateState # Methods methodTag :: GetAuthenticateState -> Tag #
type MethodState GetAuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core type MethodState GetAuthenticateState = AuthenticateState
type MethodResult GetAuthenticateState Source #
Instance details Defined in Happstack.Authenticate.Core 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

Instances details

Eq Token Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Data Token Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS Token # readList :: ReadS [Token] # readPrec :: ReadPrec Token # readListPrec :: ReadPrec [Token] #
Show Token Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Generic Token Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep Token :: Type -> Type # Methods from :: Token -> Rep Token x # to :: Rep Token x -> Token #
ToJSON Token Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJSON :: Token -> Value # toEncoding :: Token -> Encoding # toJSONList :: [Token] -> Value # toEncodingList :: [Token] -> Encoding #
FromJSON Token Source #
Instance details Defined in Happstack.Authenticate.Core Methods parseJSON :: Value -> Parser Token # parseJSONList :: Value -> Parser [Token] #
type Rep Token Source #
Instance details Defined in Happstack.Authenticate.Core type Rep Token = D1 ('MetaData "Token" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (C1 ('MetaCons "Token" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tokenUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 User) :*: S1 ('MetaSel ('Just "_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

Instances

Instances details

Eq AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: AuthenticationMethod -> AuthenticationMethod -> Bool # (/=) :: AuthenticationMethod -> AuthenticationMethod -> Bool #
Data AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS AuthenticationMethod # readList :: ReadS [AuthenticationMethod] # readPrec :: ReadPrec AuthenticationMethod # readListPrec :: ReadPrec [AuthenticationMethod] #
Show AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> AuthenticationMethod -> ShowS # show :: AuthenticationMethod -> String # showList :: [AuthenticationMethod] -> ShowS #
Generic AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep AuthenticationMethod :: Type -> Type # Methods from :: AuthenticationMethod -> Rep AuthenticationMethod x # to :: Rep AuthenticationMethod x -> AuthenticationMethod #
SafeCopy AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core 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 #
ToJSON AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core Methods toJSON :: AuthenticationMethod -> Value # toEncoding :: AuthenticationMethod -> Encoding # toJSONList :: [AuthenticationMethod] -> Value # toEncodingList :: [AuthenticationMethod] -> Encoding #
FromJSON AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core Methods parseJSON :: Value -> Parser AuthenticationMethod # parseJSONList :: Value -> Parser [AuthenticationMethod] #
PathInfo AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core Methods toPathSegments :: AuthenticationMethod -> [Text] # fromPathSegments :: URLParser AuthenticationMethod #
type Rep AuthenticationMethod Source #
Instance details Defined in Happstack.Authenticate.Core type Rep AuthenticationMethod = D1 ('MetaData "AuthenticationMethod" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'True) (C1 ('MetaCons "AuthenticationMethod" 'PrefixI 'True) (S1 ('MetaSel ('Just "_unAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

unAuthenticationMethod :: Iso' AuthenticationMethod Text Source #

rAuthenticationMethod :: forall tok e r. Boomerang e tok ((:-) Text r) ((:-) AuthenticationMethod r) Source #

type AuthenticationHandler = [Text] -> RouteT AuthenticateURL (ServerPartT IO) Response Source #

type AuthenticationHandlers = Map AuthenticationMethod AuthenticationHandler Source #

data AuthenticateURL Source #

Constructors

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

Instances

Instances details

Eq AuthenticateURL Source #
Instance details Defined in Happstack.Authenticate.Core Methods (==) :: AuthenticateURL -> AuthenticateURL -> Bool # (/=) :: AuthenticateURL -> AuthenticateURL -> Bool #
Data AuthenticateURL Source #
Instance details Defined in Happstack.Authenticate.Core 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 :: forall r r'. (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 #
Instance details Defined in Happstack.Authenticate.Core 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 #
Instance details Defined in Happstack.Authenticate.Core Methods readsPrec :: Int -> ReadS AuthenticateURL # readList :: ReadS [AuthenticateURL] # readPrec :: ReadPrec AuthenticateURL # readListPrec :: ReadPrec [AuthenticateURL] #
Show AuthenticateURL Source #
Instance details Defined in Happstack.Authenticate.Core Methods showsPrec :: Int -> AuthenticateURL -> ShowS # show :: AuthenticateURL -> String # showList :: [AuthenticateURL] -> ShowS #
Generic AuthenticateURL Source #
Instance details Defined in Happstack.Authenticate.Core Associated Types type Rep AuthenticateURL :: Type -> Type # Methods from :: AuthenticateURL -> Rep AuthenticateURL x # to :: Rep AuthenticateURL x -> AuthenticateURL #
PathInfo AuthenticateURL Source #
Instance details Defined in Happstack.Authenticate.Core Methods toPathSegments :: AuthenticateURL -> [Text] # fromPathSegments :: URLParser AuthenticateURL #
(Functor m, Monad m) => EmbedAsChild (Partial' m) PartialMsgs Source #
Instance details Defined in Happstack.Authenticate.OpenId.Partials Methods asChild :: PartialMsgs -> GenChildList (Partial' m) #
(Functor m, Monad m) => EmbedAsChild (Partial' m) PartialMsgs Source #
Instance details Defined in Happstack.Authenticate.Password.Partials Methods asChild :: PartialMsgs -> GenChildList (Partial' m) #
(Functor m, Monad m) => EmbedAsAttr (Partial' m) (Attr Text PartialMsgs) Source #
Instance details Defined in Happstack.Authenticate.OpenId.Partials Methods asAttr :: Attr Text PartialMsgs -> GenAttributeList (Partial' m) #
(Functor m, Monad m) => EmbedAsAttr (Partial' m) (Attr Text PartialMsgs) Source #
Instance details Defined in Happstack.Authenticate.Password.Partials Methods asAttr :: Attr Text PartialMsgs -> GenAttributeList (Partial' m) #
(Functor m, MonadIO m) => IntegerSupply (RouteT AuthenticateURL m) Source #
Instance details Defined in Happstack.Authenticate.Route Methods nextInteger :: RouteT AuthenticateURL m Integer #
type Rep AuthenticateURL Source #
Instance details Defined in Happstack.Authenticate.Core type Rep AuthenticateURL = D1 ('MetaData "AuthenticateURL" "Happstack.Authenticate.Core" "happstack-authenticate-2.6.0-H4Cz7jjbqfUGLgvBipYkvR" 'False) (C1 ('MetaCons "AuthenticationMethods" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (AuthenticationMethod, [Text])))) :+: C1 ('MetaCons "Controllers" 'PrefixI 'False) (U1 :: Type -> Type))

rAuthenticationMethods :: forall tok e r. Boomerang e tok ((:-) (Maybe (AuthenticationMethod, [Text])) r) ((:-) AuthenticateURL r) Source #

rControllers :: forall tok e r. Boomerang e tok r ((:-) AuthenticateURL r) Source #

systemFromAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress) Source #

systemReplyToAddress :: Lens' AuthenticateConfig (Maybe SimpleAddress) Source #

systemSendmailPath :: Lens' AuthenticateConfig (Maybe FilePath) Source #

authenticateURL :: Router () (AuthenticateURL :- ()) Source #

a Router for AuthenicateURL

nestAuthenticationMethod :: PathInfo methodURL => AuthenticationMethod -> RouteT methodURL m a -> RouteT AuthenticateURL m a Source #

helper function which converts a URL for an authentication backend into an AuthenticateURL.