QCA::SecureMessageKey Class Reference
[QCA user API]

Key for SecureMessage system. More...

#include <QtCrypto>

List of all members.

Public Types
enum	Type { None, PGP, X509 }
Public Member Functions
	SecureMessageKey (const SecureMessageKey &from)
	SecureMessageKey ()
	~SecureMessageKey ()
bool	havePrivate () const
bool	isNull () const
QString	name () const
SecureMessageKey &	operator= (const SecureMessageKey &from)
PGPKey	pgpPublicKey () const
PGPKey	pgpSecretKey () const
void	setPGPPublicKey (const PGPKey &pub)
void	setPGPSecretKey (const PGPKey &sec)
void	setX509CertificateChain (const CertificateChain &c)
void	setX509KeyBundle (const KeyBundle &kb)
void	setX509PrivateKey (const PrivateKey &k)
Type	type () const
CertificateChain	x509CertificateChain () const
PrivateKey	x509PrivateKey () const

---

Detailed Description

Key for SecureMessage system.

Definition at line 54 of file qca_securemessage.h.

---

Member Enumeration Documentation

enum QCA::SecureMessageKey::Type

The key type.

Enumerator:

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

Definition at line 60 of file qca_securemessage.h.

---

Constructor & Destructor Documentation

QCA::SecureMessageKey::SecureMessageKey

(

)

Construct an empty key.

Definition at line 68 of file qca_securemessage.cpp.

QCA::SecureMessageKey::SecureMessageKey

(

const SecureMessageKey &

from

)

Standard copy constructor.

Parameters:

from

the source key

Definition at line 73 of file qca_securemessage.cpp.

QCA::SecureMessageKey::~SecureMessageKey

(

)

Definition at line 78 of file qca_securemessage.cpp.

---

Member Function Documentation

bool QCA::SecureMessageKey::havePrivate

(

)

const

Test if this key contains a private key part.

Definition at line 149 of file qca_securemessage.cpp.

bool QCA::SecureMessageKey::isNull

(

)

const

Returns true for null object.

Definition at line 88 of file qca_securemessage.cpp.

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

Definition at line 158 of file qca_securemessage.cpp.

SecureMessageKey & QCA::SecureMessageKey::operator=

(

const SecureMessageKey &

from

)

Standard assignment operator.

Parameters:

from

the source key

Definition at line 82 of file qca_securemessage.cpp.

PGPKey QCA::SecureMessageKey::pgpPublicKey

(

)

const

Public key part of a PGP key.

Definition at line 98 of file qca_securemessage.cpp.

PGPKey QCA::SecureMessageKey::pgpSecretKey

(

)

const

Private key part of a PGP key.

Definition at line 103 of file qca_securemessage.cpp.

void QCA::SecureMessageKey::setPGPPublicKey

(

const PGPKey &

pub

)

Set the public key part of a PGP key.

Parameters:

pub

the PGP public key

Definition at line 108 of file qca_securemessage.cpp.

void QCA::SecureMessageKey::setPGPSecretKey

(

const PGPKey &

sec

)

Set the private key part of a PGP key.

Parameters:

sec

the PGP secretkey

Definition at line 114 of file qca_securemessage.cpp.

void QCA::SecureMessageKey::setX509CertificateChain

(

const CertificateChain &

c

)

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

Parameters:

c

the Certificate chain containing the public keys

Definition at line 131 of file qca_securemessage.cpp.

void QCA::SecureMessageKey::setX509KeyBundle

(

const KeyBundle &

kb

)

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

Parameters:

kb

the public and private key bundle

Definition at line 143 of file qca_securemessage.cpp.

void QCA::SecureMessageKey::setX509PrivateKey

(

const PrivateKey &

k

)

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

Parameters:

k

the private key

Definition at line 137 of file qca_securemessage.cpp.

SecureMessageKey::Type QCA::SecureMessageKey::type

(

)

const

The key type.

Definition at line 93 of file qca_securemessage.cpp.

CertificateChain QCA::SecureMessageKey::x509CertificateChain

(

)

const

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

Definition at line 121 of file qca_securemessage.cpp.

PrivateKey QCA::SecureMessageKey::x509PrivateKey

(

)

const

The X.509 private key part of this key.

Definition at line 126 of file qca_securemessage.cpp.

---

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

• qca_securemessage.h
• qca_securemessage.cpp