QAbstractOAuth2 Class

Dokumentation zu den Eigenschaften

[since 6.9] autoRefresh : bool

Diese Eigenschaft aktiviert oder deaktiviert die automatische Aktualisierung des Zugriffstokens.

Diese Eigenschaft aktiviert oder deaktiviert die automatische Aktualisierung des Zugriffstokens. Dies ist nützlich für Anwendungen, die eine unterbrechungsfreie Autorisierung ohne Benutzereingriff erfordern.

Wenn diese Eigenschaft auf „ true “ gesetzt ist, wird „ refreshTokens()“ automatisch aufgerufen, sobald das Token bald abläuft und ein gültiges „ refreshToken “ vorhanden ist.

Diese Aufzählung wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch „ refreshLeadTime “ und „ accessTokenAboutToExpire()“.

clientIdentifierSharedKey : QString

Diese Eigenschaft enthält den gemeinsamen Schlüssel des Clients, der als Passwort verwendet wird, wenn der Server eine Authentifizierung verlangt, um das Token anzufordern.

Zugriffsfunktionen:

Benachrichtigungssignal:

[read-only] expiration : QDateTime

Diese Eigenschaft enthält die Ablaufzeit des aktuellen Zugriffstokens. Ein ungültiger Wert bedeutet, dass der Autorisierungsserver keine gültige Ablaufzeit angegeben hat.

Zugriffsfunktionen:

Benachrichtigungssignal:

Siehe auch „ QDateTime::isValid()“.

[read-only, since 6.9] grantedScopeTokens : QSet<QByteArray>

Diese Eigenschaft enthält den vom Autorisierungsserver gewährten Geltungsbereich.

Der angeforderte und der gewährte Geltungsbereich können voneinander abweichen. Der Endbenutzer hat sich möglicherweise dafür entschieden, nur einen Teil des Geltungsbereichs zu gewähren, oder serverseitige Richtlinien können diesen ändern. Die Anwendung sollte auf dieses Szenario vorbereitet sein und den gewährten Geltungsbereich überprüfen, um festzustellen, ob sich dies auf die Anwendungslogik auswirkt.

Der Server kann gemäß RFC 6749 die Angabe des gewährten Geltungsbereichs gänzlich unterlassen. In diesem Fall geht die Implementierung davon aus, dass der gewährte Geltungsbereich mit dem angeforderten übereinstimmt.

Diese Aufzählung wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch QAbstractOAuth2::requestedScopeTokens.

[read-only, since 6.9] idToken : QString

Diese Eigenschaft enthält das empfangene OpenID Connect-ID-Token.

Diese Enumeration wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch „ NonceMode “, „ nonce “ und „Qt OpenID Connect-Unterstützung“.

[since 6.9] nonce : QString

Diese Eigenschaft enthält die Zeichenfolge, die während der Authentifizierung an den Server gesendet wird. Der Nonce wird verwendet, um relevante Token-Antworten (insbesondere OpenID Connect- id_token ) der Autorisierungsphase zuzuordnen.

Der Hauptzweck des „ nonce “ besteht darin, Replay-Angriffe abzuwehren. Er stellt sicher, dass die empfangenen Token-Antworten tatsächlich auf die von der Anwendung initiierten Authentifizierungsanfragen zurückgehen, und verhindert so, dass Angreifer Token in nicht autorisierten Kontexten wiederverwenden. Daher ist es wichtig, die Nonce-Überprüfung als Teil der Token-Validierung einzubeziehen.

In der Praxis können Anbieter von Autorisierungsservern die OpenID-Connect-Anfrage ablehnen, wenn in der Autorisierungsanfrage kein Nonce angegeben ist.

Das Token selbst ist eine undurchsichtige Zeichenfolge und sollte zur Gewährleistung maximaler Kompatibilität ausschließlich URL-sichere Zeichen enthalten. Darüber hinaus muss das Token eine ausreichende Entropie aufweisen , damit es für Angreifer nicht erratbar ist. Es gibt keine strengen Größenbeschränkungen für das Nonce, und Anbieter von Autorisierungsservern können eigene Mindest- und Höchstgrößen festlegen.

Während die „ nonce “ manuell festgelegt werden kann, generieren Qt-Klassen einen 32-Zeichen-Nonce- when needed, falls kein solcher festgelegt wurde.

Diese Enumeration wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch „ nonceMode “ und „Qt OpenID Connect-Unterstützung“.

[since 6.9] nonceMode : NonceMode

Diese Eigenschaft gibt den aktuellen Nonce-Modus an (ob ein Nonce verwendet wird oder nicht).

Diese Aufzählung wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch NonceMode und nonce.

[since 6.9] refreshLeadTime : std::chrono::seconds

Diese Eigenschaft legt fest, wie weit im Voraus das Signal „ accessTokenAboutToExpire()“ im Verhältnis zum Ablauf des Zugriffstokens ausgegeben wird.

Diese Eigenschaft gibt das Zeitintervall (in Sekunden) vor dem Ablauf des aktuellen Zugriffstokens an, zu dem das Signal „ accessTokenAboutToExpire()“ gesendet wird. Der für diese Eigenschaft festgelegte Wert muss eine positive Zeitdauer sein.

Dieses Intervall ermöglicht es der Anwendung, das Token rechtzeitig im Voraus zu aktualisieren, wodurch eine kontinuierliche Autorisierung ohne Unterbrechungen gewährleistet wird.

Wenn diese Eigenschaft nicht explizit festgelegt ist oder die angegebene „leadTime“ größer ist als die Lebensdauer des Tokens, wird die „leadTime“ standardmäßig auf 5 % der verbleibenden Lebensdauer des Tokens gesetzt, jedoch nicht weniger als 10 Sekunden vor Ablauf (damit genügend Zeit für die Ausführung der Aktualisierungsanfrage bleibt).

Diese Aufzählung wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch „ autoRefresh “.

refreshToken : QString

Diese Eigenschaft enthält das Aktualisierungstoken, das zum Abrufen neuer Zugriffstoken verwendet wird.

Aktualisierungstoken haben in der Regel eine längere Gültigkeitsdauer als Zugriffstoken, daher ist es sinnvoll, sie für die spätere Verwendung zu speichern.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch „ setRefreshToken()“.

[since 6.9] requestedScopeTokens : QSet<QByteArray>

Diese Eigenschaft enthält den gewünschten Geltungsbereich, der die vom Client angeforderten Berechtigungen definiert.

Diese Aufzählung wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch „ QAbstractOAuth2::grantedScopeTokens “.

[until 6.13] scope : QString

Diese Aufzählung soll in Version 6.13 als veraltet markiert werden.

Verwenden Sie stattdessen die Eigenschaften „ requestedScopeTokens “ und „ grantedScopeTokens “. Diese Eigenschaft wird in Qt 7 entfernt.

Diese Eigenschaft enthält den gewünschten Geltungsbereich, der die vom Client angeforderten Berechtigungen definiert.

Der Geltungsbereichswert wird auf den vom Autorisierungsserver gewährten Geltungsbereichswert aktualisiert. Im Falle einer leeren Geltungsbereichsantwort wird der angeforderte Geltungsbereich als gewährt angesehen und ändert sich nicht.

Die Tatsache, dass diese Eigenschaft zwei verschiedene Funktionen erfüllt – zunächst als angeforderter Geltungsbereich und später als gewährter Geltungsbereich – ist ein historisches Relikt. Für allen neuen Code wird empfohlen, QAbstractOAuth2::requestedScopeTokens und QAbstractOAuth2::grantedScopeTokens zu verwenden.

Zugriffsfunktionen:

Notifier-Signal:

Siehe auch QAbstractOAuth2::grantedScopeTokens und QAbstractOAuth2::requestedScopeTokens.

state : QString

Diese Eigenschaft enthält die Zeichenfolge, die während der Authentifizierung an den Server gesendet wurde. Der Status dient dazu, die Anfrage zu identifizieren und zu validieren, wenn der Callback empfangen wird.

Wurde zu Beginn des Autorisierungsablaufs kein Status festgelegt, wird automatisch ein zufälliger Status mit 32 Zeichen generiert. Dies ist die Standardeinstellung und die empfohlene Vorgehensweise.

Dieser Status ist der primäre Schutz vor Cross-Site-Request-Forgery und sollte daher ein ausreichendes Maß an Zufälligkeit aufweisen. Wenn Sie ihn manuell festlegen, sollten Sie mindestens 32 zufällige Zeichen verwenden.

Bestimmte Zeichen sind im „state“-Element unzulässig (siehe RFC 6749). Die Verwendung unzulässiger Zeichen könnte zu einer unbeabsichtigten Statusdiskrepanz und einer fehlgeschlagenen OAuth-2-Autorisierung führen. Wenn Sie daher versuchen, einen Wert festzulegen, der unzulässige Zeichen enthält, wird der Status ignoriert und eine Warnung protokolliert.

Zugriffsfunktionen:

Benachrichtigungssignal:

[since 6.9] tokenUrl : QUrl

Diese Eigenschaft enthält die URL des Token-Endpunkts, über den Token abgerufen werden. Je nach Anwendungsfall und Unterstützung durch den Autorisierungsserver kann es sich bei diesen Token um Zugriffstoken, Aktualisierungstoken und ID-Token handeln.

Token werden in der Regel abgerufen, sobald die Autorisierungsphase abgeschlossen ist, und der Token-Endpunkt kann bei Bedarf auch zum Aktualisieren von Token verwendet werden.

Beispielsweise verwendet QOAuth2AuthorizationCodeFlow diese URL, um eine Anfrage für ein Zugriffstoken zu stellen, und QOAuth2DeviceAuthorizationFlow nutzt diese URL, um ein Zugriffstoken abzufragen.

Diese Aufzählung wurde in Qt 6.9 eingeführt.

Zugriffsfunktionen:

Notifier-Signal:

userAgent : QString

Diese Eigenschaft enthält den User-Agent-Header, der zum Erstellen der Netzwerkanfragen verwendet wird.

Der Standardwert lautet „QtOAuth/1.0 (+https://www.qt.io)“.

Zugriffsfunktionen:

Notifier-Signal:

class MyClass : public QAbstractOAuth2
{
    ...
protected Q_SLOTS:
    void refreshTokensImplementation() QT7_ONLY(override);
};

void MyClass::refreshTokensImplementation()
{
    qDebug("refresh");
}