Skip to content

Commit d136f3d

Browse files
duttarnabduttarnab
committed
feat: adding configuration and logs details
Signed-off-by: Arnab Dutta <[email protected]>
1 parent e77d811 commit d136f3d

File tree

7 files changed

+204
-8
lines changed

7 files changed

+204
-8
lines changed

‎docs/admin/admin-ui/auth-server-interaction.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
tags:
3+
- administration
4+
- admin-ui
5+
- interaction
6+
---
7+
# Interaction with Jans Auth Server
8+
9+
This user-friendly interface facilitates interaction with the [Jans Auth Server](https://docs.jans.io) through a REST API layer known as the [Jans Config API](https://docs.jans.io/v1.0.16/admin/config-guide/config-api). Here, we'll explore the working mechanism of the Gluu Flex Admin UI, focusing on its interaction with the Jans Auth Server and the key steps involved.
10+
11+
## The Authorization Code Flow
12+
13+
When accessing the Gluu Flex Admin UI through a web browser, the following steps are involved in the Authorization Code Flow:
14+
15+
1. The user accesses the Gluu Flex Admin UI frontend through a web browser.
16+
2. The frontend initiates the Authorization Code Flow by redirecting the user to the login page of the authorization server (`jans-auth-server`) for user authentication.
17+
3. The authorization server authenticates the end-user and obtains their consent/authorization.
18+
4. Upon successful authentication, the authorization server sends an authorization `code` and a `state` to the frontend. The frontend verifies the state.
19+
5. The frontend sends a request for a User-Info JWT (`UJWT`) response using the authorization code to the Admin UI Backend. The Admin UI Backend is a plugin of the Jans Config API.
20+
6. The Admin UI Backend utilizes the authorization code to first obtain an access token (`AT1`) from the token endpoint of the authorization server.
21+
7. With AT1, the backend fetches the User-Info JWT (`UJWT`) from the authorization server and forwards it to the frontend.
22+
8. The frontend stores the UJWT and its claims, including the user's role (`jansAdminUIRole`) and other relevant information, in the Redux store.
23+
24+
## API Protection and Scopes
25+
26+
To ensure security and access control, Gluu Flex Admin UI leverages API protection and scopes:
27+
28+
1. The Jans Config API's endpoints are protected and can only be accessed using an API protection token (`AT2`) with the required scopes.
29+
2. To generate an API protection token (`AT2`), the frontend requests the Token Server (`jans-auth-server`) via the backend. The Token Server and Authorization Server can be the same or different.
30+
3. The Token Server employs an introspection script that validates the `UJWT` and refers to the role-scope mapping in the Jans Auth Server persistence.
31+
4. The introspection script validates the UJWT and includes the appropriate scopes in AT2 based on the user's role.
32+
5. The frontend receives AT2 and associated scopes from the backend.
33+
6. Features in the frontend are enabled or disabled based on the scopes provided in AT2.
34+
35+
## Accessing Config-API Endpoints
36+
37+
To access config-api endpoints, the following steps are taken:
38+
39+
1. The Admin UI frontend requests AT2 from the Token Server through the backend.
40+
2. Armed with AT2, the frontend sends a request to the desired config-api endpoint. AT2 is included in the authorization header, along with other request parameters.
41+
3. At the Jans Config API, AT2 is validated, and the provided scopes are verified to ensure the necessary scope for the requested endpoint is present.
42+
4. If the above steps are successful, the requested data is fetched from the Jans Config API and forwarded to the frontend.
43+
44+
## Conclusion
45+
46+
The Gluu Flex Admin UI simplifies the process of managing configuration and features of the Jans Auth Server through an intuitive graphical user interface. By following the Authorization Code Flow and leveraging API protection and scopes, the Gluu Flex Admin UI ensures secure and controlled interaction with the Jans Auth Server's REST API layer. This seamless interaction empowers administrators to efficiently manage the Jans Auth Server's settings while adhering to strict access controls and security protocols.
47+

‎docs/admin/admin-ui/configuration.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
tags:
3+
- administration
4+
- admin-ui
5+
- configuration
6+
---
7+
8+
# Configuration
9+
10+
This document outlines the configuration process for Gluu Flex Admin UI, with a focus on essential components stored in the Auth Server's persistence layer. These components include role-permission mapping, OIDC client details for accessing the Auth Server, OIDC client details for accessing the Token Server, OIDC client details for accessing the License Server, and license metadata.
11+
12+
## Configuration Components
13+
14+
### Role-Permission Mapping
15+
16+
[Role-permission](./admin-menu.md/) mapping defines which administrative roles are granted specific permissions within the Gluu Flex Admin UI. This mapping ensures that administrators can only access and modify functionalities relevant to their roles.
17+
18+
The mapping is stored in json format with following attributes.
19+
20+
**Roles**
21+
|Attribute Name|Description|
22+
|--------------|-----------|
23+
|roles|Array of all roles|
24+
|role|Role name|
25+
|description| Role description|
26+
27+
**Permissions**
28+
|Attribute Name|Description|
29+
|--------------|-----------|
30+
|permissions|Array of all available permissions|
31+
|permission|Permission name|
32+
|description| Permission description|
33+
|defaultPermissionInToken|If set to `true`, it indicates that permission will need authentication and valid role during `/token` request to include in token|
34+
35+
**Mapping**
36+
|Attribute Name|Description|
37+
|--------------|-----------|
38+
|rolePermissionMapping| List of all role-permission mapping|
39+
|role|Role name|
40+
|permission|Array of all permission mapped to the role|
41+
42+
43+
### OIDC Client Details for Auth Server
44+
45+
To establish secure communication with the Auth Server, Gluu Flex Admin UI requires the OIDC client details, including client ID and client secret. These details are used for authentication and authorization purposes.
46+
47+
The information is stored in json format with following attributes.
48+
49+
|Attribute Name|Description|
50+
|--------------|-----------|
51+
|authServerClient|Object with Auth Server client details|
52+
|opHost|Auth Server hostname|
53+
|clientId| Client Id of OIDC client used to access Auth server|
54+
|clientSecret| Client Secret of OIDC client used to access Auth server|
55+
|scopes|Scopes required for Admin UI authentication|
56+
|acrValues|ACR required for Admin UI authentication|
57+
|redirectUri|Redirect UI which is Admin UI home page|
58+
|postLogoutUri|Url to be redirected after Admin UI logout|
59+
|frontchannelLogoutUri|Front channel Logout Uri|
60+
61+
62+
### OIDC Client Details for Token Server
63+
64+
Similarly, Gluu Flex Admin UI needs OIDC client details to interact with the Token Server. This enables the UI to request and manage access tokens required to access protected resources.
65+
66+
The information is stored in json format with following attributes.
67+
68+
|Attribute Name|Description|
69+
|--------------|-----------|
70+
|tokenServerClient|Object with Token Server client details|
71+
|opHost|Token Server hostname|
72+
|clientId| Client Id of OIDC client used to access Token server|
73+
|clientSecret| Client Secret of OIDC client used to access Token server|
74+
|tokenEndpoint|Token endpoint of token server|
75+
76+
### OIDC Client Details for License Server
77+
78+
Access to the License APIs is managed through OIDC client details. These details allows the Gluu Flex Admin UI Backend to generated access token to allow the retrieval of license-related information using license APIs.
79+
80+
The information is stored in json format with following attributes.
81+
82+
|Attribute Name|Description|
83+
|--------------|-----------|
84+
|opHost|Auth Server hostname used to generate token to access License APIs|
85+
|clientId| Client Id of OIDC client used to generate token to access License APIs|
86+
|clientSecret| Client Secret of OIDC client used to generate token to access License APIs|
87+
88+
### License Metadata
89+
90+
License metadata includes relevant information about the Gluu Flex Admin UI's licensing, such as License Key, Hardware id, License server url, License Auth server url, SSA used to register license auth server client.
91+
92+
The information is stored in json format with following attributes.
93+
94+
|Attribute Name|Description|
95+
|--------------|-----------|
96+
|licenseConfig|Object with License configuration details|
97+
|ssa|SSA used to register OIDC client to access license APIs|
98+
|scanLicenseApiHostname| SCAN License server hostname|
99+
|licenseHardwareKey|Hardware key (org_id) to access license APIs|

‎docs/admin/admin-ui/fido-menu.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
tags:
3+
- administration
4+
- admin-ui
5+
- fido2
6+
---
17
# FIDO Configuration
28

39
[FIDO 2.0](https://fidoalliance.org/) (FIDO2) is an open authentication standard that enables people to leverage common devices to authenticate to online services in both mobile and desktop environments.

‎docs/admin/admin-ui/logs.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
tags:
3+
- administration
4+
- admin-ui
5+
- installation
6+
- logs
7+
---
8+
9+
# Logs
10+
11+
Log files are essential components of a web application's infrastructure as they provide valuable insights into its functioning, performance, and potential issues. Log files play a critical role in maintaining, troubleshooting, and monitoring the Gluu Flex Admin UI application. Understanding the different log types, their locations, and the process of accessing and analyzing them will empower administrators to efficiently manage the application's health and quickly address any issues that may arise.
12+
13+
## Log File Types
14+
15+
The Gluu Flex Admin UI generates two types of log files:
16+
17+
- **adminui.log**: This is the backend log file that captures various activities, errors, and events related to the Gluu Flex Admin UI's operation. It provides insights into the application's behavior and potential issues.
18+
- **adminuiAudit.log**: This audit log file records user interactions, actions, and events related to administrative activities. It's particularly useful for tracking changes made to the system and ensuring accountability.
19+
20+
## Configuration of Log Locations
21+
22+
The log locations for Gluu Flex Admin UI can be configured by modifying the log4j2-adminui.xml file located at:
23+
24+
```
25+
/opt/jans/jetty/jans-config-api/custom/config/log4j2-adminui.xml
26+
```
27+
28+
Within this configuration file, you can adjust various settings such as log levels, appenders, and formats.

‎docs/admin/admin-ui/services-menu.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
tags:
3+
- administration
4+
- admin-ui
5+
- services
6+
- cache-configuration
7+
---
18
# Services
29

310
This menu allows user to configure Cache Provider and LDAP schemas which can be used by the auth server.

‎docs/admin/admin-ui/smtp-menu.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
tags:
3+
- administration
4+
- admin-ui
5+
- smtp
6+
---
17
# SMTP Configuration
28

39
The description of all the fields in SMTP configuration form:

‎mkdocs.yml

+11-8
Original file line numberDiff line numberDiff line change
@@ -127,15 +127,18 @@ nav:
127127
- 'Configuration': 'admin/config.md'
128128
- 'Admin UI':
129129
- 'Introduction': 'admin/admin-ui/introduction.md'
130+
- 'Auth Server Interaction': 'admin/admin-ui/auth-server-interaction.md'
131+
- 'Configuration': 'admin/admin-ui/configuration.md'
132+
- 'Logs': 'admin/admin-ui/logs.md'
130133
- 'Left Navigation Menu': 'admin/admin-ui/left-nav-menu.md'
131-
- 'Home': 'admin/admin-ui/dashboard.md'
132-
- 'Admin': 'admin/admin-ui/admin-menu.md'
133-
- 'Auth server': 'admin/admin-ui/auth-server-menu.md'
134-
- 'Schema': 'admin/admin-ui/schema-menu.md'
135-
- 'Services': 'admin/admin-ui/services-menu.md'
136-
- 'FIDO': 'admin/admin-ui/fido-menu.md'
137-
- 'SMTP': 'admin/admin-ui/smtp-menu.md'
138-
- 'Users': 'admin/admin-ui/userMgmt-menu.md'
134+
- 'Home': 'admin/admin-ui/dashboard.md'
135+
- 'Admin': 'admin/admin-ui/admin-menu.md'
136+
- 'Auth server': 'admin/admin-ui/auth-server-menu.md'
137+
- 'Schema': 'admin/admin-ui/schema-menu.md'
138+
- 'Services': 'admin/admin-ui/services-menu.md'
139+
- 'FIDO': 'admin/admin-ui/fido-menu.md'
140+
- 'SMTP': 'admin/admin-ui/smtp-menu.md'
141+
- 'Users': 'admin/admin-ui/userMgmt-menu.md'
139142
- 'Flex Recipes':
140143
- 'admin/recipes/README.md'
141144
- 'Getting Started with Rancher': 'admin/recipes/getting-started-rancher.md'

0 commit comments

Comments
 (0)