diff --git a/include/QtCrypto/qca_core.h b/include/QtCrypto/qca_core.h index f62f44bb..7d61c152 100644 --- a/include/QtCrypto/qca_core.h +++ b/include/QtCrypto/qca_core.h @@ -378,16 +378,23 @@ QCA_EXPORT QVariant getProperty(const QString &name); Set provider configuration Allowed value types: QString, int, bool + + \param name the name of the provider to set the configuration to + \param config the configuration */ QCA_EXPORT void setProviderConfig(const QString &name, const QVariantMap &config); /** Retrieve provider configuration + + \param name the name of the provider to retrieve the configuration of */ QCA_EXPORT QVariantMap getProviderConfig(const QString &name); /** Save provider configuration to persistent storage + + \param name the name of the provider to have its configuration saved */ QCA_EXPORT void saveProviderConfig(const QString &name); @@ -816,6 +823,8 @@ QVariantMap defaultConfig() const If your provider supports configuration options, you will be advised of user changes to the configuration when this method is called. + + \param config the new configuration to be used by the provider */ virtual void configChanged(const QVariantMap &config); }; diff --git a/include/QtCrypto/qca_publickey.h b/include/QtCrypto/qca_publickey.h index cd489e3d..87eeb470 100644 --- a/include/QtCrypto/qca_publickey.h +++ b/include/QtCrypto/qca_publickey.h @@ -138,6 +138,10 @@ enum DLGroupSet to raw RSA signing (mainly smartcard providers). This is a built-in function of QCA and does not utilize a provider. SHA1, MD5, MD2, and RIPEMD160 are supported. + + \param hashName the hash type used to create the digest + \param digest the digest to encode in EMSA3 format + \param size the desired size of the encoding output (-1 for automatic size) */ QCA_EXPORT QByteArray emsa3Encode(const QString &hashName, const QByteArray &digest, int size = -1); diff --git a/include/QtCrypto/qcaprovider.h b/include/QtCrypto/qcaprovider.h index 703c6379..19df281a 100644 --- a/include/QtCrypto/qcaprovider.h +++ b/include/QtCrypto/qcaprovider.h @@ -1439,6 +1439,9 @@ public: Create PKCS#7 DER output based on the input certificates and CRLs Returns an empty array on error. + + \param certs list of certificates to store in the output + \param crls list of CRLs to store in the output */ virtual QByteArray toPKCS7(const QList &certs, const QList &crls) const = 0; @@ -2495,6 +2498,21 @@ public: This function will be called before any other configuration functions. + + \param service the name of the network service being provided by + this application, which can be used by the SASL system for policy + control. Examples: "imap", "xmpp" + \param host the hostname that the application is interacting with + or as + \param local pointer to a HostPort representing the local end of a + network socket, or 0 if this information is unknown or not + available + \param remote pointer to a HostPort representing the peer end of a + network socket, or 0 if this information is unknown or not + available + \param ext_id the id to be used for SASL EXTERNAL (client only) + \param ext_ssf the SSF of the external authentication channel + (client only) */ virtual void setup(const QString &service, const QString &host, const HostPort *local, const HostPort *remote, const QString &ext_id, int ext_ssf) = 0; @@ -2539,8 +2557,8 @@ public: Success, then serverFirstStep() will be called next. \param realm the realm to authenticate in - \param disableServerSendLast whether the client sends first (true) or the server - sends first (false) + \param disableServerSendLast whether the client sends first (true) + or the server sends first (false) */ virtual void startServer(const QString &realm, bool disableServerSendLast) = 0; @@ -2554,6 +2572,8 @@ public: is Success, then the session is now in the connected state. \param mech the mechanism to use + \param clientInit initial data from the client, or 0 if there is + no such data */ virtual void serverFirstStep(const QString &mech, const QByteArray *clientInit) = 0;