cantina-app-users
Provides a basic, extensible user system for a cantina application. Includes the user model (with an extensible default schema), authentication, and default email templates for basic user account-related emails.
Table of Contents
- Usage
- Default Schema
- Default Admin User
- Schemas
- Authentication
- API Reference
Usage
Most of the provided defaults are easily overridden via configuration (etc
) or
application hooks (app.hook
). Default email templates can be overridden by
providing an alternative template having the same name.
Default Schema
Provides the default user schema.
Extending
module { appSchema;};
Default Admin User
Provides the default admin user, Web Team dev@terraeclipse.com, with password "admin".
Configuring
# In etc/app/users.yml admin: attributes: username: webteam password: ryd9ebyz
Schemas
Provides schemas for cantina-models
See cantina-models-schemas for details.
Authentication
Provides a standard implementation of the functionality required by cantina-auth, as well as session management.
Example
module { var controller = app; controller
module { app;};
Provides templates and hooks for cantina-email user account related emails.
Templates
Provides defaults for:
- users/account_confirm
- users/email_confirm
- users/account_invitation
- users/password_reset
Your application may override any of these by providing its own template with the same name.
Hooks
Adds a hook to email:send:before
for the email templates above.
The hook will perform the following:
- Generate an expiring token
prefix
: Defaults to"password-reset"
forusers/password_reset
template,"account"
for all others. Your application may override this by settingvars.preset
in theapp.email.send
vars.expire
: Defaults to 24 hours forusers/password_reset
template, 7 days for all others. Your application may override this by settingvars.expire
in theapp.email.send
vars.
- Add
vars.app
- The result of
app.conf.get('app')
. - Required for the default email templates:
app.title
app.email
- Your application may override this by setting
vars.app
in theapp.email.send
vars.
- The result of
- Add
vars.url
- A url build of the conf's
app.protocol
,app.domain
, and a pathname appended with the generated token. The pathnames are:/forgot/{token}
/account-confirm/{token}
/email-confirm/{token}
/account-invitation/{token}
Your application may override this by settingvars.pathname
orvars.url
in theapp.email.send
vars.
- A url build of the conf's
API Reference
app.collections.users
Exentded namespace for user models
app.collections.users.findByAuth(email, password, cb)
Load user with matching email from the database and verifies password. Returns a sanitized user model, if match is found.
app.auth
Namespace for authentication-related API
app.auth.logIn(user, req, res, next)
Invokes req.logIn
and adds the req.sessionID
to a set of sessionIDs for the
user in redis.
app.auth.setPassword(user, password, cb)
Sets the auth property on the user model to be a bcrypt
hash of the password
app.auth.checkPassword(user, password, cb)
Checks the password against the user's auth property using bcrypt.compare
app.auth.killSession(user, sessionID, cb)
Destroys the session and removes the sessionID from user's set in redis.
app.auth.killAllSessions(user, cb)
Loads the user's sessionIDs from redis and destroys each. Deletes the user's set of sessionIDs in redis.
app.auth.logOut(req, cb)
Invokes req.logOut
and app.auth.killSession
for the authenticated user
app.serializeUser(user, cb)
Implements user serialization for cantina-auth. Returns the user model's id
property.
app.deserializeUser(id, cb)
Implements user deserialization for cantina-auth. Loads and returns the user
with matching id
in app.collections.user
.
app.verifyTwitterUser(token, tokenSecret, profile, done)
Implements account verification for cantina-auth-twitter. Creates or updates
the existing user account with matching email
on app.collections.user
.
app.verifyFacebookUser(token, tokenSecret, profile, done)
Implements account verification for cantina-auth-facebook. Creates or updates
the existing user account with matching email
on app.collections.user
.
Terra Eclipse
Developed byTerra Eclipse, Inc. is a nationally recognized political technology and strategy firm located in Santa Cruz, CA and Washington, D.C.