fix(docs): refresh agama lab quick start guide with respect to the latest Agama Lab version #10426

ossdhaval · 2024-12-16T10:45:07Z

Prepare

Read PR guidelines
Read license information

Description

Target issue

closes #issue-number-here

Implementation Details

Test and Document the changes

Static code analysis has been run locally and issues have been fixed
Relevant unit and integration tests have been added/updated
Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

I confirm that there is no impact on the docs due to the code changes in this PR.

Signed-off-by: ossdhaval <[email protected]>

SafinWasi

Needs changes, lots of links point to private assets.

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

docs/assets/agamalab-flow-passwd-edit-assignment-uid.png

SafinWasi · 2024-12-16T16:43:58Z

docs/assets/agamalab-flow-passwd-edit-cdiutil-instance.png

creds.username and creds.password should be separate arguments, not one argument separated by spaces. This can be done by typing creds.username, hitting Enter, then typing creds.password.

SafinWasi · 2024-12-16T16:53:41Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

+to test this project. 
+
+- [Install Jans Tarp browser plug-in](https://github.com/JanssenProject/jans/tree/main/demos/jans-tarp#installation-in-browser)
+- Follow [these instructions]() to test using the Janssen Server


Still blank link

SafinWasi · 2024-12-16T16:54:34Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

+  ![image](../../../assets/agama-login.png)
+- Upon entering a valid user-name and password, the tarp should present a page
+  with access token. 
+  ![image](../../../assets/successful-tarp-auth-screen.png)


Needs a newline before image, otherwise it breaks the formatting.

Signed-off-by: ossdhaval <[email protected]>

dryrunsecurity · 2024-12-23T03:58:45Z

DryRun Security Summary

There are no code changes or files modified in the provided text, so no summary or review can be generated.

Expand for full summary

Summary:

There are no code changes provided in the input, so I don't have any specific code changes to review or summarize. As an application security engineer, I would typically review any code changes in a pull request to ensure they do not introduce any security vulnerabilities or unintended consequences. Without any code changes to analyze, I don't have any specific security-related observations to provide. However, I'm ready to review any future code changes that may be submitted.

Files Changed:

There are no files changed in the provided input.

Code Analysis

We ran 9 analyzers against 30 files and 0 analyzers had findings. 9 analyzers had no findings.

View PR in the DryRun Dashboard.

Signed-off-by: ossdhaval <[email protected]>

SafinWasi

Some errors are still not fixed.

SafinWasi · 2024-12-27T15:18:27Z

docs/assets/agamalab-flow-passwd-edit-cdiutil-instance.png

The arguments here are still wrong. #10426 (comment)

SafinWasi · 2024-12-27T15:19:44Z

docs/assets/agamalab-flow-passwd-edit-assignment-uid.png

"String type" should be unchecked

SafinWasi · 2024-12-27T15:25:30Z

docs/assets/agamalab-flow-passwd-edit-fail-finish.png

I don't think this is correct. The option selected should be "Flow finished with an error" with a description. Like so:

"Flow finished with a variable" is used when you want to return a predefined variable. "false" is not a variable. Technically Finish false is correct according to Agama syntax, but it is better to use descriptive option

SafinWasi · 2024-12-27T15:30:42Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

+    // Create new CdiUtil object
+    cdiUtil = Call io.jans.service.cdi.uti.CdUtil#bean authService
+    // Empty result object 
+    authResult = "{}"


This is still incorrect

SafinWasi · 2024-12-27T15:30:57Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

+        // Validate username and password 
+        authResult.success = Call cdiUtil#authenticate creds.username creds.password
+        // Keep the username if the user needs to retry authentication 
+        authResult.uid = "creds.username"


Suggested change

authResult.uid = "creds.username"

authResult.uid = creds.username

SafinWasi · 2024-12-27T15:32:49Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

+        authResult.success = Call cdiUtil#authenticate creds.username creds.password
+        // Keep the username if the user needs to retry authentication 
+        authResult.uid = "creds.username"
+        When authResult.uid is true


Suggested change

When authResult.uid is true

When authResult.success is true

SafinWasi · 2024-12-27T15:33:22Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md

+to test this project. 
+
+- [Install Jans Tarp browser plug-in](https://github.com/JanssenProject/jans/tree/main/demos/jans-tarp#installation-in-browser)
+- Follow [these instructions]() to test using the Janssen Server


Still blank link

SafinWasi · 2024-12-27T15:36:33Z

docs/janssen-server/developer/agama/quick-start-using-agama-lab.md


-To use the flow for authentication in the Janssen Server, the flow needs to be released. Agama Lab
-releases the flow and the related artifacts (like template) in the form of a `.gama` file in the GitHub repository.
+At this point we have all the components of an Agama project ready, and they are 


As the screenshot shows, all Agama stuff should be on the main branch to create a release. So there should be instructions added to make a PR from agama-lab-policy-designer branch to default branch.

Signed-off-by: ossdhaval <[email protected]>

ossdhaval added 9 commits November 27, 2024 18:54

docs: update agamalab quick start

cd3205f

Signed-off-by: ossdhaval <[email protected]>

docs: update the agamalab quick start guide

3be01e5

Signed-off-by: ossdhaval <[email protected]>

docs: update agamalab quick start guide

a61f259

Signed-off-by: ossdhaval <[email protected]>

docs: update agama-lab quick start guide

1796008

Signed-off-by: ossdhaval <[email protected]>

docs: update agama-lab quick start guide

882e346

Signed-off-by: ossdhaval <[email protected]>

docs: add tarp test section in quick start guide

2d1822a

Signed-off-by: ossdhaval <[email protected]>

fix(docs): improve wording

4840a60

Signed-off-by: ossdhaval <[email protected]>

refactor(docs): update agama quick start guide

3acdf0e

Signed-off-by: ossdhaval <[email protected]>

fix(docs): agama quick-start guide

c461ff4

Signed-off-by: ossdhaval <[email protected]>

ossdhaval requested review from jgomer2001 and SafinWasi December 16, 2024 10:45

ossdhaval self-assigned this Dec 16, 2024

mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-agama Touching folder /agama comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality labels Dec 16, 2024

SafinWasi requested changes Dec 16, 2024

View reviewed changes

fix(docs): further edits

bbf379c

Signed-off-by: ossdhaval <[email protected]>

moabu force-pushed the docs-quick-start-using-agama-lab branch from 330f0c1 to 8b3fb2c Compare December 26, 2024 19:25

moabu requested review from duttarnab, yurem, yuriyz, yuriyzz, moabu and iromli as code owners December 26, 2024 19:25

moabu force-pushed the main branch from 9cf3510 to 5126af2 Compare December 26, 2024 19:33

moabu force-pushed the docs-quick-start-using-agama-lab branch from 8b3fb2c to bbf379c Compare December 27, 2024 04:55

moabu force-pushed the main branch from 5126af2 to aa1b2ed Compare December 27, 2024 04:55

Merge branch 'main' into docs-quick-start-using-agama-lab

da0050e

ossdhaval added 3 commits December 27, 2024 16:08

fix(docs): minor edits

fa2d33f

Signed-off-by: ossdhaval <[email protected]>

fix(docs): replace private links with public

71b80ea

Signed-off-by: ossdhaval <[email protected]>

fix(docs): update image

c1383bf

Signed-off-by: ossdhaval <[email protected]>

SafinWasi requested changes Dec 27, 2024

View reviewed changes

fix(docs): minor edits

c402bd7

Signed-off-by: ossdhaval <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): refresh agama lab quick start guide with respect to the latest Agama Lab version #10426

fix(docs): refresh agama lab quick start guide with respect to the latest Agama Lab version #10426

ossdhaval commented Dec 16, 2024

SafinWasi left a comment

SafinWasi Dec 16, 2024

SafinWasi Dec 16, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 16, 2024

dryrunsecurity bot commented Dec 23, 2024 •

edited

Loading

SafinWasi left a comment

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

SafinWasi Dec 27, 2024

	authResult.uid = "creds.username"
	authResult.uid = creds.username

fix(docs): refresh agama lab quick start guide with respect to the latest Agama Lab version #10426

Are you sure you want to change the base?

fix(docs): refresh agama lab quick start guide with respect to the latest Agama Lab version #10426

Conversation

ossdhaval commented Dec 16, 2024

Prepare

Description

Target issue

Implementation Details

Test and Document the changes

SafinWasi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dryrunsecurity bot commented Dec 23, 2024 • edited Loading

DryRun Security Summary

Code Analysis

SafinWasi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dryrunsecurity bot commented Dec 23, 2024 •

edited

Loading