Class Policy

Access policy class.

Defines how entity access is controlled; includes zero or more statements.

Hierarchy

Policy

Index

Constructors

Properties

_baseDirectory _id _processPolicyData _statements _validatePolicySchema

Methods

_mergePolicies checkStatementAction getActionCondition getFilename getId handlesAction load validateAction validateActionStatement

Constructors

constructor

new Policy(baseDirectory: string, id: string): Policy
Policy object constructor.
Parameters
- baseDirectory: string
  
  Application base path.
- id: string
  
  Policy id.
Returns Policy
- Defined in src/policies/Policy.d.ts:18

Properties

_baseDirectory

_baseDirectory: string

_id

_id: string

`Private` _processPolicyData

_processPolicyData: any

Reads policy data and initializes statements list.

Param

_statements

_statements: any[]

`Private` _validatePolicySchema

_validatePolicySchema: any

Validates policy data against JSONSchema.

Param

Methods

_mergePolicies

_mergePolicies(base: any, override: any): any
Merge two policy definitions into one.

The second policy definition can override parts of the first by reusing the same statement IDs ('sid'). The normal use case is that the first (base) policy is an automatically generated one, and the second (override) is defined in the YAML configuration.

Returns
Parameters
- base: any
- override: any
Returns any
- Defined in src/policies/Policy.d.ts:59

checkStatementAction

checkStatementAction(statement: __module, action: string): boolean
Checks if given statement handles an action.

Returns
Parameters
- statement: __module
  
  {Statement} - policy statement object.
- action: string
  
  {string} - the action.
Returns boolean
- Defined in src/policies/Policy.d.ts:75

getActionCondition

getActionCondition(userContext: any, action: string): undefined | RuntimeFilter
Returns pre-compiled action condition.
Parameters
- userContext: any
- action: string
  
  {string}
Returns undefined | RuntimeFilter
- Defined in src/policies/Policy.d.ts:113

getFilename

getFilename(): string
Returns policy filename.

Returns

Returns string
- Defined in src/policies/Policy.d.ts:30

getId

getId(): string
Returns policy ID / name.

Returns

Returns string
- Defined in src/policies/Policy.d.ts:36

handlesAction

handlesAction(action: string): boolean
Checks if this Policy handles given entity action.

Returns
Parameters
- action: string
  
  {string} - the entity action.
Returns boolean
- Defined in src/policies/Policy.d.ts:82

load

load(defaultPolicy: PolicySchema, validator: Validator): Promise<Policy>
Loads the Policy JSON data from the Policies directory.
Parameters
- defaultPolicy: PolicySchema
- validator: Validator
Returns Promise<Policy>
- Defined in src/policies/Policy.d.ts:44

validateAction

validateAction(userContext: any, action: string): boolean
Validates action against the policy.

Returns
Parameters
- userContext: any
- action: string
  
  {string}
Returns boolean
- Defined in src/policies/Policy.d.ts:90

validateActionStatement

validateActionStatement(statement: __module, userContext: any, action: string): boolean
Validates action statement.

Returns
Parameters
- statement: __module
  
  {Statement}
- userContext: any
- action: string
  
  {string}
Returns boolean
- Defined in src/policies/Policy.d.ts:102

Generated using TypeDoc