Class: QgsAuthSslConfigWidget

Widget for editing an SSL server configuration.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsAuthSslConfigWidget

Base classes

QWidget

QObject

QPaintDevice
class qgis.gui.QgsAuthSslConfigWidget[source]

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])[source]

Add to SSL errors to ignore for the connection

Parameters:

errors (Iterable[QSslError])

signal certFoundInAuthDatabase[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

certificateGroupBox(self) → QGroupBox | None[source]

Access to the certificate’s group box widget

Return type:

Optional[QGroupBox]

signal configEnabledChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

enableSslCustomOptions(self, enable: bool)[source]

Enable or disable the custom options widget

Parameters:

enable (bool)

signal hostPortValidityChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

loadSslCustomConfig(self, config: QgsAuthConfigSslServer = QgsAuthConfigSslServer())[source]

Load an existing SSL server configuration

Parameters:

config (QgsAuthConfigSslServer = QgsAuthConfigSslServer())

readyToSave(self) → bool[source]

Verify if the configuration if ready to save

Return type:

bool

signal readyToSaveChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

resetSslCertConfig(self)[source]

Clear the current SSL server configuration and disabled it

resetSslIgnoreErrors(self)[source]

Clear the SSL errors to ignore for the connection

resetSslPeerVerify(self)[source]

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

resetSslProtocol(self)[source]

Reset the SSL protocol to use in connections to the default

saveSslCertConfig(self)[source]

Save the current SSL server configuration to the authentication database

setConfigCheckable(self, checkable: bool)[source]

Sets whether the config group box is checkable

Parameters:

checkable (bool)

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

Sets SSl certificate and any associated host:port

Parameters:

  • cert (QSslCertificate)

  • hostport (Optional[str] = '')

setSslHost(self, host: str | None)[source]

Sets the host of the server

Parameters:

host (Optional[str])

setSslIgnoreErrorEnums(self, errorenums: Iterable[QSslError.SslError])[source]

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

Parameters:

errorenums (Iterable[QSslError.SslError])

setSslIgnoreErrors(self, errors: Iterable[QSslError])[source]

Sets the SSL errors to ignore for the connection

Parameters:

errors (Iterable[QSslError])

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

Sets the client’s peer verify mode for connections

Parameters:

  • mode (QSslSocket.PeerVerifyMode)

  • modedepth (int)

setSslProtocol(self, protocol: QSsl.SslProtocol)[source]

Sets the SSL protocol to use in connections

Parameters:

protocol (QSsl.SslProtocol)

sslCertificate(self) → QSslCertificate[source]

Gets the SSL server certificate

Return type:

QSslCertificate

sslConfigGroupBox(self) → QGroupBox | None[source]

Access to the SSL configuration’s group box widget

Return type:

Optional[QGroupBox]

sslCustomConfig(self) → QgsAuthConfigSslServer[source]

Gets the SSL configuration

Return type:

QgsAuthConfigSslServer

sslHost(self) → str[source]

Gets the host:port to associate with the server certificate

Return type:

str

sslIgnoreErrorEnums(self) → List[QSslError.SslError]

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

Return type:

List[QSslError.SslError]

sslPeerVerifyDepth(self) → int[source]

Gets the client’s peer verify depth for connections

Note

Value of 0 = unlimited

Return type:

int

sslPeerVerifyMode(self) → QSslSocket.PeerVerifyMode[source]

Gets the client’s peer verify mode for connections

Return type:

QSslSocket.PeerVerifyMode

sslProtocol(self) → QSsl.SslProtocol[source]

Gets the SSL protocol used for connections

Return type:

QSsl.SslProtocol

validateHostPortText(self, txt: str | None)[source]

Parse string for host:port

Parameters:

txt (Optional[str])