mirror of
https://github.com/QuasarApp/qca.git
synced 2025-05-13 02:59:34 +00:00
API documentation fixes.
svn path=/trunk/kdesupport/qca/; revision=707939
This commit is contained in:
Brad Hards
parent
81f57876e6
commit
9f9156e4a6
@ -232,6 +232,10 @@ public:
|
||||
|
||||
/**
|
||||
Returns a list of all of the hash types available
|
||||
|
||||
\param provider the name of the provider to get a list from, if one
|
||||
provider is required. If not specified, available hash types from all
|
||||
providers will be returned.
|
||||
*/
|
||||
static QStringList supportedTypes(const QString &provider = QString());
|
||||
|
||||
@ -621,6 +625,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the Cipher to copy state from
|
||||
*/
|
||||
Cipher(const Cipher &from);
|
||||
|
||||
@ -635,6 +641,10 @@ public:
|
||||
|
||||
/**
|
||||
Returns a list of all of the cipher types available
|
||||
|
||||
\param provider the name of the provider to get a list from, if one
|
||||
provider is required. If not specified, available cipher types from all
|
||||
providers will be returned.
|
||||
*/
|
||||
static QStringList supportedTypes(const QString &provider = QString());
|
||||
|
||||
@ -770,6 +780,11 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
Copies the state (including key) from one MessageAuthenticationCode
|
||||
to another
|
||||
|
||||
\param from the MessageAuthenticationCode to copy state from
|
||||
*/
|
||||
MessageAuthenticationCode(const MessageAuthenticationCode &from);
|
||||
|
||||
@ -780,12 +795,18 @@ public:
|
||||
|
||||
Copies the state (including key) from one MessageAuthenticationCode
|
||||
to another
|
||||
|
||||
\param from the MessageAuthenticationCode to assign from.
|
||||
*/
|
||||
MessageAuthenticationCode & operator=(const MessageAuthenticationCode &from);
|
||||
|
||||
/**
|
||||
Returns a list of all of the message authentication code types
|
||||
available
|
||||
|
||||
\param provider the name of the provider to get a list from, if one
|
||||
provider is required. If not specified, available message authentication
|
||||
codes types from all providers will be returned.
|
||||
*/
|
||||
static QStringList supportedTypes(const QString &provider = QString());
|
||||
|
||||
@ -874,6 +895,8 @@ class QCA_EXPORT KeyDerivationFunction : public Algorithm
|
||||
public:
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the KeyDerivationFunction to copy from
|
||||
*/
|
||||
KeyDerivationFunction(const KeyDerivationFunction &from);
|
||||
|
||||
@ -884,6 +907,8 @@ public:
|
||||
|
||||
Copies the state (including key) from one KeyDerivationFunction
|
||||
to another
|
||||
|
||||
\param from the KeyDerivationFunction to assign from
|
||||
*/
|
||||
KeyDerivationFunction & operator=(const KeyDerivationFunction &from);
|
||||
|
||||
@ -907,12 +932,20 @@ public:
|
||||
You can use this to build a standard name string.
|
||||
You probably only need this method if you are
|
||||
creating a new subclass.
|
||||
|
||||
\param kdfType the type of key derivation function
|
||||
\param algType the name of the algorithm to use with the key derivation function
|
||||
|
||||
\return the name of the KDF/algorithm pair
|
||||
*/
|
||||
static QString withAlgorithm(const QString &kdfType, const QString &algType);
|
||||
|
||||
protected:
|
||||
/**
|
||||
Special constructor for subclass initialisation
|
||||
|
||||
\param type the algorithm to create
|
||||
\param provider the name of the provider to create the key derivation function in.
|
||||
*/
|
||||
KeyDerivationFunction(const QString &type, const QString &provider);
|
||||
|
||||
|
||||
@ -156,6 +156,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the certificate information to copy from
|
||||
*/
|
||||
CertificateInfoType(const CertificateInfoType &from);
|
||||
|
||||
@ -163,6 +165,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the certificate information to assign from
|
||||
*/
|
||||
CertificateInfoType & operator=(const CertificateInfoType &from);
|
||||
|
||||
@ -202,16 +206,25 @@ public:
|
||||
|
||||
/**
|
||||
Comparison operator
|
||||
|
||||
\param other the certificate information to compare with this
|
||||
certificate information.
|
||||
*/
|
||||
bool operator<(const CertificateInfoType &other) const;
|
||||
|
||||
/**
|
||||
Comparison operator
|
||||
|
||||
\param other the certificate information to compare with this
|
||||
certificate information.
|
||||
*/
|
||||
bool operator==(const CertificateInfoType &other) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the certificate information to compare with this
|
||||
certificate information.
|
||||
*/
|
||||
inline bool operator!=(const CertificateInfoType &other) const
|
||||
{
|
||||
@ -248,6 +261,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the information pair to copy from
|
||||
*/
|
||||
CertificateInfoPair(const CertificateInfoPair &from);
|
||||
|
||||
@ -255,6 +270,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the information pair to assign from
|
||||
*/
|
||||
CertificateInfoPair & operator=(const CertificateInfoPair &from);
|
||||
|
||||
@ -270,11 +287,17 @@ public:
|
||||
|
||||
/**
|
||||
Comparison operator
|
||||
|
||||
\param other the certificate information pair to compare with this
|
||||
certificate information pair.
|
||||
*/
|
||||
bool operator==(const CertificateInfoPair &other) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the certificate information pair to compare with this
|
||||
certificate information pair.
|
||||
*/
|
||||
inline bool operator!=(const CertificateInfoPair &other) const
|
||||
{
|
||||
@ -369,6 +392,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the constraint type to copy from
|
||||
*/
|
||||
ConstraintType(const ConstraintType &from);
|
||||
|
||||
@ -376,6 +401,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the constraint type to assign from
|
||||
*/
|
||||
ConstraintType & operator=(const ConstraintType &from);
|
||||
|
||||
@ -415,16 +442,22 @@ public:
|
||||
|
||||
/**
|
||||
Comparison operator
|
||||
|
||||
\param other the constraint type to compare with this constraint
|
||||
*/
|
||||
bool operator<(const ConstraintType &other) const;
|
||||
|
||||
/**
|
||||
Comparison operator
|
||||
|
||||
\param other the constraint type to compare with this constraint
|
||||
*/
|
||||
bool operator==(const ConstraintType &other) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the constraint type to compare with this constraint
|
||||
*/
|
||||
inline bool operator!=(const ConstraintType &other) const
|
||||
{
|
||||
@ -520,12 +553,16 @@ public:
|
||||
|
||||
/**
|
||||
Convert to RFC 1779 string format
|
||||
|
||||
\param in the certificate info to convert
|
||||
*/
|
||||
QCA_EXPORT QString orderedToDNString(const CertificateInfoOrdered &in);
|
||||
|
||||
/**
|
||||
Return a new CertificateInfoOrdered that only contains
|
||||
the Distinguished Name (DN) types found in the input object.
|
||||
|
||||
\param in the certificate info to extract from
|
||||
*/
|
||||
QCA_EXPORT CertificateInfoOrdered orderedDNOnly(const CertificateInfoOrdered &in);
|
||||
|
||||
@ -546,6 +583,9 @@ typedef QList<ConstraintType> Constraints;
|
||||
|
||||
/**
|
||||
Create a list of unique friendly names among a list of certificates
|
||||
|
||||
\param list the list of certificates for which a friendly name is required.
|
||||
|
||||
*/
|
||||
QCA_EXPORT QStringList makeFriendlyNames(const QList<Certificate> &list);
|
||||
|
||||
@ -834,6 +874,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the certificate to copy from
|
||||
*/
|
||||
Certificate(const Certificate &from);
|
||||
|
||||
@ -841,6 +883,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the Certificate to assign from
|
||||
*/
|
||||
Certificate & operator=(const Certificate &from);
|
||||
|
||||
@ -934,21 +978,21 @@ CertificateInfoOrdered info = cert.subjectInfoOrdered();
|
||||
QStringList policies() const;
|
||||
|
||||
/**
|
||||
list of URI locations for CRL files
|
||||
List of URI locations for CRL files
|
||||
|
||||
each URI refers to the same CRL file
|
||||
Each URI refers to the same CRL file
|
||||
*/
|
||||
QStringList crlLocations() const;
|
||||
|
||||
/**
|
||||
list of URI locations for issuer certificate files
|
||||
List of URI locations for issuer certificate files
|
||||
|
||||
each URI refers to the same issuer file
|
||||
Each URI refers to the same issuer file
|
||||
*/
|
||||
QStringList issuerLocations() const;
|
||||
|
||||
/**
|
||||
list of URI locations for OCSP services
|
||||
List of URI locations for OCSP services
|
||||
*/
|
||||
QStringList ocspLocations() const;
|
||||
|
||||
@ -988,7 +1032,9 @@ CertificateInfoOrdered info = cert.subjectInfoOrdered();
|
||||
Test if the Certificate has signed another Certificate
|
||||
object and is therefore the issuer
|
||||
|
||||
\return true if the certificate is the issuer
|
||||
\param other the certificate to test
|
||||
|
||||
\return true if this certificate is the issuer of the argument
|
||||
*/
|
||||
bool isIssuerOf(const Certificate &other) const;
|
||||
|
||||
@ -1103,12 +1149,16 @@ CertificateInfoOrdered info = cert.subjectInfoOrdered();
|
||||
/**
|
||||
Test for equality of two certificates
|
||||
|
||||
\param a the certificate to compare this certificate with
|
||||
|
||||
\return true if the two certificates are the same
|
||||
*/
|
||||
bool operator==(const Certificate &a) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the certificate to compare this certificate with
|
||||
*/
|
||||
inline bool operator!=(const Certificate &other) const
|
||||
{
|
||||
@ -1117,6 +1167,8 @@ CertificateInfoOrdered info = cert.subjectInfoOrdered();
|
||||
|
||||
/**
|
||||
\internal
|
||||
|
||||
\param c context (internal)
|
||||
*/
|
||||
void change(CertContext *c);
|
||||
|
||||
@ -1266,6 +1318,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the request to copy from
|
||||
*/
|
||||
CertificateRequest(const CertificateRequest &from);
|
||||
|
||||
@ -1273,6 +1327,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the request to assign from
|
||||
*/
|
||||
CertificateRequest & operator=(const CertificateRequest &from);
|
||||
|
||||
@ -1370,12 +1426,16 @@ public:
|
||||
/**
|
||||
Test for equality of two certificate requests
|
||||
|
||||
\param csr the certificate request to be compared to this certificate request
|
||||
|
||||
\return true if the two certificate requests are the same
|
||||
*/
|
||||
bool operator==(const CertificateRequest &csr) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the certificate request to be compared to this certificate request
|
||||
*/
|
||||
inline bool operator!=(const CertificateRequest &other) const
|
||||
{
|
||||
@ -1482,6 +1542,8 @@ public:
|
||||
|
||||
/**
|
||||
\internal
|
||||
|
||||
\param c context (internal)
|
||||
*/
|
||||
void change(CSRContext *c);
|
||||
|
||||
@ -1584,18 +1646,24 @@ public:
|
||||
Test if one CRL entry is "less than" another
|
||||
|
||||
CRL entries are compared based on their serial number
|
||||
|
||||
\param a the CRL entry to be compared to this CRL entry.
|
||||
*/
|
||||
bool operator<(const CRLEntry &a) const;
|
||||
|
||||
/**
|
||||
Test for equality of two CRL Entries
|
||||
|
||||
\param a the CRL entry to be compared to this CRL entry.
|
||||
|
||||
\return true if the two certificates are the same
|
||||
*/
|
||||
bool operator==(const CRLEntry &a) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the CRL entry to be compared to this CRL entry.
|
||||
*/
|
||||
inline bool operator!=(const CRLEntry &other) const
|
||||
{
|
||||
@ -1638,6 +1706,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the revocation list to copy from
|
||||
*/
|
||||
CRL(const CRL &from);
|
||||
|
||||
@ -1645,6 +1715,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the revocation list to assign from
|
||||
*/
|
||||
CRL & operator=(const CRL &from);
|
||||
|
||||
@ -1711,12 +1783,16 @@ public:
|
||||
/**
|
||||
Test for equality of two %Certificate Revocation Lists
|
||||
|
||||
\param a the CRL to be compared to this CRL
|
||||
|
||||
\return true if the two CRLs are the same
|
||||
*/
|
||||
bool operator==(const CRL &a) const;
|
||||
|
||||
/**
|
||||
Inequality operator
|
||||
|
||||
\param other the CRL to be compared to this CRL
|
||||
*/
|
||||
inline bool operator!=(const CRL &other) const
|
||||
{
|
||||
@ -1787,6 +1863,8 @@ public:
|
||||
|
||||
/**
|
||||
\internal
|
||||
|
||||
\param c context (internal)
|
||||
*/
|
||||
void change(CRLContext *c);
|
||||
|
||||
@ -2290,8 +2368,11 @@ public:
|
||||
/**
|
||||
Create a PGP key from an encoded file
|
||||
|
||||
\sa fromFile
|
||||
\sa toFile
|
||||
\param fileName the name (and path, if required) of the file
|
||||
that the PGP key is to be loaded from.
|
||||
|
||||
\sa fromFile for a version that allows better error checking / validation
|
||||
\sa toFile for a method to write out the key.
|
||||
*/
|
||||
PGPKey(const QString &fileName);
|
||||
|
||||
|
||||
@ -316,6 +316,8 @@ QCA_EXPORT ProviderList providers();
|
||||
|
||||
/**
|
||||
Return the named provider, or 0 if not found
|
||||
|
||||
\param name the name of the provider to search for.
|
||||
*/
|
||||
QCA_EXPORT Provider *findProvider(const QString &name);
|
||||
|
||||
@ -348,16 +350,27 @@ QCA_EXPORT void clearPluginDiagnosticText();
|
||||
Add plugin diagnostic text
|
||||
|
||||
This function should only be called by providers.
|
||||
|
||||
\param text the diagnostic message to append
|
||||
*/
|
||||
QCA_EXPORT void appendPluginDiagnosticText(const QString &text);
|
||||
|
||||
/**
|
||||
Set a global property
|
||||
|
||||
\param name the name of the property
|
||||
\param value the value to set the property to
|
||||
|
||||
\sa getProperty
|
||||
*/
|
||||
QCA_EXPORT void setProperty(const QString &name, const QVariant &value);
|
||||
|
||||
/**
|
||||
Retrieve a global property
|
||||
|
||||
\param name the name of the property to look up
|
||||
|
||||
\sa setProperty
|
||||
*/
|
||||
QCA_EXPORT QVariant getProperty(const QString &name);
|
||||
|
||||
@ -389,6 +402,9 @@ QCA_EXPORT QString globalRandomProvider();
|
||||
The Random capabilities of %QCA are provided as part of the
|
||||
built in capabilities, however the generator can be changed
|
||||
if required.
|
||||
|
||||
\param provider the name of the provider to use as the global random
|
||||
provider.
|
||||
*/
|
||||
QCA_EXPORT void setGlobalRandomProvider(const QString &provider);
|
||||
|
||||
@ -957,6 +973,8 @@ public:
|
||||
|
||||
\note This will invalidate any previous
|
||||
computation using this object.
|
||||
|
||||
\param a the data to process.
|
||||
*/
|
||||
MemoryRegion process(const MemoryRegion &a);
|
||||
};
|
||||
@ -1019,6 +1037,8 @@ public:
|
||||
|
||||
\note This will invalidate any previous
|
||||
computation using this object.
|
||||
|
||||
\param a the data to process in this step
|
||||
*/
|
||||
MemoryRegion process(const MemoryRegion &a);
|
||||
};
|
||||
@ -1467,6 +1487,9 @@ Q_SIGNALS:
|
||||
|
||||
You typically need to connect this signal to
|
||||
a compatible slot in your callback handler
|
||||
|
||||
\param id the identification number for the event
|
||||
\param context information about the type of response required
|
||||
*/
|
||||
void eventReady(int id, const QCA::Event &context);
|
||||
|
||||
|
||||
@ -160,6 +160,8 @@ public:
|
||||
Create a passive KeyStoreEntry based on a serialized
|
||||
string
|
||||
|
||||
\param serialized the string containing the keystore entry information
|
||||
|
||||
\sa fromString
|
||||
*/
|
||||
KeyStoreEntry(const QString &serialized);
|
||||
@ -249,6 +251,8 @@ public:
|
||||
Load a passive entry by using a serialized string
|
||||
as input
|
||||
|
||||
\param serialized the string containing the keystore entry information
|
||||
|
||||
\return the newly created KeyStoreEntry
|
||||
*/
|
||||
static KeyStoreEntry fromString(const QString &serialized);
|
||||
@ -572,14 +576,18 @@ Q_SIGNALS:
|
||||
|
||||
/**
|
||||
Emitted when an entry has been written, in asynchronous
|
||||
mode. entryId is the newly written entry id on success,
|
||||
mode.
|
||||
|
||||
\param entryId is the newly written entry id on success,
|
||||
or an empty string if the write failed.
|
||||
*/
|
||||
void entryWritten(const QString &entryId);
|
||||
|
||||
/**
|
||||
Emitted when an entry has been removed, in asynchronous
|
||||
mode. success indicates if the removal succeeded or not.
|
||||
mode.
|
||||
|
||||
\param success indicates if the removal succeeded (true) or not (false).
|
||||
*/
|
||||
void entryRemoved(bool success);
|
||||
|
||||
@ -716,6 +724,8 @@ public:
|
||||
|
||||
/**
|
||||
Initialize a specific key store provider
|
||||
|
||||
\param provider the name of the provider to start
|
||||
*/
|
||||
static void start(const QString &provider);
|
||||
|
||||
@ -764,6 +774,8 @@ Q_SIGNALS:
|
||||
|
||||
/**
|
||||
emitted when a new key store becomes available
|
||||
|
||||
\param id the name of the key store that has become available
|
||||
*/
|
||||
void keyStoreAvailable(const QString &id);
|
||||
|
||||
|
||||
@ -280,6 +280,9 @@ else
|
||||
that uses them, including the constructor form that takes a
|
||||
fileName), then you need to check for supportedIOTypes() instead.
|
||||
|
||||
\param provider the name of the provider to use, if a particular
|
||||
provider is required.
|
||||
|
||||
\sa supportedIOTypes()
|
||||
*/
|
||||
static QList<Type> supportedTypes(const QString &provider = QString());
|
||||
@ -308,6 +311,9 @@ else
|
||||
supportedTypes(). There is no need to use both - if the key type
|
||||
is supported for IO, then is also supported for basic operations.
|
||||
|
||||
\param provider the name of the provider to use, if a particular
|
||||
provider is required.
|
||||
|
||||
\sa supportedTypes()
|
||||
*/
|
||||
static QList<Type> supportedIOTypes(const QString &provider = QString());
|
||||
@ -382,11 +388,15 @@ else
|
||||
|
||||
/**
|
||||
test if two keys are equal
|
||||
|
||||
\param a the key to compare with this key
|
||||
*/
|
||||
bool operator==(const PKey &a) const;
|
||||
|
||||
/**
|
||||
test if two keys are not equal
|
||||
|
||||
\param a the key to compare with this key
|
||||
*/
|
||||
bool operator!=(const PKey &a) const;
|
||||
|
||||
@ -398,6 +408,8 @@ protected:
|
||||
|
||||
/**
|
||||
Set the key
|
||||
|
||||
\param k the key to assign from
|
||||
*/
|
||||
void set(const PKey &k);
|
||||
|
||||
|
||||
@ -142,6 +142,8 @@ public:
|
||||
This method writes unencrypted (plain) data to
|
||||
the SecureLayer implementation. You normally
|
||||
call this function on the application side.
|
||||
|
||||
\param a the source of the application-side data
|
||||
*/
|
||||
virtual void write(const QByteArray &a) = 0;
|
||||
|
||||
@ -159,6 +161,8 @@ public:
|
||||
data read from the network socket (e.g. using
|
||||
QTcpSocket::readAll()) after receiving a signal that
|
||||
indicates that the socket has data to read.
|
||||
|
||||
\param a the ByteArray to take network-side data from
|
||||
*/
|
||||
virtual void writeIncoming(const QByteArray &a) = 0;
|
||||
|
||||
@ -168,6 +172,8 @@ public:
|
||||
to write out to the network socket (e.g. using
|
||||
QTcpSocket::write()) after receiving the
|
||||
readyReadOutgoing() signal.
|
||||
|
||||
\param plainBytes the number of bytes that were read.
|
||||
*/
|
||||
virtual QByteArray readOutgoing(int *plainBytes = 0) = 0;
|
||||
|
||||
@ -182,6 +188,8 @@ public:
|
||||
|
||||
/**
|
||||
Convert encrypted bytes written to plain text bytes written
|
||||
|
||||
\param encryptedBytes the number of bytes to convert
|
||||
*/
|
||||
virtual int convertBytesWritten(qint64 encryptedBytes) = 0;
|
||||
|
||||
@ -394,6 +402,9 @@ public:
|
||||
\overload
|
||||
|
||||
Allows setting a certificate from a KeyBundle.
|
||||
|
||||
\param kb key bundle containing the local certificate
|
||||
and associated private key.
|
||||
*/
|
||||
void setCertificate(const KeyBundle &kb);
|
||||
|
||||
@ -471,11 +482,15 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
/**
|
||||
Sets the issuer list to present to the client. For
|
||||
use with servers only. Only DN types are allowed.
|
||||
|
||||
\param issuers the list of valid issuers to be used.
|
||||
*/
|
||||
void setIssuerList(const QList<CertificateInfoOrdered> &issuers);
|
||||
|
||||
/**
|
||||
Resume a %TLS session using the given session object
|
||||
|
||||
\param session the session state to use for resumption.
|
||||
*/
|
||||
void setSession(const TLSSession &session);
|
||||
|
||||
@ -1054,6 +1069,8 @@ public:
|
||||
Call this with the mechanism selected by the client. If there
|
||||
is initial client data, call the other version of this function
|
||||
instead.
|
||||
|
||||
\param mech the mechanism to be used.
|
||||
*/
|
||||
void putServerFirstStep(const QString &mech);
|
||||
|
||||
@ -1063,6 +1080,9 @@ public:
|
||||
Call this with the mechanism selected by the client, and initial
|
||||
client data. If there is no initial client data, call the other
|
||||
version of this function instead.
|
||||
|
||||
\param mech the mechanism to be used
|
||||
\param clientInit the initial data provided by the client side
|
||||
*/
|
||||
void putServerFirstStep(const QString &mech, const QByteArray &clientInit);
|
||||
|
||||
@ -1072,6 +1092,8 @@ public:
|
||||
Call this with authentication data received from the network.
|
||||
The only exception is the first step in server mode, in which
|
||||
case putServerFirstStep must be called.
|
||||
|
||||
\param stepData the authentication data from the network
|
||||
*/
|
||||
void putStep(const QByteArray &stepData);
|
||||
|
||||
@ -1178,8 +1200,11 @@ Q_SIGNALS:
|
||||
This signal is emitted when the client needs
|
||||
additional parameters
|
||||
|
||||
Set parameter values as necessary and then call
|
||||
After receiving this signal, the application should set
|
||||
the required parameter values appropriately and then call
|
||||
continueAfterParams().
|
||||
|
||||
\param params the parameters that are required by the client
|
||||
*/
|
||||
void needParams(const QCA::SASL::Params ¶ms);
|
||||
|
||||
@ -1188,6 +1213,9 @@ Q_SIGNALS:
|
||||
perform the authentication check
|
||||
|
||||
If the user and authzid are valid, call continueAfterAuthCheck().
|
||||
|
||||
\param user the user identification name
|
||||
\param authzid the user authorization name
|
||||
*/
|
||||
void authCheck(const QString &user, const QString &authzid);
|
||||
|
||||
|
||||
@ -130,16 +130,22 @@ public:
|
||||
|
||||
/**
|
||||
Set the public key part of this X.509 key.
|
||||
|
||||
\param c the Certificate chain containing the public keys
|
||||
*/
|
||||
void setX509CertificateChain(const CertificateChain &c);
|
||||
|
||||
/**
|
||||
Set the private key part of this X.509 key.
|
||||
|
||||
\param k the private key
|
||||
*/
|
||||
void setX509PrivateKey(const PrivateKey &k);
|
||||
|
||||
/**
|
||||
Set the public and private part of this X.509 key with KeyBundle.
|
||||
|
||||
\param kb the public and private key bundle
|
||||
*/
|
||||
void setX509KeyBundle(const KeyBundle &kb);
|
||||
|
||||
@ -189,12 +195,23 @@ public:
|
||||
};
|
||||
|
||||
/**
|
||||
Create an empty signature check object
|
||||
Create an empty signature check object.
|
||||
|
||||
User applications don't normally need to create signature checks. You normally
|
||||
get the object back as a result of a SecureMessage operation.
|
||||
*/
|
||||
SecureMessageSignature();
|
||||
|
||||
/**
|
||||
Create a signature check object
|
||||
|
||||
User applications don't normally need to create signature checks. You normally
|
||||
get the object back as a result of a SecureMessage operation.
|
||||
|
||||
\param r the result of the check
|
||||
\param v the Validity of the key validation check
|
||||
\param key the key associated with the signature
|
||||
\param ts the timestamp associated with the signature
|
||||
*/
|
||||
SecureMessageSignature(IdentityResult r, Validity v, const SecureMessageKey &key, const QDateTime &ts);
|
||||
|
||||
@ -441,6 +458,8 @@ public:
|
||||
bundle the signer, greatly simplifying key management.
|
||||
|
||||
This behavior is enabled by default.
|
||||
|
||||
\param b whether to bundle (if true) or not (false)
|
||||
*/
|
||||
void setBundleSignerEnabled(bool b);
|
||||
|
||||
@ -451,6 +470,8 @@ public:
|
||||
used are decided by the provider.
|
||||
|
||||
This behavior is enabled by default.
|
||||
|
||||
\param b whether to embed extra attribues (if true) or not (false)
|
||||
*/
|
||||
void setSMIMEAttributesEnabled(bool b);
|
||||
|
||||
@ -466,6 +487,8 @@ public:
|
||||
/**
|
||||
Set the recipient for an encrypted message
|
||||
|
||||
\param key the recipient's key
|
||||
|
||||
\sa setRecipients
|
||||
*/
|
||||
void setRecipient(const SecureMessageKey &key);
|
||||
@ -475,6 +498,8 @@ public:
|
||||
|
||||
For a list with one item, this has the same effect as setRecipient.
|
||||
|
||||
\param keys the recipients' key
|
||||
|
||||
\sa setRecipient
|
||||
*/
|
||||
void setRecipients(const SecureMessageKeyList &keys);
|
||||
@ -485,6 +510,8 @@ public:
|
||||
This is used for both creating signed messages as well as for
|
||||
verifying CMS messages that have no signer bundled.
|
||||
|
||||
\param key the key associated with the signer
|
||||
|
||||
\sa setSigners
|
||||
*/
|
||||
void setSigner(const SecureMessageKey &key);
|
||||
@ -497,6 +524,8 @@ public:
|
||||
|
||||
For a list with one item, this has the same effect as setSigner.
|
||||
|
||||
\param keys the key associated with the signer
|
||||
|
||||
\sa setSigner
|
||||
*/
|
||||
void setSigners(const SecureMessageKeyList &keys);
|
||||
@ -738,6 +767,8 @@ Q_SIGNALS:
|
||||
/**
|
||||
This signal is emitted when data has been accepted
|
||||
by the message processor.
|
||||
|
||||
\param bytes the number of bytes written
|
||||
*/
|
||||
void bytesWritten(int bytes);
|
||||
|
||||
|
||||
@ -274,6 +274,8 @@ class QCA_EXPORT SyncThread : public QThread
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param parent the parent object for this parent.
|
||||
*/
|
||||
SyncThread(QObject *parent = 0);
|
||||
|
||||
@ -1065,6 +1067,9 @@ public:
|
||||
The default implementation does nothing - you should
|
||||
override this method in your subclass to do whatever
|
||||
logging is required
|
||||
|
||||
\param message the message to log
|
||||
\param severity the severity level of the message
|
||||
*/
|
||||
virtual void logTextMessage(const QString &message, Logger::Severity severity);
|
||||
|
||||
@ -1074,6 +1079,9 @@ public:
|
||||
The default implementation does nothing - you should
|
||||
override this method in your subclass to do whatever
|
||||
logging is required
|
||||
|
||||
\param blob the message (as a byte array) to log
|
||||
\param severity the severity level of the message
|
||||
*/
|
||||
virtual void logBinaryMessage(const QByteArray &blob, Logger::Severity severity);
|
||||
|
||||
|
||||
@ -256,12 +256,16 @@ public:
|
||||
added to encoded output or accepted in encoded input.
|
||||
If disabled, linebreaks in encoded input will cause
|
||||
a failure to decode. The default is disabled.
|
||||
|
||||
\param b whether to enable line breaks (true) or disable line breaks (false)
|
||||
*/
|
||||
void setLineBreaksEnabled(bool b);
|
||||
|
||||
/**
|
||||
Sets the column that linebreaks should be inserted at
|
||||
when encoding.
|
||||
|
||||
\param column the column number that line breaks should be inserted at.
|
||||
*/
|
||||
void setLineBreaksColumn(int column);
|
||||
|
||||
|
||||
@ -102,22 +102,30 @@ public:
|
||||
/**
|
||||
Constructs a new MemoryRegion from the data in a
|
||||
byte array
|
||||
|
||||
\param from the QByteArray to copy from
|
||||
*/
|
||||
MemoryRegion(const QByteArray &from);
|
||||
|
||||
/**
|
||||
Standard copy constructor
|
||||
|
||||
\param from the MemoryRegion to copy from
|
||||
*/
|
||||
MemoryRegion(const MemoryRegion &from);
|
||||
~MemoryRegion();
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the MemoryRegion to copy from
|
||||
*/
|
||||
MemoryRegion & operator=(const MemoryRegion &from);
|
||||
|
||||
/**
|
||||
Standard assignment operator
|
||||
|
||||
\param from the QByteArray to copy from
|
||||
*/
|
||||
MemoryRegion & operator=(const QByteArray &from);
|
||||
|
||||
@ -323,14 +331,18 @@ public:
|
||||
/**
|
||||
Construct a secure byte array from a string
|
||||
|
||||
Note that this copies, rather than references the source array
|
||||
Note that this copies, rather than references the source array.
|
||||
|
||||
\param str the source of the data (as a null terminated string).
|
||||
*/
|
||||
SecureArray(const char *str);
|
||||
|
||||
/**
|
||||
Construct a secure byte array from a QByteArray
|
||||
|
||||
Note that this copies, rather than references the source array
|
||||
Note that this copies, rather than references the source array.
|
||||
|
||||
\param a the source of the data.
|
||||
|
||||
\sa operator=()
|
||||
*/
|
||||
@ -341,6 +353,8 @@ public:
|
||||
|
||||
Note that this copies, rather than references the source array
|
||||
|
||||
\param a the source of the data.
|
||||
|
||||
\sa operator=()
|
||||
*/
|
||||
SecureArray(const MemoryRegion &a);
|
||||
@ -356,6 +370,8 @@ public:
|
||||
|
||||
/**
|
||||
Creates a reference, rather than a deep copy.
|
||||
|
||||
\param from the array to reference
|
||||
*/
|
||||
SecureArray & operator=(const SecureArray &from);
|
||||
|
||||
@ -477,18 +493,24 @@ public:
|
||||
|
||||
/**
|
||||
Append a secure byte array to the end of this array
|
||||
|
||||
\param a the array to append to this array
|
||||
*/
|
||||
SecureArray & append(const SecureArray &a);
|
||||
|
||||
/**
|
||||
Equality operator. Returns true if both arrays have the same
|
||||
data (and the same length, of course).
|
||||
|
||||
\param other the MemoryRegion to compare to
|
||||
*/
|
||||
bool operator==(const MemoryRegion &other) const;
|
||||
|
||||
/**
|
||||
Inequality operator. Returns true if both arrays have different
|
||||
length, or the same length but different data.
|
||||
|
||||
\param other the MemoryRegion to compare to
|
||||
*/
|
||||
inline bool operator!=(const MemoryRegion &other) const
|
||||
{
|
||||
@ -497,6 +519,8 @@ public:
|
||||
|
||||
/**
|
||||
Append a secure byte array to the end of this array
|
||||
|
||||
\param a the array to append to this array
|
||||
*/
|
||||
SecureArray & operator+=(const SecureArray &a);
|
||||
|
||||
@ -735,6 +759,8 @@ result = b.compare( c ); // return negative, -400 < 200
|
||||
/**
|
||||
Equality operator. Returns true if the two BigInteger values
|
||||
are the same, including having the same sign.
|
||||
|
||||
\param other the BigInteger to compare to
|
||||
*/
|
||||
inline bool operator==(const BigInteger &other) const
|
||||
{
|
||||
@ -744,6 +770,8 @@ result = b.compare( c ); // return negative, -400 < 200
|
||||
/**
|
||||
Inequality operator. Returns true if the two BigInteger values
|
||||
are different in magnitude, sign or both.
|
||||
|
||||
\param other the BigInteger to compare to
|
||||
*/
|
||||
inline bool operator!=(const BigInteger &other) const
|
||||
{
|
||||
@ -754,6 +782,8 @@ result = b.compare( c ); // return negative, -400 < 200
|
||||
Less than or equal operator. Returns true if the BigInteger value
|
||||
on the left hand side is equal to or less than the BigInteger
|
||||
value on the right hand side.
|
||||
|
||||
\param other the BigInteger to compare to
|
||||
*/
|
||||
inline bool operator<=(const BigInteger &other) const
|
||||
{
|
||||
@ -764,6 +794,8 @@ result = b.compare( c ); // return negative, -400 < 200
|
||||
Greater than or equal operator. Returns true if the BigInteger
|
||||
value on the left hand side is equal to or greater than the
|
||||
BigInteger value on the right hand side.
|
||||
|
||||
\param other the BigInteger to compare to
|
||||
*/
|
||||
inline bool operator>=(const BigInteger &other) const
|
||||
{
|
||||
@ -774,6 +806,8 @@ result = b.compare( c ); // return negative, -400 < 200
|
||||
Less than operator. Returns true if the BigInteger value
|
||||
on the left hand side is less than the BigInteger value
|
||||
on the right hand side.
|
||||
|
||||
\param other the BigInteger to compare to
|
||||
*/
|
||||
inline bool operator<(const BigInteger &other) const
|
||||
{
|
||||
@ -784,6 +818,8 @@ result = b.compare( c ); // return negative, -400 < 200
|
||||
Greater than operator. Returns true if the BigInteger value
|
||||
on the left hand side is greater than the BigInteger value
|
||||
on the right hand side.
|
||||
|
||||
\param other the BigInteger to compare to
|
||||
*/
|
||||
inline bool operator>(const BigInteger &other) const
|
||||
{
|
||||
@ -800,6 +836,9 @@ private:
|
||||
/**
|
||||
Stream operator
|
||||
|
||||
\param stream the stream to write to
|
||||
\param b the integer to write to the stream
|
||||
|
||||
\relates BigInteger
|
||||
*/
|
||||
QCA_EXPORT QTextStream &operator<<(QTextStream &stream, const BigInteger &b);
|
||||
|
||||
@ -400,6 +400,8 @@ class QCA_EXPORT PKeyBase : public BasicContext
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
PKeyBase(Provider *p, const QString &type);
|
||||
|
||||
@ -1376,6 +1378,8 @@ class QCA_EXPORT CAContext : public BasicContext
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
CAContext(Provider *p) : BasicContext(p, "ca") {}
|
||||
|
||||
@ -1451,6 +1455,8 @@ class QCA_EXPORT PKCS12Context : public BasicContext
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
PKCS12Context(Provider *p) : BasicContext(p, "pkcs12") {}
|
||||
|
||||
@ -1560,6 +1566,8 @@ class QCA_EXPORT PGPKeyContext : public BasicContext
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
PGPKeyContext(Provider *p) : BasicContext(p, "pgpkey") {}
|
||||
|
||||
@ -1616,6 +1624,8 @@ class QCA_EXPORT KeyStoreEntryContext : public BasicContext
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
KeyStoreEntryContext(Provider *p) : BasicContext(p, "keystoreentry") {}
|
||||
|
||||
@ -1719,6 +1729,8 @@ class QCA_EXPORT KeyStoreListContext : public Provider::Context
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
KeyStoreListContext(Provider *p) : Provider::Context(p, "keystorelist") {}
|
||||
|
||||
@ -1917,6 +1929,8 @@ class QCA_EXPORT TLSSessionContext : public BasicContext
|
||||
public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
TLSSessionContext(Provider *p) : BasicContext(p, "tlssession") {}
|
||||
};
|
||||
@ -1994,6 +2008,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
TLSContext(Provider *p, const QString &type) : Provider::Context(p, type) {}
|
||||
|
||||
@ -2006,6 +2022,8 @@ public:
|
||||
Returns a list of supported cipher suites for the specified
|
||||
SSL/TLS version. The cipher suites are specified as strings, for
|
||||
example: "TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA" (without quotes).
|
||||
|
||||
\param version the version of TLS to search for
|
||||
*/
|
||||
virtual QStringList supportedCipherSuites(const TLS::Version &version) const = 0;
|
||||
|
||||
@ -2302,6 +2320,8 @@ public:
|
||||
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
*/
|
||||
SASLContext(Provider *p) : Provider::Context(p, "sasl") {}
|
||||
|
||||
@ -2537,6 +2557,9 @@ public:
|
||||
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param p the Provider associated with this context
|
||||
\param type the name of the type of secure message to be created
|
||||
*/
|
||||
MessageContext(Provider *p, const QString &type) : Provider::Context(p, type) {}
|
||||
|
||||
@ -2558,6 +2581,8 @@ public:
|
||||
|
||||
/**
|
||||
Configure a new encrypting operation
|
||||
|
||||
\param keys the keys to be used for encryption.
|
||||
*/
|
||||
virtual void setupEncrypt(const SecureMessageKeyList &keys) = 0;
|
||||
|
||||
@ -2568,6 +2593,8 @@ public:
|
||||
|
||||
/**
|
||||
Configure a new verify operation
|
||||
|
||||
\param detachedSig the detached signature to use (if applicable) for verification
|
||||
*/
|
||||
virtual void setupVerify(const QByteArray &detachedSig) = 0;
|
||||
|
||||
|
||||
@ -146,9 +146,11 @@ public:
|
||||
void release();
|
||||
|
||||
/**
|
||||
Set the pupe end to be inheritable
|
||||
Set the pipe end to be inheritable
|
||||
|
||||
\note On Windows, this operation changes the pipe end id value.
|
||||
|
||||
\param enabled whether the pipe is inheritable (true) or not (false)
|
||||
*/
|
||||
bool setInheritable(bool enabled);
|
||||
|
||||
@ -275,6 +277,8 @@ public:
|
||||
|
||||
Enabling this may reduce performance, and it should only be used if
|
||||
sensitive data is being transmitted (such as a passphrase).
|
||||
|
||||
\param secure whether the pipe uses secure memory (true) or not (false).
|
||||
*/
|
||||
void setSecurityEnabled(bool secure);
|
||||
#endif
|
||||
@ -307,6 +311,8 @@ public:
|
||||
|
||||
Returns true if inheritability was successfully changed, otherwise
|
||||
false.
|
||||
|
||||
\param enabled whether the pipe is inheritable (true) or not (false).
|
||||
*/
|
||||
bool setInheritable(bool enabled);
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user