QGIS API Documentation  2.99.0-Master (d55fa22)
Public Slots | Signals | Public Member Functions | List of all members
QgsAuthSslConfigWidget Class Reference

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

#include <qgsauthsslconfigwidget.h>

Inheritance diagram for QgsAuthSslConfigWidget:
Inheritance graph
[legend]

Public Slots

void appendSslIgnoreErrors (const QList< QSslError > &errors)
 Add to SSL errors to ignore for the connection. More...
 
void enableSslCustomOptions (bool enable)
 Enable or disable the custom options widget. More...
 
void loadSslCustomConfig (const QgsAuthConfigSslServer &config=QgsAuthConfigSslServer())
 Load an existing SSL server configuration. More...
 
bool readyToSave ()
 Verify if the configuration if ready to save. More...
 
void resetSslCertConfig ()
 Clear the current SSL server configuration and disabled it. More...
 
void resetSslIgnoreErrors ()
 Clear the SSL errors to ignore for the connection. More...
 
void resetSslPeerVerify ()
 Reset the client's peer verify mode for connections to default. More...
 
void resetSslProtocol ()
 Reset the SSL protocol to use in connections to the default. More...
 
void saveSslCertConfig ()
 Save the current SSL server configuration to the authentication database. More...
 
void setConfigCheckable (bool checkable)
 Set whether the config group box is checkable. More...
 
void setSslCertificate (const QSslCertificate &cert, const QString &hostport=QString())
 Set SSl certificate and any associated host:port. More...
 
void setSslHost (const QString &host)
 Set the host of the server. More...
 
void setSslIgnoreErrorEnums (const QList< QSslError::SslError > &errorenums)
 Set the SSL errors (as enums) to ignore for the connection. More...
 
void setSslIgnoreErrors (const QList< QSslError > &errors)
 Set the SSL errors to ignore for the connection. More...
 
void setSslPeerVerify (QSslSocket::PeerVerifyMode mode, int modedepth)
 Set the client's peer verify mode for connections. More...
 
void setSslProtocol (QSsl::SslProtocol protocol)
 Set the SSL protocol to use in connections. More...
 
void validateHostPortText (const QString &txt)
 Parse string for host:port. More...
 

Signals

void certFoundInAuthDatabase (bool found)
 Emitted when an certificate of same SHA hash is found in authentication database. More...
 
void configEnabledChanged (bool enabled)
 Emitted when the enabled state of the configuration changes. More...
 
void hostPortValidityChanged (bool valid)
 Emitted when the validity of the host:port changes. More...
 
void readyToSaveChanged (bool cansave)
 Emitted when the configuration can be saved changes. More...
 

Public Member Functions

 QgsAuthSslConfigWidget (QWidget *parent=0, const QSslCertificate &cert=QSslCertificate(), const QString &hostport=QString(), const QList< QSslCertificate > &connectionCAs=QList< QSslCertificate >())
 Construct a widget for editing an SSL server certificate configuration. More...
 
QGroupBox * certificateGroupBox ()
 Access to the certificate's group box widget. More...
 
const QSslCertificate sslCertificate ()
 Get the SSL server certificate. More...
 
QGroupBox * sslConfigGroupBox ()
 Access to the SSL configuration's group box widget. More...
 
const QgsAuthConfigSslServer sslCustomConfig ()
 Get the SSL configuration. More...
 
const QString sslHost ()
 Get the host:port to associate with the server certificate. More...
 
const QList< QSslError::SslError > sslIgnoreErrorEnums ()
 Get list of the SSL errors (as enums) to be ignored for connections. More...
 
int sslPeerVerifyDepth ()
 Get the client's peer verify depth for connections. More...
 
QSslSocket::PeerVerifyMode sslPeerVerifyMode ()
 Get the client's peer verify mode for connections. More...
 
QSsl::SslProtocol sslProtocol ()
 Get the SSL protocl used for connections. More...
 

Detailed Description

Widget for editing an SSL server configuration.

Definition at line 38 of file qgsauthsslconfigwidget.h.

Constructor & Destructor Documentation

◆ QgsAuthSslConfigWidget()

QgsAuthSslConfigWidget::QgsAuthSslConfigWidget ( QWidget *  parent = 0,
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
parentParent widget
certSSL server certificate object
hostportUnique host:port to associate with the server certificate
connectionCAsList of trusted Certificate Authorities objects

Definition at line 41 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 373 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 91 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 231 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 281 of file qgsauthsslconfigwidget.cpp.

◆ readyToSave

bool QgsAuthSslConfigWidget::readyToSave ( )
slot

Verify if the configuration if ready to save.

Definition at line 510 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 325 of file qgsauthsslconfigwidget.cpp.

◆ resetSslIgnoreErrors

void QgsAuthSslConfigWidget::resetSslIgnoreErrors ( )
slot

Clear the SSL errors to ignore for the connection.

Definition at line 438 of file qgsauthsslconfigwidget.cpp.

◆ resetSslPeerVerify

void QgsAuthSslConfigWidget::resetSslPeerVerify ( )
slot

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

Definition at line 500 of file qgsauthsslconfigwidget.cpp.

◆ resetSslProtocol

void QgsAuthSslConfigWidget::resetSslProtocol ( )
slot

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

Definition at line 364 of file qgsauthsslconfigwidget.cpp.

◆ saveSslCertConfig

void QgsAuthSslConfigWidget::saveSslCertConfig ( )
slot

Save the current SSL server configuration to the authentication database.

Definition at line 313 of file qgsauthsslconfigwidget.cpp.

◆ setConfigCheckable

void QgsAuthSslConfigWidget::setConfigCheckable ( bool  checkable)
slot

Set whether the config group box is checkable.

Definition at line 564 of file qgsauthsslconfigwidget.cpp.

◆ setSslCertificate

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

Set SSl certificate and any associated host:port.

Definition at line 243 of file qgsauthsslconfigwidget.cpp.

◆ setSslHost

void QgsAuthSslConfigWidget::setSslHost ( const QString &  host)
slot

Set the host of the server.

Definition at line 527 of file qgsauthsslconfigwidget.cpp.

◆ setSslIgnoreErrorEnums

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

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

Definition at line 397 of file qgsauthsslconfigwidget.cpp.

◆ setSslIgnoreErrors

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

Set the SSL errors to ignore for the connection.

Definition at line 411 of file qgsauthsslconfigwidget.cpp.

◆ setSslPeerVerify

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

Set the client's peer verify mode for connections.

Definition at line 486 of file qgsauthsslconfigwidget.cpp.

◆ setSslProtocol

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

Set the SSL protocol to use in connections.

Definition at line 354 of file qgsauthsslconfigwidget.cpp.

◆ sslCertificate()

const QSslCertificate QgsAuthSslConfigWidget::sslCertificate ( )

Get the SSL server certificate.

Definition at line 213 of file qgsauthsslconfigwidget.cpp.

◆ sslConfigGroupBox()

QGroupBox * QgsAuthSslConfigWidget::sslConfigGroupBox ( )

Access to the SSL configuration's group box widget.

Definition at line 100 of file qgsauthsslconfigwidget.cpp.

◆ sslCustomConfig()

const QgsAuthConfigSslServer QgsAuthSslConfigWidget::sslCustomConfig ( )

Get the SSL configuration.

Definition at line 197 of file qgsauthsslconfigwidget.cpp.

◆ sslHost()

const QString QgsAuthSslConfigWidget::sslHost ( )

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

Definition at line 222 of file qgsauthsslconfigwidget.cpp.

◆ sslIgnoreErrorEnums()

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

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

Definition at line 450 of file qgsauthsslconfigwidget.cpp.

◆ sslPeerVerifyDepth()

int QgsAuthSslConfigWidget::sslPeerVerifyDepth ( )

Get the client's peer verify depth for connections.

Note
Value of 0 = unlimited

Definition at line 477 of file qgsauthsslconfigwidget.cpp.

◆ sslPeerVerifyMode()

QSslSocket::PeerVerifyMode QgsAuthSslConfigWidget::sslPeerVerifyMode ( )

Get the client's peer verify mode for connections.

Definition at line 468 of file qgsauthsslconfigwidget.cpp.

◆ sslProtocol()

QSsl::SslProtocol QgsAuthSslConfigWidget::sslProtocol ( )

Get the SSL protocl used for connections.

Definition at line 345 of file qgsauthsslconfigwidget.cpp.

◆ validateHostPortText

void QgsAuthSslConfigWidget::validateHostPortText ( const QString &  txt)
slot

Parse string for host:port.

Definition at line 552 of file qgsauthsslconfigwidget.cpp.


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