QDtls Class

Documentation des fonctions membres

[explicit] QDtls::QDtls(QSslSocket::SslMode mode, QObject *parent = nullptr)

Crée un objet QDtls ; la valeur « parent » est transmise au constructeur « QObject ». « mode » correspond à « QSslSocket::SslServerMode » pour une connexion DTLS côté serveur ou à « QSslSocket::SslClientMode » pour un client.

Voir également sslMode() et QSslSocket::SslMode.

[virtual noexcept] QDtls::~QDtls()

Supprime l'objet « QDtls ».

bool QDtls::abortHandshake(QUdpSocket *socket)

Interrompt la procédure d'établissement de connexion en cours. Renvoie « true » si une procédure était en cours sur socket; sinon, génère une erreur appropriée et renvoie « false ».

Voir également doHandshake() et resumeHandshake().

QDtls::GeneratorParameters QDtls::cookieGeneratorParameters() const

Renvoie l'algorithme de hachage et la clé secrète actuels, qu'il s'agisse des valeurs par défaut ou de celles précédemment définies via un appel à la fonction ` setCookieGeneratorParameters()`.

L'algorithme de hachage par défaut est QCryptographicHash::Sha256 si Qt a été configuré pour le prendre en charge, QCryptographicHash::Sha1 dans le cas contraire. La clé secrète par défaut est obtenue à partir du générateur de nombres pseudo-aléatoires cryptographiquement fort spécifique au backend.

Voir également les fonctions QDtlsClientVerifier et setCookieGeneratorParameters().

QByteArray QDtls::decryptDatagram(QUdpSocket *socket, const QByteArray &dgram)

Déchiffre ` dgram ` et renvoie son contenu sous forme de texte clair. La phase d'établissement de la connexion doit être terminée avant que les datagrammes puissent être déchiffrés. Selon le type du message TLS, la connexion peut écrire dans ` socket`, qui doit être un pointeur valide.

bool QDtls::doHandshake(QUdpSocket *socket, const QByteArray &dgram = {})

Lance ou poursuit une négociation DTLS. ` socket ` doit être un pointeur valide. Lors du lancement d’une négociation DTLS côté serveur, ` dgram ` doit contenir le message `ClientHello` initial lu à partir de ` QUdpSocket`. Cette fonction renvoie ` true ` si aucune erreur n’a été détectée. L’état de la négociation peut être vérifié à l’aide de ` handshakeState()`. Le retour de ` false ` indique qu’une erreur s’est produite ; utilisez ` dtlsError()` pour obtenir des informations plus détaillées.

if (!dtls.doHandshake(&socket, dgram)) {
    if (dtls.dtlsError() == QDtlsError::PeerVerificationError)
        dtls.abortAfterError(&socket);
}

Voir également handshakeState(), dtlsError(), ignoreVerificationErrors(), resumeHandshake() et abortHandshake().

QSslConfiguration QDtls::dtlsConfiguration() const

Renvoie soit la configuration DTLS par défaut, soit la configuration définie lors d'un appel précédent à la fonction ` setDtlsConfiguration()`.

Voir également setDtlsConfiguration() et QSslConfiguration::defaultDtlsConfiguration().

QDtlsError QDtls::dtlsError() const

Renvoie la dernière erreur rencontrée par la connexion ou par QDtlsError::NoError.

Voir également dtlsErrorString() et QDtlsError.

QString QDtls::dtlsErrorString() const

Renvoie une description textuelle de la dernière erreur rencontrée par la connexion ou une chaîne vide.

Voir également la fonction ` dtlsError()`.

bool QDtls::handleTimeout(QUdpSocket *socket)

Si un délai d'attente est atteint pendant la phase d'établissement de la connexion, le signal ` handshakeTimeout()` est émis. L'application doit appeler la fonction `handleTimeout()` pour retransmettre les messages d'établissement de la connexion ; `handleTimeout()` renvoie ` true ` si un délai d'attente a été atteint, `false` dans le cas contraire. ` socket ` doit être un pointeur valide.

Voir également handshakeTimeout().

QDtls::HandshakeState QDtls::handshakeState() const

Renvoie l'état actuel de la négociation de connexion pour cette QDtls.

Voir également doHandshake() et QDtls::HandshakeState.

[signal] void QDtls::handshakeTimeout()

La perte de paquets peut entraîner des délais d'expiration pendant la phase d'établissement de la connexion. Dans ce cas, ` QDtls ` émet un signal `handshakeTimeout()`. Appelez ` handleTimeout()` pour retransmettre les messages d'établissement de la connexion :

DtlsClient::DtlsClient()
{
    // Some initialization code here ...
    connect(&clientDtls, &QDtls::handshakeTimeout, this, &DtlsClient::handleTimeout);
}

void DtlsClient::handleTimeout()
{
    clientDtls.handleTimeout(&clientSocket);
}

Voir également handleTimeout().

void QDtls::ignoreVerificationErrors(const QList<QSslError> &errorsToIgnore)

Cette méthode indique à QDtls de ne prendre en compte que les erreurs répertoriées à l'adresse errorsToIgnore.

Si, par exemple, vous souhaitez vous connecter à un serveur utilisant un certificat auto-signé, considérez l'extrait de code suivant :

QList<QSslCertificate> cert = QSslCertificate::fromPath("server-certificate.pem"_L1);
QSslError error(QSslError::SelfSignedCertificate, cert.at(0));
QList<QSslError> expectedSslErrors;
expectedSslErrors.append(error);

QDtls dtls;
dtls.ignoreVerificationErrors(expectedSslErrors);
dtls.doHandshake(udpSocket);

Vous pouvez également appeler cette fonction après que doHandshake() a rencontré l’erreur QDtlsError::PeerVerificationError, puis reprendre la négociation de connexion en appelant resumeHandshake().

Les appels ultérieurs à cette fonction remplaceront la liste des erreurs transmises lors des appels précédents. Vous pouvez effacer la liste des erreurs que vous souhaitez ignorer en appelant cette fonction avec une liste vide.

Voir également doHandshake(), resumeHandshake() et QSslError.

bool QDtls::isConnectionEncrypted() const

Renvoie « true » si la négociation DTLS s'est déroulée avec succès.

Voir également doHandshake() et handshakeState().

quint16 QDtls::mtuHint() const

Renvoie la valeur précédemment définie par la fonction setMtuHint(). La valeur par défaut est 0.

Voir également setMtuHint().

QHostAddress QDtls::peerAddress() const

Renvoie l'adresse du pair, définie par la fonction setPeer() ou QHostAddress::Null.

Voir également la fonction setPeer().

quint16 QDtls::peerPort() const

Renvoie le numéro de port du pair, défini par la fonction setPeer(), ou 0.

Voir également la fonction ` setPeer()`.

QList<QSslError> QDtls::peerVerificationErrors() const

Renvoie les erreurs détectées lors de la vérification de l'identité du pair.

Si vous souhaitez poursuivre la connexion malgré les erreurs survenues, vous devez appeler la fonction ` ignoreVerificationErrors()`.

QString QDtls::peerVerificationName() const

Renvoie le nom d'hôte défini par la fonction setPeer() ou setPeerVerificationName(). La valeur par défaut est une chaîne vide.

Voir également setPeerVerificationName() et setPeer().

[signal] void QDtls::pskRequired(QSslPreSharedKeyAuthenticator *authenticator)

QDtls émet ce signal lorsqu'il négocie un ensemble de chiffrement PSK ; une authentification PSK est alors requise.

Lorsqu’il utilise le PSK, le client doit envoyer au serveur une identité valide et une clé pré-partagée valide pour que la poignée de main TLS puisse se poursuivre. Les applications peuvent fournir ces informations dans un slot connecté à ce signal, en remplissant l’objet ` authenticator ` transmis selon leurs besoins.

Voir aussi QSslPreSharedKeyAuthenticator.

bool QDtls::resumeHandshake(QUdpSocket *socket)

Si des erreurs de vérification par pairs ont été ignorées pendant la négociation, la fonction `resumeHandshake()` reprend et achève la négociation, puis renvoie ` true`. ` socket ` doit être un pointeur valide. Renvoie ` false ` si la négociation n'a pas pu être reprise.

Voir également doHandshake(), abortHandshake(), peerVerificationErrors() et ignoreVerificationErrors().

QSslCipher QDtls::sessionCipher() const

Renvoie l'cipher cryptographique utilisé par cette connexion, ou un chiffrement nul si la connexion n'est pas chiffrée. Le chiffrement de la session est sélectionné lors de la phase d'établissement de la connexion. Ce chiffrement est utilisé pour chiffrer et déchiffrer les données.

QSslConfiguration Fournit des fonctions permettant de définir la liste ordonnée d’xml-ph-0000@deepl.internals parmi lesquelles la phase d’établissement de la connexion sélectionnera finalement l’xml-ph-0000@deepl.internal de session. Cette liste ordonnée doit être en place avant le début de la phase d’établissement de la connexion.

Voir également QSslConfiguration, setDtlsConfiguration() et dtlsConfiguration().

QSsl::SslProtocol QDtls::sessionProtocol() const

Renvoie la version du protocole DTLS utilisée par cette connexion, ou « UnknownProtocol » si la connexion n'est pas encore chiffrée. Le protocole de la connexion est sélectionné lors de la phase d'établissement de la connexion.

setDtlsConfiguration() permet de définir la version préférée avant le début de la négociation.

Voir également setDtlsConfiguration(), QSslConfiguration, QSslConfiguration::defaultDtlsConfiguration() et QSslConfiguration::setProtocol().

bool QDtls::setCookieGeneratorParameters(const QDtls::GeneratorParameters &params)

Définit l'algorithme de hachage cryptographique et le secret à partir de params. Cette fonction n'est nécessaire que pour une connexion côté serveur QDtls. Renvoie « true » en cas de réussite.

Voir également cookieGeneratorParameters(), doHandshake(), QDtlsClientVerifier et QDtlsClientVerifier::cookieGeneratorParameters().

bool QDtls::setDtlsConfiguration(const QSslConfiguration &configuration)

Définit la configuration TLS de la connexion à partir de configuration et renvoie true en cas de succès.

Voir également dtlsConfiguration() et doHandshake().

void QDtls::setMtuHint(quint16 mtuHint)

mtuHint Il s'agit de l'unité de transmission maximale (MTU), qu'elle ait été détectée ou estimée par l'application. L'application n'est pas tenue de définir cette valeur.

Voir également mtuHint() et QAbstractSocket::PathMtuSocketOption.

bool QDtls::setPeer(const QHostAddress &address, quint16 port, const QString &verificationName = {})

Définit l'adresse, l'port et le nom d'hôte du pair, et renvoie true en cas de succès. address ne doit pas être nul, ni de type multicast ou broadcast. verificationName est le nom d'hôte utilisé pour la validation du certificat.

Voir également peerAddress(), peerPort() et peerVerificationName().

bool QDtls::setPeerVerificationName(const QString &name)

Définit l'name de l'hôte qui sera utilisée pour la validation du certificat et renvoie true en cas de succès.

Voir également peerVerificationName() et setPeer().

bool QDtls::shutdown(QUdpSocket *socket)

Envoie un message d'alerte de fermeture chiffré et ferme la connexion DTLS. L'état de la négociation passe à « QDtls::HandshakeNotStarted ». socket doit être un pointeur valide. Cette fonction renvoie « true » en cas de réussite.

Voir également doHandshake().

QSslSocket::SslMode QDtls::sslMode() const

Renvoie « QSslSocket::SslServerMode » pour une connexion côté serveur et « QSslSocket::SslClientMode » pour une connexion côté client.

Voir également QDtls() et QSslSocket::SslMode.

qint64 QDtls::writeDatagramEncrypted(QUdpSocket *socket, const QByteArray &dgram)

Chiffre le contenu de ` dgram ` et écrit les données chiffrées dans ` socket`. Renvoie le nombre d'octets écrits, ou -1 en cas d'erreur. La phase d'établissement de la connexion doit être terminée avant l'écriture des données chiffrées. ` socket ` doit être un pointeur valide.

Voir également doHandshake(), handshakeState(), isConnectionEncrypted() et dtlsError().