QAuthenticator

The QAuthenticator class provides an authentication object. More

Inheritance diagram of PySide2.QtNetwork.QAuthenticator

Synopsis

Functions

Detailed Description

The QAuthenticator class is usually used in the authenticationRequired() and proxyAuthenticationRequired() signals of QNetworkAccessManager and QAbstractSocket . The class provides a way to pass back the required authentication information to the socket when accessing services that require authentication.

QAuthenticator supports the following authentication methods:

  • Basic

  • NTLM version 2

  • Digest-MD5

Options

In addition to the username and password required for authentication, a QAuthenticator object can also contain additional options. The options() function can be used to query incoming options sent by the server; the setOption() function can be used to set outgoing options, to be processed by the authenticator calculation. The options accepted and provided depend on the authentication type (see method()).

The following tables list known incoming options as well as accepted outgoing options. The list of incoming options is not exhaustive, since servers may include additional information at any time. The list of outgoing options is exhaustive, however, and no unknown options will be treated or sent back to the server.

Basic

Option

Direction

Type

Description

realm

Incoming

QString

Contains the realm of the authentication, the same as realm()

The Basic authentication mechanism supports no outgoing options.

NTLM version 2

The NTLM authentication mechanism currently supports no incoming or outgoing options. On Windows, if no user has been set, domain\user credentials will be searched for on the local system to enable Single-Sign-On functionality.

Digest-MD5

Option

Direction

Type

Description

realm

Incoming

QString

Contains the realm of the authentication, the same as realm()

The Digest-MD5 authentication mechanism supports no outgoing options.

See also

QSslSocket

class QAuthenticator

QAuthenticator(other)

param other

QAuthenticator

Constructs an empty authentication object.

Constructs a copy of other .

PySide2.QtNetwork.QAuthenticator.isNull()
Return type

bool

Returns true if the object has not been initialized. Returns false if non-const member functions have been called, or the content was constructed or copied from another initialized QAuthenticator object.

PySide2.QtNetwork.QAuthenticator.__ne__(other)
Parameters

otherQAuthenticator

Return type

bool

Returns true if this authenticator is different from other ; otherwise returns false .

PySide2.QtNetwork.QAuthenticator.__eq__(other)
Parameters

otherQAuthenticator

Return type

bool

Returns true if this authenticator is identical to other ; otherwise returns false .

PySide2.QtNetwork.QAuthenticator.option(opt)
Parameters

opt – unicode

Return type

object

Returns the value related to option opt if it was set by the server. See the Options section for more information on incoming options. If option opt isn’t found, an invalid QVariant will be returned.

See also

setOption() options() QAuthenticator options

PySide2.QtNetwork.QAuthenticator.options()
Return type

Returns all incoming options set in this QAuthenticator object by parsing the server reply. See the Options section for more information on incoming options.

See also

option() QAuthenticator options

PySide2.QtNetwork.QAuthenticator.password()
Return type

unicode

Returns the password used for authentication.

See also

setPassword()

PySide2.QtNetwork.QAuthenticator.realm()
Return type

unicode

Returns the realm requiring authentication.

PySide2.QtNetwork.QAuthenticator.setOption(opt, value)
Parameters
  • opt – unicode

  • value – object

Sets the outgoing option opt to value value . See the Options section for more information on outgoing options.

See also

options() option() QAuthenticator options

PySide2.QtNetwork.QAuthenticator.setPassword(password)
Parameters

password – unicode

Sets the password used for authentication.

PySide2.QtNetwork.QAuthenticator.setRealm(realm)
Parameters

realm – unicode

See also

realm()

PySide2.QtNetwork.QAuthenticator.setUser(user)
Parameters

user – unicode

Sets the user used for authentication.

PySide2.QtNetwork.QAuthenticator.user()
Return type

unicode

Returns the user used for authentication.

See also

setUser()