diff options
| -rw-r--r-- | Dockerfile | 4 | ||||
| -rw-r--r-- | docker-compose.yml | 4 | ||||
| -rwxr-xr-x | releases/virtualbox/start-wekan.sh | 4 | ||||
| -rw-r--r-- | server/authentication.js | 4 | ||||
| -rwxr-xr-x | snap-src/bin/config | 10 | ||||
| -rwxr-xr-x | snap-src/bin/wekan-help | 28 | ||||
| -rw-r--r-- | start-wekan.bat | 5 | ||||
| -rwxr-xr-x | start-wekan.sh | 6 |
8 files changed, 53 insertions, 12 deletions
@@ -30,6 +30,8 @@ ARG OAUTH2_ID_MAP ARG OAUTH2_USERNAME_MAP ARG OAUTH2_FULLNAME_MAP ARG OAUTH2_EMAIL_MAP +ARG OAUTH2_ID_TOKEN_WHITELIST_FIELDS +ARG OAUTH2_REQUEST_PERMISSIONS ARG LDAP_ENABLE ARG LDAP_PORT ARG LDAP_HOST @@ -109,6 +111,8 @@ ENV BUILD_DEPS="apt-utils bsdtar gnupg gosu wget curl bzip2 build-essential pyth OAUTH2_USERNAME_MAP="" \ OAUTH2_FULLNAME_MAP="" \ OAUTH2_EMAIL_MAP="" \ + OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[] \ + OAUTH2_REQUEST_PERMISSIONS=[openid] \ LDAP_ENABLE=false \ LDAP_PORT=389 \ LDAP_HOST="" \ diff --git a/docker-compose.yml b/docker-compose.yml index 7a1f7b87..a9f11569 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -311,6 +311,10 @@ services: #- OAUTH2_FULLNAME_MAP= # OAuth2 Email Mapping #- OAUTH2_EMAIL_MAP= + # OAUTH2 ID Token Whitelist Fields. + #- OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[] + # OAUTH2 Request Permissions. + #- OAUTH2_REQUEST_PERMISSIONS=[openid email profile] #----------------------------------------------------------------- # ==== LDAP ==== # https://github.com/wekan/wekan/wiki/LDAP diff --git a/releases/virtualbox/start-wekan.sh b/releases/virtualbox/start-wekan.sh index 31d4df58..d8ac716e 100755 --- a/releases/virtualbox/start-wekan.sh +++ b/releases/virtualbox/start-wekan.sh @@ -114,6 +114,10 @@ #export OAUTH2_FULLNAME_MAP= # OAuth2 Email Mapping #export OAUTH2_EMAIL_MAP= + # OAUTH2 ID Token Whitelist Fields. + #export OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[] + # OAUTH2 Request Permissions. + #export OAUTH2_REQUEST_PERMISSIONS=[openid profile email] #--------------------------------------------- # LDAP_ENABLE : Enable or not the connection by the LDAP # example : export LDAP_ENABLE=true diff --git a/server/authentication.js b/server/authentication.js index 4d3cc53e..76ab6cf1 100644 --- a/server/authentication.js +++ b/server/authentication.js @@ -76,8 +76,8 @@ Meteor.startup(() => { authorizationEndpoint: process.env.OAUTH2_AUTH_ENDPOINT, userinfoEndpoint: process.env.OAUTH2_USERINFO_ENDPOINT, tokenEndpoint: process.env.OAUTH2_TOKEN_ENDPOINT, - idTokenWhitelistFields: [], - requestPermissions: ['openid'], + idTokenWhitelistFields: process.env.OAUTH2_ID_TOKEN_WHITELIST_FIELDS || [], + requestPermissions: process.OAUTH2_REQUEST_PERMISSIONS || ['openid'], }, } ); diff --git a/snap-src/bin/config b/snap-src/bin/config index 31605b2f..e674afa0 100755 --- a/snap-src/bin/config +++ b/snap-src/bin/config @@ -3,7 +3,7 @@ # All supported keys are defined here together with descriptions and default values # list of supported keys -keys="DEBUG MONGODB_BIND_UNIX_SOCKET MONGODB_BIND_IP MONGODB_PORT MAIL_URL MAIL_FROM ROOT_URL PORT DISABLE_MONGODB CADDY_ENABLED CADDY_BIND_PORT WITH_API CORS MATOMO_ADDRESS MATOMO_SITE_ID MATOMO_DO_NOT_TRACK MATOMO_WITH_USERNAME BROWSER_POLICY_ENABLED TRUSTED_URL WEBHOOKS_ATTRIBUTES OAUTH2_ENABLED OAUTH2_CLIENT_ID OAUTH2_SECRET OAUTH2_SERVER_URL OAUTH2_AUTH_ENDPOINT OAUTH2_USERINFO_ENDPOINT OAUTH2_TOKEN_ENDPOINT OAUTH2_ID_MAP OAUTH2_USERNAME_MAP OAUTH2_FULLNAME_MAP OAUTH2_EMAIL_MAP LDAP_ENABLE LDAP_PORT LDAP_HOST LDAP_BASEDN LDAP_LOGIN_FALLBACK LDAP_RECONNECT LDAP_TIMEOUT LDAP_IDLE_TIMEOUT LDAP_CONNECT_TIMEOUT LDAP_AUTHENTIFICATION LDAP_AUTHENTIFICATION_USERDN LDAP_AUTHENTIFICATION_PASSWORD LDAP_LOG_ENABLED LDAP_BACKGROUND_SYNC LDAP_BACKGROUND_SYNC_INTERVAL LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS LDAP_ENCRYPTION LDAP_CA_CERT LDAP_REJECT_UNAUTHORIZED LDAP_USER_SEARCH_FILTER LDAP_USER_SEARCH_SCOPE LDAP_USER_SEARCH_FIELD LDAP_SEARCH_PAGE_SIZE LDAP_SEARCH_SIZE_LIMIT LDAP_GROUP_FILTER_ENABLE LDAP_GROUP_FILTER_OBJECTCLASS LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT LDAP_GROUP_FILTER_GROUP_NAME LDAP_UNIQUE_IDENTIFIER_FIELD LDAP_UTF8_NAMES_SLUGIFY LDAP_USERNAME_FIELD LDAP_FULLNAME_FIELD LDAP_MERGE_EXISTING_USERS LDAP_SYNC_USER_DATA LDAP_SYNC_USER_DATA_FIELDMAP LDAP_SYNC_GROUP_ROLES LDAP_DEFAULT_DOMAIN LOGOUT_WITH_TIMER LOGOUT_IN LOGOUT_ON_HOURS LOGOUT_ON_MINUTES DEFAULT_AUTHENTICATION_METHOD" +keys="DEBUG MONGODB_BIND_UNIX_SOCKET MONGODB_BIND_IP MONGODB_PORT MAIL_URL MAIL_FROM ROOT_URL PORT DISABLE_MONGODB CADDY_ENABLED CADDY_BIND_PORT WITH_API CORS MATOMO_ADDRESS MATOMO_SITE_ID MATOMO_DO_NOT_TRACK MATOMO_WITH_USERNAME BROWSER_POLICY_ENABLED TRUSTED_URL WEBHOOKS_ATTRIBUTES OAUTH2_ENABLED OAUTH2_CLIENT_ID OAUTH2_SECRET OAUTH2_SERVER_URL OAUTH2_AUTH_ENDPOINT OAUTH2_USERINFO_ENDPOINT OAUTH2_TOKEN_ENDPOINT OAUTH2_ID_MAP OAUTH2_USERNAME_MAP OAUTH2_FULLNAME_MAP OAUTH2_EMAIL_MAP OAUTH2_ID_TOKEN_WHITELIST_FIELDS OAUTH2_REQUEST_PERMISSIONS LDAP_ENABLE LDAP_PORT LDAP_HOST LDAP_BASEDN LDAP_LOGIN_FALLBACK LDAP_RECONNECT LDAP_TIMEOUT LDAP_IDLE_TIMEOUT LDAP_CONNECT_TIMEOUT LDAP_AUTHENTIFICATION LDAP_AUTHENTIFICATION_USERDN LDAP_AUTHENTIFICATION_PASSWORD LDAP_LOG_ENABLED LDAP_BACKGROUND_SYNC LDAP_BACKGROUND_SYNC_INTERVAL LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS LDAP_ENCRYPTION LDAP_CA_CERT LDAP_REJECT_UNAUTHORIZED LDAP_USER_SEARCH_FILTER LDAP_USER_SEARCH_SCOPE LDAP_USER_SEARCH_FIELD LDAP_SEARCH_PAGE_SIZE LDAP_SEARCH_SIZE_LIMIT LDAP_GROUP_FILTER_ENABLE LDAP_GROUP_FILTER_OBJECTCLASS LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT LDAP_GROUP_FILTER_GROUP_NAME LDAP_UNIQUE_IDENTIFIER_FIELD LDAP_UTF8_NAMES_SLUGIFY LDAP_USERNAME_FIELD LDAP_FULLNAME_FIELD LDAP_MERGE_EXISTING_USERS LDAP_SYNC_USER_DATA LDAP_SYNC_USER_DATA_FIELDMAP LDAP_SYNC_GROUP_ROLES LDAP_DEFAULT_DOMAIN LOGOUT_WITH_TIMER LOGOUT_IN LOGOUT_ON_HOURS LOGOUT_ON_MINUTES DEFAULT_AUTHENTICATION_METHOD" # default values DESCRIPTION_DEBUG="Debug OIDC OAuth2 etc. Example: sudo snap set wekan debug='true'" @@ -138,6 +138,14 @@ DESCRIPTION_OAUTH2_EMAIL_MAP="OAuth2 Email Mapping. Example: email" DEFAULT_OAUTH2_EMAIL_MAP="" KEY_OAUTH2_EMAIL_MAP="oauth2-email-map" +DESCRIPTION_OAUTH2_ID_TOKEN_WHITELIST_FIELDS="OAuth2 ID Token Whitelist Fields. Example: []" +DEFAULT_OAUTH2_ID_TOKEN_WHITELIST_FIELDS="" +KEY_OAUTH2_ID_TOKEN_WHITELIST_FIELDS="oauth2-id-token-whitelist-fields" + +DESCRIPTION_OAUTH2_REQUEST_PERMISSIONS="OAuth2 Request Permissions. Example: [openid profile email]" +DEFAULT_OAUTH2_REQUEST_PERMISSIONS="" +KEY_OAUTH2_REQUEST_PERMISSIONS="oauth2-request-permissions" + DESCRIPTION_LDAP_ENABLE="Enable or not the connection by the LDAP" DEFAULT_LDAP_ENABLE="false" KEY_LDAP_ENABLE="ldap-enable" diff --git a/snap-src/bin/wekan-help b/snap-src/bin/wekan-help index 431be029..80cbc7ad 100755 --- a/snap-src/bin/wekan-help +++ b/snap-src/bin/wekan-help @@ -102,29 +102,41 @@ echo -e "\t-Disable the OAuth2 Token Endpoint of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-token-endpoint=''" echo -e "\n" echo -e "OAuth2 ID Mapping." -echo -e "To enable the ID Mapping of Wekan:" +echo -e "To enable the OAuth2 ID Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-id-map='username.uid'" -echo -e "\t-Disable the ID Mapping of Wekan:" +echo -e "\t-Disable the OAuth2 ID Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-id-map=''" echo -e "\n" echo -e "OAuth2 Username Mapping." -echo -e "To enable the Username Mapping of Wekan:" +echo -e "To enable the OAuth2 Username Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-username-map='username'" -echo -e "\t-Disable the Username Mapping of Wekan:" +echo -e "\t-Disable the OAuth2 Username Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-username-map=''" echo -e "\n" echo -e "OAuth2 Fullname Mapping." -echo -e "To enable the Fullname Mapping of Wekan:" +echo -e "To enable the OAuth2 Fullname Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-fullname-map='fullname'" -echo -e "\t-Disable the Fullname Mapping of Wekan:" +echo -e "\t-Disable the OAuth2 Fullname Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-fullname-map=''" echo -e "\n" echo -e "OAuth2 Email Mapping." -echo -e "To enable the Email Mapping of Wekan:" +echo -e "To enable the OAuth2 Email Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-email-map='email'" -echo -e "\t-Disable the Email Mapping of Wekan:" +echo -e "\t-Disable the OAuth2 Email Mapping of Wekan:" echo -e "\t$ snap set $SNAP_NAME oauth2-email-map=''" echo -e "\n" +echo -e "OAuth2 ID Token Whitelist Fields." +echo -e "To enable the OAuth2 ID Token Whitelist Fields of Wekan:" +echo -e "\t$ snap set $SNAP_NAME oauth2-id-token-whitelist-fields='[]'" +echo -e "\t-Disable the OAuth2 ID Token Whitelist Fields of Wekan:" +echo -e "\t$ snap set $SNAP_NAME oauth2-id-token-whitelist-fields=''" +echo -e "\n" +echo -e "OAuth2 Request Permissions." +echo -e "To enable the OAuth2 Request Permissions of Wekan:" +echo -e "\t$ snap set $SNAP_NAME oauth2-request-permissions='[openid profile email]'" +echo -e "\t-Disable the OAuth2 Request Permissions of Wekan:" +echo -e "\t$ snap set $SNAP_NAME oauth2-request-permissions=''" +echo -e "\n" echo -e "Ldap Enable." echo -e "To enable the ldap of Wekan:" echo -e "\t$ snap set $SNAP_NAME ldap-enable='true'" diff --git a/start-wekan.bat b/start-wekan.bat index 02e9258e..9d6305b6 100644 --- a/start-wekan.bat +++ b/start-wekan.bat @@ -74,6 +74,11 @@ REM # OAuth2 Token Endpoint. Example: /oauth/token REM # example: OAUTH2_TOKEN_ENDPOINT=/oauth/token REM SET OAUTH2_TOKEN_ENDPOINT= +REM # OAUTH2 ID Token Whitelist Fields. +REM SET OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[] +REM # OAUTH2 Request Permissions. +REM SET OAUTH2_REQUEST_PERMISSIONS=[openid email profile] + REM ------------------------------------------------------------ REM # LDAP_ENABLE : Enable or not the connection by the LDAP diff --git a/start-wekan.sh b/start-wekan.sh index 1de75aa4..bbfbff2b 100755 --- a/start-wekan.sh +++ b/start-wekan.sh @@ -93,8 +93,12 @@ function wekan_repo_check(){ #export OAUTH2_USERNAME_MAP=email # The claim name you want to map to the full name field: #export OAUTH2_FULLNAME_MAP=name - # Tthe claim name you want to map to the email field: + # The claim name you want to map to the email field: #export OAUTH2_EMAIL_MAP=email + # OAUTH2 ID Token Whitelist Fields. + #export OAUTH2_ID_TOKEN_WHITELIST_FIELDS=[] + # OAUTH2 Request Permissions. + #export OAUTH2_REQUEST_PERMISSIONS=[openid profile email] #----------------------------------------------------------------- # ==== OAUTH2 KEYCLOAK ==== # https://github.com/wekan/wekan/wiki/Keycloak <== MAPPING INFO, REQUIRED |