KIO::SslUi Namespace

Header: #include <SslUi>
CMake: find_package(KF6 REQUIRED COMPONENTS KIO)
target_link_libraries(mytarget PRIVATE KF6::KIOWidgets)

Types

enum RulesStorage { RecallRules, StoreRules, RecallAndStoreRules }

Functions

bool askIgnoreSslErrors(const KSslErrorUiData &uiData, KIO::SslUi::RulesStorage storedRules = RecallAndStoreRules)

Detailed Description

UI methods for handling SSL errors.

Type Documentation

enum SslUi::RulesStorage

Error rule storage behavior

ConstantValueDescription
KIO::SslUi::RecallRules1Apply stored certificate rules (typically ignored errors)
KIO::SslUi::StoreRules2Make new ignore rules from the user's choice and store them
KIO::SslUi::RecallAndStoreRules3Apply stored rules and store new rules

Function Documentation

bool SslUi::askIgnoreSslErrors(const KSslErrorUiData &uiData, KIO::SslUi::RulesStorage storedRules = RecallAndStoreRules)

If there are errors while establishing an SSL encrypted connection to a peer, usually due to certificate issues, and since this poses a security issue, we need confirmation from the user about how they wish to proceed.

This function provides a dialog asking the user if they wish to abort the connection or ignore the SSL errors that occurred and continue connecting. And in case of the latter whether to remember the decision in the future or ignore the error temporarily.

uiData the KSslErrorUiData object constructed from the socket that is trying to establish the encrypted connection

storedRules see RulesStorage Enum