#include <kpgpkey.h>

Public Member Functions
	Subkey (const KeyID &keyID, const bool secret=false)

	~Subkey ()

bool	canCertify () const

bool	canEncrypt () const

bool	canSign () const

time_t	creationDate () const

bool	disabled () const

time_t	expirationDate () const

bool	expired () const

QByteArray	fingerprint () const

bool	invalid () const

unsigned int	keyAlgorithm () const

KeyID	keyID () const

unsigned int	keyLength () const

KeyID	longKeyID () const

bool	revoked () const

bool	secret () const

void	setCanCertify (const bool canCertify)

void	setCanEncrypt (const bool canEncrypt)

void	setCanSign (const bool canSign)

void	setCreationDate (const time_t creationDate)

void	setDisabled (const bool disabled)

void	setExpirationDate (const time_t expirationDate)

void	setExpired (const bool expired)

void	setFingerprint (const QByteArray &fingerprint)

void	setInvalid (const bool invalid)

void	setKeyAlgorithm (const unsigned int keyAlgo)

void	setKeyID (const KeyID &keyID)

void	setKeyLength (const unsigned int keyLen)

void	setRevoked (const bool revoked)

void	setSecret (const bool secret)

Protected Attributes
bool	mCanCertify: 1

bool	mCanEncrypt: 1

bool	mCanSign: 1

bool	mDisabled: 1

time_t	mExpiration

bool	mExpired: 1

QByteArray	mFingerprint

bool	mInvalid: 1

unsigned int	mKeyAlgo

KeyID	mKeyID

unsigned int	mKeyLen

bool	mRevoked: 1

bool	mSecret: 1

time_t	mTimestamp

Detailed Description

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

Definition at line 183 of file kpgpkey.h.

Constructor & Destructor Documentation

Kpgp::Subkey::Subkey	(	const KeyID &	keyID,
		const bool	secret = `false`
	)

explicit

Constructs a new subkey with the given key ID.

Definition at line 65 of file kpgpkey.cpp.

Kpgp::Subkey::~Subkey ( )

inline

Definition at line 188 of file kpgpkey.h.

Member Function Documentation

bool Kpgp::Subkey::canCertify ( ) const

inline

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

Definition at line 391 of file kpgpkey.h.

bool Kpgp::Subkey::canEncrypt ( ) const

inline

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

Definition at line 381 of file kpgpkey.h.

bool Kpgp::Subkey::canSign ( ) const

inline

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

Definition at line 386 of file kpgpkey.h.

time_t Kpgp::Subkey::creationDate ( ) const

inline

Returns the creation date of the subkey.

Definition at line 421 of file kpgpkey.h.

bool Kpgp::Subkey::disabled ( ) const

inline

Returns true if the subkey has been disabled.

Definition at line 371 of file kpgpkey.h.

time_t Kpgp::Subkey::expirationDate ( ) const

inline

Returns the expiration date of the subkey.

Definition at line 426 of file kpgpkey.h.

bool Kpgp::Subkey::expired ( ) const

inline

Returns true if the subkey has expired.

Definition at line 366 of file kpgpkey.h.

QByteArray Kpgp::Subkey::fingerprint ( ) const

inline

Returns the fingerprint of the subkey.

Definition at line 416 of file kpgpkey.h.

bool Kpgp::Subkey::invalid ( ) const

inline

Returns true if the subkey is invalid.

Definition at line 376 of file kpgpkey.h.

unsigned int Kpgp::Subkey::keyAlgorithm ( ) const

inline

Returns the key algorithm of the subkey.

Definition at line 396 of file kpgpkey.h.

KeyID Kpgp::Subkey::keyID ( ) const

inline

Returns the (short) 32 bit key ID of the subkey.

Definition at line 411 of file kpgpkey.h.

unsigned int Kpgp::Subkey::keyLength ( ) const

inline

Returns the length of the subkey in bits.

Definition at line 401 of file kpgpkey.h.

KeyID Kpgp::Subkey::longKeyID ( ) const

inline

Returns the long 64 bit key ID of the subkey if it's available.

Otherwise the short 32 bit key ID is returned.

Definition at line 406 of file kpgpkey.h.

bool Kpgp::Subkey::revoked ( ) const

inline

Returns true if the subkey has been revoked.

Definition at line 361 of file kpgpkey.h.

bool Kpgp::Subkey::secret ( ) const

inline

Returns true if the subkey is a secret subkey.

Definition at line 356 of file kpgpkey.h.

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

inline

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

Parameters

canCertify Whether this subkey can certify or not.

See also: canCertify()

Definition at line 466 of file kpgpkey.h.

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

inline

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

Parameters

canEncrypt Whether this subkey can encrypt or not.

See also: canEncrypt()

Definition at line 456 of file kpgpkey.h.

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

inline

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

Parameters

canSign Whether this subkey can sign or not.

See also: canSign()

Definition at line 461 of file kpgpkey.h.

void Kpgp::Subkey::setCreationDate ( const time_t creationDate )

inline

Sets the creation date of the subkey to creationDate seconds since Epoch.

Parameters

creationDate Creation time of this subkey, in seconds since the epoch (still midnight, january 1, 1970 in most places).

Definition at line 491 of file kpgpkey.h.

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

inline

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

Parameters

disabled Whether this subkey is disabled or not.

See also: disabled()

Definition at line 446 of file kpgpkey.h.

void Kpgp::Subkey::setExpirationDate ( const time_t expirationDate )

inline

Sets the expiration date of the subkey to expirationDate seconds since Epoch.

Parameters

expirationDate Expiry time of this subkey, in seconds since the epoch (still midnight, january 1, 1970 in most places).

Todo:: Does this expiry influence any of the other flags?

Definition at line 496 of file kpgpkey.h.

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

inline

Sets the flag if the subkey has expired to expired .

Parameters

expired Whether this subkey has expired or not.

See also: expired()

Definition at line 441 of file kpgpkey.h.

void Kpgp::Subkey::setFingerprint ( const QByteArray & fingerprint )

inline

Sets the fingerprint of the subkey to fingerprint .

Parameters

fingerprint to use for this subkey

See also: fingerprint()

Todo:: What are legal fingerprints?

Definition at line 486 of file kpgpkey.h.

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

inline

Sets the flag if the subkey is invalid to invalid .

Parameters

invalid Whether this subkey is invalid or not.

See also: invalid()

Definition at line 451 of file kpgpkey.h.

void Kpgp::Subkey::setKeyAlgorithm ( const unsigned int keyAlgo )

inline

Sets the key algorithm of the subkey to keyAlgo .

Parameters

keyAlgo The key algorithm to use.

See also: keyAlgorithm

Todo:: What are legal values? What do they mean? Where are they documented?

Definition at line 471 of file kpgpkey.h.

void Kpgp::Subkey::setKeyID ( const KeyID & keyID )

inline

Sets the key ID of the subkey to keyID .

Parameters

keyID the key ID for this subkey (just a string)

See also: keyID()

Todo:: What are legal key IDs? How about NULL IDs?

Definition at line 481 of file kpgpkey.h.

void Kpgp::Subkey::setKeyLength ( const unsigned int keyLen )

inline

Sets the key length of the subkey to keyLen bits.

Parameters

keyLength Length of the subkey.

See also: keyLength()

Todo:: What are the valid lengths? Is 0 ok?

Definition at line 476 of file kpgpkey.h.

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

inline

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

Parameters

revoked Whether this subkey is revoked or not.

See also: revoked()

Definition at line 436 of file kpgpkey.h.

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

inline

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

Parameters

secret Whether this subkey is secret or not.

See also: secret()

Definition at line 431 of file kpgpkey.h.

Member Data Documentation

bool Kpgp::Subkey::mCanCertify

protected

Can this subkey certify?

See also: canCertify(); setCanCertify()

Definition at line 346 of file kpgpkey.h.

bool Kpgp::Subkey::mCanEncrypt

protected

Can this subkey encrypt?

See also: canEncrypt(); setCanEncrypt()

Definition at line 342 of file kpgpkey.h.

bool Kpgp::Subkey::mCanSign

protected

Can this subkey sign?

See also: canSign(); setCanSign()

Definition at line 344 of file kpgpkey.h.

bool Kpgp::Subkey::mDisabled

protected

Is this subkey disabled?

See also: disabled(); setDisabled()

Definition at line 338 of file kpgpkey.h.

time_t Kpgp::Subkey::mExpiration

protected

-1 for never, 0 for not available

Definition at line 353 of file kpgpkey.h.

bool Kpgp::Subkey::mExpired

protected

Is this subkey expired?

See also: expired(); setExpired()

Definition at line 336 of file kpgpkey.h.

QByteArray Kpgp::Subkey::mFingerprint

protected

Definition at line 351 of file kpgpkey.h.

bool Kpgp::Subkey::mInvalid

protected

Is this subkey invalid?

See also: invalid(); setInvalid()

Definition at line 340 of file kpgpkey.h.

unsigned int Kpgp::Subkey::mKeyAlgo

protected

Definition at line 348 of file kpgpkey.h.

KeyID Kpgp::Subkey::mKeyID

protected

Definition at line 350 of file kpgpkey.h.

unsigned int Kpgp::Subkey::mKeyLen

protected

Definition at line 349 of file kpgpkey.h.

bool Kpgp::Subkey::mRevoked

protected

Is this subkey revoked?

See also: revoked(); setRevoked()

Definition at line 334 of file kpgpkey.h.

bool Kpgp::Subkey::mSecret

protected

Is this subkey secret?

See also: secret(); setSecret()

Definition at line 332 of file kpgpkey.h.

time_t Kpgp::Subkey::mTimestamp

protected

-1 for invalid, 0 for not available

Definition at line 352 of file kpgpkey.h.

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

libkpgp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

libkpgp

kdepim API Reference

Search