Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add warning to last step #5752

Merged
merged 7 commits into from
Nov 15, 2022
Merged

Add warning to last step #5752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8d2d25c
Add warning to last step
Tostti Nov 11, 2022
002eb83
Turn steps with warnings into notes with special step
javimed Nov 14, 2022
906a80e
Add missing instructions
Tostti Nov 14, 2022
3d73f1f
Make instructions consistent
Tostti Nov 14, 2022
1f06085
Fix typo
Tostti Nov 14, 2022
a650bc4
Clarify action to perform in notes
javimed Nov 14, 2022
4126bf1
Switch to small notes
javimed Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions source/user-manual/wazuh-dashboard/single-sign-on/azure-active-directory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,18 +285,19 @@ Wazuh dashboard configuration
opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

#. Change the logout configuration in the Wazuh dashboard.
.. note::
:class: not-long

Edit the ``path: /auth/logout`` section of the ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js`` file. It is recommended to back up this file before the configuration is changed. The configuration must be similar to this:
*For versions 4.3.9 and earlier*, also replace ``path: `/auth/logout``` with ``path: `/logout``` in ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``.

.. code-block:: console
:emphasize-lines: 3
...
this.router.get({
path: `/logout`,
validate: false
...
.. code-block:: console
:emphasize-lines: 3

...
this.router.get({
path: `/logout`,
validate: false
...

#. Restart the Wazuh dashboard service.

Expand Down
29 changes: 15 additions & 14 deletions source/user-manual/wazuh-dashboard/single-sign-on/google.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,28 +242,29 @@ Wazuh dashboard configuration

Add these configurations to ``/etc/wazuh-dashboard/opensearch_dashboards.yml``. It is recommended to back up this file before the configuration is changed.

.. code-block:: console
.. code-block:: console

opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

#. Change the logout configuration in the Wazuh dashboard.
.. note::
:class: not-long

To change the logout configuration, edit the ``path: /auth/logout`` section of the ``route.js`` file. The file path is ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``. It is recommended to back up this file before the configuration is changed. The configuration must be similar to this:
*For versions 4.3.9 and earlier*, also replace ``path: `/auth/logout``` with ``path: `/logout``` in ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``.

.. code-block:: console
:emphasize-lines: 3
...
this.router.get({
path: `/logout`,
validate: false
...
.. code-block:: console
:emphasize-lines: 3

...
this.router.get({
path: `/logout`,
validate: false
...

#. Restart the Wazuh dashboard service.

.. include:: /_templates/common/restart_dashboard.rst
.. include:: /_templates/common/restart_dashboard.rst

#. Test the configuration.

To test the configuration, go to your Wazuh dashboard URL and log in with your Google Workspace account.
To test the configuration, go to your Wazuh dashboard URL and log in with your Google Workspace account.
26 changes: 21 additions & 5 deletions source/user-manual/wazuh-dashboard/single-sign-on/jumpcloud.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,16 +240,32 @@ Wazuh dashboard configuration

Add these configurations to ``/etc/wazuh-dashboard/opensearch_dashboards.yml``. It is recommended to back up this file before the configuration is changed.

.. code-block:: console

opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

.. note::
:class: not-long

*For versions 4.3.9 and earlier*, also replace ``path: `/auth/logout``` with ``path: `/logout``` in ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``.

.. code-block:: console

opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

:emphasize-lines: 3

...
this.router.get({
path: `/logout`,
validate: false
...

#. Restart the Wazuh dashboard service.

.. include:: /_templates/common/restart_dashboard.rst

#. Test the configuration.

To test the configuration, go to your Wazuh dashboard URL and log in with your Jumpcloud account.


To test the configuration, go to your Wazuh dashboard URL and log in with your Jumpcloud account.

63 changes: 16 additions & 47 deletions source/user-manual/wazuh-dashboard/single-sign-on/okta.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,64 +278,33 @@ Wazuh dashboard configuration

#. Edit the Wazuh dashboard configuration file.

Add these configurations to the ``/etc/wazuh-dashboard/opensearch_dashboards.yml`` file. It is recommended to back up this file before the configuration is changed.
Add these configurations to ``/etc/wazuh-dashboard/opensearch_dashboards.yml``. It is recommended to back up this file before the configuration is changed.

.. code-block:: console
.. code-block:: console

opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

#. Change the logout configuration in the Wazuh dashboard.

To change the logout configuration, replace the ``this.router.get({path: `auth/logout``` section of the ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js`` file with the following setting. It is recommended to back up this file before the configuration is changed.
.. note::
:class: not-long

.. code-block:: console
*For versions 4.3.9 and earlier*, also replace ``path: `/auth/logout``` with ``path: `/logout``` in ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``.

this.router.get({
path: `/logout`,
validate: false
}, async (context, request, response) => {
try {
const authInfo = await this.securityClient.authinfo(request);
this.sessionStorageFactory.asScoped(request).clear(); // TODO: need a default logout page
const redirectUrl = `${this.coreSetup.http.basePath.serverBasePath}/app/wazuh`
return response.redirected({
headers: {
location: redirectUrl
}
});
} catch (error) {
context.security_plugin.logger.error(`SAML logout failed: ${error}`);
return response.badRequest();
}
});
this.router.get({
path: `/auth/logout`,
validate: false
}, async (context, request, response) => {
try {
const authInfo = await this.securityClient.authinfo(request);
this.sessionStorageFactory.asScoped(request).clear(); // TODO: need a default logout page
const redirectUrl = `${this.coreSetup.http.basePath.serverBasePath}/app/wazuh`
return response.redirected({
headers: {
location: redirectUrl
}
});
} catch (error) {
context.security_plugin.logger.error(`SAML logout failed: ${error}`);
return response.badRequest();
}
});
}
}
.. code-block:: console
:emphasize-lines: 3

...
this.router.get({
path: `/logout`,
validate: false
...

#. Restart the Wazuh dashboard service.

.. include:: /_templates/common/restart_dashboard.rst
.. include:: /_templates/common/restart_dashboard.rst

#. Test the configuration.

To test the Okta SSO configuration, go to your Wazuh dashboard URL and log in with your Okta account.
To test the configuration, go to your Wazuh dashboard URL and log in with your Okta account.


33 changes: 17 additions & 16 deletions source/user-manual/wazuh-dashboard/single-sign-on/onelogin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,28 +273,29 @@ Wazuh dashboard configuration

Add these configurations to ``/etc/wazuh-dashboard/opensearch_dashboards.yml``. It is recommended to back up this file before the configuration is changed.

.. code-block:: console
.. code-block:: console

opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

#. Change the logout configuration in the Wazuh dashboard.
.. note::
:class: not-long

To change the logout configuration, edit the ``path: /auth/logout`` section of the ``route.js`` file. The file path is ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``. It is recommended to back up this file before the configuration is changed. The configuration must be similar to this:
.. code-block:: console
:emphasize-lines: 3
...
this.router.get({
path: `/logout`,
validate: false
...
*For versions 4.3.9 and earlier*, also replace ``path: `/auth/logout``` with ``path: `/logout``` in ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``.

.. code-block:: console
:emphasize-lines: 3

...
this.router.get({
path: `/logout`,
validate: false
...

#. Restart the Wazuh dashboard service.

.. include:: /_templates/common/restart_dashboard.rst

#. Test the configuration.

To test the configuration, go to your Wazuh dashboard URL and log in with your OneLogin account.
To test the configuration, go to your Wazuh dashboard URL and log in with your OneLogin account.
21 changes: 17 additions & 4 deletions source/user-manual/wazuh-dashboard/single-sign-on/pingone.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,16 +242,29 @@ Wazuh dashboard configuration

Add these configurations to ``/etc/wazuh-dashboard/opensearch_dashboards.yml``. It is recommended to back up this file before the configuration is changed.

.. code-block:: console
.. code-block:: console

opensearch_security.auth.type: "saml"
server.xsrf.whitelist: ["/_plugins/_security/saml/acs", "/_plugins/_security/saml/logout", "/_opendistro/_security/saml/acs", "/_opendistro/_security/saml/logout", "/_opendistro/_security/saml/acs/idpinitiated"]

.. note::
:class: not-long

*For versions 4.3.9 and earlier*, also replace ``path: `/auth/logout``` with ``path: `/logout``` in ``/usr/share/wazuh-dashboard/plugins/securityDashboards/server/auth/types/saml/routes.js``.

.. code-block:: console
:emphasize-lines: 3

...
this.router.get({
path: `/logout`,
validate: false
...

#. Restart the Wazuh dashboard service.

.. include:: /_templates/common/restart_dashboard.rst
.. include:: /_templates/common/restart_dashboard.rst

#. Test the configuration.

To test the PingOne SSO configuration, go to your Wazuh dashboard URL and log in with your Ping One account.
To test the configuration, go to your Wazuh dashboard URL and log in with your Ping One account.