View Attach (18) Info

Add new attachment

Only authorized users are allowed to upload new attachments.

List of attachments

Kind Attachment Name Size Version Date Modified Author Change note
png
 app_reg_auth_config.png 160.8 kB 1 05-Dec-2023 05:32 krivacsz
png
 app_reg_config.png 173.1 kB 1 05-Dec-2023 05:32 krivacsz
png
 b2c_azure_settings.png 184.4 kB 1 05-Dec-2023 05:32 krivacsz
png
 b2c_client_id.png 127.2 kB 1 05-Dec-2023 05:32 krivacsz
png
 b2c_id_token.png 207.0 kB 1 05-Dec-2023 05:32 krivacsz
png
 cognito_client_id_secret.png 66.4 kB 2 05-Dec-2023 05:32 krivacsz
png
 cognito_user_pool.png 82.3 kB 2 05-Dec-2023 05:32 krivacsz
png
 cognito_user_pool_app_client_1... 244.9 kB 1 05-Dec-2023 05:32 krivacsz
png
 cognito_user_pool_app_client_2... 340.5 kB 1 05-Dec-2023 05:32 krivacsz
png
 dmz_template_user_internal_por... 94.7 kB 1 05-Dec-2023 05:32 krivacsz
png
 g_sign_origin_redirect_url.png 85.4 kB 1 05-Dec-2023 05:32 krivacsz
png
 gsign_in_button.png 204.4 kB 1 05-Dec-2023 05:32 krivacsz
png
 http_port_oauth_item_settings.... 43.5 kB 1 05-Dec-2023 05:32 krivacsz
png
 plugin_settings.png 99.6 kB 7 05-Dec-2023 05:32 krivacsz
png
 port_item_settings.png 76.4 kB 2 05-Dec-2023 05:32 krivacsz
png
 port_item_settings_b2c.png 105.6 kB 1 05-Dec-2023 05:32 krivacsz
png
 port_item_settings_cognito.png 14.1 kB 2 05-Dec-2023 05:32 krivacsz
png
 port_item_settings_ms.png 75.3 kB 1 05-Dec-2023 05:32 krivacsz

This page (revision-225) was last changed on 10-Jan-2025 02:20 by krivacsz

This page was created on 05-Dec-2023 05:32 by krivacsz

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Difference between version and

At line 1 removed one line
!!Enterprise Licenses Only\\
At line 3 changed one line
!!__CrushOAuth Plugin__\\
!WARNING!!!: Outdated: Switch to the [CrushOIDC] plugin instead!\\
At line 5 changed 2 lines
This plugin allows you to delegate access of OAuth providers.\\
Currently only __Google Sign__ in is supported.\\
Constraint: __Enterprise Licenses Only__\\
This plugin allows you to delegate access to OAuth ([https://en.wikipedia.org/wiki/OAuth]) providers. On the CrushFTP's login page next to the login button will appear the enabled provider's "__Signed in"__ button".\\
Currently __Google Sign-In__([Google Sign in Configuration]), __Microsoft Sign-In__([Microsoft Sign in Configuration]), __Azure Active Directory B2C Sign in__([Azure Active Directory B2C Configuration]) and __Amazon Cognito Sign in__([Amazon Cognito Configuration]) are supported.\\
At line 8 changed one line
!__Google Sign in__\\
It only works through __HTTP__ or __HTTPS__ protocol.\\
First configure an HTTP(S) port item with OAuth Sign In configuration.\\
[attachments|http_port_oauth_item_settings.png]\\
At line 10 changed 2 lines
You will start at the API credentials manager:\\
[https://console.developers.google.com/projectselector/apis/credentials]\\
!!Supported types:\\
!1. Google Sign-In\\
See [Google Sign in Configuration]\\
!2. Microsoft Sign-In\\
See [Microsoft Sign in Configuration]\\
!3. Azure Active Directory B2C\\
See [Azure Active Directory B2C Configuration]\\
!4. Amazon Cognito\\
See [Amazon Cognito Configuration]\\
At line 13 changed 2 lines
You first need to make a project. My example calls this CrushFTP-Test.\\
[attachments|gDriveSetup/create_project.png]\\
!!Plugin Settings\\
\\
At line 25 added one line
__1.__ __Username matching__ -> It filters the OAuth user name (Google Auth: email address, Microsoft Auth: user principal name). Allow multiple values separated by a comma. Domain filter is allowed (like *mydomain.com).\\
At line 17 changed 2 lines
Next select create credentials, and choose the Web Application type.\\
[attachments|gDriveSetup/create_credentials.png]\\
__2.__ __Allowed authentication types__: Google Sign-In, Microsoft Sign-In, Azure Active Directory B2C Sign in and Amazon Cognito Sign. Configure the sign-in button on HTTP(S) server.\\
At line 20 changed 2 lines
It will warn you if you don't have an "OAuth Consent" screen configured, so go there and configure that screen too.\\
[attachments|gDriveSetup/oauth_consent.png]\\
__3.__\\
__a.__ __Skip OTP processing__: CrushOAuth plugin is not compatible with [OTP Settings] as IDP (identity provider) can have its own two-factor authentication. Turning the flag to true will skip OAuth users from CrushFTP's OTP process.\\
__b.__ __Remove email suffix from username__: It removes the email suffix of the user name. Like username "my_user@email.com" will be "my_user".\\
__c.__ __Get Cognito user info__: Gets more info about Amazon Cognito users (like custom attributes). It is related only to __Amazon Cognito Sign in__.\\
At line 23 changed 2 lines
When configuring the credential, you have to tell Google the domain you will be originating from when creating the auth token, so this is the URL you use for server administration. Just the protocol://dns_or_ip:port Don't have a trailing slash or it will complain.\\
You also need to put in the redirect URL of where google is going to send back the Id token (That will be used for authentication of the google user).
__4.__ OAuth only used for Authentication ([User Manager] defines user's access.) -> If users already exist in CrushFTP's User Manager, you can use the CrushOAuth plugin __just for authentication__.\\
At line 36 added 46 lines
__5.__ __Template Username__ -> The signed-in user inherits not just the settings, but the VFS items too (as Linked [VFS]).
\\
__Import settings from CrushFTP user__ -> The signed-in user inherits just the settings from this user. __It must have a value! __Default value would be : __default__ -> the default user of CrushFTP\\
\\
__6__ __OAuth Roles__ -> You can configure different Template Users (see 5.) based on IDP's (identity provider) attributes.\\
IDP Attribute examples:\\
{{{
Google Sign-In:
email_verified, idp_user_info, given_name, family_name, email_verified, group
Microsoft Sign-In:
mail, idp_user_info, displayName, jobTitle, businessPhones, mobilePhone, officeLocation, group
Amazon Cognito Sign-in:
email, username, identities, cognito:username, cognito:groups, custom:<<defined custom attributes>>
}}}
Role examples :
{{{
<<IDP attribute name>>=<<IDP attribute value>>,<<IDP attribute name>>=<<IDP attribute value>> : tmeplate user name
Like:
cognito:groups=Azure_SAML,custom:groups:test_group_one
or
cognito:groups=*SAML*,custom:groups:test_group_one
or
cognito:groups=REGEX:.*SAML$,custom:groups:test_group_one
}}}
\\
IDP attribute value: Exact match, Simple Match (like *mail.com*), Regex match (like REGEX:<<the regular expression>>), if the value is an array you can reference only one of the array element (exact match only). Like (IDP Attribute value -> __groups:[["group1","group2"]__ -> you can match with __group1__)\\
\\
\\
__7.__ VFS-related settings -> You can set custom [VFS] for CrushOAuth users.\\
\\
[attachments|plugin_settings.png]\\
\\
!!DMZ\\
\\
__1.__ Configure your OAuth Sign In settings on the DMZ's HTTP(S) port item.\\
__2.__ Configure the same OAuth Sign In settings on the Internal (Main) HTTP(S) port item. This port item must match with the port item configured at the DMZ template user's VFS. (See [DMZ])\\
\\
[attachments|dmz_template_user_internal_port.png]\\
\\
__3.__ Configure the OAuth plugin __only on the Internal (Main) instance__. !!!Do not configure the OAuth plugin on the DMZ too. See __Plugin Settings__ on the current page.\\
\\
Version Date Modified Size Author Changes ... Change note
225 10-Jan-2025 02:20 4.48 kB krivacsz to previous
224 10-Jan-2025 02:19 4.477 kB krivacsz to previous | to last
223 10-Jan-2025 02:17 4.469 kB krivacsz to previous | to last
222 10-Jan-2025 02:17 4.468 kB krivacsz to previous | to last
221 10-Jan-2025 02:17 4.46 kB krivacsz to previous | to last
« This page (revision-225) was last changed on 10-Jan-2025 02:20 by krivacsz
G’day (anonymous guest)
CrushFTP11 | What's New

Referenced by
Enterprise License Enhancements
LeftMenu

JSPWiki