• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KSSL Class Reference

KDE SSL Wrapper Class. More...

#include <kssl.h>

List of all members.

Public Member Functions

void close ()
bool initialize ()
 KSSL (bool init=true)
bool reconfig ()
bool reInitialize ()
int seedWithEGD ()
void setAutoReconfig (bool ar)
bool setSession (const KSSLSession *session)
bool setSettings (KSSLSettings *settings)
KSSLSettings * settings ()
bool TLSInit ()
 ~KSSL ()

Static Public Member Functions

static bool doesSSLWork ()

Detailed Description

KDE SSL Wrapper Class.

This class implements KDE's SSL support by wrapping OpenSSL.

Author:
George Staikos <staikos@kde.org>
See also:
KExtendedSocket, TCPSlaveBase KDE SSL Class

Definition at line 39 of file kssl.h.


Constructor & Destructor Documentation

KSSL::KSSL ( bool  init = true  ) 

Construct a KSSL object.

Parameters:
init Set this to false if you do not want this class to immediately initialize OpenSSL.

Definition at line 79 of file kssl.cpp.

KSSL::~KSSL (  ) 

Destroy this KSSL object.

Does not close any socket.

Definition at line 93 of file kssl.cpp.


Member Function Documentation

void KSSL::close (  ) 

Close the SSL session.

Definition at line 152 of file kssl.cpp.

bool KSSL::doesSSLWork (  )  [static]

Determine if SSL is available and works.

Returns:
true is SSL is available and usable

Definition at line 211 of file kssl.cpp.

bool KSSL::initialize (  ) 

Initialize OpenSSL.

Returns:
true on success

This will do nothing if it is already initialized.

See also:
reInitialize

Definition at line 121 of file kssl.cpp.

bool KSSL::reconfig (  ) 

Trigger a reread of KSSL configuration and reInitialize() KSSL.

Returns:
true on successful reinitalizations

If you setAutoReconfig() to false, then this will simply reInitialize() and not read in the new configuration.

See also:
setAutoReconfig

Definition at line 183 of file kssl.cpp.

bool KSSL::reInitialize (  ) 

Reinitialize OpenSSL.

Returns:
true on success

This is not generally needed unless you are reusing the KSSL object for a new session.

See also:
initialize

Definition at line 174 of file kssl.cpp.

int KSSL::seedWithEGD (  ) 

This will reseed the pseudo-random number generator with the EGD (entropy gathering daemon) if the EGD is configured and enabled.

You don't need to call this yourself normally.

Returns:
0 on success

Definition at line 100 of file kssl.cpp.

void KSSL::setAutoReconfig ( bool  ar  ) 

Enable or disable automatic reconfiguration on initialize().

Parameters:
ar Set to false in order to disable auto-reloading of the KSSL configuration during initialize().

By default, KSSL will read its configuration on initialize(). You might want to disable this for performance reasons.

Definition at line 188 of file kssl.cpp.

bool KSSL::setSession ( const KSSLSession *  session  ) 

Set an SSL session to use.

This deep copies the session so it doesn't have to remain valid. You need to call it after calling initialize or reInitialize. The ID is cleared in close().

Parameters:
session A valid session to reuse. If 0L, it will clear the session ID in memory.
Returns:
true on success
bool KSSL::setSettings ( KSSLSettings *  settings  ) 

Set a new KSSLSettings instance as the settings.

This deletes the current instance of KSSLSettings.

Parameters:
settings A new, valid settings object.
Returns:
true on success

Definition at line 193 of file kssl.cpp.

KSSLSettings * KSSL::settings (  ) 

One is built by the constructor, so this will only return a NULL pointer if you set one with setSettings().

Returns:
the current settings instance

Definition at line 199 of file kssl.cpp.

bool KSSL::TLSInit (  ) 

This is used for applicationss which do STARTTLS or something similar.

It creates a TLS method regardless of the user's settings.

Returns:
true if TLS is successfully initialized

The documentation for this class was generated from the following files:
  • kssl.h
  • kssl.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal