.TH "KSSLSettings" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KSSLSettings \- \fBKDE\fP SSL Settings \fBKDE\fP SSL Settings.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ksslsettings.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKSSLSettings\fP (bool readConfig=true)"
.br
.ti -1c
.RI "\fB~KSSLSettings\fP ()"
.br
.ti -1c
.RI "bool \fBsslv2\fP () const "
.br
.ti -1c
.RI "bool \fBsslv3\fP () const "
.br
.ti -1c
.RI "bool \fBtlsv1\fP () const "
.br
.ti -1c
.RI "bool \fBwarnOnEnter\fP () const "
.br
.ti -1c
.RI "void \fBsetWarnOnEnter\fP (bool x)"
.br
.ti -1c
.RI "bool \fBwarnOnUnencrypted\fP () const "
.br
.ti -1c
.RI "void \fBsetWarnOnUnencrypted\fP (bool x)"
.br
.ti -1c
.RI "bool \fBwarnOnLeave\fP () const "
.br
.ti -1c
.RI "void \fBsetWarnOnLeave\fP (bool x)"
.br
.ti -1c
.RI "bool \fBwarnOnMixed\fP () const "
.br
.ti -1c
.RI "bool \fBwarnOnSelfSigned\fP () const KDE_DEPRECATED"
.br
.ti -1c
.RI "bool \fBwarnOnRevoked\fP () const KDE_DEPRECATED"
.br
.ti -1c
.RI "bool \fBwarnOnExpired\fP () const KDE_DEPRECATED"
.br
.ti -1c
.RI "bool \fBuseEGD\fP () const "
.br
.ti -1c
.RI "bool \fBuseEFile\fP () const "
.br
.ti -1c
.RI "void \fBsetTLSv1\fP (bool enabled)"
.br
.ti -1c
.RI "void \fBsetSSLv2\fP (bool enabled)"
.br
.ti -1c
.RI "void \fBsetSSLv3\fP (bool enabled)"
.br
.ti -1c
.RI "bool \fBautoSendX509\fP () const "
.br
.ti -1c
.RI "bool \fBpromptSendX509\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBgetCipherList\fP ()"
.br
.ti -1c
.RI "\fBQString\fP & \fBgetEGDPath\fP ()"
.br
.ti -1c
.RI "void \fBload\fP ()"
.br
.ti -1c
.RI "void \fBdefaults\fP ()"
.br
.ti -1c
.RI "void \fBsave\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBKDE\fP SSL Settings \fBKDE\fP SSL Settings. 

This class contains some of the SSL settings for easy use.
.PP
\fBAuthor:\fP
.RS 4
George Staikos <staikos@kde.org> 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKSSL\fP 
.RE
.PP

.PP
Definition at line 39 of file ksslsettings.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KSSLSettings::KSSLSettings (bool readConfig = \fCtrue\fP)"
.PP
Construct a \fBKSSL\fP Settings object. 
.PP
\fBParameters:\fP
.RS 4
\fIreadConfig\fP read in the configuration immediately if true
.RE
.PP

.PP
Definition at line 88 of file ksslsettings.cc.
.PP
References load().
.SS "KSSLSettings::~\fBKSSLSettings\fP ()"
.PP
Destroy this \fBKSSL\fP Settings object. 
.PP
Definition at line 101 of file ksslsettings.cc.
.SH "Member Function Documentation"
.PP 
.SS "bool KSSLSettings::sslv2 () const"
.PP
Does the user allow SSLv2. 
.PP
\fBReturns:\fP
.RS 4
true if the user allows SSLv2
.RE
.PP

.PP
Definition at line 107 of file ksslsettings.cc.
.PP
Referenced by KSSL::initialize().
.SS "bool KSSLSettings::sslv3 () const"
.PP
Does the user allow SSLv3. 
.PP
\fBReturns:\fP
.RS 4
true if the user allows SSLv3
.RE
.PP

.PP
Definition at line 112 of file ksslsettings.cc.
.PP
Referenced by KSSL::initialize().
.SS "bool KSSLSettings::tlsv1 () const"
.PP
Does the user allow TLSv1. 
.PP
\fBReturns:\fP
.RS 4
true if the user allows TLSv1
.RE
.PP

.PP
Definition at line 117 of file ksslsettings.cc.
.PP
Referenced by KSSL::TLSInit().
.SS "bool KSSLSettings::warnOnEnter () const"
.PP
Does the user want to be warned on entering SSL mode. 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to be warned
.RE
.PP

.PP
Definition at line 354 of file ksslsettings.cc.
.SS "void KSSLSettings::setWarnOnEnter (bool x)"
.PP
Change the user's \fBwarnOnEnter()\fP setting 
.PP
\fBSince:\fP
.RS 4
3.3. 
.RE
.PP

.PP
\fBParameters:\fP
.RS 4
\fIx\fP true if the user is to be warned 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBwarnOnEnter\fP
.RE
.PP

.PP
Definition at line 355 of file ksslsettings.cc.
.SS "bool KSSLSettings::warnOnUnencrypted () const"
.PP
Does the user want to be warned on sending unencrypted data. 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to be warned 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetWarnOnUnencrypted\fP
.RE
.PP

.PP
Definition at line 356 of file ksslsettings.cc.
.SS "void KSSLSettings::setWarnOnUnencrypted (bool x)"
.PP
Change the user's \fBwarnOnUnencrypted()\fP setting. 
.PP
\fBParameters:\fP
.RS 4
\fIx\fP true if the user is to be warned 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBwarnOnUnencrypted\fP
.RE
.PP

.PP
Definition at line 357 of file ksslsettings.cc.
.SS "bool KSSLSettings::warnOnLeave () const"
.PP
Does the user want to be warned on leaving SSL mode. 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to be warned
.RE
.PP

.PP
Definition at line 358 of file ksslsettings.cc.
.SS "void KSSLSettings::setWarnOnLeave (bool x)"
.PP
Change the user's \fBwarnOnLeave()\fP setting 
.PP
\fBSince:\fP
.RS 4
3.3. 
.RE
.PP

.PP
\fBParameters:\fP
.RS 4
\fIx\fP true if the user is to be warned 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBwarnOnLeave\fP
.RE
.PP

.PP
Definition at line 359 of file ksslsettings.cc.
.SS "bool KSSLSettings::warnOnMixed () const"
.PP
Does the user want to be warned during mixed SSL/non-SSL mode. 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to be warned
.RE
.PP

.PP
Definition at line 360 of file ksslsettings.cc.
.SS "bool KSSLSettings::warnOnSelfSigned () const"
.PP
Do not use this. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 361 of file ksslsettings.cc.
.SS "bool KSSLSettings::warnOnRevoked () const"
.PP
Do not use this. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 362 of file ksslsettings.cc.
.SS "bool KSSLSettings::warnOnExpired () const"
.PP
Do not use this. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 363 of file ksslsettings.cc.
.SS "bool KSSLSettings::useEGD () const"
.PP
Does the user want to use the Entropy Gathering Daemon? 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to use EGD
.RE
.PP

.PP
Definition at line 364 of file ksslsettings.cc.
.PP
Referenced by KSSL::seedWithEGD().
.SS "bool KSSLSettings::useEFile () const"
.PP
Does the user want to use an entropy file? 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to use an entropy file
.RE
.PP

.PP
Definition at line 365 of file ksslsettings.cc.
.PP
Referenced by KSSL::close(), and KSSL::seedWithEGD().
.SS "void KSSLSettings::setTLSv1 (bool enabled)"
.PP
Change the user's TLSv1 preference. 
.PP
\fBParameters:\fP
.RS 4
\fIenabled\fP true if TLSv1 is enabled
.RE
.PP

.PP
Definition at line 369 of file ksslsettings.cc.
.SS "void KSSLSettings::setSSLv2 (bool enabled)"
.PP
Change the user's SSLv2 preference. 
.PP
\fBParameters:\fP
.RS 4
\fIenabled\fP true if SSLv2 is enabled
.RE
.PP

.PP
Definition at line 370 of file ksslsettings.cc.
.SS "void KSSLSettings::setSSLv3 (bool enabled)"
.PP
Change the user's SSLv3 preference. 
.PP
\fBParameters:\fP
.RS 4
\fIenabled\fP true if SSLv3 is enabled
.RE
.PP

.PP
Definition at line 371 of file ksslsettings.cc.
.SS "bool KSSLSettings::autoSendX509 () const"
.PP
Does the user want X.509 client certificates to always be sent when possible? 
.PP
\fBReturns:\fP
.RS 4
true if the user always wants a certificate sent
.RE
.PP

.PP
Definition at line 366 of file ksslsettings.cc.
.SS "bool KSSLSettings::promptSendX509 () const"
.PP
Does the user want to be prompted to send X.509 client certificates when possible? 
.PP
\fBReturns:\fP
.RS 4
true if the user wants to be prompted
.RE
.PP

.PP
Definition at line 367 of file ksslsettings.cc.
.SS "\fBQString\fP KSSLSettings::getCipherList ()"
.PP
Get the OpenSSL cipher list for selecting the list of ciphers to use in a connection. 
.PP
\fBReturns:\fP
.RS 4
the cipher list
.RE
.PP

.PP
Definition at line 125 of file ksslsettings.cc.
.PP
References QString::append(), KConfigBase::readBoolEntry(), KConfigBase::setGroup(), and QString::sprintf().
.PP
Referenced by KSSL::initialize(), and KSSL::TLSInit().
.SS "\fBQString\fP & KSSLSettings::getEGDPath ()"
.PP
Get the configured path to the entropy gathering daemon or entropy file. 
.PP
\fBReturns:\fP
.RS 4
the path
.RE
.PP

.PP
Definition at line 373 of file ksslsettings.cc.
.PP
Referenced by KSSL::close(), and KSSL::seedWithEGD().
.SS "void KSSLSettings::load ()"
.PP
Load the user's settings. 
.PP

.PP
Definition at line 238 of file ksslsettings.cc.
.PP
References KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readPathEntry(), KConfig::reparseConfiguration(), and KConfigBase::setGroup().
.PP
Referenced by KSSL::initialize(), KSSLSettings(), and KSSL::TLSInit().
.SS "void KSSLSettings::defaults ()"
.PP
Revert to default settings. 
.PP

.PP
Definition at line 278 of file ksslsettings.cc.
.SS "void KSSLSettings::save ()"
.PP
Save the current settings. 
.PP

.PP
Definition at line 295 of file ksslsettings.cc.
.PP
References QValueList::contains(), QValueList::count(), QFile::encodeName(), QString::isEmpty(), KConfigBase::setGroup(), QString::sprintf(), KConfigBase::sync(), KConfigBase::writeEntry(), and KConfigBase::writePathEntry().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
