Class: QgsAuthSslConfigWidget

class qgis.gui.QgsAuthSslConfigWidget

Bases: PyQt5.QtWidgets.QWidget

Widget for editing an SSL server configuration

QgsAuthSslConfigWidget(parent: QWidget = None, cert: QSslCertificate = QSslCertificate(), hostport: str = ‘’, connectionCAs: Iterable[QSslCertificate] = []) Construct a widget for editing an SSL server certificate configuration

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

Add to SSL errors to ignore for the connection

Parameters

errors (Iterable[QSslError]) –

certFoundInAuthDatabase

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

Parameters

found (bool) –

certificateGroupBox(self)QGroupBox

Access to the certificate’s group box widget

Return type

QGroupBox

changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
configEnabledChanged

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

Parameters

enabled (bool) –

connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enableSslCustomOptions(self, enable: bool)

Enable or disable the custom options widget

Parameters

enable (bool) –

enterEvent(self, QEvent)
event(self, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
hostPortValidityChanged

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

Parameters

valid (bool) –

initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
loadSslCustomConfig(self, config: QgsAuthConfigSslServer = QgsAuthConfigSslServer())

Load an existing SSL server configuration

Parameters

config (QgsAuthConfigSslServer = QgsAuthConfigSslServer()) –

metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, QPaintEvent)
readyToSave(self)bool

Verify if the configuration if ready to save

Return type

bool

readyToSaveChanged

Emitted when the configuration can be saved changes [signal]

Parameters

cansave (bool) –

receivers(self, PYQT_SIGNAL)int
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(self, QResizeEvent)
saveSslCertConfig(self)

Save the current SSL server configuration to the authentication database

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

Sets whether the config group box is checkable

Parameters

checkable (bool) –

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

Sets SSl certificate and any associated host:port

Parameters
  • cert (QSslCertificate) –

  • hostport (str = '') –

setSslHost(self, host: str)

Sets the host of the server

Parameters

host (str) –

setSslIgnoreErrorEnums(self, errorenums: object)

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

Parameters

errorenums (object) –

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) –

sharedPainter(self)QPainter
showEvent(self, QShowEvent)
sslCertificate(self)QSslCertificate

Gets the SSL server certificate

Return type

QSslCertificate

sslConfigGroupBox(self)QGroupBox

Access to the SSL configuration’s group box widget

Return type

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)object

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

Return type

object

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

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

Parse string for host:port

Parameters

txt (str) –

wheelEvent(self, QWheelEvent)