API Docs for: 0.8.0
Show:

SecurityService Class

Defined in: include/access_management.js:25
Module: Security
Parent Module: Services

Service for managing user access

Methods

authenticateSession

(
  • session
  • options
  • authenticator
  • cb
)
static

Defined in include/access_management.js:200

Authenticates a session

Parameters:

  • session Object
  • options Object
  • authenticator Authentication
  • cb Function

encrypt

(
  • valStr #return
)

Defined in include/access_management.js:277

One way encrypt a string

Parameters:

  • valStr #return String

    {String} Encrypted string

generatePassword

(
  • [length=8]
)
static

Defined in include/access_management.js:290

Parameters:

  • [length=8] Integer optional

getPrincipal

(
  • session
)
Object static

Defined in include/access_management.js:309

Parameters:

  • session Object

Returns:

Object:

The authenticated user principal or NULL if not authenticated

getRoleName

(
  • accessLevel
)

Defined in include/access_management.js:186

Returns the constant name of an access level number

Parameters:

  • accessLevel Number

getRoleNames

(
  • ls
)
Array

Defined in include/access_management.js:156

Retrieves the localized names of access levels as an array

Parameters:

Returns:

Array:

getRoleToDisplayNameMap

(
  • ls
)
Object static

Defined in include/access_management.js:168

Provides a hash of the default roles to their translated display name

Parameters:

Returns:

Object:

isAuthenticated

(
  • session
)

Defined in include/access_management.js:262

Check to see if a session is authentic

Parameters:

  • session Object

isAuthorized

(
  • session
  • requirements
)
static

Defined in include/access_management.js:235

Check to see if a user meets security requirements

Parameters:

  • session Object

    [description]

  • requirements Object

    Object containing access requirements

Properties

ACCESS_

Integer static

Defined in include/access_management.js:138

ACCESS_

Integer static

Defined in include/access_management.js:147

ACCESS_ADMINISTRATOR

Integer static

Defined in include/access_management.js:71

ACCESS_EDITOR

Integer static

Defined in include/access_management.js:53

ACCESS_MANAGING_EDITOR

Integer static

Defined in include/access_management.js:62

ACCESS_USER

Integer static

Defined in include/access_management.js:35

ACCESS_WRITER

Integer static

Defined in include/access_management.js:44

PASSWORD_CHARS

Array private static

Defined in include/access_management.js:115

ROLE_VAL_TO_NAME

Array private static

Defined in include/access_management.js:125

SYSTEM_ROLES

Array static

Defined in include/access_management.js:80

Provides an array of all of the system roles. It provides their numeric value as well as the unique string key