libkpgp

Public Member Functions | Protected Attributes | List of all members
Kpgp::Subkey Class Reference

#include <kpgpkey.h>

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
 
TQCString 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 TQCString &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
 
TQCString mFingerprint
 
time_t mTimestamp
 
time_t mExpiration
 

Detailed Description

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

Definition at line 162 of file kpgpkey.h.

Constructor & Destructor Documentation

◆ Subkey()

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

Constructs a new subkey with the given key ID.

Definition at line 62 of file kpgpkey.cpp.

◆ ~Subkey()

Kpgp::Subkey::~Subkey ( )
inline

Definition at line 167 of file kpgpkey.h.

Member Function Documentation

◆ canCertify()

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

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

Definition at line 316 of file kpgpkey.h.

◆ canEncrypt()

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

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

Definition at line 306 of file kpgpkey.h.

◆ canSign()

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

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

Definition at line 311 of file kpgpkey.h.

◆ creationDate()

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

Returns the creation date of the subkey.

Definition at line 346 of file kpgpkey.h.

◆ disabled()

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

Returns true if the subkey has been disabled.

Definition at line 296 of file kpgpkey.h.

◆ expirationDate()

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

Returns the expiration date of the subkey.

Definition at line 351 of file kpgpkey.h.

◆ expired()

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

Returns true if the subkey has expired.

Definition at line 291 of file kpgpkey.h.

◆ fingerprint()

TQCString Kpgp::Subkey::fingerprint ( ) const
inline

Returns the fingerprint of the subkey.

Definition at line 341 of file kpgpkey.h.

◆ invalid()

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

Returns true if the subkey is invalid.

Definition at line 301 of file kpgpkey.h.

◆ keyAlgorithm()

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

Returns the key algorithm of the subkey.

Definition at line 321 of file kpgpkey.h.

◆ keyID()

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

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

Definition at line 336 of file kpgpkey.h.

◆ keyLength()

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

Returns the length of the subkey in bits.

Definition at line 326 of file kpgpkey.h.

◆ longKeyID()

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 331 of file kpgpkey.h.

◆ revoked()

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

Returns true if the subkey has been revoked.

Definition at line 286 of file kpgpkey.h.

◆ secret()

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

Returns true if the subkey is a secret subkey.

Definition at line 281 of file kpgpkey.h.

◆ setCanCertify()

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

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

Definition at line 391 of file kpgpkey.h.

◆ setCanEncrypt()

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

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

Definition at line 381 of file kpgpkey.h.

◆ setCanSign()

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

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

Definition at line 386 of file kpgpkey.h.

◆ setCreationDate()

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

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

Definition at line 416 of file kpgpkey.h.

◆ setDisabled()

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

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

Definition at line 371 of file kpgpkey.h.

◆ setExpirationDate()

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

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

Definition at line 421 of file kpgpkey.h.

◆ setExpired()

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

Sets the flag if the subkey has expired to expired.

Definition at line 366 of file kpgpkey.h.

◆ setFingerprint()

void Kpgp::Subkey::setFingerprint ( const TQCString &  fingerprint)
inline

Sets the fingerprint of the subkey to fingerprint.

Definition at line 411 of file kpgpkey.h.

◆ setInvalid()

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

Sets the flag if the subkey is invalid to invalid.

Definition at line 376 of file kpgpkey.h.

◆ setKeyAlgorithm()

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

Sets the key algorithm of the subkey to keyAlgo.

Definition at line 396 of file kpgpkey.h.

◆ setKeyID()

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

Sets the key ID of the subkey to keyID.

Definition at line 406 of file kpgpkey.h.

◆ setKeyLength()

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

Sets the key length of the subkey to keyLen bits.

Definition at line 401 of file kpgpkey.h.

◆ setRevoked()

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

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

Definition at line 361 of file kpgpkey.h.

◆ setSecret()

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

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

Definition at line 356 of file kpgpkey.h.

Member Data Documentation

◆ mCanCertify

bool Kpgp::Subkey::mCanCertify
protected

Definition at line 271 of file kpgpkey.h.

◆ mCanEncrypt

bool Kpgp::Subkey::mCanEncrypt
protected

Definition at line 269 of file kpgpkey.h.

◆ mCanSign

bool Kpgp::Subkey::mCanSign
protected

Definition at line 270 of file kpgpkey.h.

◆ mDisabled

bool Kpgp::Subkey::mDisabled
protected

Definition at line 267 of file kpgpkey.h.

◆ mExpiration

time_t Kpgp::Subkey::mExpiration
protected

Definition at line 278 of file kpgpkey.h.

◆ mExpired

bool Kpgp::Subkey::mExpired
protected

Definition at line 266 of file kpgpkey.h.

◆ mFingerprint

TQCString Kpgp::Subkey::mFingerprint
protected

Definition at line 276 of file kpgpkey.h.

◆ mInvalid

bool Kpgp::Subkey::mInvalid
protected

Definition at line 268 of file kpgpkey.h.

◆ mKeyAlgo

unsigned int Kpgp::Subkey::mKeyAlgo
protected

Definition at line 273 of file kpgpkey.h.

◆ mKeyID

KeyID Kpgp::Subkey::mKeyID
protected

Definition at line 275 of file kpgpkey.h.

◆ mKeyLen

unsigned int Kpgp::Subkey::mKeyLen
protected

Definition at line 274 of file kpgpkey.h.

◆ mRevoked

bool Kpgp::Subkey::mRevoked
protected

Definition at line 265 of file kpgpkey.h.

◆ mSecret

bool Kpgp::Subkey::mSecret
protected

Definition at line 263 of file kpgpkey.h.

◆ mTimestamp

time_t Kpgp::Subkey::mTimestamp
protected

Definition at line 277 of file kpgpkey.h.

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