QDtls Class

Documentación de las funciones miembro

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

Crea un objeto QDtls, parent se pasa al constructor QObject. mode es QSslSocket::SslServerMode para una conexión DTLS del lado del servidor o QSslSocket::SslClientMode para un cliente.

Véase también sslMode() y QSslSocket::SslMode.

[virtual noexcept] QDtls::~QDtls()

Destruye el objeto QDtls.

bool QDtls::abortHandshake(QUdpSocket *socket)

Aborta el handshake en curso. Devuelve true si había uno en curso en socket; en caso contrario, establece un error adecuado y devuelve false.

Véase también doHandshake() y resumeHandshake().

QDtls::GeneratorParameters QDtls::cookieGeneratorParameters() const

Devuelve el algoritmo hash y el secreto actuales, ya sean los predeterminados o los establecidos previamente mediante una llamada a setCookieGeneratorParameters().

El algoritmo hash por defecto es QCryptographicHash::Sha256 si Qt fue configurado para soportarlo, QCryptographicHash::Sha1 en caso contrario. El secreto por defecto se obtiene del generador de números pseudoaleatorios criptográficamente fuerte específico del backend.

Véase también QDtlsClientVerifier y setCookieGeneratorParameters().

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

Desencripta dgram y devuelve su contenido como texto sin formato. El handshake debe completarse antes de que los datagramas puedan ser desencriptados. Dependiendo del tipo de mensaje TLS, la conexión puede escribir en socket, que debe ser un puntero válido.

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

Inicia o continúa un handshake DTLS. socket debe ser un puntero válido. Cuando se inicia un handshake DTLS del lado del servidor, dgram debe contener el mensaje ClientHello inicial leído de QUdpSocket. Esta función devuelve true si no se encontró ningún error. El estado del Handshake puede comprobarse utilizando handshakeState(). El retorno de false significa que se ha producido algún error, utilice dtlsError() para obtener información más detallada.

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

Véase también handshakeState(), dtlsError(), ignoreVerificationErrors(), resumeHandshake() y abortHandshake().

QSslConfiguration QDtls::dtlsConfiguration() const

Devuelve la configuración DTLS por defecto o la configuración establecida por una llamada anterior a setDtlsConfiguration().

Véase también setDtlsConfiguration() y QSslConfiguration::defaultDtlsConfiguration().

QDtlsError QDtls::dtlsError() const

Devuelve el último error encontrado por la conexión o QDtlsError::NoError.

Véase también dtlsErrorString() y QDtlsError.

QString QDtls::dtlsErrorString() const

Devuelve una descripción textual del último error encontrado por la conexión o una cadena vacía.

Véase también dtlsError().

bool QDtls::handleTimeout(QUdpSocket *socket)

Si se produce un timeout durante el handshake, se emite la señal handshakeTimeout(). La aplicación debe llamar a handleTimeout() para retransmitir los mensajes de handshake; handleTimeout() devuelve true si se ha producido un timeout, false en caso contrario. socket debe ser un puntero válido.

Véase también handshakeTimeout().

QDtls::HandshakeState QDtls::handshakeState() const

Devuelve el estado actual del apretón de manos para este QDtls.

Véase también doHandshake() y QDtls::HandshakeState.

[signal] void QDtls::handshakeTimeout()

La pérdida de paquetes puede provocar tiempos de espera durante la fase de handshake. En este caso QDtls emite una señal handshakeTimeout(). Llama a handleTimeout() para retransmitir los mensajes de handshake:

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

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

Véase también handleTimeout().

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

Este método indica a QDtls que ignore sólo los errores indicados en errorsToIgnore.

Si, por ejemplo, quieres conectarte a un servidor que utiliza un certificado autofirmado, considera el siguiente fragmento:

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

También puedes llamar a esta función después de que doHandshake() encuentre el error QDtlsError::PeerVerificationError, y luego reanudar el handshake llamando a resumeHandshake().

Las llamadas posteriores a esta función reemplazarán la lista de errores que se pasaron en las llamadas anteriores. Puede borrar la lista de errores que desea ignorar llamando a esta función con una lista vacía.

Véase también doHandshake(), resumeHandshake(), y QSslError.

bool QDtls::isConnectionEncrypted() const

Devuelve true si el handshake DTLS se ha completado con éxito.

Véase también doHandshake() y handshakeState().

quint16 QDtls::mtuHint() const

Devuelve el valor establecido previamente por setMtuHint(). El valor por defecto es 0.

Véase también setMtuHint().

QHostAddress QDtls::peerAddress() const

Devuelve la dirección del par, establecida por setPeer(), o QHostAddress::Null.

Véase también setPeer().

quint16 QDtls::peerPort() const

Devuelve el número de puerto del peer, establecido por setPeer(), o 0.

Véase también setPeer().

QList<QSslError> QDtls::peerVerificationErrors() const

Devuelve los errores encontrados al establecer la identidad del peer.

Si desea continuar la conexión a pesar de los errores producidos, debe llamar a ignoreVerificationErrors().

QString QDtls::peerVerificationName() const

Devuelve el nombre de host establecido por setPeer() o setPeerVerificationName(). El valor por defecto es una cadena vacía.

Véase también setPeerVerificationName() y setPeer().

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

QDtls emite esta señal cuando negocia un cifrado PSK, por lo que se requiere una autenticación PSK.

Cuando se utiliza PSK, el cliente debe enviar al servidor una identidad válida y una clave precompartida válida, para que el handshake TLS pueda continuar. Las aplicaciones pueden proporcionar esta información en una ranura conectada a esta señal, rellenando el objeto authenticator pasado según sus necesidades.

Véase también QSslPreSharedKeyAuthenticator.

bool QDtls::resumeHandshake(QUdpSocket *socket)

Si se ignoraron los errores de verificación de pares durante el handshake, resumeHandshake() reanuda y completa el handshake y devuelve true. socket debe ser un puntero válido. Devuelve false si no se ha podido reanudar el handshake.

Véase también doHandshake(), abortHandshake(), peerVerificationErrors() y ignoreVerificationErrors().

QSslCipher QDtls::sessionCipher() const

Devuelve el cipher criptográfico utilizado por esta conexión, o un cifrado nulo si la conexión no está cifrada. El cifrado para la sesión se selecciona durante la fase de apretón de manos. El cifrado se utiliza para cifrar y descifrar datos.

QSslConfiguration proporciona funciones para establecer la lista ordenada de cifradores a partir de la cual la fase de handshake seleccionará finalmente el cifrado de la sesión. Esta lista ordenada debe estar en su lugar antes de que comience la fase de handshake.

Véase también QSslConfiguration, setDtlsConfiguration(), y dtlsConfiguration().

QSsl::SslProtocol QDtls::sessionProtocol() const

Devuelve la versión del protocolo DTLS utilizada por esta conexión, o UnknownProtocol si la conexión aún no está cifrada. El protocolo para la conexión se selecciona durante la fase de handshake.

setDtlsConfiguration() puede establecer la versión preferida antes de que comience el handshake.

Véase también setDtlsConfiguration(), QSslConfiguration, QSslConfiguration::defaultDtlsConfiguration(), y QSslConfiguration::setProtocol().

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

Establece el algoritmo hash criptográfico y el secreto de params. Esta función sólo es necesaria para una conexión del lado del servidor QDtls. Devuelve true si tiene éxito.

Véase también cookieGeneratorParameters(), doHandshake(), QDtlsClientVerifier, y QDtlsClientVerifier::cookieGeneratorParameters().

bool QDtls::setDtlsConfiguration(const QSslConfiguration &configuration)

Establece la configuración TLS de la conexión desde configuration y devuelve true si tiene éxito.

Véase también dtlsConfiguration() y doHandshake().

void QDtls::setMtuHint(quint16 mtuHint)

mtuHint es la unidad de transmisión máxima (MTU), descubierta o adivinada por la aplicación. No es necesario que la aplicación establezca este valor.

Véase también mtuHint() y QAbstractSocket::PathMtuSocketOption.

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

Establece la dirección del homólogo, port, y el nombre de host y devuelve true si se ha realizado correctamente. address no debe ser nulo, multidifusión ni difusión. verificationName es el nombre de host utilizado para la validación del certificado.

Véase también peerAddress(), peerPort() y peerVerificationName().

bool QDtls::setPeerVerificationName(const QString &name)

Establece el host name que se utilizará para la validación del certificado y devuelve true si tiene éxito.

Véase también peerVerificationName() y setPeer().

bool QDtls::shutdown(QUdpSocket *socket)

Envía un mensaje de alerta de cierre cifrado y cierra la conexión DTLS. El estado de Handshake cambia a QDtls::HandshakeNotStarted. socket debe ser un puntero válido. Esta función devuelve true en caso de éxito.

Véase también doHandshake().

QSslSocket::SslMode QDtls::sslMode() const

Devuelve QSslSocket::SslServerMode para una conexión del lado del servidor y QSslSocket::SslClientMode para un cliente.

Véase también QDtls() y QSslSocket::SslMode.

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

Cifra dgram y escribe los datos cifrados en socket. Devuelve el número de bytes escritos, o -1 en caso de error. El handshake debe completarse antes de escribir los datos encriptados. socket debe ser un puntero válido.

Véase también doHandshake(), handshakeState(), isConnectionEncrypted(), y dtlsError().