En esta página

QSslConfiguration Class

La clase `QSslConfiguration` contiene la configuración y el estado de una conexión SSL. Más información...

Encabezado: #include <QSslConfiguration>
CMake: find_package(Qt6 REQUIRED COMPONENTS Network)
target_link_libraries(mytarget PRIVATE Qt6::Network)
qmake: QT += network

Nota: Todas las funciones de esta clase son reentrantes.

Tipos públicos

enum NextProtocolNegotiationStatus { NextProtocolNegotiationNone, NextProtocolNegotiationNegotiated, NextProtocolNegotiationUnsupported }

Funciones públicas

QSslConfiguration()
QSslConfiguration(const QSslConfiguration &other)
~QSslConfiguration()
void addCaCertificate(const QSslCertificate &certificate)
void addCaCertificates(const QList<QSslCertificate> &certificates)
bool addCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem, QSslCertificate::PatternSyntax syntax = QSslCertificate::PatternSyntax::FixedString)
QList<QByteArray> allowedNextProtocols() const
QMap<QByteArray, QVariant> backendConfiguration() const
QList<QSslCertificate> caCertificates() const
QList<QSslCipher> ciphers() const
QSslDiffieHellmanParameters diffieHellmanParameters() const
bool dtlsCookieVerificationEnabled() const
QList<QSslEllipticCurve> ellipticCurves() const
QSslKey ephemeralServerKey() const
(since 6.0) bool handshakeMustInterruptOnError() const
bool isNull() const
QSslCertificate localCertificate() const
QList<QSslCertificate> localCertificateChain() const
(since 6.0) bool missingCertificateIsFatal() const
QByteArray nextNegotiatedProtocol() const
QSslConfiguration::NextProtocolNegotiationStatus nextProtocolNegotiationStatus() const
bool ocspStaplingEnabled() const
QSslCertificate peerCertificate() const
QList<QSslCertificate> peerCertificateChain() const
int peerVerifyDepth() const
QSslSocket::PeerVerifyMode peerVerifyMode() const
QByteArray preSharedKeyIdentityHint() const
QSslKey privateKey() const
QSsl::SslProtocol protocol() const
QSslCipher sessionCipher() const
QSsl::SslProtocol sessionProtocol() const
QByteArray sessionTicket() const
int sessionTicketLifeTimeHint() const
void setAllowedNextProtocols(const QList<QByteArray> &protocols)
void setBackendConfiguration(const QMap<QByteArray, QVariant> &backendConfiguration = QMap<QByteArray, QVariant>())
void setBackendConfigurationOption(const QByteArray &name, const QVariant &value)
void setCaCertificates(const QList<QSslCertificate> &certificates)
void setCiphers(const QList<QSslCipher> &ciphers)
(since 6.0) void setCiphers(const QString &ciphers)
void setDiffieHellmanParameters(const QSslDiffieHellmanParameters &dhparams)
void setDtlsCookieVerificationEnabled(bool enable)
void setEllipticCurves(const QList<QSslEllipticCurve> &curves)
(since 6.0) void setHandshakeMustInterruptOnError(bool interrupt)
(since 6.12) void setKeyingMaterial(const QList<QSslKeyingMaterial> &keyMaterial)
void setLocalCertificate(const QSslCertificate &certificate)
void setLocalCertificateChain(const QList<QSslCertificate> &localChain)
(since 6.0) void setMissingCertificateIsFatal(bool cannotRecover)
void setOcspStaplingEnabled(bool enabled)
void setPeerVerifyDepth(int depth)
void setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)
void setPreSharedKeyIdentityHint(const QByteArray &hint)
void setPrivateKey(const QSslKey &key)
void setProtocol(QSsl::SslProtocol protocol)
void setSessionTicket(const QByteArray &sessionTicket)
void setSslOption(QSsl::SslOption option, bool on)
void swap(QSslConfiguration &other)
(since 6.12) QList<QSslKeyingMaterial> takeKeyingMaterial()
(since 6.12) std::optional<QSslKeyingMaterial> takeKeyingMaterial(const QSslKeyingMaterial &material)
bool testSslOption(QSsl::SslOption option) const
bool operator!=(const QSslConfiguration &other) const
QSslConfiguration &operator=(const QSslConfiguration &other)
bool operator==(const QSslConfiguration &other) const

Miembros públicos estáticos

const char[] ALPNProtocolHTTP2
const char[] NextProtocolHttp1_1
QSslConfiguration defaultConfiguration()
QSslConfiguration defaultDtlsConfiguration()
void setDefaultConfiguration(const QSslConfiguration &configuration)
void setDefaultDtlsConfiguration(const QSslConfiguration &configuration)
QList<QSslCipher> supportedCiphers()
QList<QSslEllipticCurve> supportedEllipticCurves()
QList<QSslCertificate> systemCaCertificates()

Descripción detallada

Las clases de red de Qt Network utilizan QSslConfiguration para transmitir información sobre una conexión SSL abierta y permitir que la aplicación controle determinadas características de dicha conexión.

Los parámetros que admite actualmente QSslConfiguration son:

  • El protocolo SSL/TLS que se va a utilizar
  • El certificado que se presentará al interlocutor durante la conexión y su clave privada asociada
  • Los algoritmos de cifrado permitidos para cifrar la conexión
  • La lista de certificados de las autoridades de certificación que se utilizan para validar el certificado del interlocutor

Estos ajustes solo se aplican durante el protocolo de enlace de la conexión. Configurarlos una vez establecida la conexión no tiene ningún efecto.

Los estados que admite QSslConfiguration son:

  • El certificado que el interlocutor presentó durante el establecimiento de la conexión, junto con la cadena que conduce a un certificado de CA
  • El cifrado utilizado para cifrar esta sesión

El estado solo se puede obtener una vez que se inicia la conexión SSL, pero no necesariamente antes de que finalice. Algunos ajustes pueden cambiar durante el transcurso de la conexión SSL sin necesidad de reiniciarla (por ejemplo, el cifrado se puede cambiar con el tiempo).

El estado de los objetos QSslConfiguration no se puede modificar.

QSslConfiguration se puede utilizar con « QSslSocket » y la API de acceso a la red.

Ten en cuenta que cambiar los ajustes en QSslConfiguration no es suficiente para modificar los ajustes de la conexión SSL relacionada. Para ello, debes llamar a setSslConfiguration en un objeto QSslConfiguration modificado. El siguiente ejemplo ilustra cómo cambiar el protocolo a TLSv1_2 en un objeto QSslSocket:

QSslConfiguration config = sslSocket.sslConfiguration();
config.setProtocol(QSsl::TlsV1_2);
sslSocket.setSslConfiguration(config);

Véase también QSsl::SslProtocol, QSslCertificate, QSslCipher, QSslKey, QSslSocket, QNetworkAccessManager, QSslSocket::sslConfiguration() y QSslSocket::setSslConfiguration().

Documentación sobre los tipos de miembro

enum QSslConfiguration::NextProtocolNegotiationStatus

Describe el estado de la negociación del siguiente protocolo (NPN) o de la negociación del protocolo en la capa de aplicación (ALPN).

ConstanteValorDescripción
QSslConfiguration::NextProtocolNegotiationNone0Aún no se ha negociado ningún protocolo de aplicación.
QSslConfiguration::NextProtocolNegotiationNegotiated1Se ha negociado un protocolo siguiente (véase nextNegotiatedProtocol()).
QSslConfiguration::NextProtocolNegotiationUnsupported2El cliente y el servidor no han podido ponerse de acuerdo sobre un protocolo de aplicación siguiente común.

Documentación de la función miembro

QSslConfiguration::QSslConfiguration()

Crea una configuración SSL vacía. Esta configuración no contiene ningún ajuste válido y el estado estará vacío. La función ` isNull()` devolverá «true» tras llamar a este constructor.

Una vez que se llame a cualquier método setter, isNull() devolverá «false».

QSslConfiguration::QSslConfiguration(const QSslConfiguration &other)

Copia la configuración y el estado de other. Si other es nulo, este objeto también será nulo.

[noexcept] QSslConfiguration::~QSslConfiguration()

Libera los recursos retenidos por « QSslConfiguration ».

void QSslConfiguration::addCaCertificate(const QSslCertificate &certificate)

Añade certificate a la base de datos de certificados de CA de esta configuración. La base de datos de certificados debe configurarse antes del establecimiento de la conexión SSL. El socket utiliza la base de datos de certificados de CA durante la fase de establecimiento de la conexión para validar el certificado del interlocutor.

Nota: La configuración predeterminada utiliza la base de datos de certificados de CA del sistema. Si esta no está disponible (como suele ocurrir en iOS), la base de datos predeterminada estará vacía.

Véase también caCertificates(), setCaCertificates() y addCaCertificates().

void QSslConfiguration::addCaCertificates(const QList<QSslCertificate> &certificates)

Añade certificates a la base de datos de certificados de CA de esta configuración. La base de datos de certificados debe configurarse antes del protocolo de enlace SSL. El socket utiliza la base de datos de certificados de CA durante la fase de protocolo de enlace para validar el certificado del interlocutor.

Nota: La configuración predeterminada utiliza la base de datos de certificados de CA del sistema. Si esta no está disponible (como suele ocurrir en iOS), la base de datos predeterminada estará vacía.

Véase también caCertificates(), setCaCertificates() y addCaCertificate().

bool QSslConfiguration::addCaCertificates(const QString &path, QSsl::EncodingFormat format = QSsl::Pem, QSslCertificate::PatternSyntax syntax = QSslCertificate::PatternSyntax::FixedString)

Busca en todos los archivos de la ruta « path » los certificados codificados en el archivo « format » especificado y los añade a la base de datos de certificados de CA de este socket. « path » debe ser un archivo o un patrón que coincida con uno o varios archivos, tal y como se especifica en « syntax ». Devuelve « true » si se añaden uno o varios certificados a la base de datos de certificados de CA del socket; en caso contrario, devuelve « false ».

El socket utiliza la base de datos de certificados de CA durante la fase de establecimiento de la conexión para validar el certificado del interlocutor.

Para un control más preciso, utilice addCaCertificate().

Véanse también addCaCertificate() y QSslCertificate::fromPath().

QList<QByteArray> QSslConfiguration::allowedNextProtocols() const

Esta función devuelve los protocolos permitidos para su negociación con el servidor a través de la extensión TLS «Next Protocol Negotiation» (NPN) o «Application-Layer Protocol Negotiation» (ALPN), tal y como se establece en setAllowedNextProtocols().

Véase también nextNegotiatedProtocol(), nextProtocolNegotiationStatus(), setAllowedNextProtocols() y QSslConfiguration::NextProtocolHttp1_1.

QMap<QByteArray, QVariant> QSslConfiguration::backendConfiguration() const

Devuelve la configuración específica del backend.

Solo se devolverán las opciones establecidas mediante setBackendConfigurationOption() o setBackendConfiguration(). No se muestra la configuración interna estándar del backend.

Véanse también setBackendConfigurationOption() y setBackendConfiguration().

QList<QSslCertificate> QSslConfiguration::caCertificates() const

Devuelve la base de datos de certificados de CA de esta conexión. El socket utiliza la base de datos de certificados de CA durante la fase de establecimiento de la conexión para validar el certificado del interlocutor. Se puede modificar antes del establecimiento de la conexión mediante ` setCaCertificates()` o mediante ` addCaCertificate()` y ` addCaCertificates()`.

Véanse también setCaCertificates(), addCaCertificate() y addCaCertificates().

QList<QSslCipher> QSslConfiguration::ciphers() const

Devuelve el conjunto de cifrado criptográfico actual de esta conexión. Esta lista se utiliza durante la fase de establecimiento de la conexión para elegir un cifrado de sesión. La lista de cifrados devuelta está ordenada por preferencia descendente (es decir, el primer cifrado de la lista es el más preferido). El cifrado de sesión será el primero de la lista que también sea compatible con el interlocutor.

Por defecto, la fase de establecimiento de conexión puede elegir cualquiera de los cifrados compatibles con las bibliotecas SSL de este sistema, que pueden variar de un sistema a otro. La lista de cifrados compatibles con las bibliotecas SSL de este sistema se obtiene mediante la función ` supportedCiphers()`. Puede restringir la lista de cifrados utilizados para elegir el cifrado de sesión de este socket llamando a ` setCiphers()` con un subconjunto de los cifrados admitidos. Puede volver a utilizar el conjunto completo llamando a ` setCiphers()` con la lista devuelta por ` supportedCiphers()`.

Véase también setCiphers() y supportedCiphers().

[static] QSslConfiguration QSslConfiguration::defaultConfiguration()

Devuelve la configuración SSL predeterminada que se utilizará en las nuevas conexiones SSL.

La configuración SSL predeterminada consiste en:

  • sin certificado local ni clave privada
  • protocolo SecureProtocols
  • la lista de certificados de CA predeterminada del sistema
  • la lista de cifrados, que coincide con la lista de cifrados SSL compatibles con las bibliotecas SSL y que tienen una longitud de 128 bits o más

Véase también supportedCiphers() y setDefaultConfiguration().

[static] QSslConfiguration QSslConfiguration::defaultDtlsConfiguration()

Devuelve la configuración predeterminada de DTLS que se utilizará en las nuevas conexiones DTLS.

La configuración predeterminada de DTLS consiste en:

  • sin certificado local y sin clave privada
  • protocolo DtlsV1_2OrLater
  • la lista de certificados de CA predeterminada del sistema
  • la lista de cifrados, que coincide con la lista de cifrados TLS 1.2 compatibles con las bibliotecas SSL que utilizan 128 bits secretos o más para el cifrado.

Véase también setDefaultDtlsConfiguration().

QSslDiffieHellmanParameters QSslConfiguration::diffieHellmanParameters() const

Recupera el conjunto actual de parámetros de Diffie-Hellman.

Si no se han establecido parámetros de Diffie-Hellman, el objeto ` QSslConfiguration ` utiliza por defecto el grupo MODP de 2048 bits de la norma RFC 3526.

Nota: Los parámetros por defecto pueden cambiar en futuras versiones de Qt. Consulta la documentación de la versión concreta de Qt que estés utilizando para conocer los valores por defecto de dicha versión.

Véase también setDiffieHellmanParameters().

bool QSslConfiguration::dtlsCookieVerificationEnabled() const

Esta función devuelve «true» si se ha habilitado la verificación de cookies DTLS en un socket del lado del servidor.

Véase también setDtlsCookieVerificationEnabled().

QList<QSslEllipticCurve> QSslConfiguration::ellipticCurves() const

Devuelve la lista actual de curvas elípticas de esta conexión. Esta lista se utiliza durante la fase de establecimiento de la conexión para elegir una curva elíptica (cuando se utiliza un cifrado de curva elíptica). La lista de curvas devuelta está ordenada por preferencia descendente (es decir, la primera curva de la lista es la preferida).

Por defecto, la fase de establecimiento de conexión puede elegir cualquiera de las curvas compatibles con las bibliotecas SSL de este sistema, que pueden variar de un sistema a otro. La lista de curvas compatibles con las bibliotecas SSL de este sistema se obtiene mediante la función `QSslSocket::supportedEllipticCurves()`.

Se puede restringir la lista de curvas utilizadas para elegir el cifrado de sesión de este socket llamando a ` setEllipticCurves()` con un subconjunto de los cifrados admitidos. Se puede volver a utilizar el conjunto completo llamando a ` setEllipticCurves()` con la lista devuelta por `QSslSocket::supportedEllipticCurves()`.

Véase también setEllipticCurves.

QSslKey QSslConfiguration::ephemeralServerKey() const

Devuelve la clave efímera del servidor utilizada para algoritmos de cifrado con confidencialidad hacia adelante, por ejemplo, DHE-RSA-AES128-SHA.

La clave efímera solo está disponible cuando se ejecuta en modo cliente, es decir, ` QSslSocket::SslClientMode`. Cuando se ejecuta en modo servidor o se utiliza un algoritmo de cifrado sin confidencialidad hacia adelante, se devuelve una clave nula. La clave efímera del servidor se establecerá antes de emitir la señal `encrypted()`.

[since 6.0] bool QSslConfiguration::handshakeMustInterruptOnError() const

Devuelve «true» si una función de devolución de llamada de verificación emitirá un ` QSslSocket::handshakeInterruptedOnError()` de forma anticipada, antes de concluir el protocolo de establecimiento de conexión.

Nota: Esta función siempre devuelve «false» para todos los backends excepto OpenSSL.

Esta función se introdujo en Qt 6.0.

Véase también ` setHandshakeMustInterruptOnError()`, ` QSslSocket::handshakeInterruptedOnError()` y ` QSslSocket::continueInterruptedHandshake()`.

bool QSslConfiguration::isNull() const

Devuelve ` true ` si se trata de un objeto ` QSslConfiguration ` nulo.

Un objeto ` QSslConfiguration ` es nulo si se ha construido con los valores predeterminados y no se ha llamado a ningún método de asignación.

Véase también setProtocol(), setLocalCertificate(), setPrivateKey(), setCiphers() y setCaCertificates().

QSslCertificate QSslConfiguration::localCertificate() const

Devuelve el certificado que se presentará al interlocutor durante el proceso de establecimiento de la conexión SSL.

Véase también setLocalCertificate().

QList<QSslCertificate> QSslConfiguration::localCertificateChain() const

Devuelve la cadena de certificados que se presentará al interlocutor durante el proceso de establecimiento de la conexión SSL.

Véase también setLocalCertificateChain() y localCertificate().

[since 6.0] bool QSslConfiguration::missingCertificateIsFatal() const

Devuelve «true» si no se pueden ignorar los errores con el código « QSslError::NoPeerCertificate ».

Nota: Siempre devuelve «false» para todos los backends TLS excepto OpenSSL.

Esta función se introdujo en Qt 6.0.

Véase también ` QSslSocket::ignoreSslErrors()` y ` setMissingCertificateIsFatal()`.

QByteArray QSslConfiguration::nextNegotiatedProtocol() const

Esta función devuelve el protocolo negociado con el servidor si se ha habilitado la extensión TLS «Next Protocol Negotiation» (NPN) o «Application-Layer Protocol Negotiation» (ALPN). Para que la extensión NPN/ALPN esté habilitada, es necesario llamar explícitamente a ` setAllowedNextProtocols()` antes de conectarse al servidor.

Si no se ha podido negociar ningún protocolo o la extensión no estaba habilitada, esta función devuelve un ` QByteArray ` que es nulo.

Véanse también ` setAllowedNextProtocols()` y ` nextProtocolNegotiationStatus()`.

QSslConfiguration::NextProtocolNegotiationStatus QSslConfiguration::nextProtocolNegotiationStatus() const

Esta función devuelve el estado de la negociación del siguiente protocolo (NPN) o de la negociación del protocolo de capa de aplicación (ALPN). Si la función no se ha habilitado mediante ` setAllowedNextProtocols()`, esta función devuelve ` NextProtocolNegotiationNone`. El estado se establecerá antes de emitir la señal `encrypted()`.

Véase también setAllowedNextProtocols(), allowedNextProtocols(), nextNegotiatedProtocol() y QSslConfiguration::NextProtocolNegotiationStatus.

bool QSslConfiguration::ocspStaplingEnabled() const

Devuelve «true» si se ha habilitado el «stapling» de OCSP mediante setOCSPStaplingEnabled(); en caso contrario, devuelve «false» (que es el valor por defecto).

Véase también ` setOcspStaplingEnabled()`.

QSslCertificate QSslConfiguration::peerCertificate() const

Devuelve el certificado digital del interlocutor (es decir, el certificado directo del host al que estás conectado) o un certificado nulo, si el interlocutor no ha asignado ningún certificado.

El certificado del par se comprueba automáticamente durante la fase de establecimiento de la conexión, por lo que esta función se utiliza normalmente para obtener el certificado con fines de visualización o de diagnóstico de la conexión. Contiene información sobre el par, incluyendo su nombre de host, el emisor del certificado y la clave pública del par.

Dado que el certificado del par se establece durante la fase de establecimiento de la conexión, es seguro acceder a él desde un slot conectado a la señal « QSslSocket::sslErrors()», « QNetworkReply::sslErrors()» o « QSslSocket::encrypted()».

Si se devuelve un certificado nulo, puede significar que el protocolo de enlace SSL ha fallado, que el host al que estás conectado no tiene certificado o que no hay conexión.

Si desea comprobar la cadena completa de certificados del par, utilice peerCertificateChain() para obtenerlos todos de una vez.

Véase también ` peerCertificateChain()`, ` QSslSocket::sslErrors()`, ` QSslSocket::ignoreSslErrors()`, ` QNetworkReply::sslErrors()` y ` QNetworkReply::ignoreSslErrors()`.

QList<QSslCertificate> QSslConfiguration::peerCertificateChain() const

Devuelve la cadena de certificados digitales del interlocutor, comenzando por el certificado inmediato del interlocutor y terminando con el certificado de la autoridad de certificación (CA).

Los certificados de los pares se comprueban automáticamente durante la fase de establecimiento de la conexión. Esta función se utiliza normalmente para obtener certificados con el fin de mostrarlos o para realizar diagnósticos de conexión. Los certificados contienen información sobre el par y los emisores de los certificados, incluyendo el nombre del host, los nombres de los emisores y las claves públicas de los emisores.

Dado que el certificado del par se establece durante la fase de establecimiento de la conexión, es seguro acceder a él desde una ranura conectada a la señal « QSslSocket::sslErrors()», « QNetworkReply::sslErrors()» o « QSslSocket::encrypted()».

Si se devuelve una lista vacía, puede significar que el protocolo de enlace SSL ha fallado, que el host al que estás conectado no tiene un certificado o que no hay conexión.

Si solo quieres obtener el certificado inmediato del interlocutor, utiliza ` peerCertificate()`.

Véanse también peerCertificate(), QSslSocket::sslErrors(), QSslSocket::ignoreSslErrors(), QNetworkReply::sslErrors() y QNetworkReply::ignoreSslErrors().

int QSslConfiguration::peerVerifyDepth() const

Devuelve el número máximo de certificados de la cadena de certificados del interlocutor que se deben comprobar durante la fase de establecimiento de la conexión SSL, o 0 (el valor por defecto) si no se ha establecido ninguna profundidad máxima, lo que indica que se debe comprobar toda la cadena de certificados.

Los certificados se comprueban en el orden de emisión, empezando por el propio certificado del interlocutor, seguido del certificado de su emisor, y así sucesivamente.

Véanse también setPeerVerifyDepth() y peerVerifyMode().

QSslSocket::PeerVerifyMode QSslConfiguration::peerVerifyMode() const

Devuelve el modo de verificación. Este modo determina si QSslSocket debe solicitar un certificado al interlocutor (es decir, si el cliente solicita un certificado al servidor o si el servidor solicita un certificado al cliente) y si debe exigir que dicho certificado sea válido.

El modo predeterminado es `AutoVerifyPeer`, que indica a ` QSslSocket ` que utilice `VerifyPeer` para los clientes y `QueryPeer` para los servidores.

Véase también setPeerVerifyMode().

QByteArray QSslConfiguration::preSharedKeyIdentityHint() const

Devuelve la sugerencia de identidad.

Véase también ` setPreSharedKeyIdentityHint()`.

QSslKey QSslConfiguration::privateKey() const

Devuelve el objeto ` SSL key ` asignado a esta conexión o una clave nula si aún no se ha asignado ninguna.

Véase también setPrivateKey() y localCertificate().

QSsl::SslProtocol QSslConfiguration::protocol() const

Devuelve la configuración del protocolo para esta configuración SSL.

Véase también setProtocol().

QSslCipher QSslConfiguration::sessionCipher() const

Devuelve el algoritmo criptográfico ( cipher) del socket, o un valor nulo si la conexión no está cifrada. El algoritmo del socket para la sesión se establece durante la fase de establecimiento de la conexión. El algoritmo se utiliza para cifrar y descifrar los datos transmitidos a través del socket.

La infraestructura SSL también proporciona funciones para establecer la lista ordenada de cifrados entre los que la fase de establecimiento de conexión seleccionará finalmente el cifrado de la sesión. Esta lista ordenada debe estar configurada antes de que comience la fase de establecimiento de conexión.

Véanse también ciphers(), setCiphers() y supportedCiphers().

QSsl::SslProtocol QSslConfiguration::sessionProtocol() const

Devuelve el protocolo SSL/TLS del socket o «UnknownProtocol» si la conexión no está cifrada. El protocolo del socket para la sesión se establece durante la fase de establecimiento de la conexión.

Véase también protocol() y setProtocol().

QByteArray QSslConfiguration::sessionTicket() const

Si se ha desactivado la opción « QSsl::SslOptionDisableSessionPersistence », esta función devuelve el ticket de sesión utilizado en el protocolo de enlace SSL en formato ASN.1, adecuado, por ejemplo, para guardarlo en disco. Si no se ha utilizado ningún ticket de sesión o si no se ha desactivado la opción « QSsl::SslOptionDisableSessionPersistence », esta función devuelve un objeto ` QByteArray` vacío.

Nota: Al almacenar el ticket de sesión en disco o en un soporte similar, hay que tener cuidado de no exponer la sesión a un posible atacante, ya que el conocimiento de la sesión permite interceptar datos cifrados con los parámetros de la sesión.

Véase también setSessionTicket(), QSsl::SslOptionDisableSessionPersistence, setSslOption() y QSslSocket::newSessionTicketReceived().

int QSslConfiguration::sessionTicketLifeTimeHint() const

Si se ha desactivado la opción « QSsl::SslOptionDisableSessionPersistence », esta función devuelve la indicación de la duración del ticket de sesión enviada por el servidor (que podría ser 0). Si el servidor no ha enviado un ticket de sesión (por ejemplo, al reanudar una sesión o cuando el servidor no lo admite) o si no se ha desactivado la opción « QSsl::SslOptionDisableSessionPersistence », esta función devuelve -1.

Véanse también sessionTicket(), QSsl::SslOptionDisableSessionPersistence, setSslOption() y QSslSocket::newSessionTicketReceived().

void QSslConfiguration::setAllowedNextProtocols(const QList<QByteArray> &protocols)

Esta función establece los protocolos permitidos ( protocols ) que se negociarán con el servidor a través de la extensión TLS «Next Protocol Negotiation» (NPN) o «Application-Layer Protocol Negotiation» (ALPN); cada elemento de « protocols » debe definir un protocolo permitido. La función debe invocarse explícitamente antes de establecer la conexión para enviar la extensión NPN/ALPN en el protocolo de enlace SSL. Se puede consultar si la negociación se ha realizado con éxito mediante la función ` nextProtocolNegotiationStatus()` ().

Véase también nextNegotiatedProtocol(), nextProtocolNegotiationStatus(), allowedNextProtocols() y QSslConfiguration::NextProtocolHttp1_1.

void QSslConfiguration::setBackendConfiguration(const QMap<QByteArray, QVariant> &backendConfiguration = QMap<QByteArray, QVariant>())

Establece o borra la configuración específica del backend.

Si no se especifica el parámetro ` backendConfiguration `, esta función borrará la configuración específica del backend. Para obtener más información sobre las opciones compatibles, consulta la documentación de ` setBackendConfigurationOption()`.

Véase también backendConfiguration() y setBackendConfigurationOption().

void QSslConfiguration::setBackendConfigurationOption(const QByteArray &name, const QVariant &value)

Establece la opción « name » en la configuración específica del backend en « value ».

Las opciones compatibles con el backend de OpenSSL (>= 1.0.2) están disponibles en la documentación sobre los comandos admitidos en el archivo de configuración. El tipo esperado para el parámetro « value » es « QByteArray » para todas las opciones. Los ejemplos muestran cómo utilizar algunas de las opciones.

Nota: La configuración específica del backend se aplicará después de la configuración general. Si se utiliza la configuración específica del backend para volver a establecer una opción de configuración general, se sobrescribirá dicha opción.

Véase también backendConfiguration() y setBackendConfiguration().

void QSslConfiguration::setCaCertificates(const QList<QSslCertificate> &certificates)

Establece la base de datos de certificados de CA de este socket en certificates. La base de datos de certificados debe configurarse antes del protocolo de enlace SSL. El socket utiliza la base de datos de certificados de CA durante la fase de protocolo de enlace para validar el certificado del interlocutor.

Nota: La configuración predeterminada utiliza la base de datos de certificados de CA del sistema. Si esta no está disponible (como suele ocurrir en iOS), la base de datos predeterminada estará vacía.

Véase también caCertificates(), addCaCertificates() y addCaCertificate().

void QSslConfiguration::setCiphers(const QList<QSslCipher> &ciphers)

Establece el conjunto de cifrado criptográfico de este socket en ` ciphers`, que debe contener un subconjunto de los cifrados de la lista devuelta por la función ` supportedCiphers()`.

La restricción del conjunto de cifrado debe realizarse antes de la fase de establecimiento de la conexión, en la que se elige el cifrado de sesión.

Véanse también ciphers() y supportedCiphers().

[since 6.0] void QSslConfiguration::setCiphers(const QString &ciphers)

Establece el conjunto de cifrados criptográficos para esta configuración en « ciphers », que es una lista de nombres de conjuntos de cifrados separados por dos puntos. Los cifrados se enumeran por orden de preferencia, comenzando por el más preferido. Cada nombre de cifrado de « ciphers » debe coincidir con el nombre de un cifrado de la lista devuelta por « supportedCiphers()». La restricción del conjunto de cifrados debe realizarse antes de la fase de establecimiento de la conexión, en la que se elige el cifrado de sesión.

Nota: Con el backend Schannel se ignora el orden de los cifrados y Schannel selecciona el más seguro durante el handshake.

Esta función se introdujo en Qt 6.0.

Véase también ciphers().

[static] void QSslConfiguration::setDefaultConfiguration(const QSslConfiguration &configuration)

Establece la configuración SSL predeterminada que se utilizará en las nuevas conexiones SSL en configuration. Las conexiones existentes no se ven afectadas por esta llamada.

Véase también supportedCiphers() y defaultConfiguration().

[static] void QSslConfiguration::setDefaultDtlsConfiguration(const QSslConfiguration &configuration)

Establece la configuración predeterminada de DTLS que se utilizará en las nuevas conexiones DTLS en configuration. Las conexiones existentes no se ven afectadas por esta llamada.

Véase también defaultDtlsConfiguration().

void QSslConfiguration::setDiffieHellmanParameters(const QSslDiffieHellmanParameters &dhparams)

Establece un conjunto personalizado de parámetros de Diffie-Hellman que utilizará este socket cuando funcione como servidor para dhparams.

Si no se han establecido parámetros de Diffie-Hellman, el objeto QSslConfiguration utiliza por defecto el grupo MODP de 2048 bits de la RFC 3526.

A partir de la versión 6.7, se puede proporcionar un parámetro Diffie-Hellman vacío para utilizar la selección automática (véase SSL_CTX_set_dh_auto de OpenSSL) si el backend TLS lo admite.

Nota: Los parámetros por defecto pueden cambiar en futuras versiones de Qt. Consulta la documentación de la versión exacta de Qt que estés utilizando para conocer los valores por defecto que utiliza dicha versión.

Véase también diffieHellmanParameters().

void QSslConfiguration::setDtlsCookieVerificationEnabled(bool enable)

Esta función habilita la verificación de cookies DTLS cuando enable tiene el valor «true».

Véase también dtlsCookieVerificationEnabled().

void QSslConfiguration::setEllipticCurves(const QList<QSslEllipticCurve> &curves)

Establece la lista de curvas elípticas que utilizará este socket en curves, que debe contener un subconjunto de las curvas de la lista devuelta por supportedEllipticCurves().

La restricción de las curvas elípticas debe realizarse antes de la fase de establecimiento de la conexión, en la que se elige el cifrado de la sesión.

Véase también ellipticCurves.

[since 6.0] void QSslConfiguration::setHandshakeMustInterruptOnError(bool interrupt)

Si interrupt es verdadero y el backend subyacente admite esta opción, los errores detectados durante la verificación del certificado se notifican inmediatamente mediante la emisión de QSslSocket::handshakeInterruptedOnError(). Esto permite detener el protocolo de enlace incompleto y enviar un mensaje de alerta adecuado al interlocutor. En este caso, no se requiere ninguna acción especial por parte de la aplicación. ` QSslSocket ` cerrará la conexión tras enviar el mensaje de alerta. Si, tras examinar el error, la aplicación desea continuar con el protocolo de enlace, debe llamar a ` QSslSocket::continueInterruptedHandshake()` desde su función de ranura. La conexión señal-ranura debe ser directa.

Nota: Cuando está habilitada la interrupción del protocolo de enlace, los errores que, de otro modo, serían notificados por ` QSslSocket::peerVerifyError()` son notificados únicamente por ` QSslSocket::handshakeInterruptedOnError()`.

Nota: Aunque se haya continuado el handshake, estos errores se notificarán al emitir la señal ` QSslSocket::sslErrors()` (y, por lo tanto, deben ignorarse en la función slot correspondiente).

Esta función se introdujo en Qt 6.0.

Véase también handshakeMustInterruptOnError(), QSslSocket::handshakeInterruptedOnError() y QSslSocket::continueInterruptedHandshake().

[since 6.12] void QSslConfiguration::setKeyingMaterial(const QList<QSslKeyingMaterial> &keyMaterial)

Establece la configuración del material de cifrado para esta conexión SSL en « keyMaterial ».

Esto habilita el mecanismo de exportador TLS, lo que permite a la aplicación derivar material criptográfico adicional a partir de la sesión TLS negociada. El exportador se define en los RFC 5705 y RFC 8446.

La configuración debe establecerse antes de que comience el protocolo de enlace TLS. Llamar a esta función en una conexión ya cifrada no tiene ningún efecto.

Cada entrada de QSslKeyingMaterial especifica la etiqueta del exportador, un valor de contexto opcional y la longitud del material de clave que se va a derivar. Tras un protocolo de enlace satisfactorio, el material de clave solicitado se puede recuperar de la conexión SSL.

El material de clave exportado es exclusivo de la sesión TLS y puede utilizarse de forma segura para derivar claves para protocolos a nivel de aplicación que requieran un enlace criptográfico con el canal TLS subyacente.

Nota: Esta característica es específica del backend y, actualmente, requiere compatibilidad con OpenSSL.

Advertencia: Las aplicaciones son responsables de definir etiquetas de exportador únicas y resistentes a colisiones. La reutilización de etiquetas o contextos para fines distintos puede dar lugar a sutiles vulnerabilidades de seguridad.

Esta función se introdujo en Qt 6.12.

Véase también ` takeKeyingMaterial()`.

void QSslConfiguration::setLocalCertificate(const QSslCertificate &certificate)

Establece que el certificado que se presentará al interlocutor durante el protocolo de enlace SSL sea certificate.

Configurar el certificado una vez establecida la conexión no tiene ningún efecto.

Un certificado es el medio de identificación utilizado en el proceso SSL. El extremo remoto utiliza el certificado local para verificar la identidad del usuario local comparándola con su lista de autoridades de certificación. En la mayoría de los casos, como en la navegación web por HTTP, solo los servidores se identifican ante los clientes, por lo que el cliente no envía ningún certificado.

Véase también localCertificate().

void QSslConfiguration::setLocalCertificateChain(const QList<QSslCertificate> &localChain)

Establece que la cadena de certificados que se presentará al interlocutor durante el protocolo de enlace SSL sea localChain.

Configurar la cadena de certificados una vez establecida la conexión no tiene ningún efecto.

Un certificado es el medio de identificación utilizado en el proceso SSL. El extremo remoto utiliza el certificado local para verificar la identidad del usuario local comparándola con su lista de autoridades de certificación. En la mayoría de los casos, como en la navegación web por HTTP, solo los servidores se identifican ante los clientes, por lo que el cliente no envía ningún certificado.

A diferencia de QSslConfiguration::setLocalCertificate(), este método permite especificar cualquier certificado intermedio necesario para validar su certificado. El primer elemento de la lista debe ser el certificado de hoja.

Véase también localCertificateChain().

[since 6.0] void QSslConfiguration::setMissingCertificateIsFatal(bool cannotRecover)

Si ` cannotRecover ` es verdadero y el modo de verificación utilizado es ` QSslSocket::VerifyPeer ` o ` QSslSocket::AutoVerifyPeer ` (para un socket del lado del cliente), el certificado faltante del interlocutor se considerará un error irrecuperable que no se puede ignorar. Se enviará un mensaje de alerta adecuado al interlocutor antes de cerrar la conexión.

Nota: Solo está disponible si Qt se ha configurado y compilado con el backend de OpenSSL.

Esta función se introdujo en Qt 6.0.

Véase también QSslSocket::ignoreSslErrors(), QSslSocket::PeerVerifyMode y missingCertificateIsFatal().

void QSslConfiguration::setOcspStaplingEnabled(bool enabled)

Si enabled es verdadero, el cliente QSslSocket enviará una solicitud de estado del certificado a su par al iniciar un protocolo de establecimiento de conexión. Durante dicho protocolo, QSslSocket verificará la respuesta del servidor. Este valor debe establecerse antes de que comience el protocolo de establecimiento de conexión.

Véase también ocspStaplingEnabled().

void QSslConfiguration::setPeerVerifyDepth(int depth)

Establece en depth el número máximo de certificados de la cadena de certificados del par que se comprobarán durante la fase de establecimiento de la conexión SSL. Establecer una profundidad de 0 significa que no se ha fijado ninguna profundidad máxima, lo que indica que debe comprobarse toda la cadena de certificados.

Los certificados se comprueban en el orden de emisión, empezando por el propio certificado del interlocutor, seguido del certificado de su emisor, y así sucesivamente.

Véase también peerVerifyDepth() y setPeerVerifyMode().

void QSslConfiguration::setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)

Establece el modo de verificación en « mode ». Este modo determina si QSslSocket debe solicitar un certificado al interlocutor (es decir, si el cliente solicita un certificado al servidor o si el servidor solicita un certificado al cliente) y si debe exigir que dicho certificado sea válido.

El modo predeterminado es `AutoVerifyPeer`, que indica a ` QSslSocket ` que utilice `VerifyPeer` para los clientes y `QueryPeer` para los servidores.

Véase también peerVerifyMode().

void QSslConfiguration::setPreSharedKeyIdentityHint(const QByteArray &hint)

Establece la indicación de identidad para una autenticación con clave precompartida en hint. Esto afectará al próximo protocolo de enlace que se inicie; llamar a esta función en un socket ya cifrado no afectará a la indicación de identidad del socket.

¡La indicación de identidad solo se utiliza en QSslSocket::SslServerMode!

Véase también preSharedKeyIdentityHint().

void QSslConfiguration::setPrivateKey(const QSslKey &key)

Establece la clave privada de la conexión key en key. La clave privada y el certificado local certificate son utilizados por los clientes y servidores que deben demostrar su identidad ante los pares SSL.

Tanto la clave como el certificado local son obligatorios si se crea un socket de servidor SSL. Si se crea un socket de cliente SSL, la clave y el certificado local son obligatorios si el cliente debe identificarse ante un servidor SSL.

Véase también privateKey() y setLocalCertificate().

void QSslConfiguration::setProtocol(QSsl::SslProtocol protocol)

Establece la configuración del protocolo para esta configuración en « protocol ».

Establecer el protocolo una vez que la conexión ya se ha establecido no tiene ningún efecto.

Véase también protocol().

void QSslConfiguration::setSessionTicket(const QByteArray &sessionTicket)

Establece el ticket de sesión que se utilizará en un protocolo de enlace SSL. Para que esto funcione, la opción « QSsl::SslOptionDisableSessionPersistence » debe estar desactivada, y « sessionTicket » debe estar en formato ASN.1, tal y como lo devuelve la función sessionTicket().

Véanse también sessionTicket(), QSsl::SslOptionDisableSessionPersistence, setSslOption() y QSslSocket::newSessionTicketReceived().

void QSslConfiguration::setSslOption(QSsl::SslOption option, bool on)

Activa o desactiva la compatibilidad con SSL option. Si on es «true», se activa option. Si on es «false», se desactiva option.

Véase también testSslOption().

[static] QList<QSslCipher> QSslConfiguration::supportedCiphers()

Devuelve la lista de algoritmos criptográficos compatibles con este sistema. Esta lista la establecen las bibliotecas SSL del sistema y puede variar de un sistema a otro.

Véase también ciphers() y setCiphers().

[static] QList<QSslEllipticCurve> QSslConfiguration::supportedEllipticCurves()

Devuelve la lista de curvas elípticas compatibles con este sistema. Esta lista la establecen las bibliotecas SSL del sistema y puede variar de un sistema a otro.

Véase también ellipticCurves() y setEllipticCurves().

[noexcept] void QSslConfiguration::swap(QSslConfiguration &other)

Sustituye esta instancia de configuración SSL por other. Esta operación es muy rápida y nunca falla.

[static] QList<QSslCertificate> QSslConfiguration::systemCaCertificates()

Esta función proporciona la base de datos de certificados de CA que ofrece el sistema operativo. La base de datos de certificados de CA devuelta por esta función se utiliza para inicializar la base de datos devuelta por caCertificates() en el QSslConfiguration predeterminado.

Véanse también caCertificates(), setCaCertificates(), defaultConfiguration(), addCaCertificate() y addCaCertificates().

[since 6.12] QList<QSslKeyingMaterial> QSslConfiguration::takeKeyingMaterial()

Devuelve la configuración del material de clave para esta conexión SSL.

El material de clave permite a una aplicación obtener material criptográfico adicional a partir de una sesión TLS establecida, utilizando el mecanismo de exportador TLS tal y como se define en los RFC 5705 y RFC 8446.

Cada entrada de la lista devuelta describe una solicitud de material de clave exportado, incluyendo la etiqueta del exportador, el contexto opcional y la longitud deseada de los datos exportados. El material de clave real solo está disponible tras un establecimiento de conexión satisfactorio.

El material de clave exportado está vinculado a la sesión TLS específica y es criptográficamente independiente de las claves de sesión utilizadas para el cifrado. Se puede utilizar para fines específicos de la aplicación, como el enlace de canales o la derivación de claves para protocolos superpuestos a TLS.

Si no se ha establecido ninguna configuración del material de clave, esta función devuelve una lista vacía.

Los valores se transfieren en lugar de compartirse: las entradas que quedan en esta configuración carecen de valor clones, por lo que aún pueden utilizarse para solicitar de nuevo el mismo material de clave. Solo las entradas devueltas contienen los valores derivados.

Nota: La disponibilidad del material de clave depende del backend de TLS. Actualmente, esta característica solo es compatible cuando se utiliza OpenSSL.

Advertencia: El material de claveexportado debe manejarse con cuidado. Un uso inadecuado puede comprometer la seguridad de la sesión TLS o de los protocolos de nivel superior.

Esta función se introdujo en Qt 6.12.

Véase también ` setKeyingMaterial()`.

[since 6.12] std::optional<QSslKeyingMaterial> QSslConfiguration::takeKeyingMaterial(const QSslKeyingMaterial &material)

Devuelve el material de cifrado derivado para la solicitud « material » indicada.

Devuelve la entrada de la lista de material de cifrado que coincide con material por etiqueta, contexto y tamaño solicitado, o std::nullopt si no se ha encontrado ninguna entrada que coincida.

Si se encuentra una entrada coincidente y el protocolo de enlace TLS se ha completado correctamente, el método QSslKeyingMaterial::value() del objeto devuelto contiene el material de clave derivado.

El valor solo se puede obtener una vez: la entrada que queda es un ` clone` sin valor, que sigue coincidiendo con ` material`.

Esta función se introdujo en Qt 6.12.

Véase también takeKeyingMaterial() y setKeyingMaterial().

bool QSslConfiguration::testSslOption(QSsl::SslOption option) const

Devuelve « true » si está habilitada la compatibilidad SSL especificada option.

Véase también setSslOption().

bool QSslConfiguration::operator!=(const QSslConfiguration &other) const

Devuelve « true » si este « QSslConfiguration » difiere de « other ». Se considera que dos objetos « QSslConfiguration » son diferentes si difieren en cualquier estado o configuración.

Véase también operator==().

QSslConfiguration &QSslConfiguration::operator=(const QSslConfiguration &other)

Copia la configuración y el estado de other. Si other es nulo, este objeto también será nulo.

bool QSslConfiguration::operator==(const QSslConfiguration &other) const

Devuelve ` true ` si este objeto ` QSslConfiguration ` es igual a ` other`.

Se considera que dos objetos ` QSslConfiguration ` son iguales si tienen exactamente la misma configuración y el mismo estado.

Véase también operator!=().

Documentación de las variables miembro

const char[] QSslConfiguration::ALPNProtocolHTTP2

Esta variable contiene el valor utilizado para negociar HTTP 2 durante la negociación del protocolo en la capa de aplicación.

const char[] QSslConfiguration::NextProtocolHttp1_1

Esta variable contiene el valor utilizado para negociar el protocolo HTTP 1.1 durante la negociación del protocolo siguiente.

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.