QOAuth1 Class
Die Klasse QOAuth1 bietet eine Implementierung des OAuth 1 Protokolls. Mehr...
Kopfzeile: | #include <QOAuth1> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS NetworkAuth) target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth) |
qmake: | QT += networkauth |
Vererbt: | QAbstractOAuth |
Öffentliche Typen
enum class | SignatureMethod { Hmac_Sha1, Rsa_Sha1, PlainText } |
Öffentliche Funktionen
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 |
Reimplementierte öffentliche Funktionen
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 |
Öffentliche Slots
void | continueGrantWithVerifier(const QString &verifier) |
virtual void | grant() override |
Geschützte Funktionen
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) |
Statische geschützte Mitglieder
QByteArray | generateAuthorizationHeader(const QVariantMap &oauthParams) |
QByteArray | nonce() |
Detaillierte Beschreibung
QOAuth1 bietet eine Methode für Clients, um im Namen eines Ressourcenbesitzers (z. B. eines anderen Clients oder eines Endbenutzers) auf Serverressourcen zuzugreifen. Es bietet auch einen Prozess für Endbenutzer, um den Zugriff Dritter auf ihre Serverressourcen zu autorisieren, ohne ihre Anmeldeinformationen (typischerweise ein Paar aus Benutzername und Kennwort) weiterzugeben, indem sie Benutzer-Agent-Umleitungen verwenden.
QOAuth1 verwendet Token, um die dem Client vom Ressourceneigentümer gewährte Autorisierung darzustellen. Normalerweise werden Token-Zugangsdaten vom Server auf Anfrage des Ressourcenbesitzers ausgestellt, nachdem die Identität des Ressourcenbesitzers authentifiziert wurde (normalerweise mit einem Benutzernamen und einem Passwort).
Bei der Anforderung von temporären Anmeldedaten authentifiziert sich der Client nur mit den Client-Anmeldedaten. Bei der Token-Anforderung authentifiziert sich der Client mit den Client-Anmeldedaten und den temporären Anmeldedaten. Sobald der Client die Token-Anmeldeinformationen erhalten und gespeichert hat, kann er im Namen des Ressourcenbesitzers auf geschützte Ressourcen zugreifen, indem er authentifizierte Anfragen mit den Client-Anmeldeinformationen und den erhaltenen Token-Anmeldeinformationen stellt.
Dokumentation der Mitgliedstypen
enum class QOAuth1::SignatureMethod
Gibt die Signaturmethode an, die zum Signieren von Anfragen verwendet werden soll.
Konstante | Wert | Beschreibung |
---|---|---|
QOAuth1::SignatureMethod::Hmac_Sha1 | 0 | HMAC-SHA1-Signaturmethode. |
QOAuth1::SignatureMethod::Rsa_Sha1 | 1 | RSA-SHA1-Signaturmethode (nicht unterstützt). |
QOAuth1::SignatureMethod::PlainText | 2 | PLAINTEXT-Signaturverfahren. |
Dokumentation der Mitgliedsfunktionen
[explicit]
QOAuth1::QOAuth1(QObject *parent = nullptr)
Konstruiert ein QOAuth1-Objekt mit dem übergeordneten Objekt parent.
[explicit]
QOAuth1::QOAuth1(QNetworkAccessManager *manager, QObject *parent = nullptr)
Konstruiert ein QOAuth1-Objekt mit dem übergeordneten Objekt parent und verwendet manager für den Zugriff auf das Netzwerk.
QOAuth1::QOAuth1(const QString &clientIdentifier, const QString &clientSharedSecret, QNetworkAccessManager *manager, QObject *parent = nullptr)
Konstruiert ein QOAuth1-Objekt mit dem übergeordneten Objekt parent und verwendet manager für den Zugriff auf das Netzwerk. Legt außerdem clientIdentifier und clientSharedSecret fest, um die Aufrufe an den Webserver zu signieren und die Anwendung zu identifizieren.
std::pair<QString, QString> QOAuth1::clientCredentials() const
Gibt das Paar QString zurück, das zur Identifizierung der Anwendung und zum Signieren von Anfragen an den Webserver verwendet wird.
Siehe auch setClientCredentials().
QString QOAuth1::clientSharedSecret() const
Gibt das aktuelle gemeinsame Geheimnis zurück, das zum Signieren von Anfragen an den Webserver verwendet wird.
Siehe auch setClientSharedSecret() und clientCredentials().
[slot]
void QOAuth1::continueGrantWithVerifier(const QString &verifier)
Setzt den Fluss der umleitungsbasierten Autorisierung mit verifier fort. Rufen Sie diese Funktion auf, wenn Sie einen Out-of-Band-Antwort-Handler verwenden, um den vom Webserver bereitgestellten Verifier zu liefern.
[override virtual]
QNetworkReply *QOAuth1::deleteResource(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplements: QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap ¶meters).
Sendet eine authentifizierte DELETE-Anfrage und gibt eine neue QNetworkReply zurück. Die url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: DELETE
[static protected]
QByteArray QOAuth1::generateAuthorizationHeader(const QVariantMap &oauthParams)
Erzeugt einen Autorisierungskopf mit oauthParams.
Siehe auch: Das OAuth 1.0 Protokoll: Autorisierungs-Kopfzeile
[override virtual]
QNetworkReply *QOAuth1::get(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplements: QAbstractOAuth::get(const QUrl &url, const QVariantMap ¶meters).
Sendet eine authentifizierte GET-Anfrage und gibt eine neue QNetworkReply zurück. Die url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: GET
[override virtual slot]
void QOAuth1::grant()
Reimplements: QAbstractOAuth::grant().
Startet den Fluss der umleitungsbasierten Autorisierung.
Hinweis: Bei einem Out-of-Band-Antwort-Handler wird nach dem Aufruf dieser Funktion eine Überprüfungszeichenfolge empfangen; übergeben Sie diese an continueGrantWithVerifier(), um den Erteilungsprozess fortzusetzen.
Siehe auch: Das OAuth 1.0 Protokoll: Redirection-Based Authorization
Siehe auch continueGrantWithVerifier().
[override virtual]
QNetworkReply *QOAuth1::head(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplements: QAbstractOAuth::head(const QUrl &url, const QVariantMap ¶meters).
Sendet eine authentifizierte HEAD-Anfrage und gibt eine neue QNetworkReply zurück. Die url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: HEAD
[static protected]
QByteArray QOAuth1::nonce()
Erzeugt eine Nonce.
Siehe auch: Das OAuth 1.0 Protokoll: Nonce und Zeitstempel
[override virtual]
QNetworkReply *QOAuth1::post(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplements: QAbstractOAuth::post(const QUrl &url, const QVariantMap ¶meters).
Sendet eine authentifizierte POST-Anfrage und gibt eine neue QNetworkReply zurück. Die url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: POST
[override virtual]
void QOAuth1::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())
Reimplements: QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body).
[override virtual]
QNetworkReply *QOAuth1::put(const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Reimplements: QAbstractOAuth::put(const QUrl &url, const QVariantMap ¶meters).
Sendet eine authentifizierte PUT-Anfrage und gibt eine neue QNetworkReply zurück. Die url und parameters werden verwendet, um die Anfrage zu erstellen.
Siehe auch: Hypertext Transfer Protocol - HTTP/1.1: PUT
[protected]
QNetworkReply *QOAuth1::requestTemporaryCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const QVariantMap ¶meters = QVariantMap())
Startet eine Anfrage für temporäre Anmeldeinformationen mit der Anfragemethode operation. Die Anfrage-URL lautet url und die parameters wird kodiert und während der Anfrage gesendet.
Siehe auch: Das OAuth 1.0-Protokoll: Temporäre Berechtigungsnachweise
[protected]
QNetworkReply *QOAuth1::requestTokenCredentials(QNetworkAccessManager::Operation operation, const QUrl &url, const std::pair<QString, QString> &temporaryToken, const QVariantMap ¶meters = QVariantMap())
Startet eine Anforderung von Token-Anmeldeinformationen mit der Anforderungsmethode operation. Die Anfrage-URL lautet url und die parameters wird kodiert und während der Anfrage gesendet. Das Zeichenfolgenpaar temporaryToken wird zur Identifizierung und Signierung der Anfrage verwendet.
Siehe auch: Das OAuth 1.0-Protokoll: Token Credentials
void QOAuth1::setClientCredentials(const std::pair<QString, QString> &clientCredentials)
Legt clientCredentials als das Paar von QString fest, das zur Identifizierung der Anwendung und zum Signieren von Anfragen an den Webserver verwendet wird.
Siehe auch clientCredentials().
void QOAuth1::setClientCredentials(const QString &clientIdentifier, const QString &clientSharedSecret)
Legt clientIdentifier und clientSharedSecret als das Paar von QString fest, das zur Identifizierung der Anwendung und zum Signieren von Anfragen an den Webserver verwendet wird. clientIdentifier identifiziert die Anwendung und clientSharedSecret wird zum Signieren von Anfragen verwendet.
Siehe auch clientCredentials().
void QOAuth1::setClientSharedSecret(const QString &clientSharedSecret)
Legt clientSharedSecret als Zeichenkette fest, mit der die Anfragen an den Webserver signiert werden.
Siehe auch clientSharedSecret() und setClientCredentials().
void QOAuth1::setSignatureMethod(QOAuth1::SignatureMethod value)
Legt value als die Methode fest, mit der Anfragen an den Webserver signiert werden.
Siehe auch signatureMethod().
void QOAuth1::setTemporaryCredentialsUrl(const QUrl &url)
Legt url als URL fest, um temporäre Anmeldedaten anzufordern und den Authentifizierungsprozess zu starten.
Siehe auch temporaryCredentialsUrl().
void QOAuth1::setTokenCredentials(const std::pair<QString, QString> &tokenCredentials)
Legt tokenCredentials als das Paar von QString fest, das zur Identifizierung und Signierung authentifizierter Anfragen an den Webserver verwendet wird.
Siehe auch tokenCredentials().
void QOAuth1::setTokenCredentials(const QString &token, const QString &tokenSecret)
Legt token und tokenSecret als das Paar von QString fest, das zur Identifizierung und Signierung authentifizierter Anfragen an den Webserver verwendet wird. Sobald der Client die Token-Zugangsdaten erhält und speichert, kann er im Namen des Ressourcenbesitzers auf geschützte Ressourcen zugreifen, indem er authentifizierte Anfragen unter Verwendung der Client-Zugangsdaten zusammen mit den erhaltenen Token-Zugangsdaten stellt.
Siehe auch tokenCredentials().
void QOAuth1::setTokenCredentialsUrl(const QUrl &url)
Legt url als URL fest, um die Token-Anmeldeinformationen anzufordern und den Authentifizierungsprozess fortzusetzen.
Siehe auch tokenCredentialsUrl().
void QOAuth1::setTokenSecret(const QString &tokenSecret)
Legt tokenSecret als das aktuelle Token-Geheimnis fest, das zum Signieren von authentifizierten Aufrufen des Webservers verwendet wird.
Siehe auch tokenSecret() und setTokenCredentials().
[protected]
void QOAuth1::setup(QNetworkRequest *request, const QVariantMap &signingParameters, QNetworkAccessManager::Operation operation)
Unterschreibt die request mit signingParameters und operation.
Dies ist eine überladene Funktion.
[protected]
void QOAuth1::setup(QNetworkRequest *request, const QVariantMap &signingParameters, const QByteArray &operationVerb)
Unterschreibt die request mit signingParameters und operationVerb.
Dies ist eine überladene Funktion.
QOAuth1::SignatureMethod QOAuth1::signatureMethod() const
Gibt die Methode zurück, mit der die Anfrage an den Webserver signiert wurde.
Siehe auch setSignatureMethod().
QUrl QOAuth1::temporaryCredentialsUrl() const
Gibt die URL zurück, mit der temporäre Anmeldeinformationen angefordert wurden, um den Authentifizierungsprozess zu starten.
Siehe auch setTemporaryCredentialsUrl().
std::pair<QString, QString> QOAuth1::tokenCredentials() const
Gibt das Paar QString zurück, das verwendet wird, um authentifizierte Anfragen an den Webserver zu identifizieren und zu signieren.
Siehe auch setTokenCredentials().
QUrl QOAuth1::tokenCredentialsUrl() const
Gibt die URL zurück, mit der Token-Anmeldeinformationen angefordert werden, um den Authentifizierungsprozess fortzusetzen.
Siehe auch setTokenCredentialsUrl().
QString QOAuth1::tokenSecret() const
Gibt das aktuelle Token-Geheimnis zurück, das zum Signieren authentifizierter Anfragen an den Webserver verwendet wird.
Siehe auch setTokenSecret() und tokenCredentials().
© 2025 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.