QOAuth1Signature Class
Implementa los métodos de firma de OAuth 1. Más...
| Cabecera: | #include <QOAuth1Signature> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth)target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
Tipos Públicos
| enum class | HttpRequestMethod { Head, Get, Put, Post, Delete, …, Unknown } |
Funciones públicas
| QOAuth1Signature(const QUrl &url = QUrl(), QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {}) | |
| QOAuth1Signature(const QUrl &url, const QString &clientSharedKey, const QString &tokenSecret, QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {}) | |
| QOAuth1Signature(const QOAuth1Signature &other) | |
| QOAuth1Signature(QOAuth1Signature &&other) | |
| ~QOAuth1Signature() | |
| void | addRequestBody(const QUrlQuery &body) |
| QString | clientSharedKey() const |
| QByteArray | customMethodString() const |
| QByteArray | hmacSha1() const |
| QOAuth1Signature::HttpRequestMethod | httpRequestMethod() const |
| void | insert(const QString &key, const QVariant &value) |
| QList<QString> | keys() const |
| QMultiMap<QString, QVariant> | parameters() const |
| QByteArray | plainText() const |
| QByteArray | rsaSha1() const |
| void | setClientSharedKey(const QString &secret) |
| void | setCustomMethodString(const QByteArray &verb) |
| void | setHttpRequestMethod(QOAuth1Signature::HttpRequestMethod method) |
| void | setParameters(const QMultiMap<QString, QVariant> ¶meters) |
| void | setTokenSecret(const QString &secret) |
| void | setUrl(const QUrl &url) |
| void | swap(QOAuth1Signature &other) |
| QVariant | take(const QString &key) |
| QString | tokenSecret() const |
| QUrl | url() const |
| QVariant | value(const QString &key, const QVariant &defaultValue = QVariant()) const |
| QOAuth1Signature & | operator=(QOAuth1Signature &&other) |
Miembros públicos estáticos
| QByteArray | plainText(const QString &clientSharedKey, const QString &tokenSecret) |
Descripción detallada
Las peticiones autenticadas por OAuth pueden tener dos conjuntos de credenciales: las pasadas a través del parámetro "oauth_consumer_key" y las del parámetro "oauth_token". Para que el servidor pueda verificar la autenticidad de la solicitud y evitar accesos no autorizados, el cliente debe demostrar que es el propietario legítimo de las credenciales. Para ello se utiliza la parte de secreto compartido (o clave RSA) de cada conjunto de credenciales.
OAuth especifica tres métodos para que el cliente establezca su propiedad legítima de las credenciales: "HMAC-SHA1", "RSA-SHA1" y "PLAINTEXT". Cada uno de ellos genera una "firma" con la que se "firma" la solicitud; los dos primeros utilizan un compendio de los datos firmados para generarla, aunque el último no lo hace. El método "RSA-SHA1" no se admite aquí; utilizaría una clave RSA en lugar del secreto compartido asociado a las credenciales del cliente.
Documentación del tipo de miembro
enum class QOAuth1Signature::HttpRequestMethod
Indica el método de petición HTTP.
| Constante | Valor | Descripción |
|---|---|---|
QOAuth1Signature::HttpRequestMethod::Head | 1 | Método HEAD. |
QOAuth1Signature::HttpRequestMethod::Get | 2 | Método GET. |
QOAuth1Signature::HttpRequestMethod::Put | 3 | Método PUT. |
QOAuth1Signature::HttpRequestMethod::Post | 4 | Método POST. |
QOAuth1Signature::HttpRequestMethod::Delete | 5 | Método DELETE. |
QOAuth1Signature::HttpRequestMethod::Custom | 6 | Identifica un método personalizado. |
QOAuth1Signature::HttpRequestMethod::Unknown | 0 | Método no definido. |
Documentación de las funciones miembro
[explicit] QOAuth1Signature::QOAuth1Signature(const QUrl &url = QUrl(), QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {})
Crea una QOAuth1Signature utilizando
- url como dirección de destino
- method como método HTTP utilizado para enviar la solicitud
- y el usuario dado parameters para aumentar la solicitud.
QOAuth1Signature::QOAuth1Signature(const QUrl &url, const QString &clientSharedKey, const QString &tokenSecret, QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {})
Crea una QOAuth1Signature utilizando
- url como dirección de destino
- clientSharedKey como el token de usuario utilizado para verificar la firma
- tokenSecret como el token negociado utilizado para verificar la firma
- method como el método HTTP utilizado para enviar la solicitud
- y el usuario dado parameters para aumentar la solicitud.
QOAuth1Signature::QOAuth1Signature(const QOAuth1Signature &other)
Crea una copia de other.
QOAuth1Signature::QOAuth1Signature(QOAuth1Signature &&other)
Move-construye una instancia de QOAuth1Signature, tomando los datos privados que other estaba utilizando.
[noexcept] QOAuth1Signature::~QOAuth1Signature()
Destruye el QOAuth1Signature.
void QOAuth1Signature::addRequestBody(const QUrlQuery &body)
Añade la petición body a la firma. Cuando el cuerpo de una solicitud POST contiene argumentos, estos deben incluirse en los datos firmados.
QString QOAuth1Signature::clientSharedKey() const
Devuelve el secreto de usuario utilizado para generar la firma.
Véase también setClientSharedKey().
QByteArray QOAuth1Signature::customMethodString() const
Devuelve la cadena del método personalizado.
Véase también setCustomMethodString() y httpRequestMethod().
QByteArray QOAuth1Signature::hmacSha1() const
Genera la firma HMAC-SHA1 utilizando el secreto compartido del cliente y, si está disponible, el secreto del token.
QOAuth1Signature::HttpRequestMethod QOAuth1Signature::httpRequestMethod() const
Devuelve el método de solicitud.
Véase también setHttpRequestMethod().
void QOAuth1Signature::insert(const QString &key, const QVariant &value)
Inserta un nuevo par key, value en la firma. Cuando el cuerpo de una solicitud POST contiene argumentos, estos deben incluirse en los datos firmados.
QList<QString> QOAuth1Signature::keys() const
Recupera la lista de claves de los parámetros incluidos en los datos firmados.
QMultiMap<QString, QVariant> QOAuth1Signature::parameters() const
Devuelve los parámetros.
Véase también setParameters().
QByteArray QOAuth1Signature::plainText() const
Genera la firma PLAINTEXT.
[static] QByteArray QOAuth1Signature::plainText(const QString &clientSharedKey, const QString &tokenSecret)
Genera una firma PLAINTEXT a partir del secreto del cliente clientSharedKey y el secreto del token tokenSecret.
QByteArray QOAuth1Signature::rsaSha1() const
Genera la firma RSA-SHA1.
Nota: Actualmente este método no está soportado.
void QOAuth1Signature::setClientSharedKey(const QString &secret)
Establece secret como el secreto de usuario utilizado para generar la firma.
Véase también clientSharedKey().
void QOAuth1Signature::setCustomMethodString(const QByteArray &verb)
Establece un método de petición personalizado. Establecerá el httpRequestMethod a QOAuth1Signature::HttpRequestMethod::Custom y almacenará el verb para usarlo en la generación de la firma.
Nota: Es necesario utilizar este método cuando se trabaja con verbos personalizados. Establecer sólo el método de solicitud fallará, ya que la firma necesita conocer el verbo real.
Véase también customMethodString(), setHttpRequestMethod(), y HttpRequestMethod.
void QOAuth1Signature::setHttpRequestMethod(QOAuth1Signature::HttpRequestMethod method)
Establece la petición method.
Véase también httpRequestMethod().
void QOAuth1Signature::setParameters(const QMultiMap<QString, QVariant> ¶meters)
Establece la dirección parameters.
Véase también parameters().
void QOAuth1Signature::setTokenSecret(const QString &secret)
Establece secret como el secreto negociado utilizado para generar la firma.
Véase también tokenSecret().
void QOAuth1Signature::setUrl(const QUrl &url)
Establece la URL en url.
Véase también url().
void QOAuth1Signature::swap(QOAuth1Signature &other)
Intercambia la firma other con esta firma. Esta operación es muy rápida y nunca falla.
QVariant QOAuth1Signature::take(const QString &key)
Elimina key y cualquier valor asociado de los datos firmados.
QString QOAuth1Signature::tokenSecret() const
Devuelve el secreto negociado utilizado para generar la firma.
Véase también setTokenSecret().
QUrl QOAuth1Signature::url() const
Devuelve la URL.
Véase también setUrl().
QVariant QOAuth1Signature::value(const QString &key, const QVariant &defaultValue = QVariant()) const
Devuelve el valor asociado a key, si está presente en los datos con signo, en caso contrario defaultValue.
QOAuth1Signature &QOAuth1Signature::operator=(QOAuth1Signature &&other)
Move-asigna other a esta firma y devuelve una referencia a este QOAuth1Signature.
© 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.
