-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: docker installation (#3027) * docs: docker installation * docs: add quick-start page * docs: readme.md and compose,md made identical * docs: adjust warning as per github pages syntex * docs: replace docker with docker compose * docs: github page identical to compose page * docs: remove yml file deletion * docs: fix * docs: fix helm chart url * build(deps): bump zeebe-io/backport-action from 0.0.8 to 0.0.9 (#3060) Bumps [zeebe-io/backport-action](https://github.com/zeebe-io/backport-action) from 0.0.8 to 0.0.9. - [Release notes](https://github.com/zeebe-io/backport-action/releases) - [Commits](korthout/backport-action@v0.0.8...v0.0.9) --- updated-dependencies: - dependency-name: zeebe-io/backport-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * docs: improve vm install instructions (#3091) * docs: add sha check instructions for rhel * docs: add sha check instructions for suse * docs: formating and proofreading of install docs (#3092) * feat: add custom annotation for configuration property and feature flag documentation (#2852) * feat: add custom annotation for prop documentation * feat: add annotation processor * feat: annotate properties * feat: configure annotation processor * feat: add default value * feat: add annotation to enum * feat: add comment * feat: rename annotation * feat: rename processor class * feat: refactor to new core module * feat: fix test class errors * feat: rename the module * feat: add table and details view of content * feat: sort properties * feat: change wording - mandatory to required * feat: add exception handling and logging * feat: write file under classes output dir * feat: create output file under target directory * feat: rename property and file * feat: create separate annotation for feature flags * feat: code cleanup * fix: add description to properties * fix: add property descriptions from Gluu docs * fix: add descriptions from Swagger * fix(fido2): annotate fido config properties * feat(scim): configure property documentation annotations * fix: add module name to file and title * fix: add Feature Flag descriptions * fix: integrate doc generation with CI * fix: add tags to generated docs * fix: create separate sections for properties and flags * fix: update the artifact version for jans-doc * fix: contents of markdown files after merge * ci: remove token req * fix: sonar issues * fix: sonar issues * fix: sonar issues * fix: move doc generation to shell script Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com> * ci: use hotspath-storage in quickstart script * doc: remove redundant API details sections (#3093) * feat(jans-auth-server): specify minimum acr for clients #343 (#3083) * feat(jans-auth-server): specify minimum acr for clients #343 * feat(jans-auth-server): added minimum acr properties to dynamic registration #343 * doc(jans-auth-server): added docs and updated swagger with new minimum acr related properties #343 * docs: add kuberentes planning guide initial points * docs: add kuberentes planning guide initial points * Update certificates.md (#3096) * docs: scim logs Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Amro Misbah <amromisba7@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Dhaval D <343411+ossdhaval@users.noreply.github.com> Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com> Co-authored-by: YuriyZ <yzabrovarniy@gmail.com> Co-authored-by: mzico <mohib@gluu.org>
- Loading branch information
7 people
authored
Nov 28, 2022
1 parent
2e659ed
commit f787ba1
Showing
52 changed files
with
2,003 additions
and
141 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| #!/bin/bash | ||
| set -euo pipefail | ||
|
|
||
| echo "Generate properties and feature flag documents from elements annotated with @DocFeatureFlag and @DocProperty" | ||
|
|
||
| # Compile jans-core to pick-up any changes in annotation processors | ||
| mvn -q -f jans-core/pom.xml -DskipTests clean compile install | ||
|
|
||
| # Compile modules where classes that use these annotations exist. | ||
| # This will generate markdown files under target/classes directory | ||
| mvn -q -f jans-auth-server/pom.xml clean compile | ||
| mvn -q -f jans-fido2/pom.xml clean compile | ||
| mvn -q -f jans-scim/pom.xml clean compile | ||
|
|
||
| # Move markdown files to appropriate locations under documentation root 'doc' | ||
| mv -f jans-auth-server/model/target/classes/janssenauthserver-properties.md docs/admin/reference/json/properties | ||
| mv -f jans-auth-server/model/target/classes/janssenauthserver-feature-flags.md docs/admin/reference/json/feature-flags | ||
| mv -f jans-fido2/model/target/classes/fido2-properties.md docs/admin/reference/json/properties | ||
| mv -f jans-scim/model/target/classes/scim-properties.md docs/admin/reference/json/properties |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
docs/admin/auth-server/client-management/configuration/client-config.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| tags: | ||
| - administration | ||
| - client | ||
| - configuration | ||
| --- | ||
|
|
||
| # Client Configuration | ||
|
|
||
| ## ACR client configuration | ||
|
|
||
| There are 4 client configuration properties related to ACR: | ||
|
|
||
| - `default_acr_values` - string array, default acr values which are set when `acr_values` is missed in authorization request. | ||
| - `minimumAcrLevel` - integer value which sets minimum acr level. | ||
| - `minimumAcrLevelAutoresolve` - boolean value, if `false` and `minimumAcrLevel` is higher then current `acr_values` then reject request. If `true` - resolve acr according to either client's `minimumAcrPriorityList` or AS `auth_level_mapping` | ||
| - `minimumAcrPriorityList` - string array, enables client to specify the acr order of preference, rather then just the next lowest integer value | ||
|
|
||
| AS process properties in following order: | ||
| 1. if `acr_values` is absent, set `acr_values` from `default_acr_values` | ||
| 2. Otherwise if present, checking minimum acr level: | ||
| - check `minimumAcrLevel`, if current acr level is higher or equals to `minimumAcrLevel` then proceed request processing without changes | ||
| - if `minimumAcrLevel` is less then current acr level and `minimumAcrLevelAutoresolve=false` -> reject request (return bad request error) | ||
| - if `minimumAcrLevel` is less then current acr level and `minimumAcrLevelAutoresolve=true` -> pickup value from `minimumAcrPriorityList` or if it's empty take nearest acr value that satisfy `minimumAcrLevel` | ||
|
|
||
| For example, given: | ||
| 1. `minimumAcrLevel` = 14 | ||
| 1. `default_acr_values` = "basic" | ||
| 1. `minimumAcrPriorityList` = ["u2f", "passkey", "usb_fido_key", "super_gluu"] | ||
| 1. OP `auth_level_mapping` : | ||
| ``` | ||
| "auth_level_mapping": { | ||
| "1": ["basic"], | ||
| "5": ["otp"], | ||
| "10": ["u2f"], | ||
| "11": ["super_gluu"], | ||
| "20": ["passkey"], | ||
| "30": ["usb_fido_key"] | ||
| } | ||
| ``` | ||
|
|
||
| - if current `acr_values=u2f` and `minimumAcrLevelAutoresolve=false` -> request is rejected | ||
| - if current `acr_values=u2f` and `minimumAcrLevelAutoresolve=true` -> `acr_values` set to `acr_values=passkey` and request continue processing | ||
| - if current `acr_values=usb_fido_key` -> current acr is higher then minimum. Thus nothing to do. | ||
|
|
||
| If `minimumAcrPriorityList` is missing, then the AS can pick the next highest acr in the `auth_level_mapping`. In the example above, that would be `passkey`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| --- | ||
| tags: | ||
| - administration | ||
| - installation | ||
| - quick-start | ||
| - docker compose | ||
| --- | ||
|
|
||
| !!! Warning | ||
| **This image is for testing and development purposes only. Use Janssen [helm charts](https://github.com/JanssenProject/jans/tree/main/charts/janssen) for production setups.** | ||
|
|
||
| ## Overview | ||
|
|
||
| Docker monolith image packaging for Janssen. This image packs janssen services including the auth-server, config-api, fido2, and scim. | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| - [Docker](https://docs.docker.com/install) | ||
| - [Docker compose](https://docs.docker.com/compose/install/) | ||
|
|
||
|
|
||
| ## Environment Variables | ||
|
|
||
| Installation depends on the set of environment variables shown below. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values. | ||
|
|
||
| | ENV | Description | Default | | ||
| |-------------------------|--------------------------------------------------|--------------------------------------------------| | ||
| | `CN_HOSTNAME` | Hostname to install janssen with. | `demoexample.jans.io` | | ||
| | `CN_ADMIN_PASS` | Password of the admin user. | `1t5Fin3#security` | | ||
| | `CN_ORG_NAME` | Organization name. Used for ssl cert generation. | `Janssen` | | ||
| | `CN_EMAIL` | Email. Used for ssl cert generation. | `support@jans.io` | | ||
| | `CN_CITY` | City. Used for ssl cert generation. | `Austin` | | ||
| | `CN_STATE` | State. Used for ssl cert generation | `TX` | | ||
| | `CN_COUNTRY` | Country. Used for ssl cert generation. | `US` | | ||
| | `CN_INSTALL_LDAP` | **NOT SUPPORRTED YET** | `false` | | ||
| | `CN_INSTALL_CONFIG_API` | Installs the Config API service. | `true` | | ||
| | `CN_INSTALL_SCIM` | Installs the SCIM API service. | `true` | | ||
| | `CN_INSTALL_FIDO2` | Installs the FIDO2 API service. | `true` | | ||
| | `MYSQL_DATABASE` | MySQL jans database. | `jans` | | ||
| | `MYSQL_USER` | MySQL database user. | `jans` | | ||
| | `MYSQL_PASSWORD` | MySQL database user password. | `1t5Fin3#security` | | ||
| | `MYSQL_HOST` | MySQL host. | `mysql` which is the docker compose service name | | ||
|
|
||
|
|
||
| ## How to run | ||
|
|
||
| Download the compose file | ||
|
|
||
| ```bash | ||
|
|
||
| wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml | ||
| ``` | ||
|
|
||
| This docker compose file runs two containers, the janssen monolith container and mysql container. | ||
|
|
||
| ```bash | ||
| docker compose -f jans-mysql-compose.yml up -d | ||
| ``` | ||
|
|
||
| To view the containers running | ||
|
|
||
| ```bash | ||
|
|
||
| docker compose -f jans-mysql-compose.yml ps | ||
| ``` | ||
|
|
||
| ## Configure Janssen Server | ||
|
|
||
| ```bash | ||
|
|
||
| docker compose -f jans-mysql-compose.yml exec jans sh #This opens a bash terminal in the running container | ||
|
|
||
| /opt/jans/jans-cli/config-cli.py #configure using the config-cli | ||
|
|
||
| /opt/jans/jans-cli/scim-cli.py #configure using the scim-cli | ||
| ``` | ||
|
|
||
| ## Access endpoints externally | ||
|
|
||
| Add to your `/etc/hosts` file the ip domain record which should be the ip of the instance docker is installed at and the domain used in the env above `CN_HOSTNAME`. | ||
|
|
||
| ```bash | ||
| # For-example | ||
| 172.22.0.3 demoexample.jans.io | ||
| ``` | ||
|
|
||
| After adding the record you can hit endpoints such as https://demoexample.jans.io/.well-known/openid-configuration | ||
|
|
||
| ## Clean up | ||
|
|
||
| Remove setup and volumes | ||
|
|
||
| ``` | ||
| docker compose -f jans-mysql-compose.yml down | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.