QAbstractOAuth2 Class

Documentation sur les propriétés

[since 6.9] autoRefresh : bool

Cette propriété active ou désactive le rafraîchissement automatique du jeton d'accès.

Cette propriété active ou désactive le rafraîchissement automatique du jeton d'accès. Ceci est utile pour les applications qui requièrent une autorisation ininterrompue sans intervention de l'utilisateur.

Si cette propriété vaut true, refreshTokens() sera automatiquement appelé lorsque le jeton est sur le point d'expirer et qu'il existe un refreshToken valide.

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal Notifier :

Voir aussi refreshLeadTime et accessTokenAboutToExpire().

clientIdentifierSharedKey : QString

Cette propriété contient la clé partagée du client utilisée comme mot de passe si le serveur exige une authentification pour demander le jeton.

Fonctions d'accès :

Signal de notification :

[read-only] expiration : QDateTime

Cette propriété contient l'heure d'expiration du jeton d'accès actuel. Une valeur non valide signifie que le serveur d'autorisation n'a pas fourni d'heure d'expiration valide.

Fonctions d'accès :

Signal Notificateur :

Voir aussi QDateTime::isValid().

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

Cette propriété contient l'étendue accordée par le serveur d'autorisation.

L'étendue demandée et l'étendue accordée peuvent être différentes. L'utilisateur final peut avoir choisi de n'accorder qu'un sous-ensemble de l'étendue, ou les politiques côté serveur peuvent la modifier. L'application doit être préparée à gérer ce scénario et vérifier l'étendue accordée pour voir si elle doit avoir un impact sur la logique de l'application.

Le serveur peut omettre d'indiquer la portée accordée, comme le définit la RFC 6749. Dans ce cas, l'implémentation suppose que la portée accordée est la même que la portée demandée.

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Notifier signal :

Voir aussi QAbstractOAuth2::requestedScopeTokens.

[read-only, since 6.9] idToken : QString

Cette propriété contient le jeton d'identification OpenID Connect reçu.

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Notifier signal :

Voir aussi NonceMode, nonce, et Qt OpenID Connect Support.

[since 6.9] nonce : QString

Cette propriété contient la chaîne de caractères envoyée au serveur lors de l'authentification. Le nonce est utilisé pour associer les réponses des jetons applicables (OpenID Connect id_token en particulier) à l'étape d'autorisation.

L'objectif principal de nonce est d'atténuer les attaques par rejeu. Il garantit que les réponses aux jetons reçues correspondent aux demandes d'authentification initiées par l'application, empêchant ainsi les attaquants de réutiliser les jetons dans des contextes non autorisés. Il est donc important d'inclure la vérification du nonce dans la validation du jeton.

En pratique, les fournisseurs de serveurs d'autorisation peuvent refuser la demande OpenID Connect si un nonce n'est pas fourni dans la demande d'autorisation.

Le jeton lui-même est une chaîne opaque et ne doit contenir que des caractères compatibles avec les URL pour une compatibilité maximale. De plus, le jeton doit fournir une entropie adéquate afin qu'il soit impossible à deviner pour les attaquants. Il n'y a pas de limites strictes pour la taille des nonce, et les fournisseurs de serveurs d'autorisation peuvent imposer leurs propres tailles minimales et maximales.

Bien que l'adresse nonce puisse être définie manuellement, les classes Qt génèrent un nonce de 32 caractères when needed s'il n'y en a pas.

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal Notifier :

Voir aussi nonceMode et Qt OpenID Connect Support.

[since 6.9] nonceMode : NonceMode

Cette propriété contient le mode nonce actuel (utilisation ou non du nonce).

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal Notifier :

Voir aussi NonceMode et nonce.

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

Cette propriété définit le délai d'émission du signal accessTokenAboutToExpire() par rapport à l'expiration du jeton d'accès.

Cette propriété spécifie l'intervalle de temps (en secondes) avant l'expiration du jeton d'accès actuel, lorsque le signal accessTokenAboutToExpire() est émis. La valeur définie pour cette propriété doit être une durée positive.

Cet intervalle permet à l'application de rafraîchir le jeton bien à l'avance, ce qui garantit une autorisation continue sans interruption.

Si cette propriété n'est pas explicitement définie ou si le leadTime fourni est supérieur à la durée de vie du jeton, le leadTime est fixé par défaut à 5 % de la durée de vie restante du jeton, mais pas moins de 10 secondes avant l'expiration (ce qui laisse le temps à la demande de rafraîchissement de se terminer).

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal Notificateur :

Voir aussi autoRefresh.

refreshToken : QString

Cette propriété contient le jeton de rafraîchissement utilisé pour obtenir de nouveaux jetons d'accès.

Les jetons de rafraîchissement ont généralement une durée de vie plus longue que les jetons d'accès, il est donc logique de les conserver pour une utilisation ultérieure.

Fonctions d'accès :

Signal du notificateur :

Voir aussi setRefreshToken().

[since 6.9] requestedScopeTokens : QSet<QByteArray>

Cette propriété contient l'étendue souhaitée qui définit les autorisations demandées par le client.

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal Notifier :

Voir aussi QAbstractOAuth2::grantedScopeTokens.

[until 6.13] scope : QString

Cette propriété sera obsolète à partir de la version 6.13.

Utilisez plutôt les propriétés requestedScopeTokens et grantedScopeTokens. Cette propriété sera supprimée dans Qt 7.

Cette propriété contient l'étendue souhaitée qui définit les autorisations demandées par le client.

La valeur de l'étendue est mise à jour en fonction de la valeur de l'étendue accordée par le serveur d'autorisation. Dans le cas d'une réponse vide, l'étendue demandée est considérée comme accordée et ne change pas.

Le fait que cette propriété joue deux rôles différents, d'abord en tant que champ d'application demandé et ensuite en tant que champ d'application accordé, est un artefact historique. Il est recommandé à tout nouveau code d'utiliser QAbstractOAuth2::requestedScopeTokens et QAbstractOAuth2::grantedScopeTokens.

Fonctions d'accès :

Notifier signal :

Voir également QAbstractOAuth2::grantedScopeTokens et QAbstractOAuth2::requestedScopeTokens.

state : QString

Cette propriété contient la chaîne de caractères envoyée au serveur lors de l'authentification. L'état est utilisé pour identifier et valider la demande lors de la réception du rappel.

Certains caractères sont illégaux dans l'élément state (voir RFC 6749). L'utilisation de caractères illégaux peut conduire à une inadéquation involontaire de l'état et à l'échec de l'autorisation OAuth 2. Par conséquent, si vous essayez de définir une valeur qui contient des caractères illégaux, l'état est ignoré et un avertissement est enregistré.

Fonctions d'accès :

Signal de notification :

[since 6.9] tokenUrl : QUrl

Cette propriété contient l'URL du point de terminaison du jeton qui est utilisé pour obtenir des jetons. En fonction du cas d'utilisation et du support du serveur d'autorisation, ces jetons peuvent être des jetons d'accès, des jetons de rafraîchissement et des jetons d'identification.

Les jetons sont généralement récupérés une fois l'étape d'autorisation terminée, et le point de terminaison du jeton peut également être utilisé pour rafraîchir les jetons si nécessaire.

Par exemple, QOAuth2AuthorizationCodeFlow utilise cette url pour émettre une demande de jeton d'accès, et QOAuth2DeviceAuthorizationFlow utilise cette url pour demander un jeton d'accès.

Cette propriété a été introduite dans Qt 6.9.

Fonctions d'accès :

Notifier signal :

userAgent : QString

Cette propriété contient l'en-tête User-Agent utilisé pour créer les requêtes réseau.

La valeur par défaut est "QtOAuth/1.0 (+https://www.qt.io)".

Fonctions d'accès :

Signal Notificateur :

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