Kpgp::Key Class Reference

#include <kpgpkey.h>

Public Member Functions
	Key (const KeyID &keyid=KeyID(), const TQString &uid=TQString(), const bool secret=false)
void	clear ()
bool	secret () const
bool	revoked () const
bool	expired () const
bool	disabled () const
bool	invalid () const
bool	canEncrypt () const
bool	canSign () const
bool	canCertify () const
void	setSecret (const bool secret)
void	setRevoked (const bool revoked)
void	setExpired (const bool expired)
void	setDisabled (const bool disabled)
void	setInvalid (const bool invalid)
void	setCanEncrypt (const bool canEncrypt)
void	setCanSign (const bool canSign)
void	setCanCertify (const bool canCertify)
EncryptPref	encryptionPreference ()
void	setEncryptionPreference (const EncryptPref encrPref)
TQString	primaryUserID () const
KeyID	primaryKeyID () const
TQCString	primaryFingerprint () const
bool	isNull () const
time_t	creationDate () const
Validity	keyTrust () const
Validity	keyTrust (const TQString &uid) const
void	cloneKeyTrust (const Key *key)
bool	isValid () const
bool	isValidEncryptionKey () const
bool	isValidSigningKey () const
const UserIDList	userIDs () const
const SubkeyList	subkeys () const
void	addUserID (const TQString &uid, const Validity validity=KPGP_VALIDITY_UNKNOWN, const bool revoked=false, const bool invalid=false)
void	addUserID (const UserID *userID)
bool	matchesUserID (const TQString &str, bool cs=true)
void	addSubkey (const KeyID &keyID, const bool secret=false)
void	addSubkey (const Subkey *subkey)
Subkey *	getSubkey (const KeyID &keyID)
void	setFingerprint (const KeyID &keyID, const TQCString &fpr)

Protected Attributes
bool	mSecret: 1
bool	mRevoked: 1
bool	mExpired: 1
bool	mDisabled: 1
bool	mInvalid: 1
bool	mCanEncrypt: 1
bool	mCanSign: 1
bool	mCanCertify: 1
EncryptPref	mEncryptPref
SubkeyList	mSubkeys
UserIDList	mUserIDs

Detailed Description

This class is used to store information about a PGP key.

Definition at line 432 of file kpgpkey.h.

Constructor & Destructor Documentation

Key()

Kpgp::Key::Key	(	const KeyID &	keyid = KeyID(),
		const TQString &	uid = TQString(),
		const bool	secret = false
	)

Constructs a new PGP key with keyid as key ID of the primary key and uid as primary user ID.

Definition at line 84 of file kpgpkey.cpp.

Member Function Documentation

addSubkey() [1/2]

void Kpgp::Key::addSubkey	(	const KeyID &	keyID,
		const bool	secret = false
	)

Adds a subkey with the given values to the key if keyID isn't an empty string.

Definition at line 219 of file kpgpkey.cpp.

addSubkey() [2/2]

void Kpgp::Key::addSubkey ( const Subkey *  subkey )

inline

Adds the given subkey to the key.

Definition at line 752 of file kpgpkey.h.

addUserID() [1/2]

void Kpgp::Key::addUserID	(	const TQString &	uid,
		const Validity	validity = KPGP_VALIDITY_UNKNOWN,
		const bool	revoked = false,
		const bool	invalid = false
	)

Adds a user ID with the given values to the key if uid isn't an empty string.

Definition at line 197 of file kpgpkey.cpp.

addUserID() [2/2]

void Kpgp::Key::addUserID ( const UserID *  userID )

inline

Adds the given user ID to the key.

Definition at line 746 of file kpgpkey.h.

canCertify()

bool Kpgp::Key::canCertify ( ) const

inline

Returns true if the key can be used to certify keys.

Definition at line 638 of file kpgpkey.h.

canEncrypt()

bool Kpgp::Key::canEncrypt ( ) const

inline

Returns true if the key can be used to encrypt data.

Definition at line 628 of file kpgpkey.h.

canSign()

bool Kpgp::Key::canSign ( ) const

inline

Returns true if the key can be used to sign data.

Definition at line 633 of file kpgpkey.h.

clear()

void Kpgp::Key::clear

(

)

Clears/resets all key data.

Definition at line 114 of file kpgpkey.cpp.

cloneKeyTrust()

void Kpgp::Key::cloneKeyTrust

(

const Key *

key

)

Set the validity values for the user ids to the validity values of the given key.

This is useful after rereading a key without expensive trust checking.

Definition at line 165 of file kpgpkey.cpp.

creationDate()

time_t Kpgp::Key::creationDate ( ) const

inline

Returns the creation date of the primary subkey.

Definition at line 738 of file kpgpkey.h.

disabled()

bool Kpgp::Key::disabled ( ) const

inline

Returns true if the key has been disabled.

Definition at line 618 of file kpgpkey.h.

encryptionPreference()

EncryptPref Kpgp::Key::encryptionPreference ( )

inline

Returns the encryption preference for this key.

Definition at line 683 of file kpgpkey.h.

expired()

bool Kpgp::Key::expired ( ) const

inline

Returns true if the key has expired.

Definition at line 613 of file kpgpkey.h.

getSubkey()

Subkey * Kpgp::Key::getSubkey

(

const KeyID &

keyID

)

Returns a pointer to the subkey with the given key ID.

Definition at line 227 of file kpgpkey.cpp.

invalid()

bool Kpgp::Key::invalid ( ) const

inline

Returns true if the key is invalid.

Definition at line 623 of file kpgpkey.h.

isNull()

bool Kpgp::Key::isNull ( ) const

inline

Returns true if there are no user IDs or no subkeys.

Definition at line 733 of file kpgpkey.h.

isValid()

bool Kpgp::Key::isValid

(

)

const

Returns true if the key is valid, i.e.

not revoked, expired, disabled or invalid.

Definition at line 177 of file kpgpkey.cpp.

isValidEncryptionKey()

bool Kpgp::Key::isValidEncryptionKey

(

)

const

Returns true if the key is a valid encryption key.

The trust is not checked.

Definition at line 184 of file kpgpkey.cpp.

isValidSigningKey()

bool Kpgp::Key::isValidSigningKey

(

)

const

Returns true if the key is a valid signing key.

The trust is not checked.

Definition at line 191 of file kpgpkey.cpp.

keyTrust() [1/2]

Validity Kpgp::Key::keyTrust

(

)

const

Returns the trust value of this key.

This is the maximal trust value of any of the user ids of this key.

Definition at line 134 of file kpgpkey.cpp.

keyTrust() [2/2]

Validity Kpgp::Key::keyTrust

(

const TQString &

uid

)

const

Returns the trust value for the given user id of this key.

Definition at line 148 of file kpgpkey.cpp.

matchesUserID()

bool Kpgp::Key::matchesUserID	(	const TQString &	str,
		bool	cs = true
	)

Returns true if the given string matches one of the user IDs.

The match is case sensitive if cs is true or case insensitive if cs is false.

Definition at line 206 of file kpgpkey.cpp.

primaryFingerprint()

TQCString Kpgp::Key::primaryFingerprint ( ) const

inline

Returns the fingerprint of the primary key or a null string if there are no subkeys.

Definition at line 713 of file kpgpkey.h.

primaryKeyID()

KeyID Kpgp::Key::primaryKeyID ( ) const

inline

Returns the key ID of the primary key or a null string if there are no subkeys.

Definition at line 703 of file kpgpkey.h.

primaryUserID()

TQString Kpgp::Key::primaryUserID ( ) const

inline

Returns the primary user ID or a null string if there are no user IDs.

Definition at line 693 of file kpgpkey.h.

revoked()

bool Kpgp::Key::revoked ( ) const

inline

Returns true if the key has been revoked.

Definition at line 608 of file kpgpkey.h.

secret()

bool Kpgp::Key::secret ( ) const

inline

Returns true if the key is a secret key.

Definition at line 603 of file kpgpkey.h.

setCanCertify()

void Kpgp::Key::setCanCertify ( const bool  canCertify )

inline

Sets the flag if the key can be used to certify keys to canCertify.

Definition at line 678 of file kpgpkey.h.

setCanEncrypt()

void Kpgp::Key::setCanEncrypt ( const bool  canEncrypt )

inline

Sets the flag if the key can be used to encrypt data to canEncrypt.

Definition at line 668 of file kpgpkey.h.

setCanSign()

void Kpgp::Key::setCanSign ( const bool  canSign )

inline

Sets the flag if the key can be used to sign data to canSign.

Definition at line 673 of file kpgpkey.h.

setDisabled()

void Kpgp::Key::setDisabled ( const bool  disabled )

inline

Sets the flag if the key has been disabled to disabled.

Definition at line 658 of file kpgpkey.h.

setEncryptionPreference()

void Kpgp::Key::setEncryptionPreference ( const EncryptPref  encrPref )

inline

Sets the encryption preference for this key to encrPref.

Definition at line 688 of file kpgpkey.h.

setExpired()

void Kpgp::Key::setExpired ( const bool  expired )

inline

Sets the flag if the key has expired to expired.

Definition at line 653 of file kpgpkey.h.

setFingerprint()

void Kpgp::Key::setFingerprint	(	const KeyID &	keyID,
		const TQCString &	fpr
	)

Sets the fingerprint of the given subkey to fpr.

Definition at line 249 of file kpgpkey.cpp.

setInvalid()

void Kpgp::Key::setInvalid ( const bool  invalid )

inline

Sets the flag if the key is invalid to invalid.

Definition at line 663 of file kpgpkey.h.

setRevoked()

void Kpgp::Key::setRevoked ( const bool  revoked )

inline

Sets the flag if the key has been revoked to revoked.

Definition at line 648 of file kpgpkey.h.

setSecret()

void Kpgp::Key::setSecret ( const bool  secret )

inline

Sets the flag if the key is a secret key to secret.

Definition at line 643 of file kpgpkey.h.

subkeys()

const SubkeyList Kpgp::Key::subkeys ( ) const

inline

Returns the list of subkeys.

Definition at line 728 of file kpgpkey.h.

userIDs()

const UserIDList Kpgp::Key::userIDs ( ) const

inline

Returns the list of userIDs.

Definition at line 723 of file kpgpkey.h.

---

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

• kpgpkey.h
• kpgpkey.cpp