46 #ifndef DOXYGEN_NO_PROVIDER_API
96 Q_DECLARE_INTERFACE(
QCAPlugin,
"com.affinix.qca.Plugin/1.0")
124 virtual QStringList supportedHashTypes()
const;
129 virtual QStringList supportedCipherTypes()
const;
134 virtual QStringList supportedMACTypes()
const;
191 virtual void clear() = 0;
248 virtual int blockSize()
const = 0;
371 unsigned int keyLength,
373 unsigned int *iterationCount) = 0;
405 virtual bool isNull()
const = 0;
420 virtual void fetchGroup(
DLGroupSet set,
bool block) = 0;
468 virtual bool isNull()
const = 0;
478 virtual bool isPrivate()
const = 0;
485 virtual bool canExport()
const = 0;
493 virtual void convertToPublic() = 0;
498 virtual int bits()
const = 0;
555 virtual QByteArray endSign();
564 virtual bool endVerify(
const QByteArray &sig);
620 virtual void createPrivate(
int bits,
int exp,
bool block) = 0;
702 virtual void createPrivate(
const DLGroup &domain,
bool block) = 0;
724 virtual DLGroup domain()
const = 0;
772 virtual void createPrivate(
const DLGroup &domain,
bool block) = 0;
796 virtual DLGroup domain()
const = 0;
860 virtual const PKeyBase *key()
const = 0;
869 virtual void setKey(
PKeyBase *key) = 0;
882 virtual bool importKey(
const PKeyBase *key) = 0;
889 virtual QByteArray publicToDER()
const;
896 virtual QString publicToPEM()
const;
991 virtual QByteArray toDER()
const = 0;
998 virtual QString toPEM()
const = 0;
1269 virtual bool compare(
const CertContext *other)
const = 0;
1275 virtual PKeyContext *subjectPublicKey()
const = 0;
1283 virtual bool isIssuerOf(
const CertContext *other)
const = 0;
1370 virtual bool compare(
const CSRContext *other)
const = 0;
1376 virtual PKeyContext *subjectPublicKey()
const = 0;
1384 virtual QString toSPKAC()
const = 0;
1429 virtual bool compare(
const CRLContext *other)
const = 0;
1544 virtual CRLContext *createCRL(
const QDateTime &nextUpdate)
const = 0;
1698 virtual QByteArray toBinary()
const = 0;
1703 virtual QString toAscii()
const = 0;
1758 virtual QString id()
const = 0;
1763 virtual QString name()
const = 0;
1768 virtual QString storeId()
const = 0;
1773 virtual QString storeName()
const = 0;
1778 virtual bool isAvailable()
const;
1788 virtual QString serialize()
const = 0;
1806 virtual CRL crl()
const;
1812 virtual PGPKey pgpSecretKey()
const;
1819 virtual PGPKey pgpPublicKey()
const;
1829 virtual bool ensureAccess();
1856 virtual void start();
1866 virtual void setUpdatesEnabled(
bool enabled);
1898 virtual QString storeId(
int id)
const = 0;
1906 virtual QString
name(
int id)
const = 0;
1916 virtual bool isReadOnly(
int id)
const;
1973 virtual QString writeEntry(
int id,
const KeyBundle &kb);
1984 virtual QString writeEntry(
int id,
const Certificate &cert);
1995 virtual QString writeEntry(
int id,
const CRL &crl);
2006 virtual QString writeEntry(
int id,
const PGPKey &key);
2017 virtual bool removeEntry(
int id,
const QString &entryId);
2059 void diagnosticText(
const QString &str);
2067 void storeUpdated(
int id);
2174 virtual void reset() = 0;
2183 virtual QStringList supportedCipherSuites(
const TLS::Version &version)
const = 0;
2188 virtual bool canCompress()
const = 0;
2193 virtual bool canSetHostName()
const = 0;
2198 virtual int maxSSF()
const = 0;
2210 virtual void setup(
bool serverMode,
const QString &hostName,
bool compress) = 0;
2220 virtual void setConstraints(
int minSSF,
int maxSSF) = 0;
2234 virtual void setConstraints(
const QStringList &cipherSuiteList) = 0;
2283 virtual void shutdown() = 0;
2292 virtual void setMTU(
int size);
2306 virtual void start() = 0;
2333 virtual void update(
const QByteArray &from_net,
const QByteArray &from_app) = 0;
2344 virtual bool waitForResultsReady(
int msecs) = 0;
2349 virtual Result result()
const = 0;
2354 virtual QByteArray to_net() = 0;
2360 virtual int encoded()
const = 0;
2366 virtual QByteArray to_app() = 0;
2371 virtual bool eof()
const = 0;
2379 virtual bool clientHelloReceived()
const = 0;
2386 virtual bool serverHelloReceived()
const = 0;
2394 virtual QString hostName()
const = 0;
2401 virtual bool certificateRequested()
const = 0;
2415 virtual Validity peerCertificateValidity()
const = 0;
2429 virtual SessionInfo sessionInfo()
const = 0;
2436 virtual QByteArray unprocessed() = 0;
2442 void resultsReady();
2510 virtual void reset() = 0;
2533 virtual void setup(
const QString &service,
const QString &host,
const HostPort *local,
const HostPort *remote,
const QString &ext_id,
int ext_ssf) = 0;
2545 virtual void setConstraints(
SASL::AuthFlags f,
int minSSF,
int maxSSF) = 0;
2562 virtual void startClient(
const QStringList &mechlist,
bool allowClientSendFirst) = 0;
2579 virtual void startServer(
const QString &realm,
bool disableServerSendLast) = 0;
2594 virtual void serverFirstStep(
const QString &mech,
const QByteArray *clientInit) = 0;
2607 virtual void nextStep(
const QByteArray &from_net) = 0;
2618 virtual void tryAgain() = 0;
2632 virtual void update(
const QByteArray &from_net,
const QByteArray &from_app) = 0;
2644 virtual bool waitForResultsReady(
int msecs) = 0;
2649 virtual Result result()
const = 0;
2654 virtual QStringList mechlist()
const = 0;
2659 virtual QString mech()
const = 0;
2664 virtual bool haveClientInit()
const = 0;
2670 virtual QByteArray stepData()
const = 0;
2676 virtual QByteArray to_net() = 0;
2682 virtual int encoded()
const = 0;
2688 virtual QByteArray to_app() = 0;
2695 virtual int ssf()
const = 0;
2720 virtual void setClientParams(
const QString *user,
const QString *authzid,
const SecureArray *pass,
const QString *realm) = 0;
2728 virtual QStringList realmlist()
const = 0;
2735 virtual QString username()
const = 0;
2742 virtual QString authzid()
const = 0;
2749 void resultsReady();
2791 virtual bool canSignMultiple()
const = 0;
2801 virtual void reset() = 0;
2825 virtual void setupVerify(
const QByteArray &detachedSig) = 0;
2847 virtual void update(
const QByteArray &in) = 0;
2852 virtual QByteArray read() = 0;
2858 virtual int written() = 0;
2863 virtual void end() = 0;
2868 virtual bool finished()
const = 0;
2879 virtual bool waitForFinished(
int msecs) = 0;
2886 virtual bool success()
const = 0;
2902 virtual QByteArray signature()
const = 0;
2910 virtual QString hashName()
const = 0;
2927 virtual QString diagnosticText()
const;
ConvertResult
Return value from a format conversion.
Definition: qca_publickey.h:117
X.509 certificate request provider.
Definition: qcaprovider.h:1327
CertificateInfoOrdered issuer
The issuer information of the CRL.
Definition: qcaprovider.h:1184
bool isCompressed
True if the TLS connection is compressed, otherwise false.
Definition: qcaprovider.h:2121
X.509 certificate provider.
Definition: qcaprovider.h:1234
PKeyContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:833
PBEAlgorithm
Password-based encryption.
Definition: qca_publickey.h:101
Version
Version of TLS or SSL.
Definition: qca_securelayer.h:305
Diffie-Hellman provider.
Definition: qcaprovider.h:748
MessageContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:2785
Message authentication code provider.
Definition: qcaprovider.h:277
QDateTime end
The time the certificate expires.
Definition: qcaprovider.h:1057
X.509 certificate or certificate request properties.
Definition: qcaprovider.h:1035
Parameter flags for the SASL authentication.
Definition: qca_securelayer.h:914
CSRContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1336
Generic private key.
Definition: qca_publickey.h:826
QString challenge
The SPKAC challenge value.
Definition: qcaprovider.h:1156
CertificateInfoOrdered subject
The subject information.
Definition: qcaprovider.h:1062
int cipherBits
The bit size of the cipher used for this connection.
Definition: qcaprovider.h:2138
CRLContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1417
KeyStore provider.
Definition: qcaprovider.h:1842
CertificateInfoOrdered issuer
The issuer information.
Definition: qcaprovider.h:1069
int number
The CRL number, which increases at each update.
Definition: qcaprovider.h:1189
X.509 certificate revocation list provider.
Definition: qcaprovider.h:1408
OpenPGP key properties.
Definition: qcaprovider.h:1620
QDateTime thisUpdate
The time this CRL was created.
Definition: qcaprovider.h:1194
Type
The type of entry in the KeyStore.
Definition: qca_keystore.h:146
Certificate chain and private key pair.
Definition: qca_cert.h:2135
Provider plugin base class.
Definition: qcaprovider.h:82
Discrete logarithm provider.
Definition: qcaprovider.h:386
Header file for PGP key and X.509 certificate related classes.
SignatureAlgorithm sigalgo
The signature algorithm used by the issuer to sign the CRL.
Definition: qcaprovider.h:1214
Operation completed.
Definition: qcaprovider.h:2158
X.509 certificate revocation list properties.
Definition: qcaprovider.h:1178
SecureMessage provider.
Definition: qcaprovider.h:2763
ValidateFlags
The conditions to validate for a certificate.
Definition: qca_cert.h:508
DSAContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:687
Validity
The validity (or otherwise) of a certificate.
Definition: qca_cert.h:489
QStringList policies
The policies.
Definition: qcaprovider.h:1079
Header file for SecureLayer and its subclasses.
Algorithm provider.
Definition: qca_core.h:722
QByteArray issuerId
The issuer id.
Definition: qcaprovider.h:1219
bool inKeyring
True if this key is in a keyring (and thus usable), otherwise false.
Definition: qcaprovider.h:1660
RSAContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:604
QString addr
The IP address.
Definition: qcaprovider.h:2480
Hash provider.
Definition: qcaprovider.h:176
Encrypt operation.
Definition: qcaprovider.h:2772
Header file for PublicKey and PrivateKey related classes.
RandomContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:156
KeyStoreEntry provider.
Definition: qcaprovider.h:1737
Decrypt (or Decrypt and Verify) operation.
Definition: qcaprovider.h:2773
QStringList userIds
List of user id strings for the key, the first one being the primary user id.
Definition: qcaprovider.h:1632
CAContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1500
TLS "session" provider.
Definition: qcaprovider.h:2080
PKCS12Context(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1577
TLSSessionContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:2089
PKCS#12 provider.
Definition: qcaprovider.h:1568
DHContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:757
CertCollectionContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1452
bool isCA
True if the certificate is a CA or the certificate request is requesting to be a CA, otherwise false.
Definition: qcaprovider.h:1113
Information about an active TLS connection.
Definition: qcaprovider.h:2115
QStringList crlLocations
A list of URIs for CRLs.
Definition: qcaprovider.h:1086
DSA provider.
Definition: qcaprovider.h:678
KeyLength anyKeyLength() const
Returns a KeyLength that supports any length.
Definition: qcaprovider.h:318
Type
The type of secure message.
Definition: qca_securemessage.h:327
QString keyId
The key id.
Definition: qcaprovider.h:1626
X.509 certificate collection provider.
Definition: qcaprovider.h:1443
SASL provider.
Definition: qcaprovider.h:2461
Certificate Revocation List
Definition: qca_cert.h:1702
Convenience class to hold an IP address and an associated port.
Definition: qcaprovider.h:2474
Error
Errors for secure messages.
Definition: qca_securemessage.h:355
QByteArray issuerId
The issuer id.
Definition: qcaprovider.h:1149
Container for keys for symmetric encryption algorithms.
Definition: qca_core.h:1221
QList< CRLEntry > revoked
The revoked entries.
Definition: qcaprovider.h:1204
QString type() const
The type of context, as passed to the constructor.
Simple container for acceptable key lengths.
Definition: qca_core.h:670
CertContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1243
Header file for core QCA infrastructure.
TLSSessionContext * id
Pointer to the id of this TLS session, for use with resuming.
Definition: qcaprovider.h:2150
Result
Result of a TLS operation.
Definition: qcaprovider.h:2156
Public key implementation provider base.
Definition: qcaprovider.h:451
Operation completed.
Definition: qcaprovider.h:2493
quint16 port
The port.
Definition: qcaprovider.h:2485
SignatureAlgorithm
Signature algorithm variants.
Definition: qca_publickey.h:73
A discrete logarithm group.
Definition: qca_publickey.h:170
InfoContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:119
CertificateRequestFormat format
The format used for the certificate request.
Definition: qcaprovider.h:1163
Ordered certificate properties type.
Definition: qca_cert.h:539
DLGroupSet
Well known discrete logarithm group sets.
Definition: qca_publickey.h:133
Client login can be inspected (server only)
Definition: qcaprovider.h:2496
Header file for classes that provide and manage keys.
CipherContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:229
Parameters are needed to complete authentication.
Definition: qcaprovider.h:2495
Container for initialisation vectors and nonces.
Definition: qca_core.h:1267
Format
Formats for secure messages.
Definition: qca_securemessage.h:346
TLSContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:2169
bool isTrusted
True if this key is trusted (e.g.
Definition: qcaprovider.h:1666
Direction
Direction settings for symmetric algorithms.
Definition: qca_core.h:139
QDateTime nextUpdate
The time this CRL expires, and the next CRL should be fetched.
Definition: qcaprovider.h:1199
Public key container provider.
Definition: qcaprovider.h:824
QCA - the Qt Cryptographic Architecture.
Definition: qca_basic.h:47
CertBase(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:984
SASLContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:2505
int pathLimit
The path limit.
Definition: qcaprovider.h:1125
Base class to use for primitive provider contexts.
Definition: qca_core.h:967
QString cipherSuite
The cipher suite being used for this connection.
Definition: qcaprovider.h:2133
KDFContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:348
HashContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:186
Header file for secure message (PGP, CMS) classes.
Type
The type of keystore.
Definition: qca_keystore.h:423
AuthFlags
Authentication requirement flag values.
Definition: qca_securelayer.h:875
Verify operation.
Definition: qcaprovider.h:2775
int cipherMaxBits
The maximum bit size possible of the cipher used for this connection.
Definition: qcaprovider.h:2144
Sign operation.
Definition: qcaprovider.h:2774
bool isSelfSigned
True if the certificate is self-signed.
Definition: qcaprovider.h:1120
Header file for classes for cryptographic primitives (basic operations).
SignatureFormat
Signature formats (DSA only)
Definition: qca_publickey.h:91
SignatureAlgorithm sigalgo
The signature algorithm used to create the signature.
Definition: qcaprovider.h:1135
QDateTime start
The time the certificate becomes valid (often the time of create)
Definition: qcaprovider.h:1050
Type
Types of public key cryptography keys supported by QCA.
Definition: qca_publickey.h:255
Secure array of bytes.
Definition: qca_tools.h:316
OpenPGP key provider.
Definition: qcaprovider.h:1679
MACContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:286
Result
Result of a SASL operation.
Definition: qcaprovider.h:2491
AuthCondition
Possible authentication error states.
Definition: qca_securelayer.h:856
KeyStoreListContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1851
bool isSecret
True if this key is a secret key, otherwise false.
Definition: qcaprovider.h:1637
virtual ~QCAPlugin()
Destructs the object.
Definition: qcaprovider.h:88
CertificateRequestFormat
Certificate Request Format.
Definition: qca_cert.h:54
QList< ConstraintType > Constraints
Certificate constraints type
Definition: qca_cert.h:582
Certificate options
Definition: qca_cert.h:601
TLS provider.
Definition: qcaprovider.h:2102
RSA provider.
Definition: qcaprovider.h:595
Key derivation function provider.
Definition: qcaprovider.h:338
EncryptionAlgorithm
Encryption algorithms.
Definition: qca_publickey.h:54
DLGroupContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:395
QByteArray sig
The signature data of the CRL.
Definition: qcaprovider.h:1209
A chain of related Certificates.
Definition: qca_cert.h:1207
Operation failed.
Definition: qcaprovider.h:2159
Operation
The type of operation being performed.
Definition: qcaprovider.h:2770
QDateTime expirationDate
The time the key expires.
Definition: qcaprovider.h:1647
QStringList issuerLocations
A list of URIs for issuer certificates.
Definition: qcaprovider.h:1093
Constraints constraints
The constraints.
Definition: qcaprovider.h:1074
QByteArray subjectId
The subject id.
Definition: qcaprovider.h:1142
Extended provider information.
Definition: qcaprovider.h:110
QStringList ocspLocations
A list of URIs for OCSP services.
Definition: qcaprovider.h:1100
QString fingerprint
The hex fingerprint of the key.
Definition: qcaprovider.h:1654
Public Key (X.509) certificate.
Definition: qca_cert.h:848
SMSContext(Provider *p, const QString &type)
Standard constructor.
Definition: qcaprovider.h:2958
SecureMessageSystem provider.
Definition: qcaprovider.h:2948
BigInteger serial
The certificate serial number.
Definition: qcaprovider.h:1107
int version
The X.509 certificate version, usually 3.
Definition: qcaprovider.h:1043
SignMode
The type of message signature.
Definition: qca_securemessage.h:336
Operation failed.
Definition: qcaprovider.h:2494
PGPKeyContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1688
Internal context class used for the plugin.
QDateTime creationDate
The time the key was created.
Definition: qcaprovider.h:1642
KeyStoreEntryContext(Provider *p)
Standard constructor.
Definition: qcaprovider.h:1746
UsageMode
Specify the intended usage of a certificate.
Definition: qca_cert.h:475
Arbitrary precision integer.
Definition: qca_tools.h:570
X.509 certificate and certificate request provider base.
Definition: qcaprovider.h:974
Cipher provider.
Definition: qcaprovider.h:216
TLS::Version version
The TLS protocol version being used for this connection.
Definition: qcaprovider.h:2126
Pretty Good Privacy key.
Definition: qca_cert.h:2360
Bundle of Certificates and CRLs.
Definition: qca_cert.h:1890
virtual QString name() const =0
The name of the provider.
Random provider.
Definition: qcaprovider.h:147
X.509 certificate authority provider.
Definition: qcaprovider.h:1491
Array of bytes that may be optionally secured.
Definition: qca_tools.h:90
QByteArray sig
The signature data.
Definition: qcaprovider.h:1130