\section{KSSLSettings Class Reference}
\label{classKSSLSettings}\index{KSSLSettings@{KSSLSettings}}
{\bf KDE} SSL Settings {\bf KDE} SSL Settings.  


{\tt \#include $<$ksslsettings.h$>$}

Collaboration diagram for KSSLSettings:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=272pt]{classKSSLSettings__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KSSLSettings} (bool read\-Config=true)
\item 
{\bf $\sim$KSSLSettings} ()
\item 
bool {\bf sslv2} () const 
\item 
bool {\bf sslv3} () const 
\item 
bool {\bf tlsv1} () const 
\item 
bool {\bf warn\-On\-Enter} () const 
\item 
void {\bf set\-Warn\-On\-Enter} (bool x)
\item 
bool {\bf warn\-On\-Unencrypted} () const 
\item 
void {\bf set\-Warn\-On\-Unencrypted} (bool x)
\item 
bool {\bf warn\-On\-Leave} () const 
\item 
void {\bf set\-Warn\-On\-Leave} (bool x)
\item 
bool {\bf warn\-On\-Mixed} () const 
\item 
bool {\bf warn\-On\-Self\-Signed} () const KDE\_\-DEPRECATED
\item 
bool {\bf warn\-On\-Revoked} () const KDE\_\-DEPRECATED
\item 
bool {\bf warn\-On\-Expired} () const KDE\_\-DEPRECATED
\item 
bool {\bf use\-EGD} () const 
\item 
bool {\bf use\-EFile} () const 
\item 
void {\bf set\-TLSv1} (bool enabled)
\item 
void {\bf set\-SSLv2} (bool enabled)
\item 
void {\bf set\-SSLv3} (bool enabled)
\item 
bool {\bf auto\-Send\-X509} () const 
\item 
bool {\bf prompt\-Send\-X509} () const 
\item 
{\bf QString} {\bf get\-Cipher\-List} ()
\item 
{\bf QString} \& {\bf get\-EGDPath} ()
\item 
void {\bf load} ()
\item 
void {\bf defaults} ()
\item 
void {\bf save} ()
\end{CompactItemize}


\subsection{Detailed Description}
{\bf KDE} SSL Settings {\bf KDE} SSL Settings. 

This class contains some of the SSL settings for easy use.

\begin{Desc}
\item[Author:]George Staikos $<${\tt staikos@kde.org}$>$ \end{Desc}
\begin{Desc}
\item[See also:]{\bf KSSL}{\rm (p.\,\pageref{classKSSL})} \end{Desc}




Definition at line 39 of file ksslsettings.h.

\subsection{Constructor \& Destructor Documentation}
\index{KSSLSettings@{KSSLSettings}!KSSLSettings@{KSSLSettings}}
\index{KSSLSettings@{KSSLSettings}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KSSLSettings::KSSLSettings (bool {\em read\-Config} = {\tt true})}\label{classKSSLSettings_a0}


Construct a {\bf KSSL}{\rm (p.\,\pageref{classKSSL})} Settings object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em read\-Config}]read in the configuration immediately if true\end{description}
\end{Desc}


Definition at line 88 of file ksslsettings.cc.

References load().\index{KSSLSettings@{KSSLSettings}!~KSSLSettings@{$\sim$KSSLSettings}}
\index{~KSSLSettings@{$\sim$KSSLSettings}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KSSLSettings::$\sim${\bf KSSLSettings} ()}\label{classKSSLSettings_a1}


Destroy this {\bf KSSL}{\rm (p.\,\pageref{classKSSL})} Settings object. 



Definition at line 101 of file ksslsettings.cc.

\subsection{Member Function Documentation}
\index{KSSLSettings@{KSSLSettings}!sslv2@{sslv2}}
\index{sslv2@{sslv2}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::sslv2 () const}\label{classKSSLSettings_a2}


Does the user allow SSLv2. 

\begin{Desc}
\item[Returns:]true if the user allows SSLv2\end{Desc}


Definition at line 107 of file ksslsettings.cc.

Referenced by KSSL::initialize().\index{KSSLSettings@{KSSLSettings}!sslv3@{sslv3}}
\index{sslv3@{sslv3}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::sslv3 () const}\label{classKSSLSettings_a3}


Does the user allow SSLv3. 

\begin{Desc}
\item[Returns:]true if the user allows SSLv3\end{Desc}


Definition at line 112 of file ksslsettings.cc.

Referenced by KSSL::initialize().\index{KSSLSettings@{KSSLSettings}!tlsv1@{tlsv1}}
\index{tlsv1@{tlsv1}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::tlsv1 () const}\label{classKSSLSettings_a4}


Does the user allow TLSv1. 

\begin{Desc}
\item[Returns:]true if the user allows TLSv1\end{Desc}


Definition at line 117 of file ksslsettings.cc.

Referenced by KSSL::TLSInit().\index{KSSLSettings@{KSSLSettings}!warnOnEnter@{warnOnEnter}}
\index{warnOnEnter@{warnOnEnter}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Enter () const}\label{classKSSLSettings_a5}


Does the user want to be warned on entering SSL mode. 

\begin{Desc}
\item[Returns:]true if the user wants to be warned\end{Desc}


Definition at line 354 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!setWarnOnEnter@{setWarnOnEnter}}
\index{setWarnOnEnter@{setWarnOnEnter}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::set\-Warn\-On\-Enter (bool {\em x})}\label{classKSSLSettings_a6}


Change the user's {\bf warn\-On\-Enter()}{\rm (p.\,\pageref{classKSSLSettings_a5})} setting \begin{Desc}
\item[Since:]3.3. \end{Desc}


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em x}]true if the user is to be warned \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf warn\-On\-Enter}{\rm (p.\,\pageref{classKSSLSettings_a5})}\end{Desc}


Definition at line 355 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!warnOnUnencrypted@{warnOnUnencrypted}}
\index{warnOnUnencrypted@{warnOnUnencrypted}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Unencrypted () const}\label{classKSSLSettings_a7}


Does the user want to be warned on sending unencrypted data. 

\begin{Desc}
\item[Returns:]true if the user wants to be warned \end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Warn\-On\-Unencrypted}{\rm (p.\,\pageref{classKSSLSettings_a8})}\end{Desc}


Definition at line 356 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!setWarnOnUnencrypted@{setWarnOnUnencrypted}}
\index{setWarnOnUnencrypted@{setWarnOnUnencrypted}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::set\-Warn\-On\-Unencrypted (bool {\em x})}\label{classKSSLSettings_a8}


Change the user's {\bf warn\-On\-Unencrypted()}{\rm (p.\,\pageref{classKSSLSettings_a7})} setting. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em x}]true if the user is to be warned \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf warn\-On\-Unencrypted}{\rm (p.\,\pageref{classKSSLSettings_a7})}\end{Desc}


Definition at line 357 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!warnOnLeave@{warnOnLeave}}
\index{warnOnLeave@{warnOnLeave}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Leave () const}\label{classKSSLSettings_a9}


Does the user want to be warned on leaving SSL mode. 

\begin{Desc}
\item[Returns:]true if the user wants to be warned\end{Desc}


Definition at line 358 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!setWarnOnLeave@{setWarnOnLeave}}
\index{setWarnOnLeave@{setWarnOnLeave}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::set\-Warn\-On\-Leave (bool {\em x})}\label{classKSSLSettings_a10}


Change the user's {\bf warn\-On\-Leave()}{\rm (p.\,\pageref{classKSSLSettings_a9})} setting \begin{Desc}
\item[Since:]3.3. \end{Desc}


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em x}]true if the user is to be warned \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf warn\-On\-Leave}{\rm (p.\,\pageref{classKSSLSettings_a9})}\end{Desc}


Definition at line 359 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!warnOnMixed@{warnOnMixed}}
\index{warnOnMixed@{warnOnMixed}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Mixed () const}\label{classKSSLSettings_a11}


Does the user want to be warned during mixed SSL/non-SSL mode. 

\begin{Desc}
\item[Returns:]true if the user wants to be warned\end{Desc}


Definition at line 360 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!warnOnSelfSigned@{warnOnSelfSigned}}
\index{warnOnSelfSigned@{warnOnSelfSigned}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Self\-Signed () const}\label{classKSSLSettings_a12}


Do not use this. 

\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}


Definition at line 361 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!warnOnRevoked@{warnOnRevoked}}
\index{warnOnRevoked@{warnOnRevoked}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Revoked () const}\label{classKSSLSettings_a13}


Do not use this. 

\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}


Definition at line 362 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!warnOnExpired@{warnOnExpired}}
\index{warnOnExpired@{warnOnExpired}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::warn\-On\-Expired () const}\label{classKSSLSettings_a14}


Do not use this. 

\begin{Desc}
\item[{\bf Deprecated}]\end{Desc}


Definition at line 363 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!useEGD@{useEGD}}
\index{useEGD@{useEGD}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::use\-EGD () const}\label{classKSSLSettings_a15}


Does the user want to use the Entropy Gathering Daemon? 

\begin{Desc}
\item[Returns:]true if the user wants to use EGD\end{Desc}


Definition at line 364 of file ksslsettings.cc.

Referenced by KSSL::seed\-With\-EGD().\index{KSSLSettings@{KSSLSettings}!useEFile@{useEFile}}
\index{useEFile@{useEFile}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::use\-EFile () const}\label{classKSSLSettings_a16}


Does the user want to use an entropy file? 

\begin{Desc}
\item[Returns:]true if the user wants to use an entropy file\end{Desc}


Definition at line 365 of file ksslsettings.cc.

Referenced by KSSL::close(), and KSSL::seed\-With\-EGD().\index{KSSLSettings@{KSSLSettings}!setTLSv1@{setTLSv1}}
\index{setTLSv1@{setTLSv1}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::set\-TLSv1 (bool {\em enabled})}\label{classKSSLSettings_a17}


Change the user's TLSv1 preference. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em enabled}]true if TLSv1 is enabled\end{description}
\end{Desc}


Definition at line 369 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!setSSLv2@{setSSLv2}}
\index{setSSLv2@{setSSLv2}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::set\-SSLv2 (bool {\em enabled})}\label{classKSSLSettings_a18}


Change the user's SSLv2 preference. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em enabled}]true if SSLv2 is enabled\end{description}
\end{Desc}


Definition at line 370 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!setSSLv3@{setSSLv3}}
\index{setSSLv3@{setSSLv3}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::set\-SSLv3 (bool {\em enabled})}\label{classKSSLSettings_a19}


Change the user's SSLv3 preference. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em enabled}]true if SSLv3 is enabled\end{description}
\end{Desc}


Definition at line 371 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!autoSendX509@{autoSendX509}}
\index{autoSendX509@{autoSendX509}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::auto\-Send\-X509 () const}\label{classKSSLSettings_a20}


Does the user want X.509 client certificates to always be sent when possible? 

\begin{Desc}
\item[Returns:]true if the user always wants a certificate sent\end{Desc}


Definition at line 366 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!promptSendX509@{promptSendX509}}
\index{promptSendX509@{promptSendX509}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSSLSettings::prompt\-Send\-X509 () const}\label{classKSSLSettings_a21}


Does the user want to be prompted to send X.509 client certificates when possible? 

\begin{Desc}
\item[Returns:]true if the user wants to be prompted\end{Desc}


Definition at line 367 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!getCipherList@{getCipherList}}
\index{getCipherList@{getCipherList}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KSSLSettings::get\-Cipher\-List ()}\label{classKSSLSettings_a22}


Get the Open\-SSL cipher list for selecting the list of ciphers to use in a connection. 

\begin{Desc}
\item[Returns:]the cipher list\end{Desc}


Definition at line 125 of file ksslsettings.cc.

References QString::append(), KConfig\-Base::read\-Bool\-Entry(), KConfig\-Base::set\-Group(), and QString::sprintf().

Referenced by KSSL::initialize(), and KSSL::TLSInit().\index{KSSLSettings@{KSSLSettings}!getEGDPath@{getEGDPath}}
\index{getEGDPath@{getEGDPath}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} \& KSSLSettings::get\-EGDPath ()}\label{classKSSLSettings_a23}


Get the configured path to the entropy gathering daemon or entropy file. 

\begin{Desc}
\item[Returns:]the path\end{Desc}


Definition at line 373 of file ksslsettings.cc.

Referenced by KSSL::close(), and KSSL::seed\-With\-EGD().\index{KSSLSettings@{KSSLSettings}!load@{load}}
\index{load@{load}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::load ()}\label{classKSSLSettings_a24}


Load the user's settings. 



Definition at line 238 of file ksslsettings.cc.

References KConfig\-Base::read\-Bool\-Entry(), KConfig\-Base::read\-Entry(), KConfig\-Base::read\-Path\-Entry(), KConfig::reparse\-Configuration(), and KConfig\-Base::set\-Group().

Referenced by KSSL::initialize(), KSSLSettings(), and KSSL::TLSInit().\index{KSSLSettings@{KSSLSettings}!defaults@{defaults}}
\index{defaults@{defaults}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::defaults ()}\label{classKSSLSettings_a25}


Revert to default settings. 



Definition at line 278 of file ksslsettings.cc.\index{KSSLSettings@{KSSLSettings}!save@{save}}
\index{save@{save}!KSSLSettings@{KSSLSettings}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSSLSettings::save ()}\label{classKSSLSettings_a26}


Save the current settings. 



Definition at line 295 of file ksslsettings.cc.

References QValue\-List::contains(), QValue\-List::count(), QFile::encode\-Name(), QString::is\-Empty(), KConfig\-Base::set\-Group(), QString::sprintf(), KConfig\-Base::sync(), KConfig\-Base::write\-Entry(), and KConfig\-Base::write\-Path\-Entry().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
ksslsettings.h\item 
ksslsettings.cc\end{CompactItemize}
