QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsAuthConfigSslServer Class Reference

Configuration container for SSL server connection exceptions or overrides. More...

#include <qgsauthconfig.h>

Public Member Functions

 QgsAuthConfigSslServer ()
 Construct a default SSL server configuration. More...
 
 ~QgsAuthConfigSslServer ()
 
const QString configString () const
 Configuration as a concatenated string. More...
 
bool isNull () const
 Whether configuration is null (missing components) More...
 
void loadConfigString (const QString &config=QString())
 Load concatenated string into configuration, e.g. More...
 
int qtVersion () const
 Qt version when the configuration was made (SSL protocols may differ) More...
 
void setQtVersion (int version)
 Set Qt version when the configuration was made (SSL protocols may differ) More...
 
void setSslCertificate (const QSslCertificate &cert)
 Set server certificate object. More...
 
void setSslHostPort (const QString &hostport)
 Set server host:port string. More...
 
void setSslIgnoredErrorEnums (const QList< QSslError::SslError > &errors)
 Set SSL server errors (as enum list) to ignore in connections. More...
 
void setSslPeerVerifyDepth (int depth)
 Set number or SSL client's peer to verify in connections. More...
 
void setSslPeerVerifyMode (QSslSocket::PeerVerifyMode mode)
 Set SSL client's peer verify mode to use in connections. More...
 
void setSslProtocol (QSsl::SslProtocol protocol)
 Set SSL server protocol to use in connections. More...
 
void setVersion (int version)
 Set version of the configuration (used for future upgrading) More...
 
const QSslCertificate sslCertificate () const
 Server certificate object. More...
 
const QString sslHostPort () const
 Server host:port string. More...
 
const QList< QSslError::SslError > sslIgnoredErrorEnums () const
 SSL server errors (as enum list) to ignore in connections. More...
 
const QList< QSslErrorsslIgnoredErrors () const
 SSL server errors to ignore in connections. More...
 
int sslPeerVerifyDepth () const
 Number or SSL client's peer to verify in connections. More...
 
QSslSocket::PeerVerifyMode sslPeerVerifyMode () const
 SSL client's peer verify mode to use in connections. More...
 
QSsl::SslProtocol sslProtocol () const
 SSL server protocol to use in connections. More...
 
int version () const
 Version of the configuration (used for future upgrading) More...
 

Detailed Description

Configuration container for SSL server connection exceptions or overrides.

Definition at line 291 of file qgsauthconfig.h.

Constructor & Destructor Documentation

◆ QgsAuthConfigSslServer()

QgsAuthConfigSslServer::QgsAuthConfigSslServer ( )

Construct a default SSL server configuration.

Definition at line 352 of file qgsauthconfig.cpp.

◆ ~QgsAuthConfigSslServer()

QgsAuthConfigSslServer::~QgsAuthConfigSslServer ( )
inline

Definition at line 297 of file qgsauthconfig.h.

Member Function Documentation

◆ configString()

const QString QgsAuthConfigSslServer::configString ( ) const

Configuration as a concatenated string.

Definition at line 385 of file qgsauthconfig.cpp.

◆ isNull()

bool QgsAuthConfigSslServer::isNull ( ) const

Whether configuration is null (missing components)

Definition at line 431 of file qgsauthconfig.cpp.

◆ loadConfigString()

void QgsAuthConfigSslServer::loadConfigString ( const QString config = QString())

Load concatenated string into configuration, e.g.

from auth database

Definition at line 404 of file qgsauthconfig.cpp.

◆ qtVersion()

int QgsAuthConfigSslServer::qtVersion ( ) const
inline

Qt version when the configuration was made (SSL protocols may differ)

Definition at line 341 of file qgsauthconfig.h.

◆ setQtVersion()

void QgsAuthConfigSslServer::setQtVersion ( int  version)
inline

Set Qt version when the configuration was made (SSL protocols may differ)

Definition at line 343 of file qgsauthconfig.h.

◆ setSslCertificate()

void QgsAuthConfigSslServer::setSslCertificate ( const QSslCertificate cert)
inline

Set server certificate object.

Definition at line 302 of file qgsauthconfig.h.

◆ setSslHostPort()

void QgsAuthConfigSslServer::setSslHostPort ( const QString hostport)
inline

Set server host:port string.

Definition at line 307 of file qgsauthconfig.h.

◆ setSslIgnoredErrorEnums()

void QgsAuthConfigSslServer::setSslIgnoredErrorEnums ( const QList< QSslError::SslError > &  errors)
inline

Set SSL server errors (as enum list) to ignore in connections.

Definition at line 319 of file qgsauthconfig.h.

◆ setSslPeerVerifyDepth()

void QgsAuthConfigSslServer::setSslPeerVerifyDepth ( int  depth)
inline

Set number or SSL client's peer to verify in connections.

Note
When set to 0 = unlimited depth

Definition at line 333 of file qgsauthconfig.h.

◆ setSslPeerVerifyMode()

void QgsAuthConfigSslServer::setSslPeerVerifyMode ( QSslSocket::PeerVerifyMode  mode)
inline

Set SSL client's peer verify mode to use in connections.

Definition at line 324 of file qgsauthconfig.h.

◆ setSslProtocol()

void QgsAuthConfigSslServer::setSslProtocol ( QSsl::SslProtocol  protocol)
inline

Set SSL server protocol to use in connections.

Definition at line 312 of file qgsauthconfig.h.

◆ setVersion()

void QgsAuthConfigSslServer::setVersion ( int  version)
inline

Set version of the configuration (used for future upgrading)

Definition at line 338 of file qgsauthconfig.h.

◆ sslCertificate()

const QSslCertificate QgsAuthConfigSslServer::sslCertificate ( ) const
inline

Server certificate object.

Definition at line 300 of file qgsauthconfig.h.

◆ sslHostPort()

const QString QgsAuthConfigSslServer::sslHostPort ( ) const
inline

Server host:port string.

Definition at line 305 of file qgsauthconfig.h.

◆ sslIgnoredErrorEnums()

const QList<QSslError::SslError> QgsAuthConfigSslServer::sslIgnoredErrorEnums ( ) const
inline

SSL server errors (as enum list) to ignore in connections.

Definition at line 317 of file qgsauthconfig.h.

◆ sslIgnoredErrors()

const QList< QSslError > QgsAuthConfigSslServer::sslIgnoredErrors ( ) const

SSL server errors to ignore in connections.

Definition at line 375 of file qgsauthconfig.cpp.

◆ sslPeerVerifyDepth()

int QgsAuthConfigSslServer::sslPeerVerifyDepth ( ) const
inline

Number or SSL client's peer to verify in connections.

Note
When set to 0 = unlimited depth

Definition at line 329 of file qgsauthconfig.h.

◆ sslPeerVerifyMode()

QSslSocket::PeerVerifyMode QgsAuthConfigSslServer::sslPeerVerifyMode ( ) const
inline

SSL client's peer verify mode to use in connections.

Definition at line 322 of file qgsauthconfig.h.

◆ sslProtocol()

QSsl::SslProtocol QgsAuthConfigSslServer::sslProtocol ( ) const
inline

SSL server protocol to use in connections.

Definition at line 310 of file qgsauthconfig.h.

◆ version()

int QgsAuthConfigSslServer::version ( ) const
inline

Version of the configuration (used for future upgrading)

Definition at line 336 of file qgsauthconfig.h.


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