46#ifndef DOXYGEN_NO_PROVIDER_API
98Q_DECLARE_INTERFACE(
QCAPlugin,
"com.affinix.qca.Plugin/1.0")
386 unsigned int keyLength,
387 unsigned int iterationCount) = 0;
400 unsigned int keyLength,
402 unsigned int *iterationCount) = 0;
441 unsigned int keyLength) = 0;
676 :
PKeyBase(p, QStringLiteral(
"rsa"))
766 :
PKeyBase(p, QStringLiteral(
"dsa"))
1334 :
CertBase(p, QStringLiteral(
"cert"))
1438 :
CertBase(p, QStringLiteral(
"csr"))
1522 :
CertBase(p, QStringLiteral(
"crl"))
1889 virtual QString
id()
const = 0;
2040 virtual QString
name(
int id)
const = 0;
2350 virtual void setup(
bool serverMode,
const QString &hostName,
bool compress) = 0;
2473 virtual void update(
const QByteArray &from_net,
const QByteArray &from_app) = 0;
2676 virtual void setup(
const QString &service,
2677 const QString &host,
2680 const QString &ext_id,
2710 virtual void startClient(
const QStringList &mechlist,
bool allowClientSendFirst) = 0;
2727 virtual void startServer(
const QString &realm,
bool disableServerSendLast) = 0;
2780 virtual void update(
const QByteArray &from_net,
const QByteArray &from_app) = 0;
3000 virtual void update(
const QByteArray &in) = 0;
Provider plugin base class.
Definition qcaprovider.h:83
virtual ~QCAPlugin()
Destructs the object.
Definition qcaprovider.h:88
virtual QCA::Provider * createProvider()=0
Returns a newly allocated Provider instance.
Container for authentication tag.
Definition qca_core.h:1347
Base class to use for primitive provider contexts.
Definition qca_core.h:1010
Arbitrary precision integer.
Definition qca_tools.h:571
X.509 certificate authority provider.
Definition qcaprovider.h:1603
virtual CertContext * certificate() const =0
Returns a copy of the CA's certificate.
virtual CertContext * createCertificate(const PKeyContext &pub, const CertificateOptions &opts) const =0
Issue a certificate based on a public key and options, and return the certificate.
CAContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1611
virtual CRLContext * updateCRL(const CRLContext &crl, const QList< CRLEntry > &entries, const QDateTime &nextUpdate) const =0
Update an existing CRL, by examining an old one and creating a new one based on it.
virtual CRLContext * createCRL(const QDateTime &nextUpdate) const =0
Create a new CRL and return it.
virtual CertContext * signRequest(const CSRContext &req, const QDateTime ¬ValidAfter) const =0
Issue a certificate based on a certificate request, and return the certificate.
virtual void setup(const CertContext &cert, const PKeyContext &priv)=0
Prepare the object for usage.
X.509 certificate revocation list properties.
Definition qcaprovider.h:1269
int number
The CRL number, which increases at each update.
Definition qcaprovider.h:1279
QList< CRLEntry > revoked
The revoked entries.
Definition qcaprovider.h:1294
SignatureAlgorithm sigalgo
The signature algorithm used by the issuer to sign the CRL.
Definition qcaprovider.h:1304
QByteArray issuerId
The issuer id.
Definition qcaprovider.h:1309
QByteArray sig
The signature data of the CRL.
Definition qcaprovider.h:1299
QDateTime nextUpdate
The time this CRL expires, and the next CRL should be fetched.
Definition qcaprovider.h:1289
CertificateInfoOrdered issuer
The issuer information of the CRL.
Definition qcaprovider.h:1274
QDateTime thisUpdate
The time this CRL was created.
Definition qcaprovider.h:1284
X.509 certificate revocation list provider.
Definition qcaprovider.h:1513
virtual const CRLContextProps * props() const =0
Returns a pointer to the properties of this CRL.
CRLContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1521
virtual bool compare(const CRLContext *other) const =0
Returns true if this CRL is equal to another CRL, otherwise false.
Certificate Revocation List
Definition qca_cert.h:1740
X.509 certificate request provider.
Definition qcaprovider.h:1429
virtual bool compare(const CSRContext *other) const =0
Returns true if this certificate request is equal to another certificate request, otherwise false.
virtual QString toSPKAC() const =0
Convert this certificate request to Netscape SPKAC format, and return the value.
virtual bool canUseFormat(CertificateRequestFormat f) const =0
Returns true if the provider of this object supports the specified format, otherwise false.
CSRContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1437
virtual const CertContextProps * props() const =0
Returns a pointer to the properties of this certificate request.
virtual PKeyContext * subjectPublicKey() const =0
Returns a copy of this certificate request's public key.
virtual bool createRequest(const CertificateOptions &opts, const PKeyContext &priv)=0
Create a certificate request based on the given options and private key.
virtual ConvertResult fromSPKAC(const QString &s)=0
Read Netscape SPKAC input and convert it into a certificate request.
X.509 certificate and certificate request provider base.
Definition qcaprovider.h:1062
virtual QByteArray toDER() const =0
Convert this object to DER format, and return the value.
CertBase(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:1071
virtual ConvertResult fromDER(const QByteArray &a)=0
Read DER-formatted input and convert it into this object.
virtual ConvertResult fromPEM(const QString &s)=0
Read PEM-formatted input and convert it into this object.
virtual QString toPEM() const =0
Convert this object to PEM format, and return the value.
X.509 certificate collection provider.
Definition qcaprovider.h:1551
virtual QByteArray toPKCS7(const QList< CertContext * > &certs, const QList< CRLContext * > &crls) const =0
Create PKCS#7 DER output based on the input certificates and CRLs.
virtual ConvertResult fromPKCS7(const QByteArray &a, QList< CertContext * > *certs, QList< CRLContext * > *crls) const =0
Read PKCS#7 DER input and convert it into a list of certificates and CRLs.
CertCollectionContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1559
X.509 certificate or certificate request properties.
Definition qcaprovider.h:1126
CertificateInfoOrdered subject
The subject information.
Definition qcaprovider.h:1152
QStringList ocspLocations
A list of URIs for OCSP services.
Definition qcaprovider.h:1190
int version
The X.509 certificate version, usually 3.
Definition qcaprovider.h:1133
QStringList crlLocations
A list of URIs for CRLs.
Definition qcaprovider.h:1176
QStringList issuerLocations
A list of URIs for issuer certificates.
Definition qcaprovider.h:1183
QStringList policies
The policies.
Definition qcaprovider.h:1169
int pathLimit
The path limit.
Definition qcaprovider.h:1215
bool isSelfSigned
True if the certificate is self-signed.
Definition qcaprovider.h:1210
QByteArray issuerId
The issuer id.
Definition qcaprovider.h:1239
QDateTime start
The time the certificate becomes valid (often the time of create)
Definition qcaprovider.h:1140
BigInteger serial
The certificate serial number.
Definition qcaprovider.h:1197
QString challenge
The SPKAC challenge value.
Definition qcaprovider.h:1246
QDateTime end
The time the certificate expires.
Definition qcaprovider.h:1147
CertificateRequestFormat format
The format used for the certificate request.
Definition qcaprovider.h:1253
CertificateInfoOrdered issuer
The issuer information.
Definition qcaprovider.h:1159
SignatureAlgorithm sigalgo
The signature algorithm used to create the signature.
Definition qcaprovider.h:1225
QByteArray sig
The signature data.
Definition qcaprovider.h:1220
QByteArray subjectId
The subject id.
Definition qcaprovider.h:1232
Constraints constraints
The constraints.
Definition qcaprovider.h:1164
bool isCA
True if the certificate is a CA or the certificate request is requesting to be a CA,...
Definition qcaprovider.h:1203
X.509 certificate provider.
Definition qcaprovider.h:1325
virtual bool compare(const CertContext *other) const =0
Returns true if this certificate is equal to another certificate, otherwise false.
virtual bool isIssuerOf(const CertContext *other) const =0
Returns true if this certificate is an issuer of another certificate, otherwise false.
virtual Validity validate(const QList< CertContext * > &trusted, const QList< CertContext * > &untrusted, const QList< CRLContext * > &crls, UsageMode u, ValidateFlags vf) const =0
Validate this certificate.
virtual Validity validate_chain(const QList< CertContext * > &chain, const QList< CertContext * > &trusted, const QList< CRLContext * > &crls, UsageMode u, ValidateFlags vf) const =0
Validate a certificate chain.
virtual const CertContextProps * props() const =0
Returns a pointer to the properties of this certificate.
virtual PKeyContext * subjectPublicKey() const =0
Returns a copy of this certificate's public key.
virtual bool createSelfSigned(const CertificateOptions &opts, const PKeyContext &priv)=0
Create a self-signed certificate based on the given options and private key.
CertContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1333
A chain of related Certificates.
Definition qca_cert.h:1226
Bundle of Certificates and CRLs.
Definition qca_cert.h:1929
Ordered certificate properties type.
Definition qca_cert.h:548
Certificate options
Definition qca_cert.h:610
Public Key (X.509) certificate.
Definition qca_cert.h:857
Cipher provider.
Definition qcaprovider.h:228
CipherContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:240
virtual void setup(Direction dir, const SymmetricKey &key, const InitializationVector &iv, const AuthTag &tag)=0
Set up the object for encrypt/decrypt.
virtual AuthTag tag() const =0
Returns the authentication tag for this cipher.
virtual KeyLength keyLength() const =0
Returns the KeyLength for this cipher.
virtual int blockSize() const =0
Returns the block size for this cipher.
virtual bool update(const SecureArray &in, SecureArray *out)=0
Process a chunk of data.
Diffie-Hellman provider.
Definition qcaprovider.h:830
virtual BigInteger x() const =0
Returns the private X component of this Diffie-Hellman key.
virtual void createPrivate(const DLGroup &domain, bool block)=0
Generate a Diffie-Hellman private key.
virtual BigInteger y() const =0
Returns the public Y component of this Diffie-Hellman key.
virtual DLGroup domain() const =0
Returns the public domain component of this Diffie-Hellman key.
virtual void createPublic(const DLGroup &domain, const BigInteger &y)=0
Create a Diffie-Hellman public key based on its numeric components.
DHContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:838
virtual void createPrivate(const DLGroup &domain, const BigInteger &y, const BigInteger &x)=0
Create a Diffie-Hellman private key based on its numeric components.
Discrete logarithm provider.
Definition qcaprovider.h:455
virtual void getResult(BigInteger *p, BigInteger *q, BigInteger *g) const =0
Obtain the result of the operation.
virtual bool isNull() const =0
Returns true if there is a result to obtain.
void finished()
Emitted when the fetchGroup() operation completes in non-blocking mode.
DLGroupContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:463
virtual void fetchGroup(DLGroupSet set, bool block)=0
Attempt to create P, Q, and G values from the specified group set.
virtual QList< DLGroupSet > supportedGroupSets() const =0
The DLGroupSets supported by this object.
A discrete logarithm group.
Definition qca_publickey.h:172
DSA provider.
Definition qcaprovider.h:757
virtual BigInteger y() const =0
Returns the public Y component of this DSA key.
virtual void createPrivate(const DLGroup &domain, const BigInteger &y, const BigInteger &x)=0
Create a DSA private key based on its numeric components.
virtual void createPrivate(const DLGroup &domain, bool block)=0
Generate a DSA private key.
virtual DLGroup domain() const =0
Returns the public domain component of this DSA key.
virtual void createPublic(const DLGroup &domain, const BigInteger &y)=0
Create a DSA public key based on its numeric components.
virtual BigInteger x() const =0
Returns the private X component of this DSA key.
DSAContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:765
HKDF provider.
Definition qcaprovider.h:416
virtual SymmetricKey makeKey(const SecureArray &secret, const InitializationVector &salt, const InitializationVector &info, unsigned int keyLength)=0
Create a key and return it.
HKDFContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:425
Hash provider.
Definition qcaprovider.h:185
HashContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:194
virtual void clear()=0
Reset the object to its initial state.
virtual void update(const MemoryRegion &a)=0
Process a chunk of data.
Extended provider information.
Definition qcaprovider.h:113
virtual QStringList supportedHashTypes() const
The hash algorithms supported by the provider.
virtual QStringList supportedMACTypes() const
The mac algorithms supported by the provider.
InfoContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:121
virtual QStringList supportedCipherTypes() const
The cipher algorithms supported by the provider.
Container for initialisation vectors and nonces.
Definition qca_core.h:1310
Key derivation function provider.
Definition qcaprovider.h:362
virtual SymmetricKey makeKey(const SecureArray &secret, const InitializationVector &salt, unsigned int keyLength, int msecInterval, unsigned int *iterationCount)=0
Create a key and return it.
KDFContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:371
virtual SymmetricKey makeKey(const SecureArray &secret, const InitializationVector &salt, unsigned int keyLength, unsigned int iterationCount)=0
Create a key and return it.
Certificate chain and private key pair.
Definition qca_cert.h:2176
Simple container for acceptable key lengths.
Definition qca_core.h:701
KeyStoreEntry provider.
Definition qcaprovider.h:1866
virtual QString storeId() const =0
Returns the id of the store that contains this entry.
virtual bool isAvailable() const
Returns true if the private key of this entry is present for use.
virtual QString serialize() const =0
Serialize the information about this entry.
KeyStoreEntryContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1874
virtual bool ensureAccess()
Attempt to ensure the private key of this entry is usable and accessible, potentially prompting the u...
virtual KeyBundle keyBundle() const
If this entry is of type KeyStoreEntry::TypeKeyBundle, this function returns the KeyBundle of the ent...
virtual QString storeName() const =0
Returns the name of the store that contains this entry.
virtual PGPKey pgpPublicKey() const
If this entry is of type KeyStoreEntry::TypePGPPublicKey or KeyStoreEntry::TypePGPSecretKey,...
virtual PGPKey pgpSecretKey() const
If this entry is of type KeyStoreEntry::TypePGPSecretKey, this function returns the secret PGPKey of ...
virtual QString id() const =0
Returns the entry id.
virtual CRL crl() const
If this entry is of type KeyStoreEntry::TypeCRL, this function returns the CRL of the entry.
virtual Certificate certificate() const
If this entry is of type KeyStoreEntry::TypeCertificate, this function returns the Certificate of the...
virtual QString name() const =0
Returns the name of this entry.
virtual KeyStoreEntry::Type type() const =0
Returns the entry type.
Type
The type of entry in the KeyStore.
Definition qca_keystore.h:147
KeyStore provider.
Definition qcaprovider.h:1974
void busyEnd()
Emit this to leave the busy state.
virtual QString writeEntry(int id, const Certificate &cert)
Write a Certificate to the store.
virtual QString writeEntry(int id, const KeyBundle &kb)
Write a KeyBundle to the store.
void updated()
Indicates the list of keystores has changed, and that QCA should call keyStores() to obtain the lates...
virtual KeyStoreEntryContext * entry(int id, const QString &entryId)
Returns a single entry in the store, if the entry id is already known.
virtual KeyStore::Type type(int id) const =0
Returns the type of the specified store, or -1 if the integer context id is invalid.
virtual bool removeEntry(int id, const QString &entryId)
Remove an entry from the store.
virtual QList< KeyStoreEntry::Type > entryTypes(int id) const =0
Returns the types supported by the store, or an empty list if the integer context id is invalid.
virtual KeyStoreEntryContext * entryPassive(const QString &serialized)
Returns a single entry, created from the serialization string of a previous entry (using KeyStoreEntr...
void storeUpdated(int id)
Indicates that the entry list of a keystore has changed (entries added, removed, or modified)
virtual QList< int > keyStores()=0
Returns a list of integer context ids, each representing a keystore instance.
void diagnosticText(const QString &str)
Emitted when there is diagnostic text to report.
void busyStart()
Emit this when the provider is busy looking for keystores.
KeyStoreListContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1982
virtual void setUpdatesEnabled(bool enabled)
Enables or disables update events.
virtual bool isReadOnly(int id) const
Returns true if the store is read-only.
virtual QList< KeyStoreEntryContext * > entryList(int id)=0
Returns the entries of the store, or an empty list if the integer context id is invalid.
virtual void start()
Starts the keystore provider.
virtual QString storeId(int id) const =0
Returns the string id of the store, or an empty string if the integer context id is invalid.
virtual QString writeEntry(int id, const CRL &crl)
Write a CRL to the store.
virtual QString writeEntry(int id, const PGPKey &key)
Write a PGPKey to the store.
virtual QString name(int id) const =0
Returns the friendly name of the store, or an empty string if the integer context id is invalid.
Type
The type of keystore.
Definition qca_keystore.h:424
Message authentication code provider.
Definition qcaprovider.h:298
KeyLength anyKeyLength() const
Returns a KeyLength that supports any length.
Definition qcaprovider.h:341
virtual void setup(const SymmetricKey &key)=0
Set up the object for hashing.
virtual KeyLength keyLength() const =0
Returns the KeyLength for this MAC algorithm.
MACContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:306
virtual void update(const MemoryRegion &in)=0
Process a chunk of data.
Array of bytes that may be optionally secured.
Definition qca_tools.h:91
SecureMessage provider.
Definition qcaprovider.h:2913
virtual QByteArray read()=0
Extract output from the message operation.
virtual void start(SecureMessage::Format f, Operation op)=0
Begins the secure message operation.
virtual QString diagnosticText() const
Returns any diagnostic text for the operation, potentially useful to show the user in the event the o...
Operation
The type of operation being performed.
Definition qcaprovider.h:2920
@ Verify
Verify operation.
Definition qcaprovider.h:2924
@ Sign
Sign operation.
Definition qcaprovider.h:2923
@ Decrypt
Decrypt (or Decrypt and Verify) operation.
Definition qcaprovider.h:2922
@ Encrypt
Encrypt operation.
Definition qcaprovider.h:2921
virtual void setupEncrypt(const SecureMessageKeyList &keys)=0
Configure a new encrypting operation.
virtual int written()=0
Returns the number of input bytes accepted since the last call to update()
virtual void setupVerify(const QByteArray &detachedSig)=0
Configure a new verify operation.
virtual QString hashName() const =0
Returns the name of the hash used to generate the signature, in the case of a signature operation.
virtual bool success() const =0
Returns true if the operation was successful.
virtual void setupSign(const SecureMessageKeyList &keys, SecureMessage::SignMode m, bool bundleSigner, bool smime)=0
Configure a new signing operation.
MessageContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:2934
virtual bool finished() const =0
Returns true if the operation has finished, otherwise false.
virtual void update(const QByteArray &in)=0
Provide input to the message operation.
void updated()
Emitted when there is data to read, if input data has been accepted, or if the operation has finished...
virtual SecureMessage::Error errorCode() const =0
Returns the reason for failure, if the operation was not successful.
virtual QByteArray signature() const =0
Returns the signature, in the case of a detached signature operation.
virtual void end()=0
Indicates the end of input.
virtual void reset()=0
Reset the object to its initial state.
virtual SecureMessageSignatureList signers() const =0
Returns a list of signatures, in the case of a verify or decrypt and verify operation.
virtual bool waitForFinished(int msecs)=0
Waits for the secure message operation to complete.
virtual bool canSignMultiple() const =0
Returns true if the provider supports multiple signers for signature creation or signature verificati...
virtual SecureMessage::Type type() const =0
The type of secure message (e.g.
OpenPGP key properties.
Definition qcaprovider.h:1746
bool isTrusted
True if this key is trusted (e.g.
Definition qcaprovider.h:1791
bool inKeyring
True if this key is in a keyring (and thus usable), otherwise false.
Definition qcaprovider.h:1785
QStringList userIds
List of user id strings for the key, the first one being the primary user id.
Definition qcaprovider.h:1757
QDateTime creationDate
The time the key was created.
Definition qcaprovider.h:1767
QString fingerprint
The hex fingerprint of the key.
Definition qcaprovider.h:1779
QDateTime expirationDate
The time the key expires.
Definition qcaprovider.h:1772
QString keyId
The key id.
Definition qcaprovider.h:1751
bool isSecret
True if this key is a secret key, otherwise false.
Definition qcaprovider.h:1762
OpenPGP key provider.
Definition qcaprovider.h:1805
virtual QString toAscii() const =0
Convert the key to ascii-armored format, and return the value.
virtual const PGPKeyContextProps * props() const =0
Returns a pointer to the properties of this key.
PGPKeyContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:1813
virtual QByteArray toBinary() const =0
Convert the key to binary format, and return the value.
virtual ConvertResult fromBinary(const QByteArray &a)=0
Read binary input and convert it into a key.
virtual ConvertResult fromAscii(const QString &s)=0
Read ascii-armored input and convert it into a key.
Pretty Good Privacy key.
Definition qca_cert.h:2407
PKCS#12 provider.
Definition qcaprovider.h:1684
PKCS12Context(Provider *p)
Standard constructor.
Definition qcaprovider.h:1692
virtual QByteArray toPKCS12(const QString &name, const QList< const CertContext * > &chain, const PKeyContext &priv, const SecureArray &passphrase) const =0
Create PKCS#12 DER output based on a set of input items.
virtual ConvertResult fromPKCS12(const QByteArray &in, const SecureArray &passphrase, QString *name, QList< CertContext * > *chain, PKeyContext **priv) const =0
Read PKCS#12 DER input and convert it into a set of output items.
Public key implementation provider base.
Definition qcaprovider.h:523
virtual bool isNull() const =0
Returns true if this object is not valid.
virtual PKey::Type type() const =0
Returns the type of public key.
virtual void convertToPublic()=0
If the key is a private key, this function will convert it into a public key (all private key data in...
virtual bool isPrivate() const =0
Returns true if this is a private key, otherwise false.
virtual int bits() const =0
Returns the number of bits in the key.
virtual void update(const MemoryRegion &in)
Process the plaintext input data for either signing or verifying, whichever operation is active.
virtual bool decrypt(const SecureArray &in, SecureArray *out, EncryptionAlgorithm alg)
Decrypt data.
PKeyBase(Provider *p, const QString &type)
Standard constructor.
virtual SymmetricKey deriveKey(const PKeyBase &theirs)
Compute a symmetric key based on this private key and some other public key.
void finished()
Emitted when an asynchronous operation completes on this key.
virtual int maximumEncryptSize(EncryptionAlgorithm alg) const
Returns the maximum number of bytes that can be encrypted by this key.
virtual bool endVerify(const QByteArray &sig)
Complete a verify operation, and return true if successful.
virtual QByteArray endSign()
Complete a signing operation, and return the signature value.
virtual void startVerify(SignatureAlgorithm alg, SignatureFormat format)
Begin a verify operation.
virtual SecureArray encrypt(const SecureArray &in, EncryptionAlgorithm alg)
Encrypt data.
virtual bool canExport() const =0
Returns true if the components of this key are accessible and whether it can be serialized into an ou...
virtual void startSign(SignatureAlgorithm alg, SignatureFormat format)
Begin a signing operation.
Public key container provider.
Definition qcaprovider.h:909
virtual ConvertResult privateFromPEM(const QString &s, const SecureArray &passphrase)
Read PEM-formatted input and convert it into a private key.
virtual ConvertResult publicFromPEM(const QString &s)
Read PEM-formatted input and convert it into a public key.
virtual const PKeyBase * key() const =0
Returns the key held by this object, or 0 if there is no key.
virtual QList< PBEAlgorithm > supportedPBEAlgorithms() const =0
Returns a list of password-based encryption algorithms that are supported for private key serializati...
PKeyContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:917
virtual QList< PKey::Type > supportedIOTypes() const =0
Returns a list of public key types that can be serialized and deserialized into DER and PEM format.
virtual bool importKey(const PKeyBase *key)=0
Attempt to import a key from another provider.
virtual void setKey(PKeyBase *key)=0
Sets the key for this object.
virtual ConvertResult privateFromDER(const SecureArray &a, const SecureArray &passphrase)
Read DER-formatted input and convert it into a private key.
virtual QList< PKey::Type > supportedTypes() const =0
Returns a list of supported public key types.
virtual PKeyBase * key()=0
Returns the key held by this object, or 0 if there is no key.
virtual QByteArray publicToDER() const
Convert a public key to DER format, and return the value.
virtual ConvertResult publicFromDER(const QByteArray &a)
Read DER-formatted input and convert it into a public key.
virtual QString publicToPEM() const
Convert a public key to PEM format, and return the value.
virtual SecureArray privateToDER(const SecureArray &passphrase, PBEAlgorithm pbe) const
Convert a private key to DER format, and return the value.
virtual QString privateToPEM(const SecureArray &passphrase, PBEAlgorithm pbe) const
Convert a private key to PEM format, and return the value.
Type
Types of public key cryptography keys supported by QCA.
Definition qca_publickey.h:257
Generic private key.
Definition qca_publickey.h:833
Internal context class used for the plugin.
Algorithm provider.
Definition qca_core.h:765
RSA provider.
Definition qcaprovider.h:667
virtual BigInteger e() const =0
Returns the public E component of this RSA key.
virtual BigInteger n() const =0
Returns the public N component of this RSA key.
virtual BigInteger p() const =0
Returns the private P component of this RSA key.
RSAContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:675
virtual void createPublic(const BigInteger &n, const BigInteger &e)=0
Create an RSA public key based on the two public components.
virtual BigInteger d() const =0
Returns the private D component of this RSA key.
virtual BigInteger q() const =0
Returns the private Q component of this RSA key.
virtual void createPrivate(const BigInteger &n, const BigInteger &e, const BigInteger &p, const BigInteger &q, const BigInteger &d)=0
Create an RSA private key based on the five components.
virtual void createPrivate(int bits, int exp, bool block)=0
Generate an RSA private key.
Random provider.
Definition qcaprovider.h:153
RandomContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:161
virtual SecureArray nextBytes(int size)=0
Return an array of random bytes.
Convenience class to hold an IP address and an associated port.
Definition qcaprovider.h:2615
quint16 port
The port.
Definition qcaprovider.h:2625
QString addr
The IP address.
Definition qcaprovider.h:2620
SASL provider.
Definition qcaprovider.h:2602
virtual void serverFirstStep(const QString &mech, const QByteArray *clientInit)=0
Finishes server startup.
virtual QByteArray to_net()=0
Returns data that should be sent across the network (for the security layer)
virtual SASL::AuthCondition authCondition() const =0
Returns the reason for failure, if the authentication was not successful.
virtual QString authzid() const =0
Returns the authzid attempting to authorize (server mode only)
virtual void setup(const QString &service, const QString &host, const HostPort *local, const HostPort *remote, const QString &ext_id, int ext_ssf)=0
Configure a new session.
virtual QString username() const =0
Returns the username attempting to authenticate (server mode only)
virtual int encoded() const =0
Returns the number of bytes of plaintext data that is encoded inside of to_net()
virtual void startServer(const QString &realm, bool disableServerSendLast)=0
Begins the session in server mode, starting with the authentication.
virtual void tryAgain()=0
Attempt the most recent operation again.
virtual SASL::Params clientParams() const =0
Returns the needed/optional client parameters.
virtual QByteArray stepData() const =0
Returns an authentication payload for to be transmitted over the network.
SASLContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:2645
virtual QString mech() const =0
Returns the mechanism selected.
void resultsReady()
Emit this when a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain(),...
virtual bool waitForResultsReady(int msecs)=0
Waits for a startClient(), startServer(), serverFirstStep(), nextStep(), tryAgain(),...
virtual QStringList mechlist() const =0
Returns the mechanism list (server mode only)
virtual bool haveClientInit() const =0
Returns true if the client has initialization data.
virtual int ssf() const =0
Returns the SSF of the active SASL session.
virtual QByteArray to_app()=0
Returns data that is decoded from the network and should be processed by the application.
virtual void setClientParams(const QString *user, const QString *authzid, const SecureArray *pass, const QString *realm)=0
Set some of the client parameters (pass 0 to not set a field)
virtual void reset()=0
Reset the object to its initial state.
virtual QStringList realmlist() const =0
Returns the realm list (client mode only)
virtual void update(const QByteArray &from_net, const QByteArray &from_app)=0
Performs one iteration of the SASL security layer processing.
virtual Result result() const =0
Returns the result code of an operation.
virtual void startClient(const QStringList &mechlist, bool allowClientSendFirst)=0
Begins the session in client mode, starting with the authentication.
Result
Result of a SASL operation.
Definition qcaprovider.h:2632
@ Params
Parameters are needed to complete authentication.
Definition qcaprovider.h:2635
@ Success
Operation completed.
Definition qcaprovider.h:2633
@ Error
Operation failed.
Definition qcaprovider.h:2634
@ AuthCheck
Client login can be inspected (server only)
Definition qcaprovider.h:2636
virtual void nextStep(const QByteArray &from_net)=0
Perform another step of the SASL authentication.
virtual void setConstraints(SASL::AuthFlags f, int minSSF, int maxSSF)=0
Set the constraints of the session using SSF values.
Parameter flags for the SASL authentication.
Definition qca_securelayer.h:907
AuthCondition
Possible authentication error states.
Definition qca_securelayer.h:849
AuthFlags
Authentication requirement flag values.
Definition qca_securelayer.h:868
SecureMessageSystem provider.
Definition qcaprovider.h:3102
virtual void setTrustedCertificates(const CertificateCollection &trusted)
Set the trusted certificates and for this secure message system, to be used for validation.
SMSContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:3111
virtual void setUntrustedCertificates(const CertificateCollection &untrusted)
Set the untrusted certificates and CRLs for this secure message system, to be used for validation.
virtual void setPrivateKeys(const QList< SecureMessageKey > &keys)
Set the private keys for this secure message system, to be used for decryption.
virtual MessageContext * createMessage()=0
Create a new message object for this system.
Secure array of bytes.
Definition qca_tools.h:317
Type
The type of secure message.
Definition qca_securemessage.h:327
Error
Errors for secure messages.
Definition qca_securemessage.h:355
SignMode
The type of message signature.
Definition qca_securemessage.h:336
Format
Formats for secure messages.
Definition qca_securemessage.h:346
Container for keys for symmetric encryption algorithms.
Definition qca_core.h:1264
Information about an active TLS connection.
Definition qcaprovider.h:2253
QString cipherSuite
The cipher suite being used for this connection.
Definition qcaprovider.h:2270
int cipherBits
The bit size of the cipher used for this connection.
Definition qcaprovider.h:2275
bool isCompressed
True if the TLS connection is compressed, otherwise false.
Definition qcaprovider.h:2258
TLSSessionContext * id
Pointer to the id of this TLS session, for use with resuming.
Definition qcaprovider.h:2287
TLS::Version version
The TLS protocol version being used for this connection.
Definition qcaprovider.h:2263
int cipherMaxBits
The maximum bit size possible of the cipher used for this connection.
Definition qcaprovider.h:2281
TLS provider.
Definition qcaprovider.h:2240
virtual void setCertificate(const CertificateChain &cert, const PrivateKey &key)=0
Set the local certificate.
virtual Validity peerCertificateValidity() const =0
Returns the QCA::Validity of the peer certificate.
virtual SessionInfo sessionInfo() const =0
Returns information about the active TLS session.
virtual QByteArray to_net()=0
Returns data that should be sent across the network.
virtual int maxSSF() const =0
Returns the maximum SSF supported by this provider.
virtual QByteArray to_app()=0
Returns data that is decoded from the network and should be processed by the application.
virtual bool clientHelloReceived() const =0
Returns true if the TLS client hello has been received.
virtual Result result() const =0
Returns the result code of an operation.
virtual int encoded() const =0
Returns the number of bytes of plaintext data that is encoded inside of to_net()
virtual void setConstraints(const QStringList &cipherSuiteList)=0
This is an overloaded member function, provided for convenience. It differs from the above function o...
virtual void update(const QByteArray &from_net, const QByteArray &from_app)=0
Performs one iteration of the TLS session processing.
virtual bool serverHelloReceived() const =0
Returns true if the TLS server hello has been received.
Result
Result of a TLS operation.
Definition qcaprovider.h:2294
@ Success
Operation completed.
Definition qcaprovider.h:2295
@ Error
Operation failed.
Definition qcaprovider.h:2296
virtual void setSessionId(const TLSSessionContext &id)=0
Set the TLS session id, for session resuming.
virtual bool canCompress() const =0
Returns true if the provider supports compression.
void resultsReady()
Emit this when a start() or update() operation has completed.
virtual void reset()=0
Reset the object to its initial state.
virtual void start()=0
Begins the session, starting with the handshake.
virtual QString hostName() const =0
Returns the host name sent by the client using server name indication (server mode only)
virtual void setTrustedCertificates(const CertificateCollection &trusted)=0
Set the list of trusted certificates.
virtual void setIssuerList(const QList< CertificateInfoOrdered > &issuerList)=0
Set the list of acceptable issuers.
virtual void setConstraints(int minSSF, int maxSSF)=0
Set the constraints of the session using SSF values.
virtual void setMTU(int size)
Set the maximum transmission unit size.
virtual QList< CertificateInfoOrdered > issuerList() const =0
Returns the issuer list sent by the server (client mode only)
virtual bool waitForResultsReady(int msecs)=0
Waits for a start() or update() operation to complete.
virtual QStringList supportedCipherSuites(const TLS::Version &version) const =0
Returns a list of supported cipher suites for the specified SSL/TLS version.
virtual bool certificateRequested() const =0
Returns true if the peer is requesting a certificate.
virtual CertificateChain peerCertificateChain() const =0
Returns the peer certificate chain.
virtual bool canSetHostName() const =0
Returns true if the provider supports server name indication.
virtual QByteArray unprocessed()=0
Returns any unprocessed network input data.
virtual void setup(bool serverMode, const QString &hostName, bool compress)=0
Configure a new session.
void dtlsTimeout()
Emit this to force the application to call update(), even with empty arguments.
virtual bool eof() const =0
Returns true if the peer has closed the stream.
TLSContext(Provider *p, const QString &type)
Standard constructor.
Definition qcaprovider.h:2306
virtual void shutdown()=0
Sets the session to the shutdown state.
TLS "session" provider.
Definition qcaprovider.h:2215
TLSSessionContext(Provider *p)
Standard constructor.
Definition qcaprovider.h:2223
Version
Version of TLS or SSL.
Definition qca_securelayer.h:306
QCA - the Qt Cryptographic Architecture.
Definition qca_basic.h:41
UsageMode
Specify the intended usage of a certificate.
Definition qca_cert.h:483
DLGroupSet
Well known discrete logarithm group sets.
Definition qca_publickey.h:135
CertificateRequestFormat
Certificate Request Format.
Definition qca_cert.h:54
QList< ConstraintType > Constraints
Certificate constraints type
Definition qca_cert.h:590
Validity
The validity (or otherwise) of a certificate.
Definition qca_cert.h:497
EncryptionAlgorithm
Encryption algorithms.
Definition qca_publickey.h:55
PBEAlgorithm
Password-based encryption.
Definition qca_publickey.h:103
Direction
Direction settings for symmetric algorithms.
Definition qca_core.h:141
ValidateFlags
The conditions to validate for a certificate.
Definition qca_cert.h:517
ConvertResult
Return value from a format conversion.
Definition qca_publickey.h:119
SignatureAlgorithm
Signature algorithm variants.
Definition qca_publickey.h:74
SignatureFormat
Signature formats (DSA only)
Definition qca_publickey.h:93
Header file for classes for cryptographic primitives (basic operations).
Header file for PGP key and X.509 certificate related classes.
Header file for core QCA infrastructure.
Header file for classes that provide and manage keys.
Header file for PublicKey and PrivateKey related classes.
Header file for SecureLayer and its subclasses.
Header file for secure message (PGP, CMS) classes.