Класс QSslConfiguration

Класс QSslConfiguration хранит конфигурацию и состояние подключения SSL Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются перевходными.

Типы

Открытые функции

Статические публичные члены

Подробное описание

Класс QSslConfiguration хранит конфигурацию и состояние SSL-соединения.

QSslConfiguration используется классами Qt networking для передачи информации об открытом SSL-соединении и для предоставления приложению возможности управлять определенными функциями этого соединения.

Настройки, которые в настоящее время поддерживает QSslConfiguration:

• Используемый протокол SSL/TLS
• Сертификат, который будет представлен узлу-партнёру во время подключения, и соответствующий ему закрытый ключ
• Шифры, разрешенные для шифрования подключения
• Список сертификатов Удостоверяющих центров, используемых для проверки сертификата узла-партнёра

Эти настройки применяются только во время рукопожатия подключения. Настройка их после установления подключения не оказывает никакого влияния.

Состояния, которые поддерживает QSslConfiguration:

• Сертификат, представленный узлом-партнёром во время рукопожатия, вместе с цепочкой, ведущей к сертификату УЦ
• Шифр, используемый для шифрования этого сеанса

Состояние можно получить только после начала SSL-подключения, но не обязательно до его завершения. Некоторые настройки могут измениться в ходе SSL-подключения без необходимости его перезапуска (например, шифр может со временем измениться).

Состояние в объектах QSslConfiguration изменить нельзя.

QSslConfiguration может использоваться с QSslSocket и API доступа к сети.

Обратите внимание, что изменение настроек в QSslConfiguration недостаточно для изменения настроек в связанном SSL-подключении. Вы должны вызвать setSslConfiguration на изменённом объекте QSslConfiguration, чтобы добиться этого. Следующий пример демонстрирует, как изменить протокол на TLSv1_0 в объекте QSslSocket:

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

См. также QSsl::SslProtocol, QSslCertificate, QSslCipher, QSslKey, QSslSocket, QNetworkAccessManager, QSslSocket::sslConfiguration() и QSslSocket::setSslConfiguration().

Документация по типам членов

enum QSslConfiguration::NextProtocolNegotiationStatus

Описывает состояние переговорного процесса о протоколе следующего уровня (NPN).

Документация по функциям-членам

QSslConfiguration::QSslConfiguration()

Создаёт пустую конфигурацию SSL. Эта конфигурация не содержит действительных настроек, и состояние будет пустым. isNull() вернёт true после вызова этого конструктора.

После вызова любого метода-установщика isNull() вернёт false.

QSslConfiguration::QSslConfiguration(const QSslConfiguration &other)

Копирует конфигурацию и состояние other. Если other равно null, этот объект тоже будет null.

QSslConfiguration::~QSslConfiguration()

Освобождает все ресурсы, удерживаемые QSslConfiguration.

QList<QByteArray> QSslConfiguration::allowedNextProtocols() const

Эта функция возвращает разрешенные протоколы, которые должны быть согласованы с сервером через расширение TLS Next Protocol Negotiation (NPN), как установлено с помощью setAllowedNextProtocols().

Эта функция была введена в Qt 5.3.

См. также nextNegotiatedProtocol(), nextProtocolNegotiationStatus(), setAllowedNextProtocols(), QSslConfiguration::NextProtocolSpdy3_0 и QSslConfiguration::NextProtocolHttp1_1.

QList<QSslCertificate> QSslConfiguration::caCertificates() const

Возвращает базу данных сертификатов УЦ для этого подключения. База данных сертификатов УЦ используется сокетом во время фазы рукопожатия для проверки сертификата узла-партнёра. Она может быть изменена перед рукопожатием с помощью setCaCertificates() или с помощью QSslSocket's addCaCertificate() и addCaCertificates().

См. также setCaCertificates().

QList<QSslCipher> QSslConfiguration::ciphers() const

Возвращает текущий криптографический набор шифров для этого подключения. Этот список используется во время фазы рукопожатия для выбора шифра сессии. Возвращаемый список шифров упорядочен по убыванию приоритета. (т.е. первый шифр в списке — это наиболее предпочтительный шифр). Шифр сессии будет первым в списке, который также поддерживается узлом-партнёром.

По умолчанию, фаза рукопожатия может выбрать любой из шифров, поддерживаемых SSL-библиотеками этой системы, которые могут различаться в зависимости от системы. Список шифров, поддерживаемых SSL-библиотеками этой системы, возвращается методом QSslSocket::supportedCiphers(). Вы можете ограничить список шифров, используемых для выбора шифра сессии для этого сокета, вызвав setCiphers() с подмножеством поддерживаемых шифров. Вы можете вернуться к использованию всего набора, вызвав setCiphers() со списком, возвращённым методом QSslSocket::supportedCiphers().

См. также setCiphers() и QSslSocket::supportedCiphers().

[static] QSslConfiguration QSslConfiguration::defaultConfiguration()

Возвращает стандартную конфигурацию SSL для использования в новых SSL-подключениях.

Стандартная конфигурация SSL состоит из:

• отсутствия локального сертификата и закрытого ключа
• протокола SecureProtocols (что означает, что будет использован либо TLS 1.0, либо SSL 3)
• стандартного списка сертификатов УЦ системы
• списка шифров, равного списку поддерживаемых шифров SSL библиотек системы, которые имеют 128 бит или более

См. также QSslSocket::supportedCiphers() и setDefaultConfiguration().

QVector<QSslEllipticCurve> QSslConfiguration::ellipticCurves() const

Возвращает текущий список эллиптических кривых для этого подключения. Этот список используется во время фазы рукопожатия для выбора эллиптической кривой (при использовании шифра эллиптических кривых). Возвращаемый список кривых упорядочен по убыванию приоритета (т.е. первая кривая в списке — это наиболее предпочтительная кривая).

По умолчанию, фаза рукопожатия может выбрать любую из кривых, поддерживаемых SSL-библиотеками этой системы, которые могут различаться в зависимости от системы. Список кривых, поддерживаемых SSL-библиотеками этой системы, возвращается методом QSslSocket::supportedEllipticCurves().

Вы можете ограничить список кривых, используемых для выбора шифра сессии для этого сокета, вызвав setEllipticCurves() с подмножеством поддерживаемых шифров. Вы можете вернуться к использованию всего набора, вызвав setEllipticCurves() со списком, возвращённым методом QSslSocket::supportedEllipticCurves().

Эта функция была введена в Qt 5.5.

См. также setEllipticCurves.

bool QSslConfiguration::isNull() const

Возвращает true, если это объект QSslConfiguration типа null.

Объект QSslConfiguration является null, если он был создан по умолчанию, и не были вызваны никакие методы установки.

См. также setProtocol(), setLocalCertificate(), setPrivateKey(), setCiphers() и setCaCertificates().

QSslCertificate QSslConfiguration::localCertificate() const

Возвращает сертификат, который будет представлен узлу-партнёру во время процесса SSL-рукопожатия.

См. также setLocalCertificate().

QList<QSslCertificate> QSslConfiguration::localCertificateChain() const

Возвращает цепочку сертификатов, которая будет представлена узлу-партнёру во время процесса SSL-рукопожатия.

Эта функция была введена в Qt 5.1.

См. также setLocalCertificateChain() и localCertificate().

QByteArray QSslConfiguration::nextNegotiatedProtocol() const

Эта функция возвращает протокол, согласованный с сервером, если расширение Next Protocol Negotiation (NPN) TLS было включено. Для включения расширения NPN необходимо явно вызвать setAllowedNextProtocols() перед подключением к серверу.

Если протокол не смог быть согласован или расширение не было включено, эта функция возвращает QByteArray со значением null.

Данная функция была добавлена в Qt 5.3.

См. также setAllowedNextProtocols() и nextProtocolNegotiationStatus().

NextProtocolNegotiationStatus QSslConfiguration::nextProtocolNegotiationStatus() const

Эта функция возвращает статус переговорного процесса Next Protocol Negotiation (NPN). Если функция не была включена через setAllowedNextProtocols(), эта функция возвращает NextProtocolNegotiationNone. Статус будет установлен перед вызовом сигнала encrypted().

Данная функция была добавлена в Qt 5.3.

См. также setAllowedNextProtocols(), allowedNextProtocols(), nextNegotiatedProtocol(), и QSslConfiguration::NextProtocolNegotiationStatus.

QSslCertificate QSslConfiguration::peerCertificate() const

Возвращает цифровой сертификат удаленного узла (т.е., непосредственный сертификат узла, к которому вы подключены), или нулевой сертификат, если удалённый узел не предоставил сертификат.

Сертификат удалённого узла проверяется автоматически во время фазы рукопожатия, поэтому данная функция обычно используется для извлечения сертификата для отображения или диагностики соединения. Он содержит информацию об удалённом узле, включая его имя хоста, издателя сертификата и открытый ключ удалённого узла.

Поскольку сертификат удалённого узла устанавливается во время фазы рукопожатия, доступ к сертификату удалённого узла безопасен из слота, подключенного к сигналу QSslSocket::sslErrors(), QNetworkReply::sslErrors() или QSslSocket::encrypted().

Если возвращается нулевой сертификат, это может означать, что фаза рукопожатия SSL завершилась неудачно, что у узла, к которому вы подключены, нет сертификата или что нет подключения.

Если вы хотите проверить полную цепочку сертификатов удалённого узла, используйте peerCertificateChain() для получения всех сертификатов сразу.

См. также peerCertificateChain(), QSslSocket::sslErrors(), QSslSocket::ignoreSslErrors(), QNetworkReply::sslErrors(), и QNetworkReply::ignoreSslErrors().

QList<QSslCertificate> QSslConfiguration::peerCertificateChain() const

Возвращает цепочку цифровых сертификатов удалённого узла, начиная с непосредственного сертификата удалённого узла и заканчивая сертификатом удостоверяющего центра.

Сертификаты удалённого узла проверяются автоматически во время фазы рукопожатия. Данная функция обычно используется для извлечения сертификатов для отображения или диагностики соединений. Сертификаты содержат информацию об удалённом узле и издателях сертификатов, включая имя хоста, имена издателей и открытые ключи издателей.

Поскольку сертификат удалённого узла устанавливается во время фазы рукопожатия, доступ к сертификату удалённого узла безопасен из слота, подключенного к сигналу QSslSocket::sslErrors(), QNetworkReply::sslErrors() или QSslSocket::encrypted().

Если возвращается пустой список, это может означать, что фаза рукопожатия SSL завершилась неудачно, что у узла, к которому вы подключены, нет сертификата или что нет подключения.

Если вам нужен только непосредственный сертификат удалённого узла, используйте peerCertificate().

См. также peerCertificate(), QSslSocket::sslErrors(), QSslSocket::ignoreSslErrors(), QNetworkReply::sslErrors(), и QNetworkReply::ignoreSslErrors().

int QSslConfiguration::peerVerifyDepth() const

Возвращает максимальное количество сертификатов в цепочке сертификатов удалённого узла, которые должны быть проверены во время фазы рукопожатия SSL, или 0 (по умолчанию), если максимальная глубина не установлена, что означает, что вся цепочка сертификатов должна быть проверена.

Сертификаты проверяются в порядке выдачи, начиная с сертификата самого удалённого узла, затем сертификата его издателя и так далее.

См. также setPeerVerifyDepth() и peerVerifyMode().

QSslSocket::PeerVerifyMode QSslConfiguration::peerVerifyMode() const

Возвращает режим проверки. Этот режим определяет, должен ли QSslSocket запрашивать сертификат от удалённого узла (т.е., клиент запрашивает сертификат от сервера, или сервер запрашивает сертификат от клиента), и должен ли он требовать, чтобы этот сертификат был действительным.

Режим по умолчанию — AutoVerifyPeer, который указывает QSslSocket использовать VerifyPeer для клиентов и QueryPeer для серверов.

См. также setPeerVerifyMode().

QSslKey QSslConfiguration::privateKey() const

Возвращает ключ SSL, назначенный этому соединению, или нулевой ключ, если ещё не назначен.

См. также setPrivateKey() и localCertificate().

QSsl::SslProtocol QSslConfiguration::protocol() const

Возвращает настройку протокола для данной конфигурации SSL.

См. также setProtocol().

QSslCipher QSslConfiguration::sessionCipher() const

Возвращает криптографическое шифрование сокета или нулевое шифрование, если соединение не зашифровано. Шифрование сокета для сеанса устанавливается во время фазы рукопожатия. Шифрование используется для шифрования и расшифровки данных, передаваемых через сокет.

Инфраструктура SSL также предоставляет функции для задания упорядоченного списка шифров, из которых фаза рукопожатия в конечном итоге выберет шифрование сеанса. Этот упорядоченный список должен быть создан до начала фазы рукопожатия.

См. также ciphers(), setCiphers(), и QSslSocket::supportedCiphers().

QSsl::SslProtocol QSslConfiguration::sessionProtocol() const

Возвращает протокол SSL/TLS сокета или UnknownProtocol, если соединение не зашифровано. Протокол сокета для сеанса устанавливается во время фазы рукопожатия.

Данная функция была добавлена в Qt 5.4.

См. также protocol() и setProtocol().

QByteArray QSslConfiguration::sessionTicket() const

Если QSsl::SslOptionDisableSessionPersistence был выключен, эта функция возвращает билет сеанса, используемый в рукопожатии SSL в формате ASN.1, пригодный, например, для сохранения на диске. Если билет сеанса не использовался или QSsl::SslOptionDisableSessionPersistence не был выключен, эта функция возвращает пустой QByteArray.

Примечание: При сохранении билета сеанса на диске или аналогично, будьте осторожны, чтобы не раскрыть сеанс потенциальному злоумышленнику, так как знание сеанса позволяет перехватывать данные, зашифрованные параметрами сеанса.

Данная функция была добавлена в Qt 5.2.

См. также setSessionTicket(), QSsl::SslOptionDisableSessionPersistence и setSslOption().

int QSslConfiguration::sessionTicketLifeTimeHint() const

Если QSsl::SslOptionDisableSessionPersistence был выключен, эта функция возвращает временной отметку билета сеанса, отправленный сервером (возможно, 0). Если сервер не отправил билет сеанса (например, при возобновлении сеанса или если сервер его не поддерживает) или QSsl::SslOptionDisableSessionPersistence не был выключен, эта функция возвращает -1.

Данная функция была добавлена в Qt 5.2.

См. также sessionTicket(), QSsl::SslOptionDisableSessionPersistence и setSslOption().

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

Эта функция задаёт разрешенные протоколы для переговоров с сервером через расширение NPN (Next Protocol Negotiation) протокола TLS; каждый элемент в protocols должен определять один разрешённый протокол. Функция должна быть вызвана явно перед подключением для отправки расширения NPN в процессе рукопожатия SSL. Успех переговоров можно запросить через nextProtocolNegotiationStatus().

Данная функция была добавлена в Qt 5.3.

См. также nextNegotiatedProtocol(), nextProtocolNegotiationStatus(), allowedNextProtocols(), QSslConfiguration::NextProtocolSpdy3_0 и QSslConfiguration::NextProtocolHttp1_1.

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

Устанавливает базу данных сертификатов CA для этого сокета в certificates. База данных сертификатов должна быть установлена до фазы рукопожатия SSL. База данных сертификатов CA используется сокетом во время фазы рукопожатия для проверки сертификата удалённого узла.

См. также caCertificates().

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

Устанавливает криптографический набор шифров для этого сокета в ciphers, который должен содержать подмножество шифров в списке, возвращаемом supportedCiphers().

Ограничение набора шифров должно быть выполнено до фазы рукопожатия, где выбирается сеансовый шифр.

См. также ciphers() и QSslSocket::supportedCiphers().

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

Устанавливает конфигурацию SSL по умолчанию, используемую в новых соединениях SSL, в configuration. Существующие соединения не затрагиваются этим вызовом.

См. также QSslSocket::supportedCiphers() и defaultConfiguration().

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

Устанавливает список эллиптических кривых, которые должны использоваться этим сокетом, в curves, который должен содержать подмножество кривых в списке, возвращаемом supportedEllipticCurves().

Ограничение эллиптических кривых должно быть выполнено до фазы рукопожатия, где выбирается сеансовый шифр.

Эта функция была добавлена в Qt 5.5.

См. также ellipticCurves.

void QSslConfiguration::setLocalCertificate(const QSslCertificate &certificate)

Устанавливает сертификат, который будет представлен удалённому узлу во время SSL-рукопожатия, в certificate.

Установка сертификата после того, как соединение установлено, не имеет эффекта.

Сертификат — это средство идентификации, используемое в процессе SSL. Локальный сертификат используется удалённым узлом для проверки идентификации локального пользователя по списку уполномоченных центров сертификации. В большинстве случаев, таких как веб-браузинг по протоколу HTTP, только серверы идентифицируются клиентам, поэтому клиент не отправляет сертификат.

См. также localCertificate().

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

Устанавливает цепочку сертификатов, которая будет представлена удалённому узлу во время SSL-рукопожатия, в localChain.

Установка цепочки сертификатов после того, как соединение установлено, не имеет эффекта.

Сертификат — это средство идентификации, используемое в процессе SSL. Локальный сертификат используется удалённым узлом для проверки идентификации локального пользователя по списку уполномоченных центров сертификации. В большинстве случаев, таких как веб-браузинг по протоколу HTTP, только серверы идентифицируются клиентам, поэтому клиент не отправляет сертификат.

В отличие от QSslConfiguration::setLocalCertificate(), этот метод позволяет указать все промежуточные сертификаты, необходимые для проверки вашего сертификата. Первый элемент в списке должен быть лист-сертификатом.

Эта функция была добавлена в Qt 5.1.

См. также localCertificateChain().

void QSslConfiguration::setPeerVerifyDepth(int depth)

Устанавливает максимальное количество сертификатов в цепочке сертификатов удалённого узла, которые должны быть проверены во время фазы SSL-рукопожатия, в depth. Установка глубины 0 означает, что максимальная глубина не установлена, что указывает на то, что вся цепочка сертификатов должна быть проверена.

Сертификаты проверяются в порядке выдачи, начиная с собственного сертификата удалённого узла, затем сертификата его выдавшего и так далее.

См. также peerVerifyDepth() и setPeerVerifyMode().

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

Устанавливает режим проверки в mode. Этот режим определяет, должен ли QSslSocket запрашивать сертификат от удалённого узла (т.е. клиент запрашивает сертификат у сервера или сервер запрашивает сертификат у клиента), и должен ли он требовать, чтобы этот сертификат был действительным.

Режим по умолчанию — AutoVerifyPeer, который сообщает QSslSocket использовать VerifyPeer для клиентов и QueryPeer для серверов.

См. также peerVerifyMode().

void QSslConfiguration::setPrivateKey(const QSslKey &key)

Устанавливает закрытый ключ соединения в key. Закрытый ключ и локальный сертификат используются клиентами и серверами, которые должны доказать свою личность удалённым узлам SSL.

И ключ, и локальный сертификат необходимы, если вы создаёте сокет SSL-сервера. Если вы создаёте сокет SSL-клиента, ключ и локальный сертификат необходимы, если ваш клиент должен идентифицировать себя SSL-серверу.

См. также privateKey() и setLocalCertificate().

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

Устанавливает настройку протокола для этой конфигурации в protocol.

Установка протокола после того, как соединение уже установлено, не имеет эффекта.

См. также protocol().

void QSslConfiguration::setSessionTicket(const QByteArray &sessionTicket)

Устанавливает билет сеанса, который будет использоваться в SSL-рукопожатии. QSsl::SslOptionDisableSessionPersistence должен быть выключен для работы, а sessionTicket должен быть в формате ASN.1, как возвращается sessionTicket().

Эта функция была добавлена в Qt 5.2.

См. также sessionTicket(), QSsl::SslOptionDisableSessionPersistence и setSslOption().

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

Включает или выключает параметр совместимости SSL option. Если on равно true, option включен. Если on равно false, option выключен.

См. также testSslOption().

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

Возвращает список криптографических шифров, поддерживаемых этой системой. Этот список задаётся SSL-библиотеками системы и может различаться в зависимости от системы.

Эта функция была добавлена в Qt 5.5.

См. также ciphers() и setCiphers().

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

Возвращает список эллиптических кривых, поддерживаемых этой системой. Этот список задаётся SSL-библиотеками системы и может различаться в зависимости от системы.

Эта функция была добавлена в Qt 5.5.

См. также ellipticCurves() и setEllipticCurves().

void QSslConfiguration::swap(QSslConfiguration &other)

Меняет местами это экземпляр конфигурации SSL с other. Эта функция очень быстрая и никогда не терпит неудач.

Эта функция была добавлена в Qt 5.0.

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

Эта функция предоставляет базу данных сертификатов CA, предоставленную операционной системой. База данных сертификатов CA, возвращаемая этой функцией, используется для инициализации базы данных, возвращаемой caCertificates() на стандартной QSslConfiguration.

Эта функция была добавлена в Qt 5.5.

См. также caCertificates(), setCaCertificates() и defaultConfiguration().

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

Возвращает true если указанный параметр совместимости SSL option включён.

Данная функция была представлена в Qt 4.8.

См. также setSslOption().

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

Возвращает true , если этот QSslConfiguration отличается от other. Два объекта QSslConfiguration считаются различными, если какой-либо параметр или состояние отличаются.

См. также operator==().

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

Оператор перемещающего присваивания.

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

Копирует конфигурацию и состояние other. Если other равно null, этот объект также будет null.

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

Возвращает true , если этот объект QSslConfiguration равен other.

Два объекта QSslConfiguration считаются равными, если они имеют точно такие же настройки и состояние.

См. также operator!=().