QOAuthUriSchemeReplyHandler Class

Description détaillée

Cette classe sert de gestionnaire de réponse pour les processus d'autorisation OAuth 2.0 qui utilisent des schémas URI privés/personnalisés ou HTTPS pour la redirection. Elle gère la réception de la redirection d'autorisation (également connue sous le nom de rappel) et l'acquisition ultérieure des jetons d'accès.

L'URI de redirection est l'endroit où le serveur d'autorisation redirige l'agent utilisateur (généralement, et de préférence, le navigateur du système) une fois que la partie autorisation du flux est terminée.

L'utilisation de schémas d'URI spécifiques nécessite une configuration au niveau du système d'exploitation afin d'associer l'URI à l'application correcte. La manière de configurer cette association varie d'un système d'exploitation à l'autre. Voir Platform Support and Dependencies.

Cette classe complète QOAuthHttpServerReplyHandler, qui gère les schémas http en mettant en place un serveur local.

Le code suivant illustre l'utilisation de la classe. Tout d'abord, les variables nécessaires :

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

Ensuite, la configuration d'OAuth (la gestion des erreurs est omise par souci de concision) :

m_oauth.setAuthorizationUrl(QUrl(authorizationUrl));
m_oauth.setTokenUrl(QUrl(accessTokenUrl));
m_oauth.setClientIdentifier(clientIdentifier);
m_oauth.setRequestedScopeTokens({scope});

connect(&m_oauth, &QAbstractOAuth::authorizeWithBrowser, this, &QDesktopServices::openUrl);
connect(&m_oauth, &QAbstractOAuth::granted, this, [this]() {
    // Here we use QNetworkRequestFactory to store the access token
    m_api.setBearerToken(m_oauth.token().toLatin1());
    m_handler.close();
});

Enfin, nous configurons le gestionnaire de réponse du schéma URI :

m_handler.setRedirectUrl(QUrl{"com.example.myqtapp://oauth2redirect"_L1});
m_oauth.setReplyHandler(&m_handler);

// Initiate the authorization
if (m_handler.listen()) {
    m_oauth.grant();
}

Schémas d'URI privés/personnalisés

Les schémas d'URI personnalisés utilisent généralement la notation du domaine inversé suivie d'un chemin, ou occasionnellement d'un hôte/hôte+chemin :

// Example with path:
com.example.myapp:/oauth2/callback
// Example with host:
com.example.myapp://oauth2.callback

Schéma d'URI HTTPS

Avec les URI HTTPS, les URL de redirection sont des liens https normaux :

https://myapp.example.com/oauth2/callback

Ces liens sont appelés liens universels sur iOS et liens d'application sur Android.

L'utilisation de schémas https est recommandée car elle offre une sécurité supplémentaire en obligeant les développeurs d'applications à prouver qu'ils sont propriétaires des URL utilisées. Cette preuve est apportée en hébergeant un fichier d'association, que le système d'exploitation consultera dans le cadre de sa distribution interne d'URL.

Le contenu de ce fichier associe l'application et les URL utilisés. Les fichiers d'association doivent être accessibles publiquement sans redirection HTTP. De plus, le site d'hébergement doit disposer de certificats valides et, au moins avec Android, le fichier doit être servi en tant que application/json content-type (voir le guide de configuration de votre serveur).

En outre, les liens https peuvent offrir certains avantages en termes d'utilisation :

• L'URL https se double d'un lien https normal. Si l'utilisateur n'a pas installé l'application (puisque l'URL n'a pas été traitée par une application), le lien https peut par exemple fournir des instructions pour le faire.
• Le dialogue de sélection de l'application pour ouvrir l'URL peut être évité, et votre application peut être ouverte automatiquement à la place

La contrepartie est que cela nécessite une configuration supplémentaire puisque vous devez mettre en place ce fichier d'association hébergé publiquement.

Plateformes supportées et dépendances

Les plateformes actuellement prises en charge sont Android, iOS et macOS.

L'écoute du schéma URI est basée sur QDesktopServices::setUrlHandler() et QDesktopServices::unsetUrlHandler(). Ceux-ci sont actuellement fournis par le module Qt::Gui et, par conséquent, le module QtNetworkAuth dépend de Qt::Gui. Si QtNetworkAuth est construit sans Qt::Gui, QOAuthUriSchemeReplyHandler ne sera pas inclus.

Android

Sur Android, les schémas d'URI requièrent l'utilisation du module QOAuthUriSchemeReplyHandler :

• Configurer intent-filters dans le manifeste de l'application
• Optionnellement, pour la vérification automatique avec les schémas https, l'hébergement d'un fichier d'association de site. assetlinks.json

Voir aussi la configuration du fichier manifeste de Qt Android.

iOS et macOS

Sur iOS et macOS, les schémas URI nécessitent :

• Configuration de l'association de sites entitlement
• Avec les schémas https, l'hébergement d'un site association file (apple-app-site-association)

Windows, Linux

Non pris en charge actuellement. Cependant, les plateformes et les cas d'utilisation qui supportent Qt WebEngine peuvent toujours utiliser ce gestionnaire de réponse - voir Qt OAuth2 Browser Support pour plus de détails.