# WorkJS Authentication and User Management

WorkJS provides functions to create password hashes and check passwords and log users in and out.
Authentication uses WorkJS Sessions, therefore if authentication is configured for a route,
sessions are also forced.

If a module flag *auth* is defined for a route, the WorkJS authentication is used.
It gets data of a currently logged in user from database.
This data is made available as this.auth.user and a username is put into this.auth.username .

### Module Flag: auth

### Configuration Options:

**bcrypt salt:** `conf.auth_salt = 10;`
The number of rounds (2^n) used to crypt and decrypt. Crypting becomes slow if this is set too high.
see [bcrypt](https://github.com/ncb000gt/node.bcrypt.js)

## Properties

### this.auth.user
### this.auth.username
currently logged in user

### w.auth.hash(pw)
create hash from password string

### w.auth.check(pw, hash)
check if a hash matches a password string

### this.auth.login(user)
log the user in
user is an object containing the data of the user (see database table below).

### this.auth.logout()
log out the current user, clear the session

### w.auth.logout(user_id)
log out user with user_id, clear the matching session

### w.auth.mw(next)
authentication middleware - get current user from session and fetch user data from DB

### w.auth.conf_cache
Cache outstanding registrations in memory

### Database table: work_users