|  | Home · All Classes · Modules

# QAuthenticator Class Reference
[QtNetwork module]

The QAuthenticator class provides an authentication object. More...

### Methods

- __init__ (self)
- __init__ (self, QAuthenticator)
- bool isNull (self)
- QVariant option (self, QString opt)
- dict-of-QString-QVariant options (self)
- QString password (self)
- QString realm (self)
- setOption (self, QString opt, QVariant value)
- setPassword (self, QString)
- setUser (self, QString)
- QString user (self)

### Special Methods

- bool __eq__ (self, QAuthenticator)
- bool __ne__ (self, QAuthenticator)

## Detailed Description

The QAuthenticator class provides an authentication object.

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 1
- Digest-MD5

Note that, in particular, NTLM version 2 is not supported.

### 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 | Description
--- | --- | ---
`realm` | Incoming | Contains the realm of the authentication, the same as realm()

The Basic authentication mechanism supports no outgoing options.

#### NTLM version 1

The NTLM authentication mechanism currently supports no incoming or outgoing options.

#### Digest-MD5

Option | Direction | Description
--- | --- | ---
`realm` | Incoming | Contains the realm of the authentication, the same as realm()

The Digest-MD5 authentication mechanism supports no outgoing options.

## Method Documentation

### QAuthenticator.__init__ (self)

Constructs an empty authentication object

### QAuthenticator.__init__ (self, QAuthenticator)

Constructs a copy of other.

### bool QAuthenticator.isNull (self)

Returns true if the authenticator is null.

### QVariant QAuthenticator.option (self, QString opt)

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

This function was introduced in Qt 4.7.

See also setOption(), options(), and QAuthenticator#Options.

### dict-of-QString-QVariant QAuthenticator.options (self)

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

This function was introduced in Qt 4.7.

See also option() and QAuthenticator#Options.

### QString QAuthenticator.password (self)

returns the password used for authentication.

See also setPassword().

### QString QAuthenticator.realm (self)

returns the realm requiring authentication.

### QAuthenticator.setOption (self, QString opt, QVariant value)

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

This function was introduced in Qt 4.7.

See also options(), option(), and QAuthenticator#Options.

### QAuthenticator.setPassword (self, QString)

Sets the password used for authentication.

See also password().

### QAuthenticator.setUser (self, QString)

Sets the user used for authentication.

See also user().

### QString QAuthenticator.user (self)

returns the user used for authentication.

See also setUser().

### bool QAuthenticator.__eq__ (self, QAuthenticator)

### bool QAuthenticator.__ne__ (self, QAuthenticator)