Class: QgsAuthSslConfigWidget

Widget for editing an SSL server configuration.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

appendSslIgnoreErrors	Add to SSL errors to ignore for the connection
certificateGroupBox	Access to the certificate's group box widget
enableSslCustomOptions	Enable or disable the custom options widget
loadSslCustomConfig	Load an existing SSL server configuration
readyToSave	Verify if the configuration if ready to save
resetSslCertConfig	Clear the current SSL server configuration and disabled it
resetSslIgnoreErrors	Clear the SSL errors to ignore for the connection
resetSslPeerVerify	Reset the client's peer verify mode for connections to default
resetSslProtocol	Reset the SSL protocol to use in connections to the default
saveSslCertConfig	Save the current SSL server configuration to the authentication database
setConfigCheckable	Sets whether the config group box is checkable
setSslCertificate	Sets SSl certificate and any associated host:port
setSslHost	Sets the host of the server
setSslIgnoreErrorEnums	Sets the SSL errors (as enums) to ignore for the connection
setSslIgnoreErrors	Sets the SSL errors to ignore for the connection
setSslPeerVerify	Sets the client's peer verify mode for connections
setSslProtocol	Sets the SSL protocol to use in connections
sslCertificate	Gets the SSL server certificate
sslConfigGroupBox	Access to the SSL configuration's group box widget
sslCustomConfig	Gets the SSL configuration
sslHost	Gets the host:port to associate with the server certificate
sslIgnoreErrorEnums	Gets list of the SSL errors (as enums) to be ignored for connections
sslPeerVerifyDepth	Gets the client's peer verify depth for connections
sslPeerVerifyMode	Gets the client's peer verify mode for connections
sslProtocol	Gets the SSL protocol used for connections
validateHostPortText	Parse string for host:port

Signals

certFoundInAuthDatabase	Emitted when an certificate of same SHA hash is found in authentication database
configEnabledChanged	Emitted when the enabled state of the configuration changes
hostPortValidityChanged	Emitted when the validity of the host:port changes
readyToSaveChanged	Emitted when the configuration can be saved changes

class qgis.gui.QgsAuthSslConfigWidget

Bases: QWidget

__init__(parent: QWidget | None = None, cert: QSslCertificate = QSslCertificate(), hostport: str | None = '', connectionCAs: Iterable[QSslCertificate] = [])

Construct a widget for editing an SSL server certificate configuration

Parameters:

• parent (Optional[QWidget] = None) – Parent widget

• cert (QSslCertificate = QSslCertificate()) – SSL server certificate object

• hostport (Optional[str] = '') – Unique host:port to associate with the server certificate

• connectionCAs (Iterable[QSslCertificate] = []) – List of trusted Certificate Authorities objects

appendSslIgnoreErrors(self, errors: Iterable[QSslError])

Add to SSL errors to ignore for the connection

Parameters:

errors (Iterable[QSslError])

signal certFoundInAuthDatabase(found: bool)

Emitted when an certificate of same SHA hash is found in authentication database

Parameters:

found (bool)

certificateGroupBox(self) → QGroupBox | None

Access to the certificate’s group box widget

Return type:

Optional[QGroupBox]

signal configEnabledChanged(enabled: bool)

Emitted when the enabled state of the configuration changes

Parameters:

enabled (bool)

enableSslCustomOptions(self, enable: bool)

Enable or disable the custom options widget

Parameters:

enable (bool)

signal hostPortValidityChanged(valid: bool)

Emitted when the validity of the host:port changes

Parameters:

valid (bool)

loadSslCustomConfig(self, config: QgsAuthConfigSslServer = QgsAuthConfigSslServer())

Load an existing SSL server configuration

Parameters:

config (QgsAuthConfigSslServer = QgsAuthConfigSslServer())

readyToSave(self) → bool

Verify if the configuration if ready to save

Return type:

bool

signal readyToSaveChanged(cansave: bool)

Emitted when the configuration can be saved changes

Parameters:

cansave (bool)

resetSslCertConfig(self)

Clear the current SSL server configuration and disabled it

resetSslIgnoreErrors(self)

Clear the SSL errors to ignore for the connection

resetSslPeerVerify(self)

Reset the client’s peer verify mode for connections to default

resetSslProtocol(self)

Reset the SSL protocol to use in connections to the default

saveSslCertConfig(self)

Save the current SSL server configuration to the authentication database

setConfigCheckable(self, checkable: bool)

Sets whether the config group box is checkable

Parameters:

checkable (bool)

setSslCertificate(self, cert: QSslCertificate, hostport: str | None = '')

Sets SSl certificate and any associated host:port

Parameters:

• cert (QSslCertificate)

• hostport (Optional[str] = '')

setSslHost(self, host: str | None)

Sets the host of the server

Parameters:

host (Optional[str])

setSslIgnoreErrorEnums(self, errorenums: Any)

Sets the SSL errors (as enums) to ignore for the connection

Parameters:

errorenums (Any)

setSslIgnoreErrors(self, errors: Iterable[QSslError])

Sets the SSL errors to ignore for the connection

Parameters:

errors (Iterable[QSslError])

setSslPeerVerify(self, mode: QSslSocket.PeerVerifyMode, modedepth: int)

Sets the client’s peer verify mode for connections

Parameters:

• mode (QSslSocket.PeerVerifyMode)

• modedepth (int)

setSslProtocol(self, protocol: QSsl.SslProtocol)

Sets the SSL protocol to use in connections

Parameters:

protocol (QSsl.SslProtocol)

sslCertificate(self) → QSslCertificate

Gets the SSL server certificate

Return type:

QSslCertificate

sslConfigGroupBox(self) → QGroupBox | None

Access to the SSL configuration’s group box widget

Return type:

Optional[QGroupBox]

sslCustomConfig(self) → QgsAuthConfigSslServer

Gets the SSL configuration

Return type:

QgsAuthConfigSslServer

sslHost(self) → str

Gets the host:port to associate with the server certificate

Return type:

str

sslIgnoreErrorEnums(self) → Any

Gets list of the SSL errors (as enums) to be ignored for connections

Return type:

Any

sslPeerVerifyDepth(self) → int

Gets the client’s peer verify depth for connections

Note

Value of 0 = unlimited

Return type:

int

sslPeerVerifyMode(self) → QSslSocket.PeerVerifyMode

Gets the client’s peer verify mode for connections

Return type:

QSslSocket.PeerVerifyMode

sslProtocol(self) → QSsl.SslProtocol

Gets the SSL protocol used for connections

Return type:

QSsl.SslProtocol

validateHostPortText(self, txt: str | None)

Parse string for host:port

Parameters:

txt (Optional[str])