> For the complete documentation index, see [llms.txt](https://coldbox-security.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-security.ortusbooks.com/getting-started/configuration/basic-auth.md).

# Basic Auth

The `basicAuth` key is used to store user credentials that will be used with [Basic Authentication](/usage/basic-authentication.md) and how the passwords are stored in memory.

```javascript
/**
 * --------------------------------------------------------------------------
 * Basic Auth
 * --------------------------------------------------------------------------
 * These settings are used so you can configure the hashing patterns of the user storage
 * included with cbsecurity.  These are only used if you are using the `BasicAuthUserService` as
 * your service of choice alongside the `BasicAuthValidator`
 */
basicAuth : {
	// Hashing algorithm to use
	hashAlgorithm  : "SHA-512",
	// Iterates the number of times the hash is computed to create a more computationally intensive hash.
	hashIterations : 5,
	// User storage: The `key` is the username. The value is the user credentials that can include
	// { roles: "", permissions : "", firstName : "", lastName : "", password : "" }
	users          : {}
}
```

### HashAlgorithm

This is the default algorithm used when hashing the user storage passwords in memory.  The default is `SHA-512`

```javascript
hashAlgorithm  : "SHA-256",
```

### HashIterations

Iterates the number of times the hash is computed to create a more computationally intensive hash.  The default is `5`

```javascript
hashIterations  : 10,
```

### Users

This is the in-memory user storage system.  It's a `struct` and each **key** represents a unique `username` in the storage system.  Each user can then have the following attributes, but in reality, you can add as many attributes as you want.

* `password` - The only mandatory attribute.
* `firstName`
* `lastName`
* `roles`
* `permissions`

```javascript
users : {
    "lmajano" : { password : "test", permissions : "read,write",
    "guest" : { password : "guest", permissions : "read" }
}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://coldbox-security.ortusbooks.com/getting-started/configuration/basic-auth.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
