Directories
A directory (engine name: authentication source) is where Airgate finds accounts and their attributes. You connect directories on Access › Directories and pick them per access policy under Check accounts in. This page lists every directory type, what each can do, and how lookups and attributes work.
What a directory can do
Section titled “What a directory can do”Each directory type has a set of capabilities. The directory editor shows them as chips.
| Capability | Meaning |
|---|---|
| Lookup | Finds a user without a password. Needed for EAP-TLS, MAC authentication and authorization-only lookups. |
| Verify | Checks a cleartext password: PAP, EAP-TTLS with inner PAP, the guest portal, TACACS+. |
| MSCHAP/CHAP | Returns an NT hash or cleartext password so that Airgate’s RADIUS server can run MS-CHAPv2 (PEAP) or CHAP. |
| Attributes | Returns authorization attributes such as groups, department or title. |
| MAC auth | Can be used for MAC authentication. |
Directory types
Section titled “Directory types”Directories you connect
Section titled “Directories you connect”| Type | Category | Lookup | Verify | MSCHAP/CHAP | Notes |
|---|---|---|---|---|---|
| Active Directory | Directories | Yes | Yes | No | LDAP or LDAPS to domain controllers. Search, user bind for passwords, memberOf group expansion, optional nested groups. PEAP-MSCHAPv2 needs a domain join (see Authentication methods). Backup servers supported. |
| Generic LDAP | Directories | Yes | Yes | Yes | OpenLDAP, 389 Directory Server, eDirectory. An optional password attribute lets Airgate run MS-CHAP and CHAP. Backup servers supported. |
| Microsoft Entra ID | Cloud identity providers | Yes | Yes | No | Passwords verified with the resource owner password credentials (ROPC) flow; user attributes and groups from Microsoft Graph with an app registration (client secret or certificate). Optional transitive group membership. |
| Okta | Cloud identity providers | Yes | Yes | No | Passwords through the Okta authentication API; users and groups through the Okta API with an API token (SSWS). |
| Google Workspace | Other | Yes | Yes | No | Google Secure LDAP (ldap.google.com) with the LDAP client certificate from the Google Admin console. Passwords by user bind (PAP, EAP-TTLS/PAP); groups from Google Groups. No MS-CHAP. |
| Generic SQL DB | Databases | Yes | Yes | Yes | PostgreSQL, MySQL, MariaDB or Microsoft SQL Server, with your own queries. Backup servers supported. |
| HTTP (REST) | Web services | Yes | Yes | No | Any JSON REST API: a user lookup path, an optional password verify path, JSON-path attribute mapping. |
| RADIUS server | RADIUS / token servers | No | Yes | No | Proxies PAP to another RADIUS server; the attributes of its Access-Accept become authorization attributes. Backup servers supported. |
| Token server (RADIUS) | RADIUS / token servers | No | Yes | No | One-time-password and MFA servers reached over RADIUS (for example an RSA or Duo proxy). Backup servers supported. |
| Static Host List | Host lists | Yes | Yes | No | MAC and IP lists from Devices › MAC lists, used as a MAC-authentication source. |
Built-in repositories
Section titled “Built-in repositories”Every tenant has these. They are created automatically and cannot be deleted.
| Name in the engine | Shown as | What it holds |
|---|---|---|
[Local User Repository] |
Local users | Accounts stored in Airgate (Access › Local users). Passwords are stored as bcrypt and NT hash, so PEAP-MSCHAPv2 works. Optional reversible copies for CHAP and EAP-MD5 (Settings › General › Store reversible passwords). |
[Guest User Repository] |
Guest accounts | Guest accounts (Guests › Guest accounts). |
[Endpoints Repository] |
Devices | The device records (Devices), used for MAC authentication. |
[Time Source] |
Time Source | Authorization-only attributes computed from the current time, such as Now DT, One Day DT, Today DT or now_plus_<N><unit>, in the tenant time zone. |
[Insight Repository] |
Insight Repository | Authorization-only attributes from authentication and session history, such as login counts and active sessions. |
When you set up Guests › Wi-Fi passes, the console also creates a directory named Guest Wi-Fi passes (type GuestPass). It answers MAC authentication on the guest SSID with the passphrases of the active passes, and is used only by the policy the Wi-Fi passes setup creates.
How lookups run
Section titled “How lookups run”An access policy’s Check accounts in list is an ordered list.
- Airgate asks each directory in turn.
- The first directory that has the user answers. Its verdict is final: a wrong password, a disabled account or an expired account stops the search there, and later directories are not asked.
- A directory that does not have the user passes to the next one.
- A directory that cannot be reached (timeout, connection error) also passes to the next one. If no later directory has the user, the sign-in fails with Authentication source unavailable (code
9003), not User not found. - Directories that cannot do the operation are skipped. For example, a RADIUS server cannot look a user up without a password, and Entra ID cannot do MS-CHAP.
- Disabled directories are skipped and noted in the trace.
Each call to a directory has a timeout (Server timeout (s), default 5 seconds), and never runs past the time the RADIUS request has left.
Authorization attributes
Section titled “Authorization attributes”When a directory finds a user, it can also return attributes for your rules. They appear in the namespace Authorization:<directory name>, for example:
Authorization:Contoso AD:Groups: the groups (for Active Directory, the CNs ofmemberOf, plus nested groups when Expand nested groups is on);Authorization:Contoso AD:Department,Title,Email,UPNand any other attribute you map;Authorization:Sources: the names of the directories that returned attributes.
What a directory returns is defined on its Filters & attributes tab. Each filter is a query (an LDAP filter, an SQL query, a REST path, a Graph or Okta query) and a mapping from the result’s fields to attribute names (aliases). New directories get default filters. For Active Directory these are:
| Filter | Query | Returns |
|---|---|---|
| Authentication | (&(objectClass=user)(|(sAMAccountName=%{Authentication:Username})(userPrincipalName=%{Authentication:Username}))) |
UserDN, Department, Title, company, memberOf, Phone, Email, Name, UPN |
| Group | (distinguishedName=%{memberOf}) |
Groups |
| Machine | (&(sAMAccountName=%{Host:Name}$)(objectClass=computer)) |
HostName, OperatingSystem, OSServicePack |
Values in %{…} are taken from the request and escaped (LDAP) or bound as parameters (SQL).
Other settings on the General tab:
| Setting | Meaning |
|---|---|
| Use for authorization | Fetch attributes from this directory for the users it authenticates. |
| Additional authorization sources | Other directories queried, in order, for users this directory authenticated. |
| Cache timeout (seconds) | Authorization attributes are cached per user for this long. 0 disables caching (maximum 604800). Time-based sources are never cached. |
| Enable as role (on the Filters & attributes tab) | Attribute aliases whose values become tags (Tips:Role). |
An access policy also asks its directories for attributes when the user was authenticated another way, for example by an EAP-TLS certificate that carries no password.
Backup servers
Section titled “Backup servers”Active Directory, Generic LDAP, Generic SQL DB, RADIUS server and Token server directories can list backup servers on the Backup servers tab. Airgate tries them when the primary does not answer.
Test a directory
Section titled “Test a directory”On Access › Directories:
- Test connection checks that Airgate can reach and bind to the directory, also for unsaved settings.
- Test a user (lookup / verify password) looks a user up, optionally with a password, and shows the attributes returned.