Widget for editing an SSL server configuration. More...

#include <qgsauthsslconfigwidget.h>

Inheritance diagram for QgsAuthSslConfigWidget:

[legend]

Public Slots
void	appendSslIgnoreErrors (const QList< QSslError > &errors)
	Add to SSL errors to ignore for the connection.

void	enableSslCustomOptions (bool enable)
	Enable or disable the custom options widget.

void	loadSslCustomConfig (const QgsAuthConfigSslServer &config=QgsAuthConfigSslServer())
	Load an existing SSL server configuration.

bool	readyToSave ()
	Verify if the configuration if ready to save.

void	resetSslCertConfig ()
	Clear the current SSL server configuration and disabled it.

void	resetSslIgnoreErrors ()
	Clear the SSL errors to ignore for the connection.

void	resetSslPeerVerify ()
	Reset the client's peer verify mode for connections to default.

void	resetSslProtocol ()
	Reset the SSL protocol to use in connections to the default.

void	saveSslCertConfig ()
	Save the current SSL server configuration to the authentication database.

void	setConfigCheckable (bool checkable)
	Sets whether the config group box is checkable.

void	setSslCertificate (const QSslCertificate &cert, const QString &hostport=QString())
	Sets SSl certificate and any associated host:port.

void	setSslHost (const QString &host)
	Sets the host of the server.

void	setSslIgnoreErrorEnums (const QList< QSslError::SslError > &errorenums)
	Sets the SSL errors (as enums) to ignore for the connection.

void	setSslIgnoreErrors (const QList< QSslError > &errors)
	Sets the SSL errors to ignore for the connection.

void	setSslPeerVerify (QSslSocket::PeerVerifyMode mode, int modedepth)
	Sets the client's peer verify mode for connections.

void	setSslProtocol (QSsl::SslProtocol protocol)
	Sets the SSL protocol to use in connections.

void	validateHostPortText (const QString &txt)
	Parse string for host:port.

Signals
void	certFoundInAuthDatabase (bool found)
	Emitted when an certificate of same SHA hash is found in authentication database.

void	configEnabledChanged (bool enabled)
	Emitted when the enabled state of the configuration changes.

void	hostPortValidityChanged (bool valid)
	Emitted when the validity of the host:port changes.

void	readyToSaveChanged (bool cansave)
	Emitted when the configuration can be saved changes.

Public Member Functions
	QgsAuthSslConfigWidget (QWidget *parent=nullptr, const QSslCertificate &cert=QSslCertificate(), const QString &hostport=QString(), const QList< QSslCertificate > &connectionCAs=QList< QSslCertificate >())
	Construct a widget for editing an SSL server certificate configuration.

QGroupBox *	certificateGroupBox ()
	Access to the certificate's group box widget.

const QSslCertificate	sslCertificate ()
	Gets the SSL server certificate.

QGroupBox *	sslConfigGroupBox ()
	Access to the SSL configuration's group box widget.

const QgsAuthConfigSslServer	sslCustomConfig ()
	Gets the SSL configuration.

const QString	sslHost ()
	Gets the host:port to associate with the server certificate.

const QList< QSslError::SslError >	sslIgnoreErrorEnums ()
	Gets list of the SSL errors (as enums) to be ignored for connections.

int	sslPeerVerifyDepth ()
	Gets the client's peer verify depth for connections.

QSslSocket::PeerVerifyMode	sslPeerVerifyMode ()
	Gets the client's peer verify mode for connections.

QSsl::SslProtocol	sslProtocol ()
	Gets the SSL protocol used for connections.

Detailed Description

Widget for editing an SSL server configuration.

Definition at line 39 of file qgsauthsslconfigwidget.h.

Constructor & Destructor Documentation

◆ QgsAuthSslConfigWidget()

QgsAuthSslConfigWidget::QgsAuthSslConfigWidget	(	QWidget *	parent = `nullptr`,
		const QSslCertificate &	cert = `QSslCertificate()`,
		const QString &	hostport = `QString()`,
		const QList< QSslCertificate > &	connectionCAs = `QList<QSslCertificate>()`
	)

explicit

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

Definition at line 43 of file qgsauthsslconfigwidget.cpp.

Member Function Documentation

◆ appendSslIgnoreErrors

void QgsAuthSslConfigWidget::appendSslIgnoreErrors ( const QList< QSslError > & errors )

slot

Add to SSL errors to ignore for the connection.

Definition at line 359 of file qgsauthsslconfigwidget.cpp.

◆ certFoundInAuthDatabase

void QgsAuthSslConfigWidget::certFoundInAuthDatabase ( bool found )

signal

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

◆ certificateGroupBox()

QGroupBox * QgsAuthSslConfigWidget::certificateGroupBox ( )

Access to the certificate's group box widget.

Definition at line 83 of file qgsauthsslconfigwidget.cpp.

◆ configEnabledChanged

void QgsAuthSslConfigWidget::configEnabledChanged ( bool enabled )

signal

Emitted when the enabled state of the configuration changes.

◆ enableSslCustomOptions

void QgsAuthSslConfigWidget::enableSslCustomOptions ( bool enable )

slot

Enable or disable the custom options widget.

Definition at line 217 of file qgsauthsslconfigwidget.cpp.

◆ hostPortValidityChanged

void QgsAuthSslConfigWidget::hostPortValidityChanged ( bool valid )

signal

Emitted when the validity of the host:port changes.

◆ loadSslCustomConfig

void QgsAuthSslConfigWidget::loadSslCustomConfig ( const QgsAuthConfigSslServer & config = QgsAuthConfigSslServer() )

slot

Load an existing SSL server configuration.

Definition at line 267 of file qgsauthsslconfigwidget.cpp.

◆ readyToSave

bool QgsAuthSslConfigWidget::readyToSave ( )

slot

Verify if the configuration if ready to save.

Definition at line 499 of file qgsauthsslconfigwidget.cpp.

◆ readyToSaveChanged

void QgsAuthSslConfigWidget::readyToSaveChanged ( bool cansave )

signal

Emitted when the configuration can be saved changes.

◆ resetSslCertConfig

void QgsAuthSslConfigWidget::resetSslCertConfig ( )

slot

Clear the current SSL server configuration and disabled it.

Definition at line 311 of file qgsauthsslconfigwidget.cpp.

◆ resetSslIgnoreErrors

void QgsAuthSslConfigWidget::resetSslIgnoreErrors ( )

slot

Clear the SSL errors to ignore for the connection.

Definition at line 427 of file qgsauthsslconfigwidget.cpp.

◆ resetSslPeerVerify

void QgsAuthSslConfigWidget::resetSslPeerVerify ( )

slot

Reset the client's peer verify mode for connections to default.

Definition at line 489 of file qgsauthsslconfigwidget.cpp.

◆ resetSslProtocol

void QgsAuthSslConfigWidget::resetSslProtocol ( )

slot

Reset the SSL protocol to use in connections to the default.

Definition at line 350 of file qgsauthsslconfigwidget.cpp.

◆ saveSslCertConfig

void QgsAuthSslConfigWidget::saveSslCertConfig ( )

slot

Save the current SSL server configuration to the authentication database.

Definition at line 299 of file qgsauthsslconfigwidget.cpp.

◆ setConfigCheckable

void QgsAuthSslConfigWidget::setConfigCheckable ( bool checkable )

slot

Sets whether the config group box is checkable.

Definition at line 553 of file qgsauthsslconfigwidget.cpp.

◆ setSslCertificate

void QgsAuthSslConfigWidget::setSslCertificate	(	const QSslCertificate &	cert,
		const QString &	hostport = `QString()`
	)

slot

Sets SSl certificate and any associated host:port.

Definition at line 229 of file qgsauthsslconfigwidget.cpp.

◆ setSslHost

void QgsAuthSslConfigWidget::setSslHost ( const QString & host )

slot

Sets the host of the server.

Definition at line 516 of file qgsauthsslconfigwidget.cpp.

◆ setSslIgnoreErrorEnums

void QgsAuthSslConfigWidget::setSslIgnoreErrorEnums ( const QList< QSslError::SslError > & errorenums )

slot

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

Definition at line 384 of file qgsauthsslconfigwidget.cpp.

◆ setSslIgnoreErrors

void QgsAuthSslConfigWidget::setSslIgnoreErrors ( const QList< QSslError > & errors )

slot

Sets the SSL errors to ignore for the connection.

Definition at line 399 of file qgsauthsslconfigwidget.cpp.

◆ setSslPeerVerify

void QgsAuthSslConfigWidget::setSslPeerVerify	(	QSslSocket::PeerVerifyMode	mode,
		int	modedepth
	)

slot

Sets the client's peer verify mode for connections.

Definition at line 475 of file qgsauthsslconfigwidget.cpp.

◆ setSslProtocol

void QgsAuthSslConfigWidget::setSslProtocol ( QSsl::SslProtocol protocol )

slot

Sets the SSL protocol to use in connections.

Definition at line 340 of file qgsauthsslconfigwidget.cpp.

◆ sslCertificate()

const QSslCertificate QgsAuthSslConfigWidget::sslCertificate ( )

Gets the SSL server certificate.

Definition at line 199 of file qgsauthsslconfigwidget.cpp.

◆ sslConfigGroupBox()

QGroupBox * QgsAuthSslConfigWidget::sslConfigGroupBox ( )

Access to the SSL configuration's group box widget.

Definition at line 92 of file qgsauthsslconfigwidget.cpp.

◆ sslCustomConfig()

const QgsAuthConfigSslServer QgsAuthSslConfigWidget::sslCustomConfig ( )

Gets the SSL configuration.

Definition at line 183 of file qgsauthsslconfigwidget.cpp.

◆ sslHost()

const QString QgsAuthSslConfigWidget::sslHost ( )

Gets the host:port to associate with the server certificate.

Definition at line 208 of file qgsauthsslconfigwidget.cpp.

◆ sslIgnoreErrorEnums()

const QList< QSslError::SslError > QgsAuthSslConfigWidget::sslIgnoreErrorEnums ( )

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

Definition at line 439 of file qgsauthsslconfigwidget.cpp.

◆ sslPeerVerifyDepth()

int QgsAuthSslConfigWidget::sslPeerVerifyDepth ( )

Gets the client's peer verify depth for connections.

Note: Value of 0 = unlimited

Definition at line 466 of file qgsauthsslconfigwidget.cpp.

◆ sslPeerVerifyMode()

QSslSocket::PeerVerifyMode QgsAuthSslConfigWidget::sslPeerVerifyMode ( )

Gets the client's peer verify mode for connections.

Definition at line 457 of file qgsauthsslconfigwidget.cpp.

◆ sslProtocol()

QSsl::SslProtocol QgsAuthSslConfigWidget::sslProtocol ( )

Gets the SSL protocol used for connections.

Definition at line 331 of file qgsauthsslconfigwidget.cpp.

◆ validateHostPortText

void QgsAuthSslConfigWidget::validateHostPortText ( const QString & txt )

slot

Parse string for host:port.

Definition at line 541 of file qgsauthsslconfigwidget.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/auth/qgsauthsslconfigwidget.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/auth/qgsauthsslconfigwidget.cpp

Public Slots

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsAuthSslConfigWidget()

Member Function Documentation

◆ appendSslIgnoreErrors

◆ certFoundInAuthDatabase

◆ certificateGroupBox()

◆ configEnabledChanged

◆ enableSslCustomOptions

◆ hostPortValidityChanged

◆ loadSslCustomConfig

◆ readyToSave

◆ readyToSaveChanged

◆ resetSslCertConfig

◆ resetSslIgnoreErrors

◆ resetSslPeerVerify

◆ resetSslProtocol

◆ saveSslCertConfig

◆ setConfigCheckable

◆ setSslCertificate

◆ setSslHost

◆ setSslIgnoreErrorEnums

◆ setSslIgnoreErrors

◆ setSslPeerVerify

◆ setSslProtocol

◆ sslCertificate()

◆ sslConfigGroupBox()

◆ sslCustomConfig()

◆ sslHost()

◆ sslIgnoreErrorEnums()

◆ sslPeerVerifyDepth()

◆ sslPeerVerifyMode()

◆ sslProtocol()

◆ validateHostPortText