Cherrycake
ExamplesGithub
Search…
version 1.x
Introduction
Status
Changelog
Migration
Architecture
Basics
Modules
Classes
Lifecycle
Performance
Security
Patterns
Items
Server requirements
Guide
Getting started
Modules guide
Classes guide
Actions guide
Patterns guide
Cache guide
Database guide
Items guide
HtmlDocument guide
Css and Javascript guide
Session guide
Login guide
Locale guide
Log guide
Stats guide
Janitor guide
Command line interface
Debugging
Reference
Core modules
Actions
Browser
Cache
Css
Database
Email
Errors
HtmlDocument
ItemAdmin
Janitor
Javascript
Locale
Log
Login
Login methods
Output
Patterns
Security
Session
Stats
SystemLog
TableAdmin
Validate
Core classes
Code conventions
License
Extras
Powered By GitBook
Login
The Login module provides a standardized method for implementing secure user identification workflows for web apps.
See the Login guide to learn how to work with the Login module.

Configuration

    userClassName The name of the app class that represents a user on the App. Must implement the \Cherrycake\LoginUser interface.
    passwordAuthenticationMethod One of the available LOGIN_PASSWORD_ENCRYPTION_METHOD_?constants for password authentication methods. Default:LOGIN_PASSWORD_ENCRYPTION_METHOD_PBKDF2
    isLoadUserOnInit Whether to check for a logged user and get it on this module's init sequence. Default: true
    sleepOnErrorSeconds Seconds to delay execution when a wrong login is requested, to make things difficult for bombing attacks. Default: 1

Constants

    LOGIN_PASSWORD_ENCRYPTION_METHOD_PBKDF2
​
    LOGIN_RESULT_OK
    LOGIN_RESULT_FAILED
    LOGIN_RESULT_FAILED_UNKNOWN_USER
    LOGIN_RESULT_FAILED_WRONG_PASSWORD
​
    LOGOUT_RESULT_OK
    LOGOUT_RESULT_FAILED
​
​
Previous
Log methods
Next
Login methods
Last modified 1yr ago
Copy link
Contents
Configuration
Constants