QOAuthUriSchemeReplyHandler Class

Descripción detallada

Esta clase sirve como gestor de respuesta para los procesos de autorización OAuth 2.0 que utilizan esquemas URI privados/personalizados o HTTPS para la redirección. Gestiona la recepción de la redirección de autorización (también conocida como callback) y la posterior adquisición de tokens de acceso.

El URI de redirección es donde el servidor de autorización redirige al usuario-agente (típicamente, y preferiblemente, el navegador del sistema) una vez que la parte de autorización del flujo se ha completado.

El uso de esquemas URI específicos requiere una configuración a nivel de sistema operativo para asociar el URI con la aplicación correcta. La forma de configurar esta asociación varía entre sistemas operativos. Véase Platform Support and Dependencies.

Esta clase complementa a QOAuthHttpServerReplyHandler, que gestiona los esquemas http configurando un servidor localhost.

El siguiente código ilustra el uso. Primero, las variables necesarias:

QOAuth2AuthorizationCodeFlow m_oauth;
QOAuthUriSchemeReplyHandler m_handler;

Seguido por la configuración de OAuth (se omite el manejo de errores por brevedad):

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();
});

Finalmente, configuramos el manejador de respuesta del esquema 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();
}

Esquemas URI privados/personalizados

Los esquemas URI personalizados suelen utilizar la notación de dominio inverso seguida de una ruta, u ocasionalmente un host/host+ruta:

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

Esquema URI HTTPS

Con los esquemas URI HTTPS, las URL de redirección son enlaces https normales:

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

Estos enlaces se denominan Universal Links en iOS y App Links en Android.

Se recomienda el uso de esquemas https, ya que proporcionan seguridad adicional al obligar a los desarrolladores de aplicaciones a demostrar la propiedad de las URL utilizadas. Esta prueba se realiza alojando un archivo de asociación, que el sistema operativo consultará como parte de su envío interno de URL.

El contenido de este archivo asocia la aplicación y las URL utilizadas. Los archivos de asociación deben ser accesibles al público sin redireccionamientos HTTP. Además, el sitio de alojamiento debe disponer de certificados válidos y, al menos con Android, el archivo debe servirse como application/json content-type (consulte la guía de configuración de su servidor).

Además, los enlaces https pueden proporcionar algunas ventajas de usabilidad:

• La URL https funciona como un enlace https normal. Si el usuario no ha instalado la aplicación (ya que la URL no ha sido gestionada por ninguna aplicación), el enlace https puede servir, por ejemplo, de instrucciones para hacerlo.
• El diálogo de selección de aplicación para abrir la URL puede evitarse, y en su lugar su aplicación puede abrirse automáticamente.

La contrapartida es que esto requiere una configuración adicional, ya que es necesario configurar este archivo de asociación alojado públicamente.

Plataformas compatibles y dependencias

Las plataformas soportadas actualmente son Android, iOS y macOS.

La escucha del esquema URI se basa en QDesktopServices::setUrlHandler() y QDesktopServices::unsetUrlHandler(). Estos son actualmente proporcionados por el módulo Qt::Gui y por lo tanto el módulo QtNetworkAuth depende de Qt::Gui. Si QtNetworkAuth se construye sin Qt::Gui, QOAuthUriSchemeReplyHandler no se incluirá.

Android

En Android los esquemas URI requieren:

• Configurar intent-filters en el manifiesto de la aplicación
• Opcionalmente, para la verificación automática con esquemas https, alojar un archivo de asociación de sitios assetlinks.json

Ver también la Configuración del archivo de manifiesto de Qt Android.

iOS y macOS

En iOS y macOS los esquemas URI requieren:

• Configuración de la asociación de sitios. entitlement
• Con esquemas https, alojar un site association file (apple-app-site-association)

Windows, Linux

Actualmente no es compatible. Sin embargo las plataformas y casos de uso que soportan Qt WebEngine pueden seguir utilizando este gestor de respuestas; para obtener más información, consulte Soporte de Qt OAuth2 para navegadores.