QAbstractOAuth2 Class

Documentation sur les propriétés

[since 6.9] autoRefresh : bool

Cette propriété active ou désactive l'actualisation automatique du jeton d'accès.

Cette propriété active ou désactive l'actualisation automatique du jeton d'accès. Elle est utile pour les applications qui nécessitent une autorisation ininterrompue sans intervention de l'utilisateur.

Si cette propriété est définie sur « true », la méthode refreshTokens() sera automatiquement appelée lorsque le jeton est sur le point d'expirer et qu'un jeton refreshToken valide existe.

Cette énumération a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal de notification :

Voir également ` 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 la date d'expiration du jeton d'accès actuel. Une valeur non valide signifie que le serveur d'autorisation n'a pas fourni de date d'expiration valide.

Fonctions d'accès :

Signal de notification :

Voir également ` QDateTime::isValid()`.

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

Cette propriété contient le périmètre accordé par le serveur d'autorisation.

La portée demandée et la portée accordée peuvent différer. L’utilisateur final peut avoir choisi de n’accorder qu’un sous-ensemble de la portée, ou les politiques côté serveur peuvent la modifier. L’application doit être prête à gérer ce scénario et vérifier la portée accordée afin de déterminer si cela a une incidence sur la logique de l’application.

Le serveur peut omettre complètement d'indiquer le champ d'application accordé, comme le définit la RFC 6749. Dans ce cas, l'implémentation suppose que le champ d'application accordé est identique au champ d'application demandé.

Cette énumération a été introduite dans Qt 6.9.

Fonctions d’accès :

Signal de notification :

Voir également QAbstractOAuth2::requestedScopeTokens.

[read-only, since 6.9] idToken : QString

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

Cette énumération a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal de notification :

Voir également NonceMode, nonce et Prise en charge de Qt OpenID Connect.

[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 sert à associer les réponses de jeton pertinentes (notamment les « id_token » OpenID Connect) à la phase d'autorisation.

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

Dans la pratique, les fournisseurs de serveurs d’autorisation peuvent refuser la requête OpenID Connect si aucun nonce n’est fourni dans la requête 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 présenter une entropie suffisante pour être impossible à deviner par les attaquants. Il n’existe pas de limites strictes quant à la taille du nonce, et les fournisseurs de serveurs d’autorisation peuvent imposer leurs propres tailles minimales et maximales.

Bien que l’ nonce puisse être défini manuellement, les classes Qt génèrent un nonce de 32 caractères when needed si aucun n’est défini.

Cette énumération a été introduite dans Qt 6.9.

Fonctions d’accès :

Signal de notification :

Voir également « nonceMode » et « Prise en charge de Qt OpenID Connect ».

[since 6.9] nonceMode : NonceMode

Cette propriété indique le mode « nonce » actuel (si le nonce est utilisé ou non).

Cette énumération a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal de notification :

Voir également NonceMode et nonce.

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

Cette propriété définit le délai avec lequel le signal ` accessTokenAboutToExpire()` est émis 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, au moment où le signal ` accessTokenAboutToExpire()` est émis. La valeur définie pour cette propriété doit être une durée positive.

Cet intervalle permet à l'application d'actualiser le jeton bien à l'avance, garantissant ainsi une autorisation continue sans interruption.

Si cette propriété n’est pas explicitement définie, ou si la valeur fournie pour `leadTime` est supérieure à la durée de vie du jeton, `leadTime` est alors défini par défaut à 5 % de la durée de vie restante du jeton, sans toutefois être inférieur à 10 secondes avant l’expiration (afin de laisser le temps nécessaire à l’exécution de la requête de rafraîchissement).

Cette énumération a été introduite dans Qt 6.9.

Fonctions d’accès :

Signal Notifier :

Voir également 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 judicieux de les enregistrer en vue d'une utilisation ultérieure.

Fonctions d'accès :

Signal de notification :

Voir également setRefreshToken().

[since 6.9] requestedScopeTokens : QSet<QByteArray>

Cette propriété contient le champ d'application souhaité qui définit les autorisations demandées par le client.

Cette énumération a été introduite dans Qt 6.9.

Fonctions d'accès :

Signal de notification :

Voir également QAbstractOAuth2::grantedScopeTokens.

[until 6.13] scope : QString

Cette énumération est prévue pour être 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 le champ d'application souhaité qui définit les autorisations demandées par le client.

La valeur de la portée est mise à jour pour correspondre à celle accordée par le serveur d’autorisation. En cas de réponse vide concernant la portée, la portée demandée est considérée comme accordée et ne change pas.

Le fait que cette propriété remplisse deux rôles différents, d’abord celui de la portée demandée puis celui de la portée accordée, est un vestige historique. Il est recommandé d’utiliser QAbstractOAuth2::requestedScopeTokens et QAbstractOAuth2::grantedScopeTokens dans tout nouveau code.

Fonctions d’accès :

Signal de notification :

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

state : QString

Cette propriété contient la chaîne envoyée au serveur lors de l'authentification. L'état sert à identifier et à valider la requête à la réception du rappel.

Si aucun état n’a été défini au début du flux d’autorisation, un état aléatoire de 32 caractères est généré automatiquement. Il s’agit de la méthode par défaut et recommandée.

Cet état constitue la principale protection contre la falsification de requêtes intersites (CSRF) et doit donc présenter un degré de hasard suffisant. Si vous le définissez manuellement, veillez à utiliser au moins 32 caractères aléatoires.

Certains caractères sont interdits dans l’élément « state » (voir RFC 6749). L’utilisation de caractères interdits pourrait entraîner une non-correspondance involontaire de l’état et l’échec de l’autorisation OAuth 2. Par conséquent, si vous tentez de définir une valeur contenant des caractères interdits, l’état est ignoré et un avertissement est consigné.

Fonctions d’accès :

Signal de notification :

[since 6.9] tokenUrl : QUrl

Cette propriété contient l'URL du point de terminaison des jetons, qui sert à obtenir des jetons. En fonction du cas d'utilisation et de la prise en charge par le serveur d'autorisation, ces jetons peuvent être des jetons d'accès, des jetons de rafraîchissement ou des jetons d'identité.

Les jetons sont généralement récupérés une fois la phase d'autorisation terminée, et le point de terminaison des jetons peut également être utilisé pour actualiser les jetons si nécessaire.

Par exemple, QOAuth2AuthorizationCodeFlow utilise cette URL pour envoyer une requête de jeton d'accès, et QOAuth2DeviceAuthorizationFlow utilise cette URL pour interroger le serveur afin d'obtenir un jeton d'accès.

Cette énumération a été introduite dans Qt 6.9.

Fonctions d’accès :

Signal de notification :

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 de notification :

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

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