QOAuth1Signature Class
Implementiert OAuth-1-Signaturmethoden. Mehr...
| Header: | #include <QOAuth1Signature> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
| qmake: | QT += networkauth |
Öffentliche Typen
| enum class | HttpRequestMethod { Head, Get, Put, Post, Delete, …, Unknown } |
Öffentliche Funktionen
| 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) |
Statische öffentliche Elemente
| QByteArray | plainText(const QString &clientSharedKey, const QString &tokenSecret) |
Ausführliche Beschreibung
OAuth-authentifizierte Anfragen können zwei Sätze von Anmeldeinformationen enthalten: diejenigen, die über den Parameter „oauth_consumer_key“ übergeben werden, und diejenigen im Parameter „oauth_token“. Damit der Server die Echtheit der Anfrage überprüfen und unbefugten Zugriff verhindern kann, muss der Client nachweisen, dass er der rechtmäßige Eigentümer der Anmeldedaten ist. Dies geschieht mithilfe des Shared-Secret-Teils (oder des RSA-Schlüssels) jedes Satzes von Anmeldedaten.
OAuth legt drei Methoden fest, mit denen der Client sein rechtmäßiges Eigentum an den Anmeldedaten nachweisen kann: „HMAC-SHA1“, „RSA-SHA1“ und „PLAINTEXT“. Jede Methode erzeugt eine „Signatur“, mit der die Anfrage „signiert“ wird; die ersten beiden verwenden dabei einen Digest der signierten Daten, die letzte Methode hingegen nicht. Die „RSA-SHA1“-Methode wird hier nicht unterstützt; sie würde einen RSA-Schlüssel anstelle des mit den Client-Anmeldedaten verknüpften gemeinsamen Geheimnisses verwenden.
Dokumentation zu Mitgliedstypen
enum class QOAuth1Signature::HttpRequestMethod
Gibt die HTTP-Anfragemethode an.
| Konstante | Wert | Beschreibung |
|---|---|---|
QOAuth1Signature::HttpRequestMethod::Head | 1 | HEAD-Methode. |
QOAuth1Signature::HttpRequestMethod::Get | 2 | GET-Methode. |
QOAuth1Signature::HttpRequestMethod::Put | 3 | PUT-Methode. |
QOAuth1Signature::HttpRequestMethod::Post | 4 | POST-Methode. |
QOAuth1Signature::HttpRequestMethod::Delete | 5 | DELETE-Methode. |
QOAuth1Signature::HttpRequestMethod::Custom | 6 | Bezeichnet eine benutzerdefinierte Methode. |
QOAuth1Signature::HttpRequestMethod::Unknown | 0 | Methode nicht festgelegt. |
Dokumentation zu Mitgliedsfunktionen
[explicit] QOAuth1Signature::QOAuth1Signature(const QUrl &url = QUrl(), QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {})
Erstellt eine QOAuth1Signature unter Verwendung
- url als Zieladresse
- method als die zum Senden der Anfrage verwendete HTTP-Methode
- und der angegebenen Benutzer parameters, um die Anfrage zu ergänzen.
QOAuth1Signature::QOAuth1Signature(const QUrl &url, const QString &clientSharedKey, const QString &tokenSecret, QOAuth1Signature::HttpRequestMethod method = HttpRequestMethod::Post, const QMultiMap<QString, QVariant> ¶meters = {})
Erstellt eine QOAuth1Signature unter Verwendung
- url als Zieladresse
- clientSharedKey als das zur Überprüfung der Signatur verwendete Benutzer-Token
- tokenSecret als ausgehandeltes Token zur Überprüfung der Signatur
- method als HTTP-Methode zum Senden der Anfrage
- und der angegebenen Benutzer- parameters, um die Anfrage zu ergänzen.
QOAuth1Signature::QOAuth1Signature(const QOAuth1Signature &other)
Erstellt eine Kopie von „ other “.
QOAuth1Signature::QOAuth1Signature(QOAuth1Signature &&other)
Erstellt eine QOAuth1Signature-Instanz und übernimmt dabei die privaten Daten, die von „ other “ verwendet wurden.
[noexcept] QOAuth1Signature::~QOAuth1Signature()
Zerstört die „ QOAuth1Signature “.
void QOAuth1Signature::addRequestBody(const QUrlQuery &body)
Fügt den Anfrage- body en zur Signatur hinzu. Wenn der Hauptteil einer POST-Anfrage Argumente enthält, sollten diese in die signierten Daten aufgenommen werden.
QString QOAuth1Signature::clientSharedKey() const
Gibt das Benutzersekret zurück, das zur Erstellung der Signatur verwendet wurde.
Siehe auch setClientSharedKey().
QByteArray QOAuth1Signature::customMethodString() const
Gibt die Zeichenfolge der benutzerdefinierten Methode zurück.
Siehe auch „ setCustomMethodString()“ und „ httpRequestMethod()“.
QByteArray QOAuth1Signature::hmacSha1() const
Erzeugt die HMAC-SHA1-Signatur unter Verwendung des gemeinsamen Geheimnisses des Clients und, sofern vorhanden, des Token-Geheimnisses.
QOAuth1Signature::HttpRequestMethod QOAuth1Signature::httpRequestMethod() const
Gibt die Anfrage-Methode zurück.
Siehe auch „ setHttpRequestMethod()“.
void QOAuth1Signature::insert(const QString &key, const QVariant &value)
Fügt ein neues Paar „ key “ und „ value “ in die Signatur ein. Wenn der Hauptteil einer POST-Anfrage Argumente enthält, sollten diese in die signierten Daten aufgenommen werden.
QList<QString> QOAuth1Signature::keys() const
Ruft die Liste der Schlüssel der Parameter ab, die in den signierten Daten enthalten sind.
QMultiMap<QString, QVariant> QOAuth1Signature::parameters() const
Gibt die Parameter zurück.
Siehe auch setParameters().
QByteArray QOAuth1Signature::plainText() const
Erzeugt die PLAINTEXT-Signatur.
[static] QByteArray QOAuth1Signature::plainText(const QString &clientSharedKey, const QString &tokenSecret)
Erzeugt eine PLAINTEXT-Signatur aus dem Client-Secret clientSharedKey und dem Token-Secret tokenSecret.
QByteArray QOAuth1Signature::rsaSha1() const
Erzeugt die RSA-SHA1-Signatur.
Hinweis: Derzeit wird diese Methode nicht unterstützt.
void QOAuth1Signature::setClientSharedKey(const QString &secret)
Legt „ secret “ als das zur Erzeugung der Signatur verwendete Benutzersekret fest.
Siehe auch clientSharedKey().
void QOAuth1Signature::setCustomMethodString(const QByteArray &verb)
Legt eine benutzerdefinierte Anfrage-Methode fest. Dabei wird „ httpRequestMethod “ auf „ QOAuth1Signature::HttpRequestMethod::Custom “ gesetzt und „ verb “ gespeichert, um diese für die Erstellung der Signatur zu verwenden.
Hinweis: Die Verwendung dieser Methode ist erforderlich, wenn mit benutzerdefinierten Verben gearbeitet wird. Das Setzen der Anfragemethode allein führt zu einem Fehler, da die Signatur das tatsächliche Verb kennen muss.
Siehe auch customMethodString(), setHttpRequestMethod() und HttpRequestMethod.
void QOAuth1Signature::setHttpRequestMethod(QOAuth1Signature::HttpRequestMethod method)
Legt den Anforderungs method fest.
Siehe auch httpRequestMethod().
void QOAuth1Signature::setParameters(const QMultiMap<QString, QVariant> ¶meters)
Legt die „ parameters “ fest.
Siehe auch parameters().
void QOAuth1Signature::setTokenSecret(const QString &secret)
Legt „ secret “ als ausgehandeltes Geheimnis fest, das zur Erzeugung der Signatur verwendet wird.
Siehe auch tokenSecret().
void QOAuth1Signature::setUrl(const QUrl &url)
Legt die URL auf url fest.
Siehe auch url().
void QOAuth1Signature::swap(QOAuth1Signature &other)
Ersetzt die Signatur „ other “ durch diese Signatur. Dieser Vorgang ist sehr schnell und schlägt niemals fehl.
QVariant QOAuth1Signature::take(const QString &key)
Entfernt „ key “ und alle damit verbundenen Werte aus den signierten Daten.
QString QOAuth1Signature::tokenSecret() const
Gibt das ausgehandelte Geheimnis zurück, das zur Erzeugung der Signatur verwendet wurde.
Siehe auch ` setTokenSecret()`.
QUrl QOAuth1Signature::url() const
Gibt die URL zurück.
Siehe auch ` setUrl()`.
QVariant QOAuth1Signature::value(const QString &key, const QVariant &defaultValue = QVariant()) const
Gibt den Wert zurück, der mit „ key “ verknüpft ist, sofern dieser in den signierten Daten vorhanden ist; andernfalls „ defaultValue “.
QOAuth1Signature &QOAuth1Signature::operator=(QOAuth1Signature &&other)
Weist „ other “ dieser Signatur zu und gibt eine Referenz auf „ QOAuth1Signature “ zurück.
© 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.
