QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsPkiConfigBundle Class Reference

Storage set for constructed SSL certificate, key, associated with an authentication config. More...

#include <qgsauthconfig.h>

Public Member Functions

 QgsPkiConfigBundle (const QgsAuthMethodConfig &config, const QSslCertificate &cert, const QSslKey &certkey, const QList< QSslCertificate > &cachain=QList< QSslCertificate >())
 Construct a bundle from existing PKI components and authentication method configuration. More...
 
QList< QSslCertificate > caChain () const
 caChain return the CA chain More...
 
const QSslCertificate clientCert () const
 Client certificate object. More...
 
const QSslKey clientCertKey () const
 Private key object. More...
 
const QgsAuthMethodConfig config () const
 Authentication method configuration. More...
 
bool isValid ()
 Whether the bundle is valid. More...
 
void setCaChain (const QList< QSslCertificate > &caChain)
 setCaChain set the CA chain More...
 
void setClientCert (const QSslCertificate &cert)
 Sets client certificate object. More...
 
void setClientCertKey (const QSslKey &certkey)
 Sets private key object. More...
 
void setConfig (const QgsAuthMethodConfig &config)
 Sets authentication method configuration. More...
 

Detailed Description

Storage set for constructed SSL certificate, key, associated with an authentication config.

Definition at line 258 of file qgsauthconfig.h.

Constructor & Destructor Documentation

◆ QgsPkiConfigBundle()

QgsPkiConfigBundle::QgsPkiConfigBundle ( const QgsAuthMethodConfig config,
const QSslCertificate &  cert,
const QSslKey &  certkey,
const QList< QSslCertificate > &  cachain = QList<QSslCertificate>( ) 
)

Construct a bundle from existing PKI components and authentication method configuration.

Parameters
configAuthentication method configuration
certCertificate to store in bundle
certkeyPrivate key to store in bundle
cachainlist of CA certificates

Definition at line 294 of file qgsauthconfig.cpp.

Member Function Documentation

◆ caChain()

QList<QSslCertificate> QgsPkiConfigBundle::caChain ( ) const
inline

caChain return the CA chain

Returns
list of CA certificates

Definition at line 299 of file qgsauthconfig.h.

◆ clientCert()

const QSslCertificate QgsPkiConfigBundle::clientCert ( ) const
inline

Client certificate object.

Definition at line 284 of file qgsauthconfig.h.

◆ clientCertKey()

const QSslKey QgsPkiConfigBundle::clientCertKey ( ) const
inline

Private key object.

Definition at line 290 of file qgsauthconfig.h.

◆ config()

const QgsAuthMethodConfig QgsPkiConfigBundle::config ( ) const
inline

Authentication method configuration.

Definition at line 278 of file qgsauthconfig.h.

◆ isValid()

bool QgsPkiConfigBundle::isValid ( )

Whether the bundle is valid.

Definition at line 305 of file qgsauthconfig.cpp.

◆ setCaChain()

void QgsPkiConfigBundle::setCaChain ( const QList< QSslCertificate > &  caChain)
inline

setCaChain set the CA chain

Parameters
caChain

Definition at line 305 of file qgsauthconfig.h.

◆ setClientCert()

void QgsPkiConfigBundle::setClientCert ( const QSslCertificate &  cert)
inline

Sets client certificate object.

Definition at line 287 of file qgsauthconfig.h.

◆ setClientCertKey()

void QgsPkiConfigBundle::setClientCertKey ( const QSslKey &  certkey)
inline

Sets private key object.

Definition at line 293 of file qgsauthconfig.h.

◆ setConfig()

void QgsPkiConfigBundle::setConfig ( const QgsAuthMethodConfig config)
inline

Sets authentication method configuration.

Definition at line 281 of file qgsauthconfig.h.


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