From 9ff59e4540366593edb726e3ad0ee1ae7deafec0 Mon Sep 17 00:00:00 2001 From: jgomer2001 Date: Wed, 3 Jan 2024 08:53:35 -0500 Subject: [PATCH 1/3] docs: re-arrange TOC and improve intro page #7254 --- docs/casa/administration/README.md | 20 -------------------- docs/casa/index.md | 27 +++++++++------------------ mkdocs.yml | 3 +-- 3 files changed, 10 insertions(+), 40 deletions(-) delete mode 100644 docs/casa/administration/README.md diff --git a/docs/casa/administration/README.md b/docs/casa/administration/README.md deleted file mode 100644 index 525fe685a90..00000000000 --- a/docs/casa/administration/README.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -tags: -- Casa -- administration ---- - -# Jans Casa Administration Guide - -## Unlocking admin features - -Admin capabilities are disabled by default. To unlock admin features follow these steps: - -1. Navigate to `/opt/jans/jetty/jans-casa` -1. Create an empty file named `.administrable` (ie. `touch .administrable`) -1. Run `chown casa:casa .administrable` (do this only if you are on FIPS environment) -1. Logout in case you have an open browser session - -!!! Warning - Once you have configured, tailored, and tested your deployment thoroughly, you are strongly encouraged to remove the marker file. This will prevent problems in case a user can escalate privileges or if some administrative account is compromised. - diff --git a/docs/casa/index.md b/docs/casa/index.md index adf163ec7dc..b03fc5318cb 100644 --- a/docs/casa/index.md +++ b/docs/casa/index.md @@ -15,9 +15,9 @@ For example, as people interact with an organization's digital services, they ma - Enroll, delete and manage two-factor authentication (2FA) credentials for their account (e.g. FIDO security keys, mobile apps, phone numbers, etc.) - Turn 2FA on and off - View and manage which external apps have been authorized to access what personal data -- View trusted devices +- View trusted devices -Casa provides a platform for people to perform these account security functions and more. +Casa provides a platform for people to perform these account security functions and more in an friendly, straightforward manner. ## Two-factor authentication @@ -25,44 +25,38 @@ The core use case for Casa is self-service 2FA. If people need to call the helpd Out-of-the-box, Casa can be used to enroll and manage the following authenticators: -- FIDO2 security keys like [Yubikeys](https://www.yubico.com/products/yubikey-hardware/) -- Gluu's FIDO push-notification mobile app, [Super Gluu](https://super.gluu.org) +- FIDO2 security keys like [Yubikeys](https://www.yubico.com/products/) +- Gluu's FIDO push-notification mobile app, [Super Gluu](https://docs.gluu.org/head/supergluu/) - OTP hardware cards like [these](https://www.ftsafe.com/Products/Power_Card/Standard) or dongles like [these](https://www.ftsafe.com/Products/OTP/Single_Button_OTP) - OTP mobile apps like Google Authenticator, FreeOTP, etc. - Mobile phone numbers able to receive OTPs via SMS - Passwords (if stored in the corresponding Janssen Server's local database, i.e. not a backend LDAP like AD) -Additional authenticators and use cases can be supported via [custom plugins](#plugin-oriented). +Additional authenticators and use cases can be supported via [custom plugins](#existing-plugins). ## 2FA enrollment APIs To facilitate 2FA device enrollment during account registration, or elsewhere in an application ecosystem, Casa exposes APIs for enrolling the following types of authenticators: -- Phone numbers for SMS OTP -- OTP apps, cards or dongles -- [Super Gluu](https://super.gluu.org) Android and iOS devices +- Phone numbers for SMS OTP +- OTP apps, cards, or dongles - FIDO2 security keys ## Configuration via APIs Besides a comprehensive graphical admin console, application settings can also be manipulated by means of a configuration API. -## Plugin oriented - -Casa is a plugin-oriented, Java web application. Existing functionality can be extended and new functionality and APIs can be introduced through plugins. - ## Existing plugins -Gluu has written a number of plugins to extend Casa, including plugins for: +Casa is a plugin-oriented, Java web application. Existing functionality can be extended and new functionality and APIs can be introduced through plugins. Currently, there are plugins available for the following: - [Consent management](./plugins/consent-management.md) - [Custom branding](./plugins/custom-branding.md) - [2FA settings](./plugins/2fa-settings.md) - ## Janssen Server integration -Janssen Server relies on "interception scripts" to implement user authentication. Casa itself has an interception script which defines authentication logic and routes authentications to specific 2FA mechanisms which also have their own scripts. All scripts must be enabled in the Janssen Server. +Janssen Server relies on "interception scripts" to implement user authentication. Casa itself has an interception script which defines authentication logic and routes authentications to specific 2FA mechanisms which also have their own scripts. ## User roles @@ -80,7 +74,6 @@ Use the following links to get started with Casa: ### Admin Guide - - [Administration](./administration/README.md) - [Admin console](./administration/admin-console.md) - [Credentials storage](./administration/credentials-stored.md) - [Custom branding](./administration/custom-branding.md) @@ -89,5 +82,3 @@ Use the following links to get started with Casa: ### User Guide - [Home](./user-guide.md) - - diff --git a/mkdocs.yml b/mkdocs.yml index 77cc02cb6c6..a7791ef78de 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8804,9 +8804,8 @@ nav: - 'casa/index.md' - Quick Start: 'casa/quick-start.md' - Administration Guide: - - 'casa/administration/README.md' - - 'About 2FA': 'casa/administration/2fa-basics.md' - 'Admin console': 'casa/administration/admin-console.md' + - 'About 2FA': 'casa/administration/2fa-basics.md' - 'Credentials storage': 'casa/administration/credentials-stored.md' - 'Custom branding': 'casa/administration/custom-branding.md' - 'URL path customization': 'casa/administration/change-context-path.md' From 3c32a8e19f7f1bb82721211976ff64f7697e1fff Mon Sep 17 00:00:00 2001 From: jgomer2001 Date: Wed, 3 Jan 2024 09:02:35 -0500 Subject: [PATCH 2/3] docs: rework intro paragraph in quick start guide #7254 Signed-off-by: jgomer2001 --- docs/casa/quick-start.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/casa/quick-start.md b/docs/casa/quick-start.md index 765f6462ff3..6a1ab1a0717 100644 --- a/docs/casa/quick-start.md +++ b/docs/casa/quick-start.md @@ -6,10 +6,9 @@ tags: # Jans Casa Quick Start Guide -Jans Casa is a self-service web portal for end-users to manage security preferences for their accounts. Jans Casa can -be used to with [Janssen Server](https://jans.io) or [Gluu Flex Server](https://gluu.org). +Jans Casa can be used with [Janssen Server](https://jans.io) or [Gluu Flex Server](https://gluu.org). At installation time (applies to any of these two products), you will be prompted if you desire to include Casa. If you want to add Casa post-installation, you will simply have to re-run the installer and ensure to select Casa. -Use this guide to install and configure a deployment of Casa. +Use this guide to configure your Casa deployment. ## Installation From 260ebee3174674a91214ae7d508885a17c4ed0a0 Mon Sep 17 00:00:00 2001 From: jgomer2001 Date: Wed, 3 Jan 2024 09:08:04 -0500 Subject: [PATCH 3/3] docs: add proper reference to installer #7254 Signed-off-by: jgomer2001 --- docs/casa/quick-start.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/casa/quick-start.md b/docs/casa/quick-start.md index 6a1ab1a0717..6f09b35418b 100644 --- a/docs/casa/quick-start.md +++ b/docs/casa/quick-start.md @@ -6,13 +6,11 @@ tags: # Jans Casa Quick Start Guide -Jans Casa can be used with [Janssen Server](https://jans.io) or [Gluu Flex Server](https://gluu.org). At installation time (applies to any of these two products), you will be prompted if you desire to include Casa. If you want to add Casa post-installation, you will simply have to re-run the installer and ensure to select Casa. - -Use this guide to configure your Casa deployment. +Use this guide to install and configure your Casa deployment. ## Installation -Follow the Jans Casa [installation guide](./administration/README.md) to install Gluu Casa. +Jans Casa can be used with [Janssen Server](https://jans.io) or [Gluu Flex Server](https://gluu.org). At [installation](https://docs.jans.io/head/admin/install/) time (applies to any of these two products), you will be prompted if you desire to include Casa. If you want to add Casa post-installation, you will simply have to re-run the installer and ensure to select Casa. ## Configuration