Skip to content

Commit

Permalink
quick realm information
Browse files Browse the repository at this point in the history
  • Loading branch information
meek0 committed Jul 25, 2019
1 parent 7e3067b commit 0f47567
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
1 change: 1 addition & 0 deletions index.rst
Expand Up @@ -35,6 +35,7 @@ Agate is the `OBiBa <http://obiba.org/>`_'s central authentication server which
web-user-guide/groups
web-user-guide/applications
web-user-guide/tickets
web-user-guide/realms
web-user-guide/administration

.. toctree::
Expand Down
36 changes: 36 additions & 0 deletions web-user-guide/realms.rst
@@ -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.

0 comments on commit 0f47567

Please sign in to comment.