QDtls Class

Dokumentation der Member-Funktionen

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

Erstellt ein QDtls-Objekt, wobei „ parent “ an den Konstruktor „ QObject “ übergeben wird. „ mode “ ist „ QSslSocket::SslServerMode “ für eine serverseitige DTLS-Verbindung oder „ QSslSocket::SslClientMode “ für einen Client.

Siehe auch sslMode() und QSslSocket::SslMode.

[virtual noexcept] QDtls::~QDtls()

Löscht das „ QDtls “-Objekt.

bool QDtls::abortHandshake(QUdpSocket *socket)

Bricht den laufenden Handshake ab. Gibt „true“ zurück, wenn auf socket ein Handshake im Gange war; andernfalls wird ein entsprechender Fehler gesetzt und „false“ zurückgegeben.

Siehe auch doHandshake() und resumeHandshake().

QDtls::GeneratorParameters QDtls::cookieGeneratorParameters() const

Gibt den aktuellen Hash-Algorithmus und den Schlüssel zurück, entweder die Standardwerte oder die zuvor durch einen Aufruf von ` setCookieGeneratorParameters()` festgelegten.

Der Standard-Hash-Algorithmus ist „ QCryptographicHash::Sha256 “, sofern Qt für dessen Unterstützung konfiguriert wurde; andernfalls ist es „ QCryptographicHash::Sha1 “. Der Standard-Schlüssel wird aus dem backend-spezifischen, kryptografisch starken Pseudozufallszahlengenerator gewonnen.

Siehe auch QDtlsClientVerifier und setCookieGeneratorParameters().

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

Entschlüsselt „ dgram “ und gibt dessen Inhalt als Klartext zurück. Der Handshake muss abgeschlossen sein, bevor Datagramme entschlüsselt werden können. Je nach Art der TLS-Nachricht schreibt die Verbindung möglicherweise in „ socket “, das ein gültiger Zeiger sein muss.

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

Startet oder setzt einen DTLS-Handshake fort. ` socket ` muss ein gültiger Zeiger sein. Beim Starten eines serverseitigen DTLS-Handshakes muss ` dgram ` die anfängliche `ClientHello`-Nachricht enthalten, die aus ` QUdpSocket` gelesen wurde. Diese Funktion gibt ` true ` zurück, wenn kein Fehler festgestellt wurde. Der Handshake-Status kann mit ` handshakeState()` überprüft werden. Die Rückgabe von ` false ` bedeutet, dass ein Fehler aufgetreten ist; verwenden Sie ` dtlsError()` für detailliertere Informationen.

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

Siehe auch „ handshakeState()“, „ dtlsError()“, „ ignoreVerificationErrors()“, „ resumeHandshake()“ und „ abortHandshake()“.

QSslConfiguration QDtls::dtlsConfiguration() const

Gibt entweder die Standard-DTLS-Konfiguration oder die durch einen früheren Aufruf von ` setDtlsConfiguration()` festgelegte Konfiguration zurück.

Siehe auch „ setDtlsConfiguration()“ und „ QSslConfiguration::defaultDtlsConfiguration()“.

QDtlsError QDtls::dtlsError() const

Gibt den letzten Fehler zurück, der bei der Verbindung aufgetreten ist, oder QDtlsError::NoError.

Siehe auch ` dtlsErrorString()` und ` QDtlsError`.

QString QDtls::dtlsErrorString() const

Gibt eine textuelle Beschreibung des letzten Fehlers zurück, der bei der Verbindung aufgetreten ist, oder eine leere Zeichenkette.

Siehe auch ` dtlsError()`.

bool QDtls::handleTimeout(QUdpSocket *socket)

Tritt während des Handshakes ein Timeout auf, wird das Signal „ handshakeTimeout()“ ausgelöst. Die Anwendung muss die Funktion „handleTimeout()“ aufrufen, um die Handshake-Nachrichten erneut zu senden; „handleTimeout()“ gibt „ true “ zurück, wenn ein Timeout aufgetreten ist, andernfalls „false“. „ socket “ muss ein gültiger Zeiger sein.

Siehe auch ` handshakeTimeout()`.

QDtls::HandshakeState QDtls::handshakeState() const

Gibt den aktuellen Handshake-Status für dieses QDtls zurück.

Siehe auch „ doHandshake()“ und „ QDtls::HandshakeState “.

[signal] void QDtls::handshakeTimeout()

Paketverluste können während der Handshake-Phase zu Timeouts führen. In diesem Fall gibt „ QDtls “ das Signal „handshakeTimeout()“ aus. Rufen Sie „ handleTimeout()“ auf, um die Handshake-Nachrichten erneut zu senden:

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

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

Siehe auch handleTimeout().

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

Diese Methode weist „ QDtls “ an, ausschließlich die unter errorsToIgnore aufgeführten Fehler zu ignorieren.

Wenn Sie beispielsweise eine Verbindung zu einem Server herstellen möchten, der ein selbstsigniertes Zertifikat verwendet, sollten Sie den folgenden Codeausschnitt berücksichtigen:

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);

Sie können diese Funktion auch aufrufen, nachdem doHandshake() den Fehler QDtlsError::PeerVerificationError festgestellt hat, und anschließend den Handshake durch Aufruf von resumeHandshake() fortsetzen.

Spätere Aufrufe dieser Funktion überschreiben die Liste der Fehler, die bei früheren Aufrufen übergeben wurden. Sie können die Liste der Fehler, die Sie ignorieren möchten, löschen, indem Sie diese Funktion mit einer leeren Liste aufrufen.

Siehe auch „ doHandshake()“, „ resumeHandshake()“ und „ QSslError “.

bool QDtls::isConnectionEncrypted() const

Gibt „ true “ zurück, wenn der DTLS-Handshake erfolgreich abgeschlossen wurde.

Siehe auch „ doHandshake()“ und „ handshakeState()“.

quint16 QDtls::mtuHint() const

Gibt den zuvor mit ` setMtuHint()` festgelegten Wert zurück. Der Standardwert ist 0.

Siehe auch setMtuHint().

QHostAddress QDtls::peerAddress() const

Gibt die Adresse des Peers zurück, die mit „ setPeer()“ oder „ QHostAddress::Null “ festgelegt wurde.

Siehe auch setPeer().

quint16 QDtls::peerPort() const

Gibt die Portnummer des Peers zurück, die mit ` setPeer()` festgelegt wurde, oder 0.

Siehe auch ` setPeer()`.

QList<QSslError> QDtls::peerVerificationErrors() const

Gibt Fehler zurück, die beim Feststellen der Identität des Gegenübers aufgetreten sind.

Wenn Sie die Verbindung trotz der aufgetretenen Fehler fortsetzen möchten, müssen Sie die Funktion „ ignoreVerificationErrors()“ aufrufen.

QString QDtls::peerVerificationName() const

Gibt den Hostnamen zurück, der mit setPeer() oder setPeerVerificationName() festgelegt wurde. Der Standardwert ist eine leere Zeichenkette.

Siehe auch setPeerVerificationName() und setPeer().

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

QDtls gibt dieses Signal aus, wenn es eine PSK-Verschlüsselungssuite aushandelt; daher ist anschließend eine PSK-Authentifizierung erforderlich.

Bei Verwendung von PSK muss der Client dem Server eine gültige Identität und einen gültigen vorab geteilten Schlüssel senden, damit der TLS-Handshake fortgesetzt werden kann. Anwendungen können diese Informationen in einem mit diesem Signal verbundenen Slot bereitstellen, indem sie das übergebene ` authenticator `-Objekt entsprechend ihren Anforderungen ausfüllen.

Siehe auch „ QSslPreSharedKeyAuthenticator “.

bool QDtls::resumeHandshake(QUdpSocket *socket)

Wenn während des Handshakes Fehler bei der Peer-Überprüfung ignoriert wurden, setzt resumeHandshake() den Handshake fort, schließt ihn ab und gibt „ true “ zurück. „ socket “ muss ein gültiger Zeiger sein. Gibt „ false “ zurück, wenn der Handshake nicht fortgesetzt werden konnte.

Siehe auch ` doHandshake()`, ` abortHandshake()`, ` peerVerificationErrors()` und ` ignoreVerificationErrors()`.

QSslCipher QDtls::sessionCipher() const

Gibt das von dieser Verbindung verwendete kryptografische Verschlüsselungs cipher zurück oder eine Null-Verschlüsselung, falls die Verbindung nicht verschlüsselt ist. Die Verschlüsselung für die Sitzung wird während der Handshake-Phase ausgewählt. Die Verschlüsselung wird zum Ver- und Entschlüsseln von Daten verwendet.

QSslConfiguration Stellt Funktionen zur Festlegung der geordneten Liste von Verschlüsselungsalgorithmen bereit, aus der die Handshake-Phase schließlich den Sitzungsverschlüsselungsalgorithmus auswählt. Diese geordnete Liste muss vor Beginn der Handshake-Phase vorliegen.

Siehe auch QSslConfiguration, setDtlsConfiguration() und dtlsConfiguration().

QSsl::SslProtocol QDtls::sessionProtocol() const

Gibt die von dieser Verbindung verwendete DTLS-Protokollversion zurück oder „UnknownProtocol“, falls die Verbindung noch nicht verschlüsselt ist. Das Protokoll für die Verbindung wird während der Handshake-Phase ausgewählt.

setDtlsConfiguration() kann die bevorzugte Version vor Beginn des Handshakes festlegen.

Siehe auch „ setDtlsConfiguration()“, „ QSslConfiguration “, „ QSslConfiguration::defaultDtlsConfiguration()“ und „ QSslConfiguration::setProtocol()“.

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

Legt den kryptografischen Hash-Algorithmus und das Geheimnis aus „ params “ fest. Diese Funktion wird nur für eine serverseitige „ QDtls “-Verbindung benötigt. Gibt bei Erfolg „ true “ zurück.

Siehe auch cookieGeneratorParameters(), doHandshake(), QDtlsClientVerifier sowie QDtlsClientVerifier::cookieGeneratorParameters().

bool QDtls::setDtlsConfiguration(const QSslConfiguration &configuration)

Legt die TLS-Konfiguration der Verbindung anhand von „ configuration “ fest und gibt bei Erfolg „ true “ zurück.

Siehe auch dtlsConfiguration() und doHandshake().

void QDtls::setMtuHint(quint16 mtuHint)

mtuHint ist die maximale Übertragungseinheit (MTU), die entweder von der Anwendung ermittelt oder geschätzt wurde. Die Anwendung muss diesen Wert nicht festlegen.

Siehe auch mtuHint() und QAbstractSocket::PathMtuSocketOption.

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

Legt die Adresse des Peers, port, sowie den Hostnamen fest und gibt bei Erfolg true zurück. address darf nicht null sein und keine Multicast- oder Broadcast-Adresse darstellen. verificationName ist der Hostname, der für die Zertifikatsvalidierung verwendet wird.

Siehe auch peerAddress(), peerPort() und peerVerificationName().

bool QDtls::setPeerVerificationName(const QString &name)

Legt die Host- name fest, die für die Zertifikatsvalidierung verwendet wird, und gibt bei Erfolg „ true “ zurück.

Siehe auch peerVerificationName() und setPeer().

bool QDtls::shutdown(QUdpSocket *socket)

Sendet eine verschlüsselte Abschaltmeldung und schließt die DTLS-Verbindung. Der Handshake-Status wechselt zu „ QDtls::HandshakeNotStarted “. „ socket “ muss ein gültiger Zeiger sein. Diese Funktion gibt bei Erfolg „ true “ zurück.

Siehe auch doHandshake().

QSslSocket::SslMode QDtls::sslMode() const

Gibt bei einer serverseitigen Verbindung „ QSslSocket::SslServerMode “ und bei einer clientseitigen Verbindung „ QSslSocket::SslClientMode “ zurück.

Siehe auch QDtls() und QSslSocket::SslMode.

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

Verschlüsselt ` dgram ` und schreibt die verschlüsselten Daten in ` socket`. Gibt die Anzahl der geschriebenen Bytes zurück oder -1 im Fehlerfall. Der Handshake muss vor dem Schreiben der verschlüsselten Daten abgeschlossen sein. ` socket ` muss ein gültiger Zeiger sein.

Siehe auch doHandshake(), handshakeState(), isConnectionEncrypted() und dtlsError().