QOAuth2AuthorizationCodeFlow Class
La clase `QOAuth2AuthorizationCodeFlow` proporciona una implementación del flujo de concesión de código de autorización. Más información...
| Encabezado: | #include <QOAuth2AuthorizationCodeFlow> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
| Heredan: | QAbstractOAuth2 |
Tipos públicos
(since 6.8) enum class | PkceMethod { None, Plain, S256 } |
Funciones públicas
| QOAuth2AuthorizationCodeFlow(QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| virtual | ~QOAuth2AuthorizationCodeFlow() |
(until 6.13) QUrl | accessTokenUrl() const |
(since 6.8) QOAuth2AuthorizationCodeFlow::PkceMethod | pkceMethod() const |
(until 6.13) void | setAccessTokenUrl(const QUrl &accessTokenUrl) |
(since 6.8) void | setPkceMethod(QOAuth2AuthorizationCodeFlow::PkceMethod method, qsizetype length = 43) |
Ranuras públicas
| virtual void | grant() override |
(until 6.13) void | refreshAccessToken() |
Funciones protegidas
| QUrl | buildAuthenticateUrl(const QMultiMap<QString, QVariant> ¶meters = {}) |
| void | requestAccessToken(const QString &code) |
Funciones protegidas reimplementadas
| virtual void | resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters = {}) override |
Ranuras protegidas
(since 6.9) void | refreshTokensImplementation() |
Descripción detallada
Esta clase implementa el flujo de concesión de código de autorización, que se utiliza tanto para obtener como para actualizar tokens de acceso. Se trata de un flujo basado en la redirección, por lo que el usuario necesitará tener acceso a un navegador web.
Al tratarse de un flujo basado en la redirección, esta clase requiere que se configure un gestor de respuestas adecuado. Consulte la Descripción general de OAuth 2.0, QOAuthHttpServerReplyHandler y QOAuthUriSchemeReplyHandler.
Documentación sobre los tipos de miembro
[since 6.8] enum class QOAuth2AuthorizationCodeFlow::PkceMethod
Lista de métodos disponibles de «Proof Key for Code Exchange» (PKCE).
PKCE es una medida de seguridad destinada a mitigar el riesgo de ataques de interceptación de códigos de autorización. Como tal, es relevante para el flujo de «código de autorización» (concesión) de OAuth2 y, en particular, para las aplicaciones nativas.
PKCE inserta parámetros adicionales en las solicitudes de tokens de autorización y de acceso. Con la ayuda de estos parámetros, el servidor de autorización puede verificar que una solicitud de token de acceso procede de la misma entidad que emitió la solicitud de autorización.
| Constante | Valor | Descripción |
|---|---|---|
QOAuth2AuthorizationCodeFlow::PkceMethod::None | 255 | No se utiliza PKCE. Esto deja el flujo desprotegido frente a la interceptación del código de autorización. Utilízalo solo si el servidor de autorización no admite PKCE. |
QOAuth2AuthorizationCodeFlow::PkceMethod::Plain | 1 | Se utiliza el método PKCE «Plain». Utilízalo solo si no es posible utilizar S256. Con el método «Plain», el desafío de código es igual al verificador de código, lo que expone el verificador a cualquiera que pueda interceptar la solicitud de autorización. |
QOAuth2AuthorizationCodeFlow::PkceMethod::S256 | 0 | Se utiliza el método S256 PKCE. Este es el método predeterminado y el recomendado para aplicaciones nativas. Con el método S256, el código de desafío es un valor codificado en base64url del SHA-256 del verificador de código. |
Esta enumeración se introdujo en Qt 6.8.
Véase también setPkceMethod() y pkceMethod().
Documentación de las funciones miembro
[explicit] QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(QObject *parent = nullptr)
Crea un objeto `QOAuth2AuthorizationCodeFlow` con el objeto padre ` parent`.
[explicit] QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(QNetworkAccessManager *manager, QObject *parent = nullptr)
Crea un objeto `QOAuth2AuthorizationCodeFlow` utilizando ` parent ` como objeto padre y establece ` manager ` como gestor de acceso a la red.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, QNetworkAccessManager *manager, QObject *parent = nullptr)
Crea un objeto `QOAuth2AuthorizationCodeFlow` utilizando ` parent ` como objeto padre y establece ` manager ` como gestor de acceso a la red. El identificador del cliente se establece en ` clientIdentifier`.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)
Crea un objeto `QOAuth2AuthorizationCodeFlow` utilizando ` parent ` como objeto padre y establece ` manager ` como gestor de acceso a la red. La URL de autenticación se establece en ` authenticateUrl ` y la URL del token de acceso se establece en ` accessTokenUrl`.
QOAuth2AuthorizationCodeFlow::QOAuth2AuthorizationCodeFlow(const QString &clientIdentifier, const QUrl &authenticateUrl, const QUrl &accessTokenUrl, QNetworkAccessManager *manager, QObject *parent = nullptr)
Crea un objeto `QOAuth2AuthorizationCodeFlow` utilizando ` parent ` como objeto padre y establece ` manager ` como gestor de acceso a la red. El identificador del cliente se establece en ` clientIdentifier `, la URL de autenticación se establece en ` authenticateUrl ` y la URL del token de acceso se establece en ` accessTokenUrl`.
[virtual noexcept] QOAuth2AuthorizationCodeFlow::~QOAuth2AuthorizationCodeFlow()
Elimina la instancia de « QOAuth2AuthorizationCodeFlow ».
[until 6.13] QUrl QOAuth2AuthorizationCodeFlow::accessTokenUrl() const
Está previsto que esta función quede obsoleta en la versión 6.13.
Utiliza en su lugar QAbstractOAuth2::tokenUrl().
Devuelve la URL utilizada para solicitar el token de acceso.
Véase también setAccessTokenUrl().
[protected] QUrl QOAuth2AuthorizationCodeFlow::buildAuthenticateUrl(const QMultiMap<QString, QVariant> ¶meters = {})
Genera una URL de autenticación que se utilizará en la solicitud de autorización mediante parameters.
[override virtual slot] void QOAuth2AuthorizationCodeFlow::grant()
Reimplementa: QAbstractOAuth::grant().
Inicia el flujo de autenticación tal y como se describe en «El marco de autorización de OAuth 2.0».
[noexcept, since 6.8] QOAuth2AuthorizationCodeFlow::PkceMethod QOAuth2AuthorizationCodeFlow::pkceMethod() const
Devuelve el método PKCE actual.
Esta función se introdujo en Qt 6.8.
Véase también setPkceMethod() y QOAuth2AuthorizationCodeFlow::PkceMethod.
[slot, until 6.13] void QOAuth2AuthorizationCodeFlow::refreshAccessToken()
Está previsto que esta función quede obsoleta en la versión 6.13.
Utiliza en su lugar QAbstractOAuth2::refreshTokens().
Llama a esta función para actualizar el token.
Esta función llama a refreshTokensImplementation().
[protected slot, since 6.9] void QOAuth2AuthorizationCodeFlow::refreshTokensImplementation()
Esta función envía una solicitud de actualización del token.
Si la solicitud de actualización se ha iniciado correctamente, el estado se establece en « QAbstractOAuth::Status::RefreshingToken »; de lo contrario, se emite la señal « requestFailed()» y el estado no cambia.
Esta función no tiene ningún efecto si el proceso de actualización del token ya está en curso.
Si falla la actualización del token y existe un token de acceso, el estado se establece en « QAbstractOAuth::Status::Granted », y en « QAbstractOAuth::Status::NotAuthenticated » si no existe ningún token de acceso.
Esta función se introdujo en Qt 6.9.
Véanse también QAbstractOAuth::requestFailed() y QAbstractOAuth2::refreshTokens().
[protected] void QOAuth2AuthorizationCodeFlow::requestAccessToken(const QString &code)
Solicita un token de acceso a partir del code recibido. El code se recibe como respuesta cuando el usuario completa con éxito la autenticación en el navegador.
[override virtual protected] void QOAuth2AuthorizationCodeFlow::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters = {})
Reimplementa: QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> ¶meters).
Crea una URL de autenticación utilizando url y parameters. Esta función emite una señal authorizeWithBrowser() para solicitar la intervención del usuario.
[until 6.13] void QOAuth2AuthorizationCodeFlow::setAccessTokenUrl(const QUrl &accessTokenUrl)
Está previsto que esta función quede obsoleta en la versión 6.13.
Utiliza en su lugar QAbstractOAuth2::setTokenUrl().
Establece la URL utilizada para solicitar el token de acceso en accessTokenUrl.
Véase también accessTokenUrl().
[since 6.8] void QOAuth2AuthorizationCodeFlow::setPkceMethod(QOAuth2AuthorizationCodeFlow::PkceMethod method, qsizetype length = 43)
Establece el método PKCE actual en « method ».
Opcionalmente, se puede utilizar el parámetro « length » para establecer la longitud del « code_verifier ». El valor debe estar comprendido entre 43 y 128 bytes. El propio «code verifier» es generado aleatoriamente por la biblioteca.
Establecer method en PkceMethod::None o PkceMethod::Plain debilita la protección contra la interceptación del código de autorización.
Esta función se introdujo en Qt 6.8.
Véase también pkceMethod() y QOAuth2AuthorizationCodeFlow::PkceMethod.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.