Skip to content

Conversation

@misba7
Copy link
Contributor

@misba7 misba7 commented Sep 8, 2023

Prepare


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)

Closes #5985,

@mo-auto
Copy link
Member

mo-auto commented Sep 8, 2023

Error: Hi @misba7, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-jans-config-api Component affected by issue or PR labels Sep 8, 2023
@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 8, 2023

[jans-config-api-parent] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

warning The version of Java (11.0.20.1) you have used to run this analysis is deprecated and we will stop accepting it soon. Please update to at least Java 17.
Read more here

yuriyz
yuriyz previously approved these changes Sep 8, 2023
Below is an illustration of the Janssen Server's default FIDO2 login page:

![fido2](https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/docs/assets/image_fido2.png)
![fido2](../../../assets/image_fido2.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave as is. The assets are generated.

A user's FIDO2 devices can be removed by a Janssen administrator in LDAP under the user entry as shown in the below screenshot.

![fido2](https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/docs/assets/image-fido2-ldap-structure.png)
![fido2](../../../assets/image-fido2-ldap-structure.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leave as is. The assets are generated

Signed-off-by: Amro Misbah <amromisba7@gmail.com>
Signed-off-by: Amro Misbah <amromisba7@gmail.com>

This document explains how to use the Janssen Auth Server's built-in
[FIDO2 interception script](https://github.com/JanssenProject/jans/blob/vreplace-janssen-version/jans-linux-setup/jans_setup/static/extension/person_authentication/Fido2ExternalAuthenticator.py)
[FIDO2 interception script](https://github.com/JanssenProject/jans/blob/v1.0.16/docs/script-catalog/person_authentication/fido2-external-authenticator/Fido2ExternalAuthenticator.py)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You will break the auto doc generator and the docs will be outdated. Please do not remove the special keywords like vreplace-janssen-version with any specific version in head. This goes for there other locations in which this has occurred

Signed-off-by: Amro Misbah <amromisba7@gmail.com>

![fido2](https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/docs/assets/image_fido2.png)

The design is being rendered from the [FIDO2 xhtml page](https://github.com/JanssenProject/jans/blob/vreplace-janssen-version/jans-auth-server/server/src/main/webapp/auth/fido2/login.xhtml). To customize the look and feel of this page, follow the [customization guide](https://jans.io/docs/admin/developer/customization/customize-web-pages/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use vreplace-janssen-version instead of head


- **K8s:**
1. client_id: `kubectl get cm cn -n <namespace> -o yaml | grep test_client_id`
1. client_id: `kubectl get cm cn -n <namespace> --template={{.data.jca_client_id}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can now use the test_client_id as thats working. You can add the jca as a fallback

@moabu moabu merged commit 8b0cbfb into main Oct 18, 2023
@moabu moabu deleted the docs-fixes branch October 18, 2023 09:53
devrimyatar pushed a commit that referenced this pull request Dec 30, 2023
* docs: fixes

* docs: fixes

Signed-off-by: Amro Misbah <amromisba7@gmail.com>

* docs: fix urls

Signed-off-by: Amro Misbah <amromisba7@gmail.com>

* docs: terraform fixes

Signed-off-by: Amro Misbah <amromisba7@gmail.com>

* docs: add vreplace-janssen-version

Signed-off-by: Amro Misbah <amromisba7@gmail.com>

* docs: change to test client and change head

---------

Signed-off-by: Amro Misbah <amromisba7@gmail.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-documentation Documentation needs to change as part of issue or PR comp-jans-config-api Component affected by issue or PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: docs: fixes -autocreated

4 participants