Kpgp::Subkey

Kpgp::Subkey Class Reference

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

#include <kpgpkey.h>

List of all members.

Public Member Functions

Subkey (const KeyID &keyID, const bool secret=false)
bool secret () const
bool revoked () const
bool expired () const
bool disabled () const
bool invalid () const
bool canEncrypt () const
bool canSign () const
bool canCertify () const
unsigned int keyAlgorithm () const
unsigned int keyLength () const
KeyID longKeyID () const
KeyID keyID () const
QCString fingerprint () const
time_t creationDate () const
time_t expirationDate () 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)
void setKeyAlgorithm (const unsigned int keyAlgo)
void setKeyLength (const unsigned int keyLen)
void setKeyID (const KeyID &keyID)
void setFingerprint (const QCString &fingerprint)
void setCreationDate (const time_t creationDate)
void setExpirationDate (const time_t expirationDate)

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
unsigned int mKeyAlgo
unsigned int mKeyLen
KeyID mKeyID
QCString mFingerprint
time_t mTimestamp
time_t mExpiration

Detailed Description

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

Constructor & Destructor Documentation

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

Constructs a new subkey with the given key ID.

Member Function Documentation

bool Kpgp::Subkey::secret ( ) const [inline]

Returns true if the subkey is a secret subkey.

bool Kpgp::Subkey::revoked ( ) const [inline]

Returns true if the subkey has been revoked.

bool Kpgp::Subkey::expired ( ) const [inline]

Returns true if the subkey has expired.

bool Kpgp::Subkey::disabled ( ) const [inline]

Returns true if the subkey has been disabled.

bool Kpgp::Subkey::invalid ( ) const [inline]

Returns true if the subkey is invalid.

bool Kpgp::Subkey::canEncrypt ( ) const [inline]

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

bool Kpgp::Subkey::canSign ( ) const [inline]

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

bool Kpgp::Subkey::canCertify ( ) const [inline]

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

unsigned int Kpgp::Subkey::keyAlgorithm ( ) const [inline]

Returns the key algorithm of the subkey.

unsigned int Kpgp::Subkey::keyLength ( ) const [inline]

Returns the length of the subkey in bits.

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.

KeyID Kpgp::Subkey::keyID ( ) const [inline]

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

QCString Kpgp::Subkey::fingerprint ( ) const [inline]

Returns the fingerprint of the subkey.

time_t Kpgp::Subkey::creationDate ( ) const [inline]

Returns the creation date of the subkey.

time_t Kpgp::Subkey::expirationDate ( ) const [inline]

Returns the expiration date of the subkey.

void Kpgp::Subkey::setSecret ( const bool secret ) [inline]

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

void Kpgp::Subkey::setRevoked ( const bool revoked ) [inline]

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

void Kpgp::Subkey::setExpired ( const bool expired ) [inline]

Sets the flag if the subkey has expired to expired.

void Kpgp::Subkey::setDisabled ( const bool disabled ) [inline]

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

void Kpgp::Subkey::setInvalid ( const bool invalid ) [inline]

Sets the flag if the subkey is invalid to invalid.

void Kpgp::Subkey::setCanEncrypt ( const bool canEncrypt ) [inline]

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

void Kpgp::Subkey::setCanSign ( const bool canSign ) [inline]

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

void Kpgp::Subkey::setCanCertify ( const bool canCertify ) [inline]

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

void Kpgp::Subkey::setKeyAlgorithm ( const unsigned int keyAlgo ) [inline]

Sets the key algorithm of the subkey to keyAlgo.

void Kpgp::Subkey::setKeyLength ( const unsigned int keyLen ) [inline]

Sets the key length of the subkey to keyLen bits.

void Kpgp::Subkey::setKeyID ( const KeyID & keyID ) [inline]

Sets the key ID of the subkey to keyID.

void Kpgp::Subkey::setFingerprint ( const QCString & fingerprint ) [inline]

Sets the fingerprint of the subkey to fingerprint.

void Kpgp::Subkey::setCreationDate ( const time_t creationDate ) [inline]

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

void Kpgp::Subkey::setExpirationDate ( const time_t expirationDate ) [inline]

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

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

kpgpkey.h
kpgpkey.cpp