QOAuth1 Class
La clase QOAuth1 ofrece una implementación del protocolo OAuth 1. Más información...
| Encabezado: | #include <QOAuth1> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
| Heredado de: | QAbstractOAuth |
Tipos públicos
| enum class | SignatureMethod { Hmac_Sha1, Rsa_Sha1, PlainText } |
Funciones públicas
| QOAuth1(QObject *parent = nullptr) | |
| QOAuth1(QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| QOAuth1(const QString &clientIdentifier, const QString &clientSharedSecret, QNetworkAccessManager *manager, QObject *parent = nullptr) | |
| std::pair<QString, QString> | clientCredentials() const |
| QString | clientSharedSecret() const |
| void | setClientCredentials(const std::pair<QString, QString> &clientCredentials) |
| void | setClientCredentials(const QString &clientIdentifier, const QString &clientSharedSecret) |
| void | setClientSharedSecret(const QString &clientSharedSecret) |
| void | setSignatureMethod(QOAuth1::SignatureMethod value) |
| void | setTemporaryCredentialsUrl(const QUrl &url) |
| void | setTokenCredentials(const std::pair<QString, QString> &tokenCredentials) |
| void | setTokenCredentials(const QString &token, const QString &tokenSecret) |
| void | setTokenCredentialsUrl(const QUrl &url) |
| void | setTokenSecret(const QString &tokenSecret) |
| QOAuth1::SignatureMethod | signatureMethod() const |
| QUrl | temporaryCredentialsUrl() const |
| std::pair<QString, QString> | tokenCredentials() const |
| QUrl | tokenCredentialsUrl() const |
| QString | tokenSecret() const |
Funciones públicas reimplementadas
| virtual QNetworkReply * | deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual QNetworkReply * | get(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual QNetworkReply * | head(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual QNetworkReply * | post(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
| virtual void | prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray()) override |
| virtual QNetworkReply * | put(const QUrl &url, const QVariantMap ¶meters = QVariantMap()) override |
Ranuras públicas
| void | continueGrantWithVerifier(const QString &verifier) |
| virtual void | grant() override |
Señales
| void | clientSharedSecretChanged(const QString &credential) |
| void | signatureMethodChanged(QOAuth1::SignatureMethod method) |
| void | temporaryCredentialsUrlChanged(const QUrl &url) |
| void | tokenCredentialsUrlChanged(const QUrl &url) |
| void | tokenSecretChanged(const QString &token) |
Funciones protegidas
| QNetworkReply * | requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap ¶meters = QVariantMap()) |
| QNetworkReply * | requestTokenCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const std::pair<QString, QString> &temporaryToken, const QVariantMap ¶meters = QVariantMap()) |
| void | setup(QNetworkRequest *request, const QVariantMap &signingParameters, QNetworkAccessManager::Operation operation) |
| void | setup(QNetworkRequest *request, const QVariantMap &signingParameters, const QByteArray &operationVerb) |
Miembros estáticos protegidos
| QByteArray | generateAuthorizationHeader(const QVariantMap &oauthParams) |
| QByteArray | nonce() |
Descripción detallada
QOAuth1 proporciona un método para que los clientes accedan a los recursos del servidor en nombre del propietario de los recursos (como otro cliente o un usuario final). También ofrece un proceso para que los usuarios finales autoricen el acceso de terceros a sus recursos del servidor sin compartir sus credenciales (normalmente, un nombre de usuario y una contraseña), mediante redireccionamientos del agente de usuario.
QOAuth1 utiliza tokens para representar la autorización concedida al cliente por el propietario del recurso. Normalmente, el servidor emite las credenciales del token a petición del propietario del recurso, tras autenticar la identidad de este (por lo general, mediante un nombre de usuario y una contraseña).
Al realizar la solicitud de credenciales temporales, el cliente se autentica utilizando únicamente las credenciales del cliente. Al realizar la solicitud del token, el cliente se autentica utilizando tanto las credenciales del cliente como las credenciales temporales. Una vez que el cliente recibe y almacena las credenciales del token, puede proceder a acceder a los recursos protegidos en nombre del propietario del recurso realizando solicitudes autenticadas utilizando las credenciales del cliente junto con las credenciales del token recibidas.
Documentación sobre los tipos de miembro
enum class QOAuth1::SignatureMethod
Indica el método de firma que se debe utilizar para firmar las solicitudes.
Documentación de las funciones miembro
[explicit] QOAuth1::QOAuth1(QObject *parent = nullptr)
Crea un objeto QOAuth1 con el objeto padre parent.
[explicit] QOAuth1::QOAuth1(QNetworkAccessManager *manager, QObject *parent = nullptr)
Crea un objeto QOAuth1 con el objeto padre parent, utilizando manager para acceder a la red.
QOAuth1::QOAuth1(const QString &clientIdentifier, const QString &clientSharedSecret, QNetworkAccessManager *manager, QObject *parent = nullptr)
Crea un objeto QOAuth1 con el objeto padre parent, utilizando manager para acceder a la red. Además, establece clientIdentifier y clientSharedSecret para firmar las llamadas al servidor web e identificar la aplicación.
std::pair<QString, QString> QOAuth1::clientCredentials() const
Devuelve el par de certificados « QString » que se utiliza para identificar la aplicación y firmar las solicitudes enviadas al servidor web.
Véase también setClientCredentials().
QString QOAuth1::clientSharedSecret() const
Devuelve el secreto compartido actual que se utiliza para firmar las solicitudes enviadas al servidor web.
Véase también setClientSharedSecret() y clientCredentials().
[signal] void QOAuth1::clientSharedSecretChanged(const QString &credential)
Se emite cuando cambia el secreto compartido del cliente credential.
Véase también clientSharedSecret(), setClientSharedSecret() y setClientCredentials().
[slot] void QOAuth1::continueGrantWithVerifier(const QString &verifier)
Continúa el flujo de autorización basado en redirección utilizando verifier. Llama a esta función cuando utilices un gestor de respuestas fuera de banda para proporcionar el verificador facilitado por el servidor web.
[override virtual] QNetworkReply *QOAuth1::deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplementa: QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap ¶meters).
Envía una solicitud DELETE autenticada y devuelve un nuevo objeto ` QNetworkReply`. Los parámetros ` url ` y ` parameters ` se utilizan para crear la solicitud.
Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: DELETE
[static protected] QByteArray QOAuth1::generateAuthorizationHeader(const QVariantMap &oauthParams)
Genera un encabezado de autorización utilizando oauthParams.
Véase también: El protocolo OAuth 1.0: Encabezado de autorización
[override virtual] QNetworkReply *QOAuth1::get(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplementa: QAbstractOAuth::get(const QUrl &url, const QVariantMap ¶meters).
Envía una solicitud GET autenticada y devuelve un nuevo objeto ` QNetworkReply`. Los parámetros ` url ` y ` parameters ` se utilizan para crear la solicitud.
Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: GET
[override virtual slot] void QOAuth1::grant()
Reimplementa: QAbstractOAuth::grant().
Inicia el flujo de autorización basado en redirección.
Nota: En el caso de un gestor de respuestas fuera de banda, se recibe una cadena de verificación tras la llamada a esta función; pásala a continueGrantWithVerifier() para continuar con el proceso de concesión.
Véase también: El protocolo OAuth 1.0: Autorización basada en redirección
Véase también continueGrantWithVerifier().
[override virtual] QNetworkReply *QOAuth1::head(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplementa: QAbstractOAuth::head(const QUrl &url, const QVariantMap ¶meters).
Envía una solicitud HEAD autenticada y devuelve un nuevo objeto ` QNetworkReply`. Se utilizan los parámetros ` url ` y ` parameters ` para crear la solicitud.
Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: HEAD
[static protected] QByteArray QOAuth1::nonce()
Genera un nonce.
Véase también: El protocolo OAuth 1.0: Nonce y marca de tiempo
[override virtual] QNetworkReply *QOAuth1::post(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplementa: QAbstractOAuth::post(const QUrl &url, const QVariantMap ¶meters).
Envía una solicitud POST autenticada y devuelve un nuevo objeto ` QNetworkReply`. Los parámetros ` url ` y ` parameters ` se utilizan para crear la solicitud.
Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: POST
[override virtual] void QOAuth1::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())
Reimplementa: ` QAbstractOAuth::prepareRequest` (`QNetworkRequest *request, const QByteArray &verb, const QByteArray &body)`.
[override virtual] QNetworkReply *QOAuth1::put(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplementa: QAbstractOAuth::put(const QUrl &url, const QVariantMap ¶meters).
Envía una solicitud PUT autenticada y devuelve un nuevo objeto ` QNetworkReply`. Los parámetros ` url ` y ` parameters ` se utilizan para crear la solicitud.
Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: PUT
[protected] QNetworkReply *QOAuth1::requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Inicia una solicitud de credenciales temporales utilizando el método de solicitud « operation ». La URL de la solicitud es url y el campo « parameters » debe codificarse y enviarse durante la solicitud.
Véase también: El protocolo OAuth 1.0: credenciales temporales
[protected] QNetworkReply *QOAuth1::requestTokenCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const std::pair<QString, QString> &temporaryToken, const QVariantMap ¶meters = QVariantMap())
Inicia una solicitud de credenciales de token utilizando el método de solicitud « operation ». La URL de la solicitud es url y el « parameters » deberá codificarse y enviarse durante la solicitud. El par de cadenas « temporaryToken » se utiliza para identificar y firmar la solicitud.
Véase también: El protocolo OAuth 1.0: Credenciales de token
void QOAuth1::setClientCredentials(const std::pair<QString, QString> &clientCredentials)
Establece « clientCredentials » como el par de « QString » que se utiliza para identificar la aplicación y firmar las solicitudes enviadas al servidor web.
Véase también clientCredentials().
void QOAuth1::setClientCredentials(const QString &clientIdentifier, const QString &clientSharedSecret)
Establece clientIdentifier y clientSharedSecret como el par de QString utilizado para identificar la aplicación y firmar las solicitudes enviadas al servidor web. clientIdentifier identifica la aplicación y clientSharedSecret se utiliza para firmar las solicitudes.
Véase también clientCredentials().
void QOAuth1::setClientSharedSecret(const QString &clientSharedSecret)
Establece clientSharedSecret como la cadena utilizada para firmar las solicitudes enviadas al servidor web.
Véase también clientSharedSecret() y setClientCredentials().
void QOAuth1::setSignatureMethod(QOAuth1::SignatureMethod value)
Establece « value » como el método utilizado para firmar las solicitudes enviadas al servidor web.
Véase también signatureMethod().
void QOAuth1::setTemporaryCredentialsUrl(const QUrl &url)
Establece url como la URL para solicitar credenciales temporales con el fin de iniciar el proceso de autenticación.
Véase también temporaryCredentialsUrl().
void QOAuth1::setTokenCredentials(const std::pair<QString, QString> &tokenCredentials)
Establece « tokenCredentials » como el par « QString » utilizado para identificar y firmar las solicitudes autenticadas enviadas al servidor web.
Véase también tokenCredentials().
void QOAuth1::setTokenCredentials(const QString &token, const QString &tokenSecret)
Establece token y tokenSecret como el par de QString que se utiliza para identificar y firmar las solicitudes autenticadas dirigidas al servidor web. Una vez que el cliente recibe y almacena las credenciales del token, puede acceder a los recursos protegidos en nombre del propietario del recurso realizando solicitudes autenticadas mediante las credenciales del cliente junto con las credenciales del token recibidas.
Véase también tokenCredentials().
void QOAuth1::setTokenCredentialsUrl(const QUrl &url)
Establece url como la URL para solicitar las credenciales del token y continuar con el proceso de autenticación.
Véase también tokenCredentialsUrl().
void QOAuth1::setTokenSecret(const QString &tokenSecret)
Establece tokenSecret como el secreto del token actual que se utiliza para firmar las llamadas autenticadas al servidor web.
Véase también tokenSecret() y setTokenCredentials().
[protected] void QOAuth1::setup(QNetworkRequest *request, const QVariantMap &signingParameters, QNetworkAccessManager::Operation operation)
Se inscribe en el « request » a través de signingParameters y operation.
Se trata de una función sobrecargada.
[protected] void QOAuth1::setup(QNetworkRequest *request, const QVariantMap &signingParameters, const QByteArray &operationVerb)
Se inscribe en la « request » a través de signingParameters y operationVerb.
Se trata de una función sobrecargada.
QOAuth1::SignatureMethod QOAuth1::signatureMethod() const
Devuelve el método utilizado para firmar la solicitud enviada al servidor web.
Véase también setSignatureMethod().
[signal] void QOAuth1::signatureMethodChanged(QOAuth1::SignatureMethod method)
Se emite cuando cambia la firma method.
Véase también signatureMethod() y setSignatureMethod().
QUrl QOAuth1::temporaryCredentialsUrl() const
Devuelve la URL utilizada para solicitar credenciales temporales con el fin de iniciar el proceso de autenticación.
Véase también setTemporaryCredentialsUrl().
[signal] void QOAuth1::temporaryCredentialsUrlChanged(const QUrl &url)
Se emite cuando cambian las credenciales temporales url.
Véase también temporaryCredentialsUrl() y setTemporaryCredentialsUrl().
std::pair<QString, QString> QOAuth1::tokenCredentials() const
Devuelve el par de « QString » que se utiliza para identificar y firmar las solicitudes autenticadas enviadas al servidor web.
Véase también setTokenCredentials().
QUrl QOAuth1::tokenCredentialsUrl() const
Devuelve la URL utilizada para solicitar las credenciales del token con el fin de continuar el proceso de autenticación.
Véase también setTokenCredentialsUrl().
[signal] void QOAuth1::tokenCredentialsUrlChanged(const QUrl &url)
Se emite cuando cambian las credenciales del token url.
Véase también tokenCredentialsUrl() y setTokenCredentialsUrl().
QString QOAuth1::tokenSecret() const
Devuelve el secreto del token actual que se utiliza para firmar las solicitudes autenticadas enviadas al servidor web.
Véase también setTokenSecret() y tokenCredentials().
[signal] void QOAuth1::tokenSecretChanged(const QString &token)
Se emite cuando cambia el secreto del token token.
Véanse también tokenSecret(), setTokenSecret() y setTokenCredentials().
© 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.