QCA::SecureMessageKey

Search for usage in LXR

QCA::SecureMessageKey Class Reference

#include <QtCrypto>

Public Types

enum  Type { None, PGP, X509 }
 

Public Member Functions

 SecureMessageKey ()
 
 SecureMessageKey (const SecureMessageKey &from)
 
bool havePrivate () const
 
bool isNull () const
 
QString name () const
 
SecureMessageKeyoperator= (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

Examples
publickeyexample.cpp.

Definition at line 54 of file qca_securemessage.h.

Member Enumeration Documentation

◆ 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

◆ SecureMessageKey() [1/2]

QCA::SecureMessageKey::SecureMessageKey ( )

Construct an empty key.

◆ SecureMessageKey() [2/2]

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

Standard copy constructor.

Parameters
fromthe source key

Member Function Documentation

◆ havePrivate()

bool QCA::SecureMessageKey::havePrivate ( ) const

Test if this key contains a private key part.

◆ isNull()

bool QCA::SecureMessageKey::isNull ( ) const

Returns true for null object.

◆ name()

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

◆ operator=()

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

Standard assignment operator.

Parameters
fromthe source key

◆ pgpPublicKey()

PGPKey QCA::SecureMessageKey::pgpPublicKey ( ) const

Public key part of a PGP key.

◆ pgpSecretKey()

PGPKey QCA::SecureMessageKey::pgpSecretKey ( ) const

Private key part of a PGP key.

◆ setPGPPublicKey()

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

Set the public key part of a PGP key.

Parameters
pubthe PGP public key

◆ setPGPSecretKey()

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

Set the private key part of a PGP key.

Parameters
secthe PGP secretkey

◆ setX509CertificateChain()

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

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

Parameters
cthe Certificate chain containing the public keys
Examples
publickeyexample.cpp.

◆ setX509KeyBundle()

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

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

Parameters
kbthe public and private key bundle

◆ setX509PrivateKey()

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

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

Parameters
kthe private key

◆ type()

Type QCA::SecureMessageKey::type ( ) const

The key type.

◆ x509CertificateChain()

CertificateChain QCA::SecureMessageKey::x509CertificateChain ( ) const

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

◆ x509PrivateKey()

PrivateKey QCA::SecureMessageKey::x509PrivateKey ( ) const

The X.509 private key part of this key.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu May 26 2022 03:46:48 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.