QOAuth1Signature Class
Implémente les méthodes de signature OAuth 1. En savoir plus...
| En-tête : | #include <QOAuth1Signature> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake : | QT += networkauth |
Types publics
| enum class | HttpRequestMethod { Head, Get, Put, Post, Delete, …, Unknown } |
Fonctions publiques
| 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) |
Membres publics statiques
| QByteArray | plainText(const QString &clientSharedKey, const QString &tokenSecret) |
Description détaillée
Les requêtes authentifiées via OAuth peuvent comporter deux ensembles d’informations d’identification : celles transmises via le paramètre « oauth_consumer_key » et celles contenues dans le paramètre « oauth_token ». Afin que le serveur puisse vérifier l’authenticité de la requête et empêcher tout accès non autorisé, le client doit prouver qu’il est bien le propriétaire légitime des identifiants. Pour ce faire, il utilise la partie « secret partagé » (ou clé RSA) de chaque jeu d’identifiants.
OAuth spécifie trois méthodes permettant au client d’établir sa propriété légitime des informations d’identification : « HMAC-SHA1 », « RSA-SHA1 » et « PLAINTEXT ». Chacune génère une « signature » avec laquelle la requête est « signée » ; les deux premières utilisent un condensé des données signées pour générer cette signature, ce qui n’est pas le cas de la dernière. La méthode « RSA-SHA1 » n’est pas prise en charge ici ; elle utiliserait une clé RSA plutôt que le secret partagé associé aux identifiants du client.
Documentation sur les types de membres
enum class QOAuth1Signature::HttpRequestMethod
Indique la méthode de requête HTTP.
| Constante | Valeur | Description |
|---|---|---|
QOAuth1Signature::HttpRequestMethod::Head | 1 | Méthode HEAD. |
QOAuth1Signature::HttpRequestMethod::Get | 2 | Méthode GET. |
QOAuth1Signature::HttpRequestMethod::Put | 3 | Méthode PUT. |
QOAuth1Signature::HttpRequestMethod::Post | 4 | Méthode POST. |
QOAuth1Signature::HttpRequestMethod::Delete | 5 | Méthode DELETE. |
QOAuth1Signature::HttpRequestMethod::Custom | 6 | Identifie une méthode personnalisée. |
QOAuth1Signature::HttpRequestMethod::Unknown | 0 | Méthode non définie. |
Documentation sur les fonctions membres
[explicit] QOAuth1Signature::QOAuth1Signature(const QUrl &url = QUrl(), QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {})
Crée une signature QOAuth1Signature en utilisant
- url comme adresse de destination
- method comme méthode HTTP utilisée pour envoyer la requête
- et l'parameters utilisateur fournie pour enrichir la requête.
QOAuth1Signature::QOAuth1Signature(const QUrl &url, const QString &clientSharedKey, const QString &tokenSecret, QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {})
Crée une signature QOAuth1Signature en utilisant
- url comme adresse de destination
- clientSharedKey comme jeton utilisateur utilisé pour vérifier la signature
- tokenSecret comme jeton négocié utilisé pour vérifier la signature
- method comme méthode HTTP utilisée pour envoyer la requête
- et l'parameters s utilisateur fournies pour enrichir la requête.
QOAuth1Signature::QOAuth1Signature(const QOAuth1Signature &other)
Crée une copie de other.
QOAuth1Signature::QOAuth1Signature(QOAuth1Signature &&other)
Crée une instance de `QOAuth1Signature` en reprenant les données privées utilisées par ` other `.
[noexcept] QOAuth1Signature::~QOAuth1Signature()
Supprime l'QOAuth1Signature.
void QOAuth1Signature::addRequestBody(const QUrlQuery &body)
Ajoute l'body s de la requête à la signature. Lorsque le corps d'une requête POST contient des arguments, ceux-ci doivent être inclus dans les données signées.
QString QOAuth1Signature::clientSharedKey() const
Renvoie le secret utilisateur utilisé pour générer la signature.
Voir également setClientSharedKey().
QByteArray QOAuth1Signature::customMethodString() const
Renvoie la chaîne de caractères de la méthode personnalisée.
Voir également setCustomMethodString() et httpRequestMethod().
QByteArray QOAuth1Signature::hmacSha1() const
Génère la signature HMAC-SHA1 à l'aide du secret partagé du client et, le cas échéant, du secret du jeton.
QOAuth1Signature::HttpRequestMethod QOAuth1Signature::httpRequestMethod() const
Renvoie la méthode de la requête.
Voir également setHttpRequestMethod().
void QOAuth1Signature::insert(const QString &key, const QVariant &value)
Insère une nouvelle paire key, value dans la signature. Lorsque le corps d'une requête POST contient des arguments, ceux-ci doivent être inclus dans les données signées.
QList<QString> QOAuth1Signature::keys() const
Récupère la liste des clés des paramètres inclus dans les données signées.
QMultiMap<QString, QVariant> QOAuth1Signature::parameters() const
Renvoie les paramètres.
Voir aussi setParameters().
QByteArray QOAuth1Signature::plainText() const
Génère la signature en texte clair.
[static] QByteArray QOAuth1Signature::plainText(const QString &clientSharedKey, const QString &tokenSecret)
Génère une signature en TEXTE CLAIR à partir du secret client clientSharedKey et du secret de jeton tokenSecret.
QByteArray QOAuth1Signature::rsaSha1() const
Génère la signature RSA-SHA1.
Remarque : cette méthode n'estactuellement pas prise en charge.
void QOAuth1Signature::setClientSharedKey(const QString &secret)
Définit ` secret ` comme secret utilisateur utilisé pour générer la signature.
Voir également clientSharedKey().
void QOAuth1Signature::setCustomMethodString(const QByteArray &verb)
Définit une méthode de requête personnalisée. Définit l'httpRequestMethod e sur QOAuth1Signature::HttpRequestMethod::Custom et enregistre l'verb e afin de l'utiliser pour la génération de la signature.
Remarque : l’utilisation de cette méthode est obligatoire lorsque vous travaillez avec des verbes personnalisés. Se contenter de définir la méthode de requête échouera, car la signature doit connaître le verbe réel.
Voir également customMethodString(), setHttpRequestMethod() et HttpRequestMethod.
void QOAuth1Signature::setHttpRequestMethod(QOAuth1Signature::HttpRequestMethod method)
Définit l'method de la requête.
Voir également httpRequestMethod().
void QOAuth1Signature::setParameters(const QMultiMap<QString, QVariant> ¶meters)
Définit la propriété « parameters ».
Voir aussi parameters().
void QOAuth1Signature::setTokenSecret(const QString &secret)
Définit secret comme clé secrète négociée utilisée pour générer la signature.
Voir également tokenSecret().
void QOAuth1Signature::setUrl(const QUrl &url)
Définit l'URL sur url.
Voir également url().
void QOAuth1Signature::swap(QOAuth1Signature &other)
Remplace la signature other par cette signature. Cette opération est très rapide et ne rencontre jamais d'échec.
QVariant QOAuth1Signature::take(const QString &key)
Supprime « key » et toute valeur associée des données signées.
QString QOAuth1Signature::tokenSecret() const
Renvoie le secret négocié utilisé pour générer la signature.
Voir également setTokenSecret().
QUrl QOAuth1Signature::url() const
Renvoie l'URL.
Voir aussi setUrl().
QVariant QOAuth1Signature::value(const QString &key, const QVariant &defaultValue = QVariant()) const
Renvoie la valeur associée à ` key`, si elle est présente dans les données signées ; sinon, renvoie ` defaultValue`.
QOAuth1Signature &QOAuth1Signature::operator=(QOAuth1Signature &&other)
La fonction « move-assign » attribue la valeur « other » à cette signature et renvoie une référence à cette valeur « 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.
