Spec-Zone.ru › Qt 6.0

Класс 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.

QVariantHash QAuthenticator::options() const

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

См. также option() и Параметры QAuthenticator.

QString QAuthenticator::password() const

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

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

QString QAuthenticator::realm() const

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

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

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

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

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.0/qauthenticator.html

Spec-Zone.ru

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