QCA::MessageContext

#include <QtCrypto>

Inheritance diagram for QCA::MessageContext:

[legend]

Public Types
enum	Operation { Encrypt , Decrypt , Sign , Verify , SignAndEncrypt }

Public Types inherited from QObject
typedef	QObjectList

Signals
void	updated ()

Public Member Functions
	MessageContext (Provider *p, const QString &type)

virtual bool	canSignMultiple () const =0

virtual QString	diagnosticText () const

virtual void	end ()=0

virtual SecureMessage::Error	errorCode () const =0

virtual bool	finished () const =0

virtual QString	hashName () const =0

virtual QByteArray	read ()=0

virtual void	reset ()=0

virtual void	setupEncrypt (const SecureMessageKeyList &keys)=0

virtual void	setupSign (const SecureMessageKeyList &keys, SecureMessage::SignMode m, bool bundleSigner, bool smime)=0

virtual void	setupVerify (const QByteArray &detachedSig)=0

virtual QByteArray	signature () const =0

virtual SecureMessageSignatureList	signers () const =0

virtual void	start (SecureMessage::Format f, Operation op)=0

virtual bool	success () const =0

virtual SecureMessage::Type	type () const =0

virtual void	update (const QByteArray &in)=0

virtual bool	waitForFinished (int msecs)=0

virtual int	written ()=0

Public Member Functions inherited from QCA::Provider::Context
virtual Context *	clone () const =0

Provider *	provider () const

bool	sameProvider (const Context *c) const

QString	type () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QCA::Provider::Context
	Context (const Context &from)

	Context (Provider *parent, const QString &type)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

SecureMessage provider.

Note: This class is part of the provider plugin interface and should not be used directly by applications. You probably want SecureMessage instead.

Definition at line 2912 of file qcaprovider.h.

Member Enumeration Documentation

◆ Operation

enum QCA::MessageContext::Operation

The type of operation being performed.

Enumerator
Encrypt	Encrypt operation.
Decrypt	Decrypt (or Decrypt and Verify) operation.
Sign	Sign operation.
Verify	Verify operation.
SignAndEncrypt	Sign and Encrypt operation.

Definition at line 2919 of file qcaprovider.h.

Constructor & Destructor Documentation

◆ MessageContext()

QCA::MessageContext::MessageContext	(	Provider *	p,
		const QString &	type )

inline

Standard constructor.

Parameters

p	the Provider associated with this context
type	the name of the type of secure message to be created

Definition at line 2934 of file qcaprovider.h.

Member Function Documentation

◆ canSignMultiple()

virtual bool QCA::MessageContext::canSignMultiple ( ) const

pure virtual

Returns true if the provider supports multiple signers for signature creation or signature verification.

◆ diagnosticText()

virtual QString QCA::MessageContext::diagnosticText ( ) const

virtual

Returns any diagnostic text for the operation, potentially useful to show the user in the event the operation is unsuccessful.

For example, this could be the stderr output of gpg.

This is only valid if the operation has finished.

◆ end()

virtual void QCA::MessageContext::end ( )

pure virtual

Indicates the end of input.

◆ errorCode()

virtual SecureMessage::Error QCA::MessageContext::errorCode ( ) const

pure virtual

Returns the reason for failure, if the operation was not successful.

This is only valid if the operation has finished.

◆ finished()

virtual bool QCA::MessageContext::finished ( ) const

pure virtual

Returns true if the operation has finished, otherwise false.

◆ hashName()

virtual QString QCA::MessageContext::hashName ( ) const

pure virtual

Returns the name of the hash used to generate the signature, in the case of a signature operation.

This is only valid if the operation has finished.

◆ read()

virtual QByteArray QCA::MessageContext::read ( )

pure virtual

Extract output from the message operation.

◆ reset()

virtual void QCA::MessageContext::reset ( )

pure virtual

Reset the object to its initial state.

◆ setupEncrypt()

virtual void QCA::MessageContext::setupEncrypt ( const SecureMessageKeyList & keys )

pure virtual

Configure a new encrypting operation.

Parameters

keys	the keys to be used for encryption.

◆ setupSign()

virtual void QCA::MessageContext::setupSign	(	const SecureMessageKeyList &	keys,
		SecureMessage::SignMode	m,
		bool	bundleSigner,
		bool	smime )

pure virtual

Configure a new signing operation.

Parameters

keys	the keys to use for signing
m	the mode to sign in
bundleSigner	whether to bundle the signing keys (true) or not (false)
smime	whether to use smime format (true) or not (false)

◆ setupVerify()

virtual void QCA::MessageContext::setupVerify ( const QByteArray & detachedSig )

pure virtual

Configure a new verify operation.

Parameters

detachedSig the detached signature to use (if applicable) for verification

◆ signature()

virtual QByteArray QCA::MessageContext::signature ( ) const

pure virtual

Returns the signature, in the case of a detached signature operation.

This is only valid if the operation has finished.

◆ signers()

virtual SecureMessageSignatureList QCA::MessageContext::signers ( ) const

pure virtual

Returns a list of signatures, in the case of a verify or decrypt and verify operation.

This is only valid if the operation has finished.

◆ start()

virtual void QCA::MessageContext::start	(	SecureMessage::Format	f,
		Operation	op )

pure virtual

Begins the secure message operation.

This function returns immediately.

If there is input data, update() will be called (potentially repeatedly) afterwards. Emit updated() if there is data to read, if input data has been accepted, or if the operation has finished.

Parameters

f	the format of the message to be produced
op	the operation to be performed

◆ success()

virtual bool QCA::MessageContext::success ( ) const

pure virtual

Returns true if the operation was successful.

This is only valid if the operation has finished.

◆ type()

virtual SecureMessage::Type QCA::MessageContext::type ( ) const

pure virtual

The type of secure message (e.g.

PGP or CMS)

◆ update()

virtual void QCA::MessageContext::update ( const QByteArray & in )

pure virtual

Provide input to the message operation.

Parameters

in	the data to use for the message operation

◆ updated

void QCA::MessageContext::updated ( )

signal

Emitted when there is data to read, if input data has been accepted, or if the operation has finished.

◆ waitForFinished()

virtual bool QCA::MessageContext::waitForFinished ( int msecs )

pure virtual

Waits for the secure message operation to complete.

In this case, the updated() signal is not emitted. Returns true if the operation completed or false if this function times out.

This function is blocking.

Parameters

msecs number of milliseconds to wait (-1 to wait forever)

◆ written()

virtual int QCA::MessageContext::written ( )

pure virtual

Returns the number of input bytes accepted since the last call to update()

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

qcaprovider.h

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About QCA

QCA::MessageContext

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Operation

Constructor & Destructor Documentation

◆ MessageContext()

Member Function Documentation

◆ canSignMultiple()

◆ diagnosticText()

◆ end()

◆ errorCode()

◆ finished()

◆ hashName()

◆ read()

◆ reset()

◆ setupEncrypt()

◆ setupSign()

◆ setupVerify()

◆ signature()

◆ signers()

◆ start()

◆ success()

◆ type()

◆ update()

◆ updated

◆ waitForFinished()

◆ written()