Spec-Zone.ru › Qt 6.1

Класс QAuthenticator

Класс QAuthenticator предоставляет объект аутентификации. Подробнее...

Заголовок: #include <QAuthenticator>
CMake: find_package(Qt6 COMPONENTS Network REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Network)
qmake: QT += network
  • Список всех членов, включая унаследованные

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

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

QAuthenticator(const QAuthenticator &other)
QAuthenticator()
QAuthenticator & operator=(const QAuthenticator &other)
~QAuthenticator()
bool isNull() const
QVariant option(const QString &opt) const
QVariantHash options() const
QString password() const
QString realm() const
void setOption(const QString &opt, const QVariant &value)
void setPassword(const QString &password)
void setUser(const QString &user)
QString user() const
bool operator!=(const QAuthenticator &other) const
bool operator==(const QAuthenticator &other) const

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

Класс QAuthenticator обычно используется в сигналах authenticationRequired() и proxyAuthenticationRequired() класса QNetworkAccessManager и QAbstractSocket. Класс предоставляет способ возврата необходимой информации об аутентификации в сокет при доступе к службам, требующим аутентификации.

QAuthenticator поддерживает следующие методы аутентификации:

  • Basic
  • NTLM версии 2
  • Digest-MD5
  • SPNEGO/Negotiate

Параметры

Помимо имени пользователя и пароля, необходимых для аутентификации, объект QAuthenticator может также содержать дополнительные параметры. Функция options() может использоваться для запроса входящих параметров, отправленных сервером; функция setOption() может использоваться для установки исходящих параметров, которые будут обработаны вычислением аутентификатора. Принимаемые и предоставляемые параметры зависят от типа аутентификации (см. метод()).

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

Basic

Параметр Направление Тип Описание
realm Входящий QString Содержит область аутентификации, аналогично realm()

Механизм аутентификации Basic не поддерживает исходящих параметров.

NTLM версии 2

Механизм аутентификации NTLM в настоящее время не поддерживает входящих или исходящих параметров. В Windows, если user не был задан, будут использоваться учетные данные домена\пользователя на локальной системе для включения функции Single-Sign-On.

Digest-MD5

Параметр Направление Тип Описание
realm Входящий QString Содержит область аутентификации, аналогично realm()

Механизм аутентификации Digest-MD5 не поддерживает исходящих параметров.

SPNEGO/Negotiate

Этот механизм аутентификации в настоящее время не поддерживает входящих или исходящих параметров.

См. также QSslSocket.

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

QAuthenticator::QAuthenticator(const QAuthenticator &other)

Создаёт копию other.

QAuthenticator::QAuthenticator()

Создаёт пустой объект аутентификации.

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

Присваивает содержимое other данному аутентификатору.

QAuthenticator::~QAuthenticator()

Деструктор объекта.

bool QAuthenticator::isNull() const

Возвращает true если объект не был инициализирован. Возвращает false если были вызваны не-константные члены-функции, или содержимое было создано или скопировано из другого инициализированного объекта QAuthenticator.

QVariant QAuthenticator::option(const QString &opt) const

Возвращает значение, связанное с параметром opt, если оно было установлено сервером. См. раздел Параметры для получения дополнительной информации о входящих параметрах. Если параметр opt не найден, будет возвращён невалидный QVariant.

См. также setOption(), options(), и QAuthenticator options.

QVariantHash QAuthenticator::options() const

Возвращает все входящие параметры, установленные в этом объекте QAuthenticator путём парсинга ответа сервера. См. раздел Параметры для получения дополнительной информации о входящих параметрах.

См. также option() и QAuthenticator options.

QString QAuthenticator::password() const

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

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

QString QAuthenticator::realm() const

Возвращает область, требующую аутентификации.

void QAuthenticator::setOption(const QString &opt, const QVariant &value)

Устанавливает исходящий параметр opt со значением value. См. раздел Параметры для получения дополнительной информации об исходящих параметрах.

См. также options(), option(), и QAuthenticator options.

void QAuthenticator::setPassword(const QString &password)

Устанавливает password, используемый для аутентификации.

См. также password() и QNetworkAccessManager::authenticationRequired().

void QAuthenticator::setUser(const QString &user)

Устанавливает user, используемый для аутентификации.

См. также user() и QNetworkAccessManager::authenticationRequired().

QString QAuthenticator::user() const

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

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

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

Возвращает true если этот аутентификатор отличается от other; в противном случае возвращает false.

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

Возвращает true если этот аутентификатор идентичен other; в противном случае возвращает false.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.1/qauthenticator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API