From ff57e8e842e0c769d072f69d579bd55116782250 Mon Sep 17 00:00:00 2001 From: Madhumita Date: Mon, 2 Jan 2023 11:51:18 +0530 Subject: [PATCH] docs: typos #2201 --- docs/admin/developer/interception-scripts.md | 2 +- docs/admin/developer/managed-beans.md | 59 ++++++++++++++++++-- docs/admin/fido/README.md | 6 +- docs/admin/fido/logs.md | 5 +- 4 files changed, 59 insertions(+), 13 deletions(-) diff --git a/docs/admin/developer/interception-scripts.md b/docs/admin/developer/interception-scripts.md index 66f8b83d8cd..037179aa9d7 100644 --- a/docs/admin/developer/interception-scripts.md +++ b/docs/admin/developer/interception-scripts.md @@ -237,7 +237,7 @@ value for getApiVersion is greater than 10 ### Building business logic in a custom script Jans-auth server uses Weld 3.0 (JSR-365 aka CDI 2.0) for managed beans. The most -important aspects of business logic are implemented through a set of beans. This +common business functions are implemented through a set of beans. This [article](https://jans.io/docs/admin/developer/managed-beans/) presents many ready-to-use beans which can be used to build a script. diff --git a/docs/admin/developer/managed-beans.md b/docs/admin/developer/managed-beans.md index c2c5697b216..9b22c500279 100644 --- a/docs/admin/developer/managed-beans.md +++ b/docs/admin/developer/managed-beans.md @@ -4,11 +4,12 @@ tags: - developer - bean - CdiUtil + --- ## Ready-to-use code in Custom script: Jans-auth server uses Weld 3.0 (JSR-365 aka CDI 2.0) for managed beans. -The most important aspects of business logic are implemented through a set of beans +The most useful functions are implemented through a set of beans which can be re-used in all custom scripts. ### Obtaining a bean inside a custom script: [CdiUtil](https://github.com/JanssenProject/jans/blob/main/jans-core/service/src/main/java/io/jans/service/cdi/util/CdiUtil.java) used to obtain managed beans inside a custom script. @@ -23,8 +24,8 @@ Usage (jython code): Suppose UserService and AuthenticationService beans have to be referenced in the code, it can be done as below: ``` -from org.gluu.oxauth.service import UserService -from org.gluu.oxauth.service import AuthenticationService +from io.jans.as.server.service import UserService +from io.jans.as.server.service import AuthenticationService ... userService = CdiUtil.bean(UserService) authenticationService = CdiUtil.bean(AuthenticationService) @@ -141,15 +142,61 @@ A class employed to represent a user entry in the persistence. Provides getters ### 5. [CustomAttribute](https://github.com/JanssenProject/jans/blob/main/jans-orm/model/src/main/java/io/jans/orm/model/base/CustomAttribute.java) A class that models an attribute. An attribute has a name and a collection of associated values -### 6. [Identity](https://github.com/JanssenProject/jans/blob/main/jans-core/service/src/main/java/io/jans/model/security/Identity.java) -Mainly used to carry data between steps of authentication flows. +### 6. [Identity](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/security/Identity.java) +The authentication flow in jans-auth server is stateless and the instance is preserved because the Identity parameters (another name for session parameters) are persisted in databases. +A function in the `PersonAuthenticationType` script called `getExtraParametersForStep` should be overridden to include any new session variable. The underlying Jans-auth server takes care of retrieving it, persisting it etc. + +``` +def getExtraParametersForStep(self, configurationAttributes, step): + return Arrays.asList("sessionParamName1", "sessionParamName2", "sessionParamName3") +``` +Bean details: |Signature|Description| |-|-| |`Object getWorkingParameter(String name)`|Retrieves a working parameter by name previously set via `setWorkingParameter`| |`void setWorkingParameter(String name, Object value)`|Binds data to a name for further use in an authentication flow. Recommended values to store are `String`s| |`SessionId getSessionId()`|Retrieves a reference to the associated server session object, see [SessionId](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/model/common/SessionId.java)| +Usage +``` +from io.jans.as.server.security import Identity +identity = CdiUtil.bean(Identity) + +#1. +newExpDate = identity.getWorkingParameter("expDate") + +#2. +identity.setWorkingParameter("expDate", expDate) + +#3. +session_attributes = identity.getSessionId().getSessionAttributes() +session_attributes.containsKey("remote_ip") +``` + +### 8. [SessionIdService](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/service/SessionIdService.java) + +``` +#1. get session +sessionIdservice = CdiUtil.bean(SessionIdService).getSessionId() + +#2. update session + +sessionIdservice.getSessionAttributes().put(key, value) +sessionIdservice.updateSessionId(session) +``` + +### 9. [GrantService](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/service/GrantService.java) + +### 10. [ClientService](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/service/ClientService.java) : Provides operations with clients. + +Usage: +``` +from io.jans.as.server.service import ClientService + +clientService = CdiUtil.bean(ClientService) +client = clientService.getClient(clientId) +``` ### 7. HttpService: [HttpService](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/server/src/main/java/io/jans/as/server/service/net/HttpService.java) Provides utility methods to execute HTTP requests, manipulate responses, etc @@ -259,7 +306,7 @@ pwd_decrypted = encryptionService.decrypt("stringtobedecrypted") ``` -14. [Base64Util](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/model/src/main/java/io/jans/as/model/util/Base64Util.java) +### 14. [Base64Util](https://github.com/JanssenProject/jans/blob/main/jans-auth-server/model/src/main/java/io/jans/as/model/util/Base64Util.java) Usage: diff --git a/docs/admin/fido/README.md b/docs/admin/fido/README.md index c530c657b65..d6c628317c0 100644 --- a/docs/admin/fido/README.md +++ b/docs/admin/fido/README.md @@ -24,7 +24,7 @@ https:///.well-known/fido2-configuration Response: - ``` + ``` { "version": "1.1", "issuer": "https://", @@ -39,10 +39,10 @@ Response: "result_enpoint": "https:///jans-fido2/restv1/assertion/result" } } - ``` + ``` ## Customization authentication flow using Interception script - + In the Janssen ecosystem, the authentication flow that comprises of the calls to WebAuthn API and the FIDO server is achieved using an interception script, details of it can be found [here](../../script-catalog/person_authentication/fido2-external-authenticator/README). diff --git a/docs/admin/fido/logs.md b/docs/admin/fido/logs.md index 645cd1c062d..fe169b52acb 100644 --- a/docs/admin/fido/logs.md +++ b/docs/admin/fido/logs.md @@ -61,7 +61,6 @@ Response: ``` - #### 2. Update `loggingLevel` or `loggingLayout`: Steps: A. Create a JSON file say `/tmp/config_values.json` by editing the JSON from Point 1 and @@ -74,6 +73,6 @@ Response: C. restart `jans-fido2` `service fido2 restart` or `systemctl restart fido2` - ### Location of logs in FIDO2 server: +### Location of logs in FIDO2 server: - Logs can be found at `/opt/jans/jetty/jans-fido2/logs` +Logs can be found at `/opt/jans/jetty/jans-fido2/logs`