cbSecurity
CommunitySlackSupport
v3.x
v3.x
  • 🔏Introduction
    • Release History
      • What's New With 3.4.0
      • What's New With 3.3.0
      • What's New With 3.2.0
      • What's New With 3.1.0
      • What's New With 3.0.0
    • Upgrade to 3.0.0
    • About This Book
      • Author
  • Getting Started
    • Installation
    • Overview
    • Configuration
      • 🔏Authentication
      • 🥸Basic Auth
      • 🙈CSRF
      • 🌐JWT
      • 🧱Firewall
        • DB Rules
        • JSON Rules
        • Model Rules
        • XML Rules
      • ☢️Security Headers
      • 🔬Visualizer
  • Usage
    • Authentication Services
    • Basic Authentication
    • Security Rules
    • Security Annotations
    • cbSecurity Model
      • Authentication Methods
      • Authorization Contexts
      • Blocking Methods
      • Securing Views
      • Utility Methods
      • Verification Methods
    • Secured URL
    • Interceptions
    • Cross Site Request Forgery
    • Delegates
    • Auth User
  • Security Validators
    • Auth Validator
    • BasicAuth Validator
    • CFML Security Validator
    • Custom Validator
  • JWT
    • JWT Services
    • JWT Validator
    • Refresh Tokens
    • Token Storage
    • JWT Interceptions
  • External links
    • Issue Tracker
    • Source code
    • Sponsor Us
Powered by GitBook
On this page
  • System Requirements
  • Mixins
  • Configuration Settings

Was this helpful?

Edit on GitHub
Export as PDF
  1. Getting Started

Installation

Get up and running with CBSecurity in no time!

PreviousAuthorNextOverview

Last updated 1 month ago

Was this helpful?

Leverage to install into your ColdBox app:

# Latest version
install cbsecurity

# Bleeding Edge
install cbsecurity@be

System Requirements

  • A database for optional firewall logging

  • ColdBox 6+

  • ColdBox 7+ for delegates and basic auth support only

Mixins

The following mixins are registered once the module is installed:

/**
 * Retrieve the Jwt Auth Service
 */
function jwtAuth()

/**
 * Retrieve the CBSecurity Service Object
 */
function cbSecure()

Configuration Settings

By default cbsecurity is configured to work with cbauth as the authentication service. You only need to provide a user service class that knows how to connect to your database to retrieve and validate credentials. You can also use the in-built basic authentication users as well.

You can find much more information about cbauth here:

CommandBox
https://forgebox.io/view/cbauth
Configuration