Qt Cryptographic Architecture
|
#include <QtCrypto>
Public Types | |
enum | PasswordStyle { StylePassword , StylePassphrase , StylePIN } |
enum | Source { KeyStore , Data } |
enum | Type { Password , Token } |
Public Member Functions | |
Event () | |
Event (const Event &from) | |
QString | fileName () const |
bool | isNull () const |
KeyStoreEntry | keyStoreEntry () const |
KeyStoreInfo | keyStoreInfo () const |
Event & | operator= (const Event &from) |
PasswordStyle | passwordStyle () const |
void * | ptr () const |
void | setPasswordData (PasswordStyle pstyle, const QString &fileName, void *ptr) |
void | setPasswordKeyStore (PasswordStyle pstyle, const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr) |
void | setToken (const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr) |
Source | source () const |
Type | type () const |
~Event () | |
An asynchronous event.
Events are produced in response to the library's need for some user intervention, such as entering a pin or password, or inserting a cryptographic token.
Event is an abstraction, so you can handle this need in a way that makes sense for your application.
enum QCA::Event::Type |
Type of event
Enumerator | |
---|---|
Password | Asking for a password, PIN or passphrase. |
Token | Asking for a token. |
enum QCA::Event::Source |
Source of the event
Events are associated with access to a KeyStore, or access to a file (or bytearray/stream or equivalent). This tells you the type of source that caused the Event.
Enumerator | |
---|---|
KeyStore | KeyStore generated the event. |
Data | File or bytearray generated the event. |
password variation
If the Type of Event is Password, PasswordStyle tells you whether it is a PIN, passphrase or password.
Enumerator | |
---|---|
StylePassword | User should be prompted for a "Password". |
StylePassphrase | User should be prompted for a "Passphrase". |
StylePIN | User should be prompted for a "PIN". |
QCA::Event::Event | ( | ) |
Constructor.
QCA::Event::~Event | ( | ) |
Destructor.
Assignment operator.
from | the Event to copy from |
bool QCA::Event::isNull | ( | ) | const |
test if this event has been setup correctly
Type QCA::Event::type | ( | ) | const |
the Type of this event
Source QCA::Event::source | ( | ) | const |
the Source of this event
PasswordStyle QCA::Event::passwordStyle | ( | ) | const |
the style of password required.
This is not meaningful unless the Type is Event::Password.
KeyStoreInfo QCA::Event::keyStoreInfo | ( | ) | const |
KeyStoreEntry QCA::Event::keyStoreEntry | ( | ) | const |
The KeyStoreEntry associated with this event.
This is not meaningful unless the Source is KeyStore.
QString QCA::Event::fileName | ( | ) | const |
Name or other identifier for the file or byte array associated with this event.
This is not meaningful unless the Source is Data.
void* QCA::Event::ptr | ( | ) | const |
opaque data
void QCA::Event::setPasswordKeyStore | ( | PasswordStyle | pstyle, |
const KeyStoreInfo & | keyStoreInfo, | ||
const KeyStoreEntry & | keyStoreEntry, | ||
void * | ptr | ||
) |
Set the values for this Event.
This creates a Password type event, for a keystore.
pstyle | the style of information required (e.g. PIN, password or passphrase) |
keyStoreInfo | info about the keystore that the information is required for |
keyStoreEntry | the entry in the keystore that the information is required for |
ptr | opaque data |
void QCA::Event::setPasswordData | ( | PasswordStyle | pstyle, |
const QString & | fileName, | ||
void * | ptr | ||
) |
Set the values for this Event.
This creates a Password type event, for a file.
pstyle | the style of information required (e.g. PIN, password or passphrase) |
fileName | the name of the file (or other identifier) that the information is required for |
ptr | opaque data |
void QCA::Event::setToken | ( | const KeyStoreInfo & | keyStoreInfo, |
const KeyStoreEntry & | keyStoreEntry, | ||
void * | ptr | ||
) |
Set the values for this Event.
This creates a Token type event.
keyStoreInfo | info about the keystore that the token is required for |
keyStoreEntry | the entry in the keystore that the token is required for |
ptr | opaque data |