kgpg

KgpgInterface Class Reference

#include <kgpginterface.h>

Inheritance diagram for KgpgInterface:

[legend]

List of all members.

Detailed Description

This class is the interface for gpg.

Definition at line 35 of file kgpginterface.h.


Public Slots
void	downloadKeys (const QStringList &keys, const QString &keyserver, const bool &refresh, const QString &proxy="")
void	downloadKeysAbort ()
QString	getKeys (const QString *attributes=NULL, const QStringList &ids=QStringList())
void	importKey (const QString &keystr)
void	importKey (const KUrl &url)
void	KgpgDelSignature (const QString &keyID, const QString &uid, QString signKeyID)
void	KgpgRevokeKey (const QString &keyID, const QString &revokeUrl, const int reason, const QString &description)
QPixmap	loadPhoto (const QString &keyid, const QString &uid, const bool &block=false)
KgpgCore::KgpgKeyList	readJoinedKeys (const KgpgCore::KgpgKeyTrust &trust, const QStringList &ids=QStringList())
KgpgCore::KgpgKeyList	readPublicKeys (const bool &block, const QString &ids, const bool &withsigs=false)
KgpgCore::KgpgKeyList	readPublicKeys (const bool &block=false, const QStringList &ids=QStringList(), const bool &withsigs=false)
KgpgCore::KgpgKeyList	readSecretKeys (const QStringList &ids=QStringList())
void	revokeover (GPGProc *)
void	revokeprocess (GPGProc *p)
void	signKey (const QString &keyid, const QString &signkeyid, const bool &local, const int &checking, const bool &terminal=false, const QString &uid=QString())
void	uploadKeys (const QStringList &keys, const QString &keyserver, const QString &attributes, const QString &proxy="")
void	uploadKeysAbort ()
Signals
void	delsigfinished (bool)
void	downloadKeysAborted (KgpgInterface *)
void	downloadKeysFinished (QList< int >, QStringList, bool, QString, KgpgInterface *)
void	getKeysFinished (QString, KgpgInterface *)
void	importKeyFinished (KgpgInterface *, QStringList)
void	loadPhotoFinished (QPixmap, KgpgInterface *)
void	readPublicKeysFinished (KgpgCore::KgpgKeyList, KgpgInterface *)
void	revokecertificate (QString)
void	revokeurl (QString)
void	signKeyFinished (int, const QString &, KgpgInterface *)
void	uploadKeysAborted (KgpgInterface *)
void	uploadKeysFinished (QString, KgpgInterface *)
Public Member Functions
	KgpgInterface ()
	~KgpgInterface ()
Static Public Member Functions
static QString	checkForUtf8 (QString txt)
static QString	checkForUtf8bis (QString txt)
static void	delGpgGroup (const QString &name, const QString &configfile)
static bool	getGpgBoolSetting (const QString &name, const QString &configfile)
static QStringList	getGpgGroupNames (const QString &configfile)
static QStringList	getGpgGroupSetting (const QString &name, const QString &configfile)
static QString	getGpgHome (const QString &binary)
static QString	getGpgSetting (QString name, const QString &configfile)
static int	gpgVersion (const QString &vstr)
static QString	gpgVersionString (const QString &binary)
static int	sendPassphrase (const QString &text, KProcess *process, const bool isnew=true)
static void	setGpgBoolSetting (const QString &name, const bool &enable, const QString &url)
static void	setGpgGroupSetting (const QString &name, const QStringList &values, const QString &configfile)
static void	setGpgSetting (const QString &name, const QString &value, const QString &url)

Constructor & Destructor Documentation

KgpgInterface::KgpgInterface ( )

Initialize the class.

Definition at line 43 of file kgpginterface.cpp.

KgpgInterface::~KgpgInterface ( )

Definition at line 47 of file kgpginterface.cpp.

Member Function Documentation

QString KgpgInterface::checkForUtf8 ( QString txt ) [static]

Definition at line 65 of file kgpginterface.cpp.

QString KgpgInterface::checkForUtf8bis ( QString txt ) [static]

Definition at line 82 of file kgpginterface.cpp.

void KgpgInterface::delGpgGroup	(	const QString &	name,
		const QString &	configfile
	)			`[static]`

Definition at line 271 of file kgpginterface.cpp.

void KgpgInterface::delsigfinished ( bool ) [signal]

true if key signature deletion successful, false on error.

void KgpgInterface::downloadKeys	(	const QStringList &	keys,
		const QString &	keyserver,
		const bool &	refresh,
		const QString &	proxy = `""`
	)			`[slot]`

Definition at line 1255 of file kgpginterface.cpp.

void KgpgInterface::downloadKeysAbort ( ) [slot]

Definition at line 1285 of file kgpginterface.cpp.

void KgpgInterface::downloadKeysAborted ( KgpgInterface * ) [signal]

void KgpgInterface::downloadKeysFinished	(	QList< int >	,
		QStringList	,
		bool	,
		QString	,
		KgpgInterface *
	)			`[signal]`

bool KgpgInterface::getGpgBoolSetting	(	const QString &	name,
		const QString &	configfile
	)			`[static]`

Definition at line 365 of file kgpginterface.cpp.

QStringList KgpgInterface::getGpgGroupNames ( const QString & configfile ) [static]

Definition at line 180 of file kgpginterface.cpp.

QStringList KgpgInterface::getGpgGroupSetting	(	const QString &	name,
		const QString &	configfile
	)			`[static]`

Definition at line 201 of file kgpginterface.cpp.

QString KgpgInterface::getGpgHome ( const QString & binary ) [static]

find users GnuPG directory

Parameters:

binary

name or path to GnuPG binary

Returns:: path to directory

Use this function to find out where GnuPG would store it's configuration and data files. The returned path always ends with a '/'.

Definition at line 145 of file kgpginterface.cpp.

QString KgpgInterface::getGpgSetting	(	QString	name,
		const QString &	configfile
	)			`[static]`

Definition at line 303 of file kgpginterface.cpp.

QString KgpgInterface::getKeys	(	const QString *	attributes = `NULL`,
		const QStringList &	ids = `QStringList()`
	)			`[slot]`

Definition at line 888 of file kgpginterface.cpp.

void KgpgInterface::getKeysFinished	(	QString	,
		KgpgInterface *
	)			`[signal]`

int KgpgInterface::gpgVersion ( const QString & vstr ) [static]

parse GnuPG version string and return version as number

Parameters:

vstr

version string

Returns:: -1 if vstr is empty, -2 on parse error, parsed number on success

The version string must be in format A.B.C with A, B, and C numbers. The returned number is A * 65536 + B * 256 + C.

Definition at line 94 of file kgpginterface.cpp.

QString KgpgInterface::gpgVersionString ( const QString & binary ) [static]

get the GnuPG version string of the given binary

Parameters:

binary

name or path to GnuPG binary

Returns:: version string or empty string on error

This starts a GnuPG process and asks the binary for version information. The returned string is the version information without any leading text.

Definition at line 106 of file kgpginterface.cpp.

void KgpgInterface::importKey ( const QString & keystr ) [slot]

Import key function.

Parameters:

keystr

QString containing th key. Allows public & secret key import.

Definition at line 1122 of file kgpginterface.cpp.

void KgpgInterface::importKey ( const KUrl & url ) [slot]

Import key function.

Parameters:

url

Kurl the url of the key file. Allows public & secret key import.

Definition at line 1139 of file kgpginterface.cpp.

void KgpgInterface::importKeyFinished	(	KgpgInterface *	,
		QStringList
	)			`[signal]`

void KgpgInterface::KgpgDelSignature	(	const QString &	keyID,
		const QString &	uid,
		QString	signKeyID
	)			`[slot]`

Key signature deletion function.

Parameters:

	keyID	QString the ID of the key
	signKeyID	QString the ID of the signature key

Definition at line 1413 of file kgpginterface.cpp.

void KgpgInterface::KgpgRevokeKey	(	const QString &	keyID,
		const QString &	revokeUrl,
		const int	reason,
		const QString &	description
	)			`[slot]`

Definition at line 1469 of file kgpginterface.cpp.

QPixmap KgpgInterface::loadPhoto	(	const QString &	keyid,
		const QString &	uid,
		const bool &	block = `false`
	)			`[slot]`

Definition at line 1078 of file kgpginterface.cpp.

void KgpgInterface::loadPhotoFinished	(	QPixmap	,
		KgpgInterface *
	)			`[signal]`

KgpgCore::KgpgKeyList KgpgInterface::readJoinedKeys	(	const KgpgCore::KgpgKeyTrust &	trust,
		const QStringList &	ids = `QStringList()`
	)			`[slot]`

KgpgCore::KgpgKeyList KgpgInterface::readPublicKeys	(	const bool &	block,
		const QString &	ids,
		const bool &	withsigs = `false`
	)			`[inline, slot]`

Definition at line 115 of file kgpginterface.h.

KgpgKeyList KgpgInterface::readPublicKeys	(	const bool &	block = `false`,
		const QStringList &	ids = `QStringList()`,
		const bool &	withsigs = `false`
	)			`[slot]`

Definition at line 463 of file kgpginterface.cpp.

void KgpgInterface::readPublicKeysFinished	(	KgpgCore::KgpgKeyList	,
		KgpgInterface *
	)			`[signal]`

KgpgKeyList KgpgInterface::readSecretKeys ( const QStringList & ids = QStringList() ) [slot]

Definition at line 763 of file kgpginterface.cpp.

void KgpgInterface::revokecertificate ( QString ) [signal]

void KgpgInterface::revokeover ( GPGProc * ) [slot]

Definition at line 1488 of file kgpginterface.cpp.

void KgpgInterface::revokeprocess ( GPGProc * p ) [slot]

Definition at line 1502 of file kgpginterface.cpp.

void KgpgInterface::revokeurl ( QString ) [signal]

int KgpgInterface::sendPassphrase	(	const QString &	text,
		KProcess *	process,
		const bool	isnew = `true`
	)			`[static]`

ask the user for a passphrase and send it to the given gpg process

Parameters:

	text	text is the message that must be displayed in the MessageBox
	process	gnupg process
	isnew	if the password is a new password that must be confirmed. Default is true

Returns:: 0 if there is no error
1 if there is an error

Definition at line 421 of file kgpginterface.cpp.

void KgpgInterface::setGpgBoolSetting	(	const QString &	name,
		const bool &	enable,
		const QString &	url
	)			`[static]`

Definition at line 381 of file kgpginterface.cpp.

void KgpgInterface::setGpgGroupSetting	(	const QString &	name,
		const QStringList &	values,
		const QString &	configfile
	)			`[static]`

Definition at line 229 of file kgpginterface.cpp.

void KgpgInterface::setGpgSetting	(	const QString &	name,
		const QString &	value,
		const QString &	url
	)			`[static]`

Definition at line 327 of file kgpginterface.cpp.

void KgpgInterface::signKey	(	const QString &	keyid,
		const QString &	signkeyid,
		const bool &	local,
		const int &	checking,
		const bool &	terminal = `false`,
		const QString &	uid = `QString()`
	)			`[slot]`

Key signature function.

Parameters:

	keyid	the ID of the key to be signed
	signkeyid	the ID of the signing key
	local	should the signature be local
	checking	how careful the key was checked
	terminal	if the user want to sign the key manually

Definition at line 923 of file kgpginterface.cpp.

void KgpgInterface::signKeyFinished	(	int	,
		const QString &	,
		KgpgInterface *
	)			`[signal]`

Signature process result: 0 = Unknown error 1 = Bad passphrase 2 = Good passphrase 3 = Aborted by user 4 = Already signed.

void KgpgInterface::uploadKeys	(	const QStringList &	keys,
		const QString &	keyserver,
		const QString &	attributes,
		const QString &	proxy = `""`
	)			`[slot]`

Definition at line 1351 of file kgpginterface.cpp.

void KgpgInterface::uploadKeysAbort ( ) [slot]

Definition at line 1380 of file kgpginterface.cpp.

void KgpgInterface::uploadKeysAborted ( KgpgInterface * ) [signal]

void KgpgInterface::uploadKeysFinished	(	QString	,
		KgpgInterface *
	)			`[signal]`

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

kgpg

KgpgInterface Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

kgpg

kdeutils