OAuth Redirect URL breaking change

chris001 · 30 January 2024 19:02

There’s been a breaking change by Microsoft for OAuth.
Microsoft OAuth Redirect URL has new rules, coming after OAuth was added in Suite.
The Redirect URL may not contain a query string!
Also, public (domain) URLs must be secure (https). Insecure (http) is not accepted!
So in the Suite 8 OAuth documentation example Redirect URL: http://suite.mysite.tld/legacy/index.php?entryPoint=setExternalOAuthToken
…is now rejected in Microsoft Azure OAuth settings.
Same documentation for Suite 7, without the legacy part of the Redirect URL.
A fix is needed to get Microsoft OAuth working again.
Azure OAuth Redirect URL may not coontain a query string

rsp · 30 January 2024 20:58

Did you open new PR/issue on the GitHub?

chris001 · 30 January 2024 21:39

Yes, the issue is open now:

github.com/salesagility/SuiteCRM

Microsoft Azure OAuth Redirect URI doesn't allow the query string.

opened 09:38PM - 30 Jan 24 UTC

chris001

#### Issue **Microsoft OAuth Redirect URL** has new rules, since OAuth Login to Email was added in Suite. The OAuth Redirect URL may not contain a query string! Also, public (domain) URLs must be secure (https). Insecure (http) is not accepted! In the Suite 7 + Suite 8 OAuth Email documentation steps, the Redirect URL: `http://suite.mysite.tld/legacy/index.php?entryPoint=setExternalOAuthToken` …is now rejected as a Microsoft Azure OAuth Redirect URL! A fix is needed, for all users, to get the Microsoft OAuth Redirect URL working again, and TLS certificates since `https` is now mandatory. #### Expected Behavior Users should be able to enter an acceptable Redirect URL to Azure, **a URL that doesn't contain a Query String**. Users should be able to enter `https://suite.mysite.tld/legacy/entryPoint/setExternalOAuthToken` and have the Suite `.htaccess` rewrite it to: `https://suite.mysite.tld/legacy/index.php?entryPoint=setExternalOAuthToken` #### Actual Behavior Azure refuses saving Suite's OAuth Redirect URL: ![Azure OAuth Redirect URL may not coontain a query string](https://github.com/salesagility/SuiteCRM/assets/259416/cfbca314-5abe-47e7-9686-8a2cb3d5027b) #### Possible Fix `RewriteRule` in the Apache `.htaccess`. Suite should detect when it's running on publicly accessible domain: auto configure a free TLS certificate & enable `HTTPS`. Or **just run Suite on a server with a Virtualmin control panel, it will automatically install a free TLS certificate, `https` will be active, and OAuth login from a Suite server on a domain will work.** #### Steps to Reproduce 1. Login to Microsoft Azure. 2. Follow the Suite documentation on how to setup an "app" for Microsoft OAuth for email. 3. Enable for personal email accounts also. May not make any difference. 4. When you go to paste in the Redirect URL from the docs, you'll see an error box. It refuses to save the Redirect URL. #### Context 1. Fails to connect to email on Microsoft email accounts! 2. Unable to test new email features such as RFC8055 One Click Unsubscribe, on Microsoft email accounts! #### Your Environment * SuiteCRM Version used: 7.14.2, 8.5.0 * Browser name and version (e.g. Chrome Version 51.0.2704.63 (64-bit)): Firefox * Environment name and version (e.g. MySQL, PHP 7): PHP 8.1 and 8.2 * Operating System and version (e.g Ubuntu 16.04): Debian 12

gunnicom · 31 January 2024 08:08

I only recently (last week) configured OAuth with MS Office365, and hat no problems with the redirect URL.

chris001 · 31 January 2024 08:21

github.com/salesagility/SuiteCRM

Fix #10345 Microsoft Azure OAuth Redirect URL doesn't allow the query string.

salesagility:hotfix ← chris001:Microsoft-Azure-OAuth-Redirect-URL

opened 08:21AM - 31 Jan 24 UTC

chris001

+3 -0

## Description Setting up MS Azure OAuth for email accounts was failing because Suite docs say use a Redirect URL containing a query string, and Azure forbids Redirect URLs with query strings. My fix involves adding a line to the `.htaccess` to rewrite the incoming Redirect URL compatible with Microsoft Azure OAuth, to the query-string type of Redirect URL expected by Suite. ## Motivation and Context Microsoft Azure OAuth does not allow Redirect URL to have query strings, which is the exact type of URL Suite uses. ## How To Test This Try creating an application in Azure according to the documentation. At one point, it will have you paste the Suite Redirect URL into Microsoft Azure application. Paste the URL with query strings from the docs. Azure will refuse to save it because query strings are not allowed. ![Azure OAuth Redirect URL may not coontain a query string](https://github.com/salesagility/SuiteCRM/assets/259416/7554f2a7-a307-401b-9488-afe522417907) Try again with the URL like this instead: `https://suite.mysite.tld/entryPoint/setExternalOAuthToken` Azure will save this Redirect URL. And Suite will accept the Redirect URL during the OAuth email account login, because Suite will internally rewrite the incoming Redirect URL from Azure, to the expected URL `https://suite.mysite.tld/index.php?entryPoint=setExternalOAuthToken`, Suite will receive the token back from Azure OAuth, making OAuth login to the MS Azure email account work. ## Types of changes - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) ### Final checklist - [x] My code follows the code style of this project found [here](https://docs.suitecrm.com/community/contributing-code/coding-standards/). - [x] My change requires a change to the documentation. - [x] I have read the [**How to Contribute**](https://docs.suitecrm.com/community/contributing-code/) guidelines.

chris001 · 31 January 2024 08:23

Interesting. Is it a localhost URL, or a publicly accessible domain? http or https? Organization or non-organization personal email accounts?

gunnicom · 31 January 2024 08:48

It is a not publicly accessible https URL. like https://suite.company.local/index.php?entryPoint=setExternalOAuthToken

chris001 · 31 January 2024 15:52

Is your Azure app configured to allow only Organization email accounts? Or allow Personal email accounts (non-organization)?

rsp · 31 January 2024 16:04

You could provide your steps and some screenshots, so we could understand it better.

gunnicom · 31 January 2024 17:12

I don’t know to be honest. It was our MS admin that configured it on the Microsoft side, I only did it on the SuiteCRM side. But I would guess only organisation emails.