diff options
author | Djebran Lezzoum <ldjebran@gmail.com> | 2024-10-02 15:40:16 +0200 |
---|---|---|
committer | jessicamack <jmack@redhat.com> | 2024-10-15 23:43:32 +0200 |
commit | f22b192fb4eac82dbe29d7c4c95c69dd6813382d (patch) | |
tree | a392fec43af0ee9b6f2680ffee1538b1547dc47a /docs/docsite/rst | |
parent | Prettier DRF pages when using trusted proxy (#15579) (diff) | |
download | awx-f22b192fb4eac82dbe29d7c4c95c69dd6813382d.tar.xz awx-f22b192fb4eac82dbe29d7c4c95c69dd6813382d.zip |
Remove LDAP authentication (#15546)
Remove LDAP authentication from AWX
Diffstat (limited to 'docs/docsite/rst')
-rw-r--r-- | docs/docsite/rst/administration/configure_awx_authentication.rst | 5 | ||||
-rw-r--r-- | docs/docsite/rst/administration/ent_auth.rst | 11 | ||||
-rw-r--r-- | docs/docsite/rst/administration/index.rst | 1 | ||||
-rw-r--r-- | docs/docsite/rst/administration/ldap_auth.rst | 361 | ||||
-rw-r--r-- | docs/docsite/rst/administration/logging.rst | 8 | ||||
-rw-r--r-- | docs/docsite/rst/administration/oauth2_token_auth.rst | 2 | ||||
-rw-r--r-- | docs/docsite/rst/administration/performance.rst | 11 | ||||
-rw-r--r-- | docs/docsite/rst/administration/secret_handling.rst | 2 | ||||
-rw-r--r-- | docs/docsite/rst/administration/security_best_practices.rst | 2 | ||||
-rw-r--r-- | docs/docsite/rst/administration/social_auth.rst | 2 | ||||
-rw-r--r-- | docs/docsite/rst/administration/troubleshooting.rst | 3 | ||||
-rw-r--r-- | docs/docsite/rst/release_notes/known_issues.rst | 8 | ||||
-rw-r--r-- | docs/docsite/rst/userguide/overview.rst | 2 | ||||
-rw-r--r-- | docs/docsite/rst/userguide/rbac.rst | 2 |
14 files changed, 9 insertions, 411 deletions
diff --git a/docs/docsite/rst/administration/configure_awx_authentication.rst b/docs/docsite/rst/administration/configure_awx_authentication.rst index f90576f918..c56dfc5937 100644 --- a/docs/docsite/rst/administration/configure_awx_authentication.rst +++ b/docs/docsite/rst/administration/configure_awx_authentication.rst @@ -1,4 +1,4 @@ -Through the AWX user interface, you can set up a simplified login through various authentication types: GitHub, Google, LDAP, and RADIUS. After you create and register your developer application with the appropriate service, you can set up authorizations for them. +Through the AWX user interface, you can set up a simplified login through various authentication types: GitHub, Google, and RADIUS. After you create and register your developer application with the appropriate service, you can set up authorizations for them. 1. From the left navigation bar, click **Settings**. @@ -7,8 +7,7 @@ Through the AWX user interface, you can set up a simplified login through variou - :ref:`ag_auth_azure` - :ref:`ag_auth_github` - :ref:`ag_auth_google_oauth2` -- :ref:`LDAP settings <ag_auth_ldap>` -- :ref:`ag_auth_radius` +- :ref:`ag_auth_radius` - :ref:`ag_auth_tacacs` Different authentication types require you to enter different information. Be sure to include all the information as required. diff --git a/docs/docsite/rst/administration/ent_auth.rst b/docs/docsite/rst/administration/ent_auth.rst index 73039f4677..238893ecee 100644 --- a/docs/docsite/rst/administration/ent_auth.rst +++ b/docs/docsite/rst/administration/ent_auth.rst @@ -13,10 +13,6 @@ This section describes setting up authentication for the following enterprise sy .. contents:: :local: -.. note:: - - For LDAP authentication, see :ref:`ag_auth_ldap`. - Azure, RADIUS, and TACACS+ users are categorized as 'Enterprise' users. The following rules apply to Enterprise users: - Enterprise users can only be created via the first successful login attempt from remote authentication backend. @@ -62,13 +58,6 @@ For application registering basics in Azure AD, refer to the `Azure AD Identity .. _`Azure AD Identity Platform (v2)`: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-overview - -LDAP Authentication ---------------------- - -Refer to the :ref:`ag_auth_ldap` section. - - .. _ag_auth_radius: RADIUS settings diff --git a/docs/docsite/rst/administration/index.rst b/docs/docsite/rst/administration/index.rst index 5ba867d856..247bc6db4a 100644 --- a/docs/docsite/rst/administration/index.rst +++ b/docs/docsite/rst/administration/index.rst @@ -41,7 +41,6 @@ Need help or want to discuss AWX including the documentation? See the :ref:`Comm oauth2_token_auth social_auth ent_auth - ldap_auth authentication_timeout kerberos_auth session_limits diff --git a/docs/docsite/rst/administration/ldap_auth.rst b/docs/docsite/rst/administration/ldap_auth.rst deleted file mode 100644 index 62372d949b..0000000000 --- a/docs/docsite/rst/administration/ldap_auth.rst +++ /dev/null @@ -1,361 +0,0 @@ -.. _ag_auth_ldap: - -Setting up LDAP Authentication -================================ - -.. index:: - single: LDAP - pair: authentication; LDAP - -This chapter describes how to integrate LDAP authentication with AWX. - -.. note:: - - If the LDAP server you want to connect to has a certificate that is self-signed or signed by a corporate internal certificate authority (CA), the CA certificate must be added to the system's trusted CAs. Otherwise, connection to the LDAP server will result in an error that the certificate issuer is not recognized. - -Administrators use LDAP as a source for account authentication information for AWX users. User authentication is provided, but not the synchronization of user permissions and credentials. Organization membership (as well as the organization admin) and team memberships can be synchronized. - -When so configured, a user who logs in with an LDAP username and password automatically gets an AWX account created for them and they can be automatically placed into organizations as either regular users or organization administrators. - -Users created locally in the user interface, take precedence over those logging into controller for their first time with an alternative authentication solution. You must delete the local user if you want to re-use it with another authentication method, such as LDAP. - -Users created through an LDAP login cannot change their username, given name, surname, or set a local password for themselves. You can also configure this to restrict editing of other field names. - -To configure LDAP integration for AWX: - -1. First, create a user in LDAP that has access to read the entire LDAP structure. - -2. Test if you can make successful queries to the LDAP server, use the ``ldapsearch`` command, which is a command line tool that can be installed on AWX command line as well as on other Linux and OSX systems. Use the following command to query the ldap server, where *josie* and *Josie4Cloud* are replaced by attributes that work for your setup: - -:: - - ldapsearch -x -H ldap://win -D "CN=josie,CN=Users,DC=website,DC=com" -b "dc=website,dc=com" -w Josie4Cloud - -Here ``CN=josie,CN=users,DC=website,DC=com`` is the Distinguished Name of the connecting user. - -.. note:: - - The ``ldapsearch`` utility is not automatically pre-installed with AWX, however, you can install it from the ``openldap-clients`` package. - -3. In the AWX User Interface, click **Settings** from the left navigation and click to select **LDAP settings** from the list of Authentication options. - - - Multiple LDAP configurations are not needed per LDAP server, but you can configure multiple LDAP servers from this page, otherwise, leave the server at **Default**: - - .. image:: ../common/images/configure-awx-auth-ldap-servers.png - - | - - The equivalent API endpoints will show ``AUTH_LDAP_*`` repeated: ``AUTH_LDAP_1_*``, ``AUTH_LDAP_2_*``, ..., ``AUTH_LDAP_5_*`` to denote server designations. - - -4. To enter or modify the LDAP server address to connect to, click **Edit** and enter in the **LDAP Server URI** field using the same format as the one prepopulated in the text field: - -.. image:: ../common/images/configure-awx-auth-ldap-server-uri.png - -.. note:: - - Multiple LDAP servers may be specified by separating each with spaces or commas. Click the |help| icon to comply with proper syntax and rules. - -.. |help| image:: ../common/images/tooltips-icon.png - -5. Enter the password to use for the Binding user in the **LDAP Bind Password** text field. In this example, the password is 'passme': - -.. image:: ../common/images/configure-awx-auth-ldap-bind-pwd.png - -6. Click to select a group type from the **LDAP Group Type** drop-down menu list. - - LDAP Group Types include: - - - ``PosixGroupType`` - - ``GroupOfNamesType`` - - ``GroupOfUniqueNamesType`` - - ``ActiveDirectoryGroupType`` - - ``OrganizationalRoleGroupType`` - - ``MemberDNGroupType`` - - ``NISGroupType`` - - ``NestedGroupOfNamesType`` - - ``NestedGroupOfUniqueNamesType`` - - ``NestedActiveDirectoryGroupType`` - - ``NestedOrganizationalRoleGroupType`` - - ``NestedMemberDNGroupType`` - - ``PosixUIDGroupType`` - - The LDAP Group Types that are supported by leveraging the underlying `django-auth-ldap library`_. To specify the parameters for the selected group type, see :ref:`Step 15 <ldap_grp_params>` below. - - .. _`django-auth-ldap library`: https://django-auth-ldap.readthedocs.io/en/latest/groups.html#types-of-groups - - -7. The **LDAP Start TLS** is disabled by default. To enable TLS when the LDAP connection is not using SSL/TLS, click the toggle to **ON**. - -.. image:: ../common/images/configure-awx-auth-ldap-start-tls.png - -8. Enter the Distinguished Name in the **LDAP Bind DN** text field to specify the user that AWX uses to connect (Bind) to the LDAP server. Below uses the example, ``CN=josie,CN=users,DC=website,DC=com``: - -.. image:: ../common/images/configure-awx-auth-ldap-bind-dn.png - - -9. If that name is stored in key ``sAMAccountName``, the **LDAP User DN Template** populates with ``(sAMAccountName=%(user)s)``. Active Directory stores the username to ``sAMAccountName``. Similarly, for OpenLDAP, the key is ``uid``--hence the line becomes ``(uid=%(user)s)``. - -10. Enter the group distinguish name to allow users within that group to access AWX in the **LDAP Require Group** field, using the same format as the one shown in the text field, ``CN=awx Users,OU=Users,DC=website,DC=com``. - -.. image:: ../common/images/configure-awx-auth-ldap-req-group.png - -11. Enter the group distinguish name to prevent users within that group to access AWX in the **LDAP Deny Group** field, using the same format as the one shown in the text field. In this example, leave the field blank. - - -12. Enter where to search for users while authenticating in the **LDAP User Search** field using the same format as the one shown in the text field. In this example, use: - -:: - - [ - "OU=Users,DC=website,DC=com", - "SCOPE_SUBTREE", - "(cn=%(user)s)" - ] - -The first line specifies where to search for users in the LDAP tree. In the above example, the users are searched recursively starting from ``DC=website,DC=com``. - -The second line specifies the scope where the users should be searched: - - - SCOPE_BASE: This value is used to indicate searching only the entry at the base DN, resulting in only that entry being returned - - SCOPE_ONELEVEL: This value is used to indicate searching all entries one level under the base DN - but not including the base DN and not including any entries under that one level under the base DN. - - SCOPE_SUBTREE: This value is used to indicate searching of all entries at all levels under and including the specified base DN. - -The third line specifies the key name where the user name is stored. - -.. image:: ../common/images/configure-awx-authen-ldap-user-search.png - -.. note:: - - For multiple search queries, the proper syntax is: - :: - - [ - [ - "OU=Users,DC=northamerica,DC=acme,DC=com", - "SCOPE_SUBTREE", - "(sAMAccountName=%(user)s)" - ], - [ - "OU=Users,DC=apac,DC=corp,DC=com", - "SCOPE_SUBTREE", - "(sAMAccountName=%(user)s)" - ], - [ - "OU=Users,DC=emea,DC=corp,DC=com", - "SCOPE_SUBTREE", - "(sAMAccountName=%(user)s)" - ] - ] - - -13. In the **LDAP Group Search** text field, specify which groups should be searched and how to search them. In this example, use: - -:: - - [ - "dc=example,dc=com", - "SCOPE_SUBTREE", - "(objectClass=group)" - ] - -- The first line specifies the BASE DN where the groups should be searched. -- The second lines specifies the scope and is the same as that for the user directive. -- The third line specifies what the ``objectclass`` of a group object is in the LDAP you are using. - -.. image:: ../common/images/configure-awx-authen-ldap-group-search.png - -14. Enter the user attributes in the **LDAP User Attribute Map** the text field. In this example, use: - -:: - - { - "first_name": "givenName", - "last_name": "sn", - "email": "mail" - } - - -The above example retrieves users by last name from the key ``sn``. You can use the same LDAP query for the user to figure out what keys they are stored under. - -.. image:: ../common/images/configure-awx-auth-ldap-user-attrb-map.png - -.. _ldap_grp_params: - -15. Depending on the selected **LDAP Group Type**, different parameters are available in the **LDAP Group Type Parameters** field to account for this. ``LDAP_GROUP_TYPE_PARAMS`` is a dictionary, which will be converted by AWX to kwargs and passed to the LDAP Group Type class selected. There are two common parameters used by any of the LDAP Group Type; ``name_attr`` and ``member_attr``. Where ``name_attr`` defaults to ``cn`` and ``member_attr`` defaults to ``member``: - - :: - - {"name_attr": "cn", "member_attr": "member"} - - To determine what parameters a specific LDAP Group Type expects. refer to the `django_auth_ldap`_ documentation around the classes ``init`` parameters. - - .. _`django_auth_ldap`: https://django-auth-ldap.readthedocs.io/en/latest/reference.html#django_auth_ldap.config.LDAPGroupType - - -16. Enter the user profile flags in the **LDAP User Flags by Group** the text field. In this example, use the following syntax to set LDAP users as "Superusers" and "Auditors": - -:: - - { - "is_superuser": "cn=superusers,ou=groups,dc=website,dc=com", - "is_system_auditor": "cn=auditors,ou=groups,dc=website,dc=com" - } - -The above example retrieves users who are flagged as superusers or as auditor in their profile. - -.. image:: ../common/images/configure-awx-auth-ldap-user-flags.png - -17. For details on completing the mapping fields, see :ref:`ag_ldap_org_team_maps`. - -.. image:: ../common/images/configure-ldap-orgs-teams-mapping.png - -18. Click **Save** when done. - -With these values entered on this form, you can now make a successful authentication with LDAP. - -.. note:: - - AWX does not actively sync users, but they are created during their initial login. - To improve performance associated with LDAP authentication, see :ref:`ldap_auth_perf_tips` at the end of this chapter. - - -.. _ag_ldap_org_team_maps: - -LDAP Organization and Team Mapping -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: organization mapping - single: LDAP mapping - pair: authentication; LDAP mapping - pair: authentication; organization mapping - pair: authentication; LDAP team mapping - pair: authentication; team mapping - single: team mapping - -You can control which users are placed into which organizations based on LDAP attributes (mapping out between your organization admins/users and LDAP groups). - -Keys are organization names. Organizations will be created if not present. Values are dictionaries defining the options for each organization's membership. For each organization, it is possible to specify what groups are automatically users of the organization and also what groups can administer the organization. - -**admins**: None, True/False, string or list/tuple of strings. - - If **None**, organization admins will not be updated based on LDAP values. - - If **True**, all users in LDAP will automatically be added as admins of the organization. - - If **False**, no LDAP users will be automatically added as admins of the organization. - - If a string or list of strings, specifies the group DN(s) that will be added of the organization if they match any of the specified groups. - -**remove_admins**: True/False. Defaults to **False**. - - When **True**, a user who is not an member of the given groups will be removed from the organization's administrative list. - -**users**: None, True/False, string or list/tuple of strings. Same rules apply as for **admins**. - -**remove_users**: True/False. Defaults to **False**. Same rules apply as **remove_admins**. - -:: - - { - "LDAP Organization": { - "admins": "cn=engineering_admins,ou=groups,dc=example,dc=com", - "remove_admins": false, - "users": [ - "cn=engineering,ou=groups,dc=example,dc=com", - "cn=sales,ou=groups,dc=example,dc=com", - "cn=it,ou=groups,dc=example,dc=com" - ], - "remove_users": false - }, - "LDAP Organization 2": { - "admins": [ - "cn=Administrators,cn=Builtin,dc=example,dc=com" - ], - "remove_admins": false, - "users": true, - "remove_users": false - } - } - -Mapping between team members (users) and LDAP groups. Keys are team names (will be created if not present). Values are dictionaries of options for each team's membership, where each can contain the following parameters: - -**organization**: string. The name of the organization to which the team belongs. The team will be created if the combination of organization and team name does not exist. The organization will first be created if it does not exist. - -**users**: None, True/False, string or list/tuple of strings. - - - If **None**, team members will not be updated. - - If **True/False**, all LDAP users will be added/removed as team members. - - If a string or list of strings, specifies the group DN(s). User will be added as a team member if the user is a member of ANY of these groups. - -**remove**: True/False. Defaults to **False**. When **True**, a user who is not a member of the given groups will be removed from the team. - -:: - - { - "LDAP Engineering": { - "organization": "LDAP Organization", - "users": "cn=engineering,ou=groups,dc=example,dc=com", - "remove": true - }, - "LDAP IT": { - "organization": "LDAP Organization", - "users": "cn=it,ou=groups,dc=example,dc=com", - "remove": true - }, - "LDAP Sales": { - "organization": "LDAP Organization", - "users": "cn=sales,ou=groups,dc=example,dc=com", - "remove": true - } - } - - -.. _ldap_logging: - -Enabling Logging for LDAP -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - single: LDAP - pair: authentication; LDAP - -To enable logging for LDAP, you must set the level to ``DEBUG`` in the Settings configuration window: - -1. Click **Settings** from the left navigation pane and click to select **Logging settings** from the System list of options. -2. Click **Edit**. -3. Set the **Logging Aggregator Level Threshold** field to **Debug**. - -.. image:: ../common/images/settings-system-logging-debug.png - -4. Click **Save** to save your changes. - - -Referrals -~~~~~~~~~~~ - -.. index:: - pair: LDAP; referrals - pair: troubleshooting; LDAP referrals - -Active Directory uses "referrals" in case the queried object is not available in its database. It has been noted that this does not work properly with the django LDAP client and, most of the time, it helps to disable referrals. Disable LDAP referrals by adding the following lines to your ``/etc/awx/conf.d/custom.py`` file: - - .. code-block:: bash - - AUTH_LDAP_GLOBAL_OPTIONS = { - ldap.OPT_REFERRALS: False, - } - - -.. _ldap_auth_perf_tips: - -LDAP authentication performance tips -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. index:: - pair: best practices; ldap - -When an LDAP user authenticates, by default, all user-related attributes will be updated in the database on each log in. In some environments, this operation can be skipped due to performance issues. To avoid it, you can disable the option `AUTH_LDAP_ALWAYS_UPDATE_USER`. - -.. warning:: - - - With this option set to False, no changes to LDAP user's attributes will be updated. Attributes will only be updated the first time the user is created. - diff --git a/docs/docsite/rst/administration/logging.rst b/docs/docsite/rst/administration/logging.rst index ff5453839a..bf484ab9cd 100644 --- a/docs/docsite/rst/administration/logging.rst +++ b/docs/docsite/rst/administration/logging.rst @@ -363,11 +363,3 @@ Troubleshoot Logging API 4XX Errors ~~~~~~~~~~~~~~~~~~~~ You can include the API error message for 4XX errors by modifying the log format for those messages. Refer to the :ref:`logging-api-400-error-config` section for more detail. - -LDAP -~~~~~~ -You can enable logging messages for the LDAP adapter. Refer to the :ref:`ldap_logging` section for more detail. - -SAML -~~~~~~~ -You can enable logging messages for the SAML adapter the same way you can enable logging for LDAP. Refer to the :ref:`ldap_logging` section for more detail. diff --git a/docs/docsite/rst/administration/oauth2_token_auth.rst b/docs/docsite/rst/administration/oauth2_token_auth.rst index e6a3497f5e..7ab83a16e6 100644 --- a/docs/docsite/rst/administration/oauth2_token_auth.rst +++ b/docs/docsite/rst/administration/oauth2_token_auth.rst @@ -451,7 +451,7 @@ Revoking an access token by this method is the same as deleting the token resour .. note:: - The **Allow External Users to Create Oauth2 Tokens** (``ALLOW_OAUTH2_FOR_EXTERNAL_USERS`` in the API) setting is disabled by default. External users refer to users authenticated externally with a service like LDAP, or any of the other SSO services. This setting ensures external users cannot *create* their own tokens. If you enable then disable it, any tokens created by external users in the meantime will still exist, and are not automatically revoked. + The **Allow External Users to Create Oauth2 Tokens** (``ALLOW_OAUTH2_FOR_EXTERNAL_USERS`` in the API) setting is disabled by default. External users refer to users authenticated externally with services like SSO services. This setting ensures external users cannot *create* their own tokens. If you enable then disable it, any tokens created by external users in the meantime will still exist, and are not automatically revoked. Alternatively, you can use the ``manage`` utility, :ref:`ag_manage_utility_revoke_tokens`, to revoke tokens as described in the :ref:`ag_token_utility` section. diff --git a/docs/docsite/rst/administration/performance.rst b/docs/docsite/rst/administration/performance.rst index 32d3c96cd0..05b1c0f62b 100644 --- a/docs/docsite/rst/administration/performance.rst +++ b/docs/docsite/rst/administration/performance.rst @@ -80,15 +80,6 @@ Metrics added in this release to track: - **callback_receiver_event_processing_avg_seconds** - Proxy for “how far behind the callback receiver workers are in processing output". If this number stays large, consider horizontally scaling the control plane and reducing the ``capacity_adjustment`` value on the node. -LDAP login and basic authentication -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. index:: - pair: improvements; LDAP - pair: improvements; basic auth - -Enhancements were made to the authentication backend that syncs LDAP configuration with the organizations and teams in the AWX. Logging in with large mappings between LDAP groups and organizations and teams is now up to 10 times faster than in previous versions. - - Capacity Planning ------------------ .. index:: @@ -382,4 +373,4 @@ For workloads with high levels of API interaction, best practices include: - Use dynamic inventory sources instead of individually creating inventory hosts via the API - Use webhook notifications instead of polling for job status -Since the published blog, additional observations have been made in the field regarding authentication methods. For automation clients that will make many requests in rapid succession, using tokens is a best practice, because depending on the type of user, there may be additional overhead when using basic authentication. For example, LDAP users using basic authentication trigger a process to reconcile if the LDAP user is correctly mapped to particular organizations, teams and roles. Refer to :ref:`ag_oauth2_token_auth` for detail on how to generate and use tokens. +Since the published blog, additional observations have been made in the field regarding authentication methods. For automation clients that will make many requests in rapid succession, using tokens is a best practice, because depending on the type of user, there may be additional overhead when using basic authentication. Refer to :ref:`ag_oauth2_token_auth` for detail on how to generate and use tokens. diff --git a/docs/docsite/rst/administration/secret_handling.rst b/docs/docsite/rst/administration/secret_handling.rst index 41b35d7310..fb5eb86e8c 100644 --- a/docs/docsite/rst/administration/secret_handling.rst +++ b/docs/docsite/rst/administration/secret_handling.rst @@ -24,7 +24,7 @@ User passwords for local users ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ AWX hashes local AWX user passwords with the PBKDF2 algorithm using a SHA256 hash. Users who authenticate via external -account mechanisms (LDAP, SAML, OAuth, and others) do not have any password or secret stored. +account mechanisms (SAML, OAuth, and others) do not have any password or secret stored. Secret handling for operational use ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/docsite/rst/administration/security_best_practices.rst b/docs/docsite/rst/administration/security_best_practices.rst index 8695082fbf..e5d7395593 100644 --- a/docs/docsite/rst/administration/security_best_practices.rst +++ b/docs/docsite/rst/administration/security_best_practices.rst @@ -82,7 +82,7 @@ Do not disable SELinux, and do not disable AWX’s existing multi-tenant contain External account stores ^^^^^^^^^^^^^^^^^^^^^^^^^ -Maintaining a full set of users just in AWX can be a time-consuming task in a large organization, prone to error. AWX supports connecting to external account sources via :ref:`LDAP <ag_auth_ldap>` and certain :ref:`OAuth providers <ag_social_auth>`. Using this eliminates a source of error when working with permissions. +Maintaining a full set of users just in AWX can be a time-consuming task in a large organization, prone to error. AWX supports connecting to external account sources via certain :ref:`OAuth providers <ag_social_auth>`. Using this eliminates a source of error when working with permissions. .. _ag_security_django_password: diff --git a/docs/docsite/rst/administration/social_auth.rst b/docs/docsite/rst/administration/social_auth.rst index 9979fb0d39..05a62f0201 100644 --- a/docs/docsite/rst/administration/social_auth.rst +++ b/docs/docsite/rst/administration/social_auth.rst @@ -11,7 +11,7 @@ Authentication methods help simplify logins for end users--offering single sign- Account authentication can be configured in the AWX User Interface and saved to the PostgreSQL database. For instructions, refer to the :ref:`ag_configure_awx` section. -Account authentication in AWX can be configured to centrally use OAuth2, while enterprise-level account authentication can be configured for :ref:`Azure <ag_auth_azure>`, :ref:`RADIUS <ag_auth_radius>`, or even :ref:`LDAP <ag_auth_ldap>` as a source for authentication information. See :ref:`ag_ent_auth` for more detail. +Account authentication in AWX can be configured to centrally use OAuth2, while enterprise-level account authentication can be configured for :ref:`Azure <ag_auth_azure>`, :ref:`RADIUS <ag_auth_radius>` as a source for authentication information. See :ref:`ag_ent_auth` for more detail. For websites, such as Microsoft Azure, Google or GitHub, that provide account information, account information is often implemented using the OAuth standard. OAuth is a secure authorization protocol which is commonly used in conjunction with account authentication to grant 3rd party applications a "session token" allowing them to make API calls to providers on the user’s behalf. diff --git a/docs/docsite/rst/administration/troubleshooting.rst b/docs/docsite/rst/administration/troubleshooting.rst index 43c9bfa8d9..f363695265 100644 --- a/docs/docsite/rst/administration/troubleshooting.rst +++ b/docs/docsite/rst/administration/troubleshooting.rst @@ -52,9 +52,6 @@ Example configuration of ``extra_settings`` parameter: - setting: MAX_PAGE_SIZE value: "500" - - setting: AUTH_LDAP_BIND_DN - value: "cn=admin,dc=example,dc=com" - - setting: LOG_AGGREGATOR_LEVEL value: "'DEBUG'" diff --git a/docs/docsite/rst/release_notes/known_issues.rst b/docs/docsite/rst/release_notes/known_issues.rst index ae685f152c..d92590a02b 100644 --- a/docs/docsite/rst/release_notes/known_issues.rst +++ b/docs/docsite/rst/release_notes/known_issues.rst @@ -14,7 +14,6 @@ Known Issues pair: known issues; live event statuses pair: live event statuses; green dot pair: live event statuses; red dot - pair: known issues; LDAP authentication pair: known issues; lost isolated jobs pair: known issues; sosreport pair: known issues; local management @@ -97,13 +96,6 @@ Misuse of job slicing can cause errors in job scheduling .. include:: ../common/job-slicing-rule.rst - -Default LDAP directory must be configured to use LDAP Authentication -====================================================================== - -The ability to configure up to six LDAP directories for authentication requires a value. On the settings page for LDAP, there is a "Default" LDAP configuration followed by five-numbered configuration slots. If the "Default" is not populated, AWX will not try to authenticate using the other directory configurations. - - Potential security issue using ``X_FORWARDED_FOR`` in ``REMOTE_HOST_HEADERS`` ================================================================================= diff --git a/docs/docsite/rst/userguide/overview.rst b/docs/docsite/rst/userguide/overview.rst index 59f44063f9..87390a3910 100644 --- a/docs/docsite/rst/userguide/overview.rst +++ b/docs/docsite/rst/userguide/overview.rst @@ -189,7 +189,7 @@ Authentication Enhancements pair: features; authentication pair: features; OAuth 2 token -AWX supports LDAP, SAML, token-based authentication. Enhanced LDAP and SAML support allows you to integrate your account information in a more flexible manner. Token-based Authentication allows for easily authentication of third-party tools and services with AWX via integrated OAuth 2 token support. +AWX supports SAML, token-based authentication. Enhanced SAML support allows you to integrate your account information in a more flexible manner. Token-based Authentication allows for easily authentication of third-party tools and services with AWX via integrated OAuth 2 token support. Cluster Management ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/docsite/rst/userguide/rbac.rst b/docs/docsite/rst/userguide/rbac.rst index f94e957637..1eb31e9f94 100644 --- a/docs/docsite/rst/userguide/rbac.rst +++ b/docs/docsite/rst/userguide/rbac.rst @@ -248,7 +248,7 @@ Often, you will have many Roles in a system and you will want some roles to incl .. |rbac-heirarchy-morecomplex| image:: ../common/images/rbac-heirarchy-morecomplex.png -RBAC controls also give you the capability to explicitly permit User and Teams of Users to run playbooks against certain sets of hosts. Users and teams are restricted to just the sets of playbooks and hosts to which they are granted capabilities. And, with AWX, you can create or import as many Users and Teams as you require--create users and teams manually or import them from LDAP or Active Directory. +RBAC controls also give you the capability to explicitly permit User and Teams of Users to run playbooks against certain sets of hosts. Users and teams are restricted to just the sets of playbooks and hosts to which they are granted capabilities. And, with AWX, you can create or import as many Users and Teams as you require--create users and teams manually or import them from Active Directory. RBACs are easiest to think of in terms of who or what can see, change, or delete an "object" for which a specific capability is being determined. |