Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,38 @@ | ||
Realms Management | ||
================= | ||
|
||
A Realm is a data access object that provides authentication capabilites for Agate users user the underlying datasource's specific API to discover authorization data. | ||
|
||
Realm Types | ||
----------- | ||
|
||
LDAP Realm | ||
~~~~~~~~~~ | ||
|
||
A realm that authenticates users by using Lightweight Directory Access Protocol to query a Directory Access Agent. | ||
This realm uses a user's Distinguished Name (DN) template to build queries. | ||
|
||
Active Directory Realm | ||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
The only difference between this and the LDAP realm is the query template. | ||
This realm queries by using a combination of a search filter and search base. | ||
|
||
SQL Database Realm | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
``mysql``, ``mariadb`` and ``postgresql`` are supported. | ||
This realm queries the user's password with the salt style used by the database. | ||
|
||
Salt styles include: | ||
|
||
- ``NO_SALT``: used when the password is in plain text. | ||
- ``CRYPT``: uses the database's underlying cryptographic method to decrypt the password. | ||
- ``COLUMN``: the salt column must be the second column included in the query. | ||
- ``EXTERNAL``: uses the specified algorithm to decrypt the password. | ||
|
||
|
||
Open ID Connect Realm | ||
~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
A realm that uses the OpenID Connect (`OIDC <https://auth0.com/docs/protocols/oidc>`_) protocol to authenticate users. |