QCA::KeyStore Class Reference

General purpose key storage object. More...

#include <QtCrypto>

Inheritance diagram for QCA::KeyStore:

QObject QCA::Algorithm Collaboration diagram for QCA::KeyStore:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Type {
  System, User, Application, SmartCard,
  PGPKeyring
}

Public Member Functions

 KeyStore (const QString &id, KeyStoreManager *keyStoreManager)
bool isValid () const
Type type () const
QString name () const
QString id () const
bool isReadOnly () const
void startAsynchronousMode ()
QList< KeyStoreEntryentryList () const
bool holdsTrustedCertificates () const
bool holdsIdentities () const
bool holdsPGPPublicKeys () const
QString writeEntry (const KeyBundle &kb)
QString writeEntry (const Certificate &cert)
QString writeEntry (const CRL &crl)
QString writeEntry (const PGPKey &key)
bool removeEntry (const QString &id)
void unavailable ()
void entryWritten (const QString &entryId)
void entryRemoved (bool success)

Public Attributes

Q_SIGNALS __pad0__: void updated()

Friends

class KeyStorePrivate
class KeyStoreManagerPrivate

Detailed Description

General purpose key storage object.

Examples of use of this are:

Note:


Member Enumeration Documentation

enum QCA::KeyStore::Type
 

The type of keystore.

Enumerator:
System  objects such as root certificates
User  objects such as Apple Keychain, KDE Wallet
Application  for caching accepted self-signed certificates
SmartCard  for smartcards
PGPKeyring  for a PGP keyring


Constructor & Destructor Documentation

QCA::KeyStore::KeyStore const QString id,
KeyStoreManager keyStoreManager
 

Obtain a specific KeyStore.

Parameters:
id the identification for the key store
keyStoreManager the parent manager for this keystore


Member Function Documentation

bool QCA::KeyStore::isValid  )  const
 

Check if this KeyStore is valid.

Returns:
true if the KeyStore is valid

Type QCA::KeyStore::type  )  const
 

The KeyStore Type.

Reimplemented from QCA::Algorithm.

QString QCA::KeyStore::name  )  const
 

The name associated with the KeyStore.

QString QCA::KeyStore::id  )  const
 

The ID associated with the KeyStore.

bool QCA::KeyStore::isReadOnly  )  const
 

Test if the KeyStore is writeable or not.

Returns:
true if the KeyStore is read-only

void QCA::KeyStore::startAsynchronousMode  ) 
 

Turns on asynchronous mode for this KeyStore instance.

Normally, entryList() and writeEntry() are blocking calls. However, if startAsynchronousMode() is called, then these functions will return immediately. entryList() will return with the latest known entries, or an empty list if none are known yet (in this mode, updated() will be emitted once the initial entries are known, even if the store has not actually been altered). writeEntry() will always return an empty string, and the entryWritten() signal indicates the result of a write.

QList<KeyStoreEntry> QCA::KeyStore::entryList  )  const
 

A list of the KeyStoreEntry objects in this store.

Note:
This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler (this is not a concern if asynchronous mode is enabled).
See also:
startAsynchronousMode

bool QCA::KeyStore::holdsTrustedCertificates  )  const
 

test if the KeyStore holds trusted certificates (and CRLs)

bool QCA::KeyStore::holdsIdentities  )  const
 

test if the KeyStore holds identities (eg KeyBundle or PGPSecretKey)

bool QCA::KeyStore::holdsPGPPublicKeys  )  const
 

test if the KeyStore holds PGPPublicKey objects

QString QCA::KeyStore::writeEntry const KeyBundle kb  ) 
 

Add a entry to the KeyStore.

Returns the entryId of the written entry or an empty string on failure.

Parameters:
kb the KeyBundle to add to the KeyStore
Note:
This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler (this is not a concern if asynchronous mode is enabled).
See also:
startAsynchronousMode

QString QCA::KeyStore::writeEntry const Certificate cert  ) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
cert the Certificate to add to the KeyStore

QString QCA::KeyStore::writeEntry const CRL crl  ) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
crl the CRL to add to the KeyStore

QString QCA::KeyStore::writeEntry const PGPKey key  ) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
key the PGPKey to add to the KeyStore
Returns:
a ref to the key in the keyring

bool QCA::KeyStore::removeEntry const QString id  ) 
 

Delete the a specified KeyStoreEntry from this KeyStore.

Parameters:
id the ID for the entry to be deleted
Note:
This synchronous operation may require event handling, and so it must not be called from the same thread as an EventHandler (this is not a concern if asynchronous mode is enabled).
See also:
startAsynchronousMode

void QCA::KeyStore::unavailable  ) 
 

Emitted when the KeyStore becomes unavailable.

void QCA::KeyStore::entryWritten const QString entryId  ) 
 

Emitted when an entry has been written, in asynchronous mode.

entryId is the newly written entry id on success, or an empty string if the write failed.

void QCA::KeyStore::entryRemoved bool  success  ) 
 

Emitted when an entry has been removed, in asynchronous mode.

success indicates if the removal succeeded or not.


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