eventhandlerdemo.cpp

The code below shows to implement a client side handler for password / passphrase / PIN and token requests from QCA and any associated providers.

The code below shows to implement a client side handler for password / passphrase / PIN and token requests from QCA and any associated providers.

/*
Copyright (C) 2007 Brad Hards <bradh@frogmouth.net>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
// QtCrypto has the declarations for all of QCA
#include <QtCrypto>
#include <QCoreApplication>
#include <iostream>
#ifdef QT_STATICPLUGIN
#include "import_plugins.h"
#endif
class ClientPassphraseHandler : public QObject
{
Q_OBJECT
public:
ClientPassphraseHandler(QObject *parent = nullptr)
: QObject(parent)
{
// When the PasswordAsker or TokenAsker needs to interact
// with the user, it raises a signal. We connect that to a
// local slot to get the required information.
connect(&m_handler, &QCA::EventHandler::eventReady, this, &ClientPassphraseHandler::my_eventReady);
// Now that we are set up, we can start the EventHandler. Nothing
// will happen if you don't call this method.
m_handler.start();
}
private Q_SLOTS:
// This slot gets called when the provider needs a token inserted,
// or to get a passphrase / password / PIN.
void my_eventReady(int id, const QCA::Event &event)
{
// We can sanity check the event
if (event.isNull()) {
return;
}
// Events can be associated with a a keystore or a file/bytearray
// You can tell which by looking at the Source
if (event.source() == QCA::Event::KeyStore) {
std::cout << "Event is associated with a key store operation" << std::endl;
} else if (event.source() == QCA::Event::Data) {
std::cout << "Event is associated with a file or some other data" << std::endl;
// if the event comes from a file type operation, you can get the
// name / label using fileName()
std::cout << " Filename: " << qPrintable(event.fileName()) << std::endl;
} else {
std::cout << "Unexpected Source for Event" << std::endl;
}
// There are different kinds of events.
if (event.type() == QCA::Event::Token) {
// You would typically ask the user to insert the token here
std::cout << "Request for token" << std::endl;
// we just fake it for this demo.
m_handler.tokenOkay(id);
// you could use m_handler.reject( id ) to refuse the token request
} else if (event.type() == QCA::Event::Password) {
std::cout << "Request for password, passphrase or PIN" << std::endl;
// and within the Password type, we have a few different styles.
if (event.passwordStyle() == QCA::Event::StylePassword) {
std::cout << " [Password request]" << std::endl;
} else if (event.passwordStyle() == QCA::Event::StylePassphrase) {
std::cout << " [Passphrase request]" << std::endl;
} else if (event.passwordStyle() == QCA::Event::StylePIN) {
std::cout << " [PIN request]" << std::endl;
} else {
std::cout << " [unexpect request style]" << std::endl;
}
// You would typically request the password/PIN/passphrase.
// again, we just fake it.
m_handler.submitPassword(id, QCA::SecureArray("hello"));
} else {
std::cout << "Unexpected event type" << std::endl;
}
}
private:
QCA::EventHandler m_handler;
};
void asker_procedure();
class AskerThread : public QThread
{
Q_OBJECT
protected:
void run() override
{
asker_procedure();
}
};
int main(int argc, char **argv)
{
// the Initializer object sets things up, and
// also does cleanup when it goes out of scope
QCA::Initializer init;
QCoreApplication exampleApp(argc, argv);
ClientPassphraseHandler cph;
// handler and asker cannot occur in the same thread
AskerThread askerThread;
QObject::connect(&askerThread, &AskerThread::finished, &exampleApp, &QCoreApplication::quit);
askerThread.start();
exampleApp.exec();
return 0;
}
void asker_procedure()
{
QCA::PasswordAsker pwAsker;
pwAsker.ask(QCA::Event::StylePassword, QStringLiteral("foo.tmp"), nullptr);
pwAsker.waitForResponse();
std::cout << "Password was: " << pwAsker.password().toByteArray().data() << std::endl;
std::cout << std::endl << "Now do token:" << std::endl;
QCA::TokenAsker tokenAsker;
tokenAsker.ask(
QCA::KeyStoreInfo(QCA::KeyStore::SmartCard, QStringLiteral("Token Id"), QStringLiteral("Token Name")),
QCA::KeyStoreEntry(),
nullptr);
tokenAsker.waitForResponse();
if (tokenAsker.accepted()) {
std::cout << "Token was accepted" << std::endl;
} else {
std::cout << "Token was not accepted" << std::endl;
}
}
#include "eventhandlerdemo.moc"
QCA::EventHandler
Interface class for password / passphrase / PIN and token handlers.
Definition qca_core.h:1579
QCA::EventHandler::eventReady
void eventReady(int id, const QCA::Event &context)
signal emitted when an Event requires attention.
QCA::Event
An asynchronous event.
Definition qca_core.h:1391
QCA::Event::Data
@ Data
File or bytearray generated the event.
Definition qca_core.h:1419
QCA::Event::KeyStore
@ KeyStore
KeyStore generated the event.
Definition qca_core.h:1418
QCA::Event::fileName
QString fileName() const
Name or other identifier for the file or byte array associated with this event.
QCA::Event::passwordStyle
PasswordStyle passwordStyle() const
the style of password required.
QCA::Event::type
Type type() const
the Type of this event
QCA::Event::isNull
bool isNull() const
test if this event has been setup correctly
QCA::Event::source
Source source() const
the Source of this event
QCA::Event::Password
@ Password
Asking for a password, PIN or passphrase.
Definition qca_core.h:1400
QCA::Event::Token
@ Token
Asking for a token.
Definition qca_core.h:1401
QCA::Event::StylePIN
@ StylePIN
User should be prompted for a "PIN".
Definition qca_core.h:1434
QCA::Event::StylePassphrase
@ StylePassphrase
User should be prompted for a "Passphrase".
Definition qca_core.h:1433
QCA::Event::StylePassword
@ StylePassword
User should be prompted for a "Password".
Definition qca_core.h:1432
QCA::Initializer
Convenience method for initialising and cleaning up QCA.
Definition qca_core.h:660
QCA::KeyStoreEntry
Single entry in a KeyStore.
Definition qca_keystore.h:141
QCA::KeyStoreInfo
Key store information, outside of a KeyStore object.
Definition qca_keystore.h:624
QCA::KeyStore::SmartCard
@ SmartCard
for smartcards
Definition qca_keystore.h:428
QCA::PasswordAsker
User password / passphrase / PIN handler.
Definition qca_core.h:1661
QCA::PasswordAsker::waitForResponse
void waitForResponse()
Block until the password / passphrase request is completed.
QCA::PasswordAsker::ask
void ask(Event::PasswordStyle pstyle, const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr)
queue a password / passphrase request associated with a key store
QCA::PasswordAsker::password
SecureArray password() const
The password / passphrase / PIN provided by the user in response to the asker request.
QCA::SecureArray
Secure array of bytes.
Definition qca_tools.h:317
QCA::SecureArray::toByteArray
QByteArray toByteArray() const
Copy the contents of the secure array out to a standard QByteArray.
QCA::TokenAsker
User token handler.
Definition qca_core.h:1754
QCA::TokenAsker::waitForResponse
void waitForResponse()
Block until the token request is completed.
QCA::TokenAsker::accepted
bool accepted() const
Test if the token request was accepted or not.
QCA::TokenAsker::ask
void ask(const KeyStoreInfo &keyStoreInfo, const KeyStoreEntry &keyStoreEntry, void *ptr)
queue a token request associated with a key store
QObject
QThread
QCA::init
QCA_EXPORT void init()
Initialise QCA.