IceSSL::PasswordPrompt Class Reference

In order to read an encrypted file, such as one containing a private key, OpenSSL requests a password from IceSSL. More...

#include <IceSSL/IceSSL.h>

Inheritance diagram for IceSSL::PasswordPrompt:

Collaboration diagram for IceSSL::PasswordPrompt:

Public Member Functions
virtual std::string	getPassword ()=0
	Obtains the password.
virtual	~PasswordPrompt ()
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

In order to read an encrypted file, such as one containing a private key, OpenSSL requests a password from IceSSL.

The password can be defined using an IceSSL configuration property, but a plain-text password is a security risk. If a password is not supplied via configuration, IceSSL allows OpenSSL to prompt the user interactively. This may not be desirable (or even possible), so the application can supply an implementation of PasswordPrompt to take responsibility for obtaining the password.

Note that the password is needed during plug-in initialization, so in general you will need to delay initialization (by defining IceSSL.DelayInit=1), configure the PasswordPrompt, then manually initialize the plug-in.

Constructor & Destructor Documentation

~PasswordPrompt()

virtual IceSSL::PasswordPrompt::~PasswordPrompt ( )

virtual

Member Function Documentation

getPassword()

virtual std::string IceSSL::PasswordPrompt::getPassword ( )

pure virtual

Obtains the password.

This method may be invoked repeatedly, such as when several encrypted files are opened, or when multiple password attempts are allowed.

Returns

The clear-text password.

---

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

• IceSSL/Plugin.h