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

Update janssenauthserver-feature-flags.md #9592

Open
wants to merge 4,336 commits into
base: main
Choose a base branch
from
Open

Update janssenauthserver-feature-flags.md #9592

wants to merge 4,336 commits into from

Conversation

mzico
Copy link
Contributor

@mzico mzico commented Sep 25, 2024

Adding how to access "Feature Flag" property

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)

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.

yuriyz and others added 30 commits July 1, 2024 12:43
…BMS #8825 (#8826)

#8825

Signed-off-by: YuriyZ <yzabrovarniy@gmail.com>
* feat: ui improvement and fido authentication integration #5962

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: adding loader

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: fix loading issue

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: fixing logout

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: fixing logout

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: adding docs

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: adding docs

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: adding docs

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: remove extra OP_config call

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: modify README

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: modify README

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

* feat: changing ReadMe

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>

---------

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
* chore(docker-jans-auth-server): sync jans-lock assets

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* feat(cloud-native): add Token Status List support

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* chore(cloud-native): sync assets to OCI images

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* feat(docker-jans-saml): update kc-saml integration installation

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* fix: migrate jans storage

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* chore: remove unused client

Signed-off-by: iromli <isman.firmansyah@gmail.com>

---------

Signed-off-by: iromli <isman.firmansyah@gmail.com>
* docs: update fido2 configuration document

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* fido2 : add schema format and example

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs: update file names

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs: remove old files

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(fido2): update the instructions for update conf section

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(fido2): proofreading

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

---------

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Co-authored-by: Devrim <devrimyatar@gluu.org>
* docs: update JWKS conf

* jwks : add schema format and example

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(jwks): add schema format and example

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(jwk): Add tui section and add schema

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(jwks): fix update instructions

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

* docs(jwk): rephrase and proofread

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>

---------

Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Co-authored-by: Devrim <devrimyatar@gluu.org>
Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
…8857)

* feat(cloud-native): add ingress for jans-lock as jans-auth service

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* fix(docker-jans-all-in-one): remove unused KC_PROXY env

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* docs(charts): add ingress for jans-lock config

Signed-off-by: iromli <isman.firmansyah@gmail.com>

---------

Signed-off-by: iromli <isman.firmansyah@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
* chore(docker-jans-saml): sync asset for OCI image

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* chore(all-in-one): update JANS_SOURCE_VERSION

Signed-off-by: iromli <isman.firmansyah@gmail.com>

---------

Signed-off-by: iromli <isman.firmansyah@gmail.com>
Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
#8863 (#8865)

* fix(jans-linux-setup): improper scim configuration for jans kc #8210
* updated the keycloak configuration file to reflect the  configuration for the storage-spi

Signed-off-by: Rolain Djeumen <uprightech@gmail.com>

* chore(jans-keycloak-integration): bump kc version to 24.0.0 #8315

Signed-off-by: Rolain Djeumen <uprightech@gmail.com>

* feat(jans-keycloak-integration): disable keycloak required action verify_profile #8863

Signed-off-by: Rolain Djeumen <uprightech@gmail.com>

---------

Signed-off-by: Rolain Djeumen <uprightech@gmail.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
)

Signed-off-by: Mustafa Baser <mbaser@mail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
Signed-off-by: Yuriy Movchan <Yuriy.Movchan@gmail.com>
Co-authored-by: YuriyZ <yzabrovarniy@gmail.com>
Co-authored-by: Yuriy M <95305560+yuremm@users.noreply.github.com>
* feat(cloud-native): disable keycloak verify_profile action

Signed-off-by: iromli <isman.firmansyah@gmail.com>

* chore(cloud-native): update JANS_SOURCE_VERSION for aio

Signed-off-by: iromli <isman.firmansyah@gmail.com>

---------

Signed-off-by: iromli <isman.firmansyah@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
fix(cloud-native): pre-populate providerId in userstorage config

Signed-off-by: iromli <isman.firmansyah@gmail.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
* chore: 1.1.3-SNAPSHOT to 1.1.3

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

* chore: modify image tags

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

* chore: add 1.1.3 to version list in readme

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

* docs: lock configuration schema declaration (#8862)

doc: lock config documentation

Signed-off-by: pujavs <pujas.works@gmail.com>

* chore: update Dockerfile

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

* chore: update prereelase chart flag

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

---------

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
Signed-off-by: pujavs <pujas.works@gmail.com>
Co-authored-by: pujavs <43700552+pujavs@users.noreply.github.com>
* docs: auto-generated property docs

* docs: auto-generated Swagger SPEC docs
* chore: release 1.1.4 SNAPSHOT

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

* fix: add conditionals on running tests

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

---------

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
)

* feat(jans-auth-server): added jti and client_id to userinfo #8763

Signed-off-by: YuriyZ <yzabrovarniy@gmail.com>

* docs(jans-auth-server): added jti and client_id to userinfo #8763

Signed-off-by: YuriyZ <yzabrovarniy@gmail.com>

---------

Signed-off-by: YuriyZ <yzabrovarniy@gmail.com>
…8819)

* feat(jans-lock): Implemented token2entiy mapper, crypto module, correct LockMaster config handling, Restructured codebase

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* chore(jans-lock): Added documentation via README.md, fixed token registration endpoint

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* chore(jans-lock): Expanded documentation a bit

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* chore(jans-lock): fixed typo

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* docs(jans-lock): Updated readme, further developments on token2entity

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* feat(jans-lock): Use  claim from SSA_JWT in Dynamic Client Registration

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* chore(jans-lock): Clean local tree

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* docs(jans-lock): Added instructions for Web builds

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* chore(jans-lock): Separated out SSE into module

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* feat(jans-lock): Initial cedarling SSE status list update support

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

* docs(jans-lock): Added special instructions for cedarling usage on the Web

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>

---------

Signed-off-by: sokorototo <nyachiengatoto@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
* feat: enable missing services in docker monolith

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

* ci: fix missing FQDN parse

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>

---------

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
ci: fix override on runnign tests and registered FQDN

Signed-off-by: moabu <47318409+moabu@users.noreply.github.com>
jgomer2001 and others added 10 commits September 23, 2024 15:47
fix: update jansExtUid regardless of skipProfileUpdate value #9558

Signed-off-by: jgomer2001 <bonustrack310@gmail.com>
chore: remove id_token_hint from logout url #9562

Signed-off-by: jgomer2001 <bonustrack310@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
feat(jans-lock): rename Lock Master to Lock Server #9572

Signed-off-by: Yuriy Movchan <Yuriy.Movchan@gmail.com>
… (#9574)

Signed-off-by: shekhar16 <shekharlaad1609@gmail.com>
Co-authored-by: Devrim <devrimyatar@gluu.org>
…presence #9559 (#9580)

Signed-off-by: YuriyZ <yzabrovarniy@gmail.com>
…9571)

* feat(jans-orm): add CB cluster option waitUntilReady support

Signed-off-by: Yuriy Movchan <Yuriy.Movchan@gmail.com>

* feat(jans-orm): add CB cluster option waitUntilReady support

Signed-off-by: Yuriy Movchan <Yuriy.Movchan@gmail.com>

---------

Signed-off-by: Yuriy Movchan <Yuriy.Movchan@gmail.com>
fix:changes in passkey script

Signed-off-by: Arnab Dutta <arnab.bdutta@gmail.com>
chore: update labels #9544

Signed-off-by: jgomer2001 <bonustrack310@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
* feat(jans-cedarling): add PolicyStore and field schema. Also added decoding from json.

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* test(jans-cedarling): add unit tests to check `parse_cedar_schema` (deserialize cedar schema from json)

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* docs(jans-cedarling): add docs for PolicyStore

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* feat(jans-cedarling): add loading policy store based on config

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* feat(jans-cedarling): add loading policy store to Cedarling

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): rename LogType to LogTypeConfig

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): fix `log_init` example after updating config

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): add allow(dead_code) on schema

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): add copyright notice

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* docs(jans-cedarling): add README to init module

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* docs(jans-cedarling): add README to authz module

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): update message in ErrorLoadPolicyStore::MoreThanOnePolicy

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): add comments to Cedarling::new

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): remove unnecessary code

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* docs(jans-cedarling):  in README removed `Cedarling bindings` section

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): move position of PolicyStoreMap to be first

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

* chore(jans-cedarling): refactor, move errors messages to the enum

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>

---------

Signed-off-by: Oleh Bohzok <olehbozhok@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
Adding how to access "Feature Flag" property

Signed-off-by: mzico <mohib@gluu.org>
@mzico mzico requested a review from ossdhaval September 25, 2024 14:13
Copy link

DryRun Security Summary

The pull request updates the documentation for the Janssen Auth Server's feature flags, including instructions on accessing them in the Thin User Interface (TUI) and descriptions of security-critical functionalities such as CIBA, device authorization, token introspection, token revocation, and UMA.

Expand for full summary

Summary:

The code change in this pull request appears to be an update to the documentation for the Janssen Auth Server's feature flags. The changes include the addition of a new section that provides instructions on how to access the feature flags within the Thin User Interface (TUI) of the auth server. From an application security perspective, the feature flags described in this documentation are particularly interesting as they provide a way to enable or disable various security-related functionalities of the auth server, such as support for the OpenID Connect Client Initiated Backchannel Authentication Flow (CIBA), device authorization, token introspection, token revocation, and User-Managed Access (UMA). It's important to ensure that these feature flags are properly configured and managed to maintain the overall security of the auth server and the applications that rely on it.

Files Changed:

  • docs/admin/reference/json/feature-flags/janssenauthserver-feature-flags.md: This file has been updated to include a new section that provides instructions on how to access the feature flags within the Thin User Interface (TUI) of the Janssen Auth Server. The documentation also describes several notable feature flags that are related to security-critical functionalities, such as CIBA, device authorization, token introspection, token revocation, and UMA. Developers and security engineers should review the feature flags and their descriptions to understand the security implications of enabling or disabling each one.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs labels Sep 25, 2024
mo-auto
mo-auto previously approved these changes Sep 25, 2024
@mo-auto mo-auto enabled auto-merge (squash) September 25, 2024 14:20
Copy link
Contributor

@ossdhaval ossdhaval left a comment

Choose a reason for hiding this comment

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

Hi @mzico

This file is auto-generated. So all edits to this file will be lost in the next cycle.

If you want to add this content add it via code at this location

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-docs Touching folder /docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.