> For the complete documentation index, see [llms.txt](https://coldbox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coldbox.ortusbooks.com/digging-deeper/security.md).

# Security

Secure ColdBox applications with cbsecurity, the recommended engine for authentication, authorization, JWT, CSRF and security headers.

**cbsecurity** is the recommended way to secure a ColdBox application. Instead of hand-rolling login checks in handlers and interceptors, you declare who can reach what and cbsecurity enforces it before your handlers run, over sessions or JWT.

```bash
box install cbsecurity
```

📖 **Full documentation:** [coldbox-security.ortusbooks.com](https://coldbox-security.ortusbooks.com)

## Your First Secured Application

Configure the module in your `ColdBox` class. Authentication is delegated to **cbauth**, which needs a user service of your own.

{% tabs %}
{% tab title="BoxLang" %}

```javascript
// config/ColdBox.bx
moduleSettings = {
    cbauth : { userServiceClass : "UserService" },
    cbsecurity : {
        firewall : {
            // Where to send guests and users without access
            invalidAuthenticationEvent : "main.login",
            invalidAuthorizationEvent  : "main.unauthorized",
            rules : [
                { secureList : "^admin", roles : "admin" }
            ]
        }
    }
}
```

{% endtab %}

{% tab title="CFML" %}

```javascript
// config/ColdBox.cfc
moduleSettings = {
    cbauth : { userServiceClass : "UserService" },
    cbsecurity : {
        firewall : {
            // Where to send guests and users without access
            invalidAuthenticationEvent : "main.login",
            invalidAuthorizationEvent  : "main.unauthorized",
            rules : [
                { secureList : "^admin", roles : "admin" }
            ]
        }
    }
};
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
The default invalid action is a `redirect`, so always set `invalidAuthenticationEvent` and `invalidAuthorizationEvent`. Without them, a denied request throws an `InvalidAccessAction` exception.
{% endhint %}

## Three Ways to Declare Security

All three share the same validators, invalid actions, interception points and logging, so pick the one that matches where you want the rule to live.

| Approach             | Declared in                              | Best for                                       |
| -------------------- | ---------------------------------------- | ---------------------------------------------- |
| **Firewall rules**   | Config, JSON, XML, a database or a model | Central, data-driven policies.                 |
| **Annotations**      | On the handler or action                 | Security that travels with the code.           |
| **Route middleware** | Next to the route in `config/Router`     | Securing routes and groups with no rules file. |

```javascript
// 1. Firewall rule (config/ColdBox)
{ secureList : "^admin", permissions : "ADMIN" }

// 2. Annotation on an action
function delete( event, rc, prc ) secured="ADMIN" {
    userService.delete( rc.id )
}

// 3. Route middleware (config/Router)
route( "/admin" )
    .middleware( "Authorized@cbsecurity" )
    .meta( { permissions : "ADMIN" } )
    .to( "admin.index" )
```

Route middleware needs ColdBox 8.2+ and cbsecurity 3.9+. See [Route Middleware](/the-basics/routing/routing-dsl/middleware.md) and the cbsecurity [Route Middleware guide](https://coldbox-security.ortusbooks.com/usage/route-middleware).

## How a Request Is Secured

```mermaid
flowchart LR
    A[Incoming request] --> B[Global preProcess interceptors]
    B --> C[cbsecurity firewall: rules and annotations]
    C --> D[Route middleware]
    D --> E[Handler action]
    C -. denied .-> F[Redirect, override or block]
    D -. denied .-> F
```

A denied request never reaches the handler. The firewall's settings decide whether the user is redirected, sent to an override event, or blocked with a `401`.

## What You Get

| Capability                                                    | Provided by  |
| ------------------------------------------------------------- | ------------ |
| Firewall, annotations and route middleware                    | `cbsecurity` |
| Authentication: `authenticate()`, `isLoggedIn()`, `getUser()` | `cbauth`     |
| JWT access and refresh tokens                                 | `cbsecurity` |
| CSRF tokens for forms and AJAX                                | `cbcsrf`     |
| HTTP security response headers                                | `cbsecurity` |
| Firewall visualizer                                           | `cbsecurity` |

## See Also

* [Security Best Practices](/digging-deeper/security/best-practices.md)
* [Route Middleware](/the-basics/routing/routing-dsl/middleware.md)
* [HTTP Method Security](/the-basics/event-handlers/http-method-security.md)
* [Validation](/ecosystem/validation.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://coldbox.ortusbooks.com/digging-deeper/security.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.