| At line 1 removed 3 lines |
| !!Enterprise Licenses Only\\ |
| This plugin allows you to delegate access of 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__, __Microsoft Sign-In__, __Azure Active Directory B2C Sign in__ and __Amazon Cognito Sign in__ are supported.\\ |
| At line 2 added 11 lines |
| !WARNING!!!: Outdated: Switch to the [CrushOIDC] plugin instead!\\ |
| \\ |
| 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.\\ |
| \\ |
| 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]\\ |
| \\ |
| !!Supported types:\\ |
| At line 13 removed one line |
| !5. Plugin Settings\\ |
| At line 22 added 2 lines |
| !!Plugin Settings\\ |
| \\ |
| At line 16 changed one line |
| __1.__ Username matching -> It filters the OAuth user name (Google Auth: email address, Microsoft Auth: user principle name). You can put multiple value separated by comma. Domain filter is allowed to (like *mydomain.com).\\ |
| __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 18 changed one line |
| __2.__ Allowed authentication types\\ |
| __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 21 changed 2 lines |
| __A.__ Skip OTP processing -> CrushOAuth is not compatible with [OTP Settings] as IDP providers can have their own two factor authentication.\\ |
| __B.__ Get Cognito user info -> \\ |
| __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 24 changed one line |
| __4.__ OAuth only used for Authentication (User manager then defines user's access.) -> If users already exists with username of the OAuth, you can use the plugin just for authentication.\\ |
| __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 26 changed one line |
| __5.__ Template Username -> The signed in user inherits no just the settings, but the VFS items too (as Linked VFS).\\ |
| __5.__ __Template Username__ -> The signed-in user inherits not just the settings, but the VFS items too (as Linked [VFS]). |
| At line 28 changed one line |
| 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\\ |
| __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\\ |
| At line 30 changed one line |
| __6__\\ |
| __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 |
| }}} |
| At line 32 changed one line |
| __7.__ VFS related settings : You can also assign a VFS item for the signed in user.\\ |
| 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__)\\ |
| \\ |
| At line 69 added 2 lines |
| __7.__ VFS-related settings -> You can set custom [VFS] for CrushOAuth users.\\ |
| \\ |
| At line 73 added 9 lines |
| !!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.\\ |
| \\ |
