From 3b4f285fea4a90ee96bfce855e1539adcec9b7aa Mon Sep 17 00:00:00 2001 From: guillaume Date: Tue, 9 Oct 2018 14:14:39 +0200 Subject: add ldap support | simplify authentications --- snap-src/bin/config | 161 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 160 insertions(+), 1 deletion(-) (limited to 'snap-src') diff --git a/snap-src/bin/config b/snap-src/bin/config index a54b13c2..076a2a57 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="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 MATOMO_ADDRESS MATOMO_SITE_ID MATOMO_DO_NOT_TRACK MATOMO_WITH_USERNAME BROWSER_POLICY_ENABLED TRUSTED_URL WEBHOOKS_ATTRIBUTES OAUTH2_CLIENT_ID OAUTH2_SECRET OAUTH2_SERVER_URL OAUTH2_AUTH_ENDPOINT OAUTH2_USERINFO_ENDPOINT OAUTH2_TOKEN_ENDPOINT" +keys="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 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 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_MERGE_EXISTING_USERS LDAP_SYNC_USER_DATA LDAP_SYNC_USER_DATA_FIELDMAP LDAP_SYNC_GROUP_ROLES LDAP_DEFAULT_DOMAIN" # default values DESCRIPTION_MONGODB_BIND_UNIX_SOCKET="mongodb binding unix socket:\n"\ @@ -82,6 +82,10 @@ DESCRIPTION_WEBHOOKS_ATTRIBUTES="What to send to Outgoing Webhook, or leave out. DEFAULT_WEBHOOKS_ATTRIBUTES="" KEY_WEBHOOKS_ATTRIBUTES="webhooks-attributes" +DESCRIPTION_OAUTH2_ENABLED="Enable the OAuth2 connection" +DEFAULT_OAUTH2_ENABLED="false" +KEY_OAUTH2_ENABLED="oauth2-enabled" + DESCRIPTION_OAUTH2_CLIENT_ID="OAuth2 Client ID, for example from Rocket.Chat. Example: abcde12345" DEFAULT_OAUTH2_CLIENT_ID="" KEY_OAUTH2_CLIENT_ID="oauth2-client-id" @@ -106,3 +110,158 @@ DESCRIPTION_OAUTH2_TOKEN_ENDPOINT="OAuth2 token endpoint. Example: /oauth/token" DEFAULT_OAUTH2_TOKEN_ENDPOINT="" KEY_OAUTH2_TOKEN_ENDPOINT="oauth2-token-endpoint" +DESCRIPTION_LDAP_ENABLE="Enable or not the connection by the LDAP" +DEFAULT_LDAP_ENABLE="false" +KEY_LDAP_ENABLE="ldap-enable" + +DESCRIPTION_LDAP_PORT="The port of the LDAP server" +DEFAULT_LDAP_PORT="389" +KEY_LDAP_PORT="ldap-port" + +DESCRIPTION_LDAP_HOST="The host server for the LDAP server" +DEFAULT_LDAP_HOST="" +KEY_LDAP_HOST="ldap-host" + +DESCRIPTION_LDAP_BASEDN="The base DN for the LDAP Tree" +DEFAULT_LDAP_BASEDN="" +KEY_LDAP_BASEDN="ldap-basedn" + +DESCRIPTION_LDAP_LOGIN_FALLBACK="Fallback on the default authentication method" +DEFAULT_LDAP_LOGIN_FALLBACK="false" +KEY_LDAP_LOGIN_FALLBACK="ldap-login-fallback" + +DESCRIPTION_LDAP_RECONNECT="Reconnect to the server if the connection is lost" +DEFAULT_LDAP_RECONNECT="true" +KEY_LDAP_RECONNECT="ldap-reconnect" + +DESCRIPTION_LDAP_TIMEOUT="Overall timeout, in milliseconds." +DEFAULT_LDAP_TIMEOUT="10000" +KEY_LDAP_TIMEOUT="ldap-timeout" + +DESCRIPTION_LDAP_IDLE_TIMEOUT="Specifies the timeout for idle LDAP connections in milliseconds" +DEFAULT_LDAP_IDLE_TIMEOUT="10000" +KEY_LDAP_IDLE_TIMEOUT="ldap-idle-timeout" + +DESCRIPTION_LDAP_CONNECT_TIMEOUT="Connection timeout, in milliseconds." +DEFAULT_LDAP_CONNECT_TIMEOUT="10000" +KEY_LDAP_CONNECT_TIMEOUT="ldap-connect-timeout" + +DESCRIPTION_LDAP_AUTHENTIFICATION="If the LDAP needs a user account to search" +DEFAULT_LDAP_AUTHENTIFICATION="false" +KEY_LDAP_AUTHENTIFICATION="ldap-authentication" + +DESCRIPTION_LDAP_AUTHENTIFICATION_USERDN="The search user DN" +DEFAULT_LDAP_AUTHENTIFICATION_USERDN="" +KEY_LDAP_AUTHENTIFICATION_USERDN="ldap-authentication-userdn" + +DESCRIPTION_LDAP_AUTHENTIFICATION_PASSWORD="The password for the search user" +DEFAULT_LDAP_AUTHENTIFICATION_PASSWORD="" +KEY_LDAP_AUTHENTIFICATION_PASSWORD="ldap-authentication-password" + +DESCRIPTION_LDAP_LOG_ENABLED="Enable logs for the module" +DEFAULT_LDAP_LOG_ENABLED="false" +KEY_LDAP_LOG_ENABLED="ldap-log-enabled" + +DESCRIPTION_LDAP_BACKGROUND_SYNC="If the sync of the users should be done in the background" +DEFAULT_LDAP_BACKGROUND_SYNC="false" +KEY_LDAP_BACKGROUND_SYNC="ldap-background-sync" + +DESCRIPTION_LDAP_BACKGROUND_SYNC_INTERVAL="At which interval does the background task sync in milliseconds" +DEFAULT_LDAP_BACKGROUND_SYNC_INTERVAL="100" +KEY_LDAP_BACKGROUND_SYNC_INTERVAL="ldap-background-sync-interval" + +DESCRIPTION_LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED="" +DEFAULT_LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED="false" +KEY_LDAP_BACKGROUND_SYNC_KEEP_EXISTANT_USERS_UPDATED="ldap-background-sync-keep-existant-users-updated" + +DESCRIPTION_LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS="" +DEFAULT_LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS="false" +KEY_LDAP_BACKGROUND_SYNC_IMPORT_NEW_USERS="ldap-background-sync-import-new-users" + +DESCRIPTION_LDAP_ENCRYPTION="If using LDAPS" +DEFAULT_LDAP_ENCRYPTION="false" +KEY_LDAP_ENCRYPTION="ldap-encryption" + +DESCRIPTION_LDAP_CA_CERT="The certification for the LDAPS server" +DEFAULT_LDAP_CA_CERT="" +KEY_LDAP_CA_CERT="ldap-ca-cert" + +DESCRIPTION_LDAP_REJECT_UNAUTHORIZED="Reject Unauthorized Certificate" +DEFAULT_LDAP_REJECT_UNAUTHORIZED="false" +KEY_LDAP_REJECT_UNAUTHORIZED="ldap-reject-unauthorized" + +DESCRIPTION_LDAP_USER_SEARCH_FILTER="Optional extra LDAP filters. Don't forget the outmost enclosing parentheses if needed" +DEFAULT_LDAP_USER_SEARCH_FILTER="" +KEY_LDAP_USER_SEARCH_FILTER="ldap-user-search-filter" + +DESCRIPTION_LDAP_USER_SEARCH_SCOPE="Base (search only in the provided DN), one (search only in the provided DN and one level deep), or subtree (search the whole subtree)." +DEFAULT_LDAP_USER_SEARCH_SCOPE="" +KEY_LDAP_USER_SEARCH_SCOPE="ldap-user-search-scope" + +DESCRIPTION_LDAP_USER_SEARCH_FIELD="Which field is used to find the user" +DEFAULT_LDAP_USER_SEARCH_FIELD="" +KEY_LDAP_USER_SEARCH_FIELD="ldap-user-search-field" + +DESCRIPTION_LDAP_SEARCH_PAGE_SIZE="Used for pagination (0=unlimited)" +DEFAULT_LDAP_SEARCH_PAGE_SIZE="0" +KEY_LDAP_SEARCH_PAGE_SIZE="ldap-search-page-size" + +DESCRIPTION_LDAP_SEARCH_SIZE_LIMIT="The limit number of entries (0=unlimited)" +DEFAULT_LDAP_SEARCH_SIZE_LIMIT="0" +KEY_LDAP_SEARCH_SIZE_LIMIT="ldap-search-size-limit" + +DESCRIPTION_LDAP_GROUP_FILTER_ENABLE="Enable group filtering" +DEFAULT_LDAP_GROUP_FILTER_ENABLE="false" +KEY_LDAP_GROUP_FILTER_ENABLE="ldap-group-filter-enable" + +DESCRIPTION_LDAP_GROUP_FILTER_OBJECTCLASS="The object class for filtering" +DEFAULT_LDAP_GROUP_FILTER_OBJECTCLASS="" +KEY_LDAP_GROUP_FILTER_OBJECTCLASS="ldap-group-filter-objectclass" + +DESCRIPTION_LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE="" +DEFAULT_LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE="" +KEY_LDAP_GROUP_FILTER_GROUP_ID_ATTRIBUTE="ldap-group-filter-id-attribute" + +DESCRIPTION_LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE="" +DEFAULT_LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE="" +KEY_LDAP_GROUP_FILTER_GROUP_MEMBER_ATTRIBUTE="ldap-group-filter-member-attribute" + +DESCRIPTION_LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT="" +DEFAULT_LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT="" +KEY_LDAP_GROUP_FILTER_GROUP_MEMBER_FORMAT="ldap-group-filter-member-format" + +DESCRIPTION_LDAP_GROUP_FILTER_GROUP_NAME="" +DEFAULT_LDAP_GROUP_FILTER_GROUP_NAME="" +KEY_LDAP_GROUP_FILTER_GROUP_NAME="ldap-group-filter-member-format" + +DESCRIPTION_LDAP_UNIQUE_IDENTIFIER_FIELD="This field is sometimes class GUID (Globally Unique Identifier)" +DEFAULT_LDAP_UNIQUE_IDENTIFIER_FIELD="" +KEY_LDAP_UNIQUE_IDENTIFIER_FIELD="ldap-unique-identifier-field" + +DESCRIPTION_LDAP_UTF8_NAMES_SLUGIFY="Convert the username to utf8" +DEFAULT_LDAP_UTF8_NAMES_SLUGIFY="true" +KEY_LDAP_UTF8_NAMES_SLUGIFY="ldap-utf8-names-slugify" + +DESCRIPTION_LDAP_USERNAME_FIELD="Which field contains the ldap username" +DEFAULT_LDAP_USERNAME_FIELD="" +KEY_LDAP_USERNAME_FIELD="ldap-username-field" + +DESCRIPTION_LDAP_MERGE_EXISTING_USERS="" +DEFAULT_LDAP_MERGE_EXISTING_USERS="false" +KEY_LDAP_MERGE_EXISTING_USERS="ldap-merge-existing-users" + +DESCRIPTION_LDAP_SYNC_USER_DATA="" +DEFAULT_LDAP_SYNC_USER_DATA="false" +KEY_LDAP_SYNC_USER_DATA="ldap-sync-user-data" + +DESCRIPTION_LDAP_SYNC_USER_DATA_FIELDMAP="" +DEFAULT_LDAP_SYNC_USER_DATA_FIELDMAP="" +KEY_LDAP_SYNC_USER_DATA_FIELDMAP="ldap-sync-user-data-fieldmap" + +DESCRIPTION_LDAP_SYNC_GROUP_ROLES="" +DEFAULT_LDAP_SYNC_GROUP_ROLES="" +KEY_LDAP_SYNC_GROUP_ROLES="ldap-sync-group-roles" + +DESCRIPTION_LDAP_DEFAULT_DOMAIN="The default domain of the ldap it is used to create email if the field is not map correctly with the LDAP_SYNC_USER_DATA_FIELDMAP" +DEFAULT_LDAP_DEFAULT_DOMAIN="" +KEY_LDAP_DEFAULT_DOMAIN="ldap-default-domain" -- cgit v1.2.3-1-g7c22