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.

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

docs: re-arrange TOC and improve intro page #7255

Merged
merged 4 commits into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 0 additions & 20 deletions docs/casa/administration/README.md

This file was deleted.

27 changes: 9 additions & 18 deletions docs/casa/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,54 +15,48 @@ 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

The core use case for Casa is self-service 2FA. If people need to call the helpdesk every time they get a new phone or security key, supporting strong authentication becomes prohibitively expensive.

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)
<!-- - [BioID authentication](./plugins/bioid.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

Expand All @@ -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)
Expand All @@ -89,5 +82,3 @@ Use the following links to get started with Casa:
### User Guide

- [Home](./user-guide.md)


7 changes: 2 additions & 5 deletions docs/casa/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,11 @@ 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).

Use this guide to install and configure a deployment of Casa.
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

Expand Down
3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down