Subgroup: Auth

Class: QgsAuthSslConfigWidget

class qgis.gui.QgsAuthSslConfigWidget(parent: QWidget = None, cert: QSslCertificate = QSslCertificate(), hostport: str = '', connectionCAs: Iterable[QSslCertificate] = [])

Bases: PyQt5.QtWidgets.QWidget

Construct a widget for editing an SSL server certificate configuration

Parameters:
  • parent – Parent widget
  • cert – SSL server certificate object
  • hostport – Unique host:port to associate with the server certificate
  • connectionCAs – List of trusted Certificate Authorities objects

Widget for editing an SSL server configuration

Methods

actionEvent
appendSslIgnoreErrors Add to SSL errors to ignore for the connection
certificateGroupBox Access to the certificate’s group box widget
changeEvent
childEvent
closeEvent
connectNotify
contextMenuEvent
create
customEvent
destroy
disconnectNotify
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
enableSslCustomOptions Enable or disable the custom options widget
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
initPainter
inputMethodEvent
isSignalConnected
keyPressEvent
keyReleaseEvent
leaveEvent
loadSslCustomConfig Load an existing SSL server configuration
metric
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveEvent
nativeEvent
paintEvent
readyToSave Verify if the configuration if ready to save
receivers
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
resizeEvent
saveSslCertConfig Save the current SSL server configuration to the authentication database
sender
senderSignalIndex
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
sharedPainter
showEvent
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 protocl used for connections
tabletEvent
timerEvent
updateMicroFocus
validateHostPortText Parse string for host:port
wheelEvent

Signals

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

Attributes

actionEvent()
appendSslIgnoreErrors(self, errors: Iterable[QSslError])

Add to SSL errors to ignore for the connection

certFoundInAuthDatabase

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

certificateGroupBox(self) → QGroupBox

Access to the certificate’s group box widget

changeEvent()
childEvent()
closeEvent()
configEnabledChanged

Emitted when the enabled state of the configuration changes [signal]

connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enableSslCustomOptions(self, enable: bool)

Enable or disable the custom options widget

enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
hostPortValidityChanged

Emitted when the validity of the host:port changes [signal]

initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
loadSslCustomConfig(self, config: QgsAuthConfigSslServer = QgsAuthConfigSslServer())

Load an existing SSL server configuration

metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
readyToSave(self) → bool

Verify if the configuration if ready to save

readyToSaveChanged

Emitted when the configuration can be saved changes [signal]

receivers()
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

resizeEvent()
saveSslCertConfig(self)

Save the current SSL server configuration to the authentication database

sender()
senderSignalIndex()
setConfigCheckable(self, checkable: bool)

Sets whether the config group box is checkable

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

Sets SSl certificate and any associated host:port

setSslHost(self, host: str)

Sets the host of the server

setSslIgnoreErrorEnums(self, errorenums: object)

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

setSslIgnoreErrors(self, errors: Iterable[QSslError])

Sets the SSL errors to ignore for the connection

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

Sets the client’s peer verify mode for connections

setSslProtocol(self, protocol: QSsl.SslProtocol)

Sets the SSL protocol to use in connections

sharedPainter()
showEvent()
sslCertificate(self) → QSslCertificate

Gets the SSL server certificate

sslConfigGroupBox(self) → QGroupBox

Access to the SSL configuration’s group box widget

sslCustomConfig(self) → QgsAuthConfigSslServer

Gets the SSL configuration

sslHost(self) → str

Gets the host:port to associate with the server certificate

sslIgnoreErrorEnums(self) → object

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

sslPeerVerifyDepth(self) → int

Gets the client’s peer verify depth for connections

Note

Value of 0 = unlimited

sslPeerVerifyMode(self) → QSslSocket.PeerVerifyMode

Gets the client’s peer verify mode for connections

sslProtocol(self) → QSsl.SslProtocol

Gets the SSL protocl used for connections

tabletEvent()
timerEvent()
updateMicroFocus()
validateHostPortText(self, txt: str)

Parse string for host:port

wheelEvent()