QCA::SecureMessageKey Class Reference

Key for SecureMessage system. More...

#include <QtCrypto>

Collaboration diagram for QCA::SecureMessageKey:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Type { None, PGP, X509 }

Public Member Functions

 SecureMessageKey ()
 SecureMessageKey (const SecureMessageKey &from)
SecureMessageKey & operator= (const SecureMessageKey &from)
bool isNull () const
Type type () const
PGPKey pgpPublicKey () const
PGPKey pgpSecretKey () const
void setPGPPublicKey (const PGPKey &pub)
void setPGPSecretKey (const PGPKey &sec)
CertificateChain x509CertificateChain () const
PrivateKey x509PrivateKey () const
void setX509CertificateChain (const CertificateChain &c)
void setX509PrivateKey (const PrivateKey &k)
void setX509KeyBundle (const KeyBundle &kb)
bool havePrivate () const
QString name () const

Detailed Description

Key for SecureMessage system.
Examples:

cmsexample.cpp, and publickeyexample.cpp.


Member Enumeration Documentation

enum QCA::SecureMessageKey::Type
 

The key type.

Enumerator:
None  no key
PGP  Pretty Good Privacy key.
X509  X.509 CMS key.


Constructor & Destructor Documentation

QCA::SecureMessageKey::SecureMessageKey (   ) 
 

Construct an empty key.

QCA::SecureMessageKey::SecureMessageKey (  const SecureMessageKey &  from  ) 
 

Standard copy constructor.

Parameters:
from the source key


Member Function Documentation

SecureMessageKey& QCA::SecureMessageKey::operator= (  const SecureMessageKey &  from  ) 
 

Standard assignment operator.

Parameters:
from the source key

bool QCA::SecureMessageKey::isNull (   )  const
 

Returns true for null object.

Type QCA::SecureMessageKey::type (   )  const
 

The key type.

PGPKey QCA::SecureMessageKey::pgpPublicKey (   )  const
 

Public key part of a PGP key.

PGPKey QCA::SecureMessageKey::pgpSecretKey (   )  const
 

Private key part of a PGP key.

void QCA::SecureMessageKey::setPGPPublicKey (  const PGPKey &  pub  ) 
 

Set the public key part of a PGP key.

Parameters:
pub the PGP public key

void QCA::SecureMessageKey::setPGPSecretKey (  const PGPKey &  sec  ) 
 

Set the private key part of a PGP key.

Parameters:
sec the PGP secretkey

CertificateChain QCA::SecureMessageKey::x509CertificateChain (   )  const
 

The X.509 certificate chain (public part) for this key.

PrivateKey QCA::SecureMessageKey::x509PrivateKey (   )  const
 

The X.509 private key part of this key.

void QCA::SecureMessageKey::setX509CertificateChain (  const CertificateChain &  c  ) 
 

Set the public key part of this X.509 key.

Examples:
cmsexample.cpp, and publickeyexample.cpp.

void QCA::SecureMessageKey::setX509PrivateKey (  const PrivateKey &  k  ) 
 

Set the private key part of this X.509 key.

Examples:
cmsexample.cpp.

void QCA::SecureMessageKey::setX509KeyBundle (  const KeyBundle &  kb  ) 
 

Set the public and private part of this X.509 key with KeyBundle.

bool QCA::SecureMessageKey::havePrivate (   )  const
 

Test if this key contains a private key part.

QString QCA::SecureMessageKey::name (   )  const
 

The name associated with this key.

For a PGP key, this is the primary user ID

For an X.509 key, this is the Common Name


The documentation for this class was generated from the following file:
Generated on Fri Jul 6 13:24:18 2007 for Qt Cryptographic Architecture by  doxygen 1.4.6