mirror of
https://github.com/QuasarApp/qca.git
synced 2025-04-27 12:04:31 +00:00
Reduce number of dubious links in API docs.
svn path=/trunk/kdesupport/qca/; revision=696619
This commit is contained in:
Brad Hards
parent
67109b2a33
commit
e7bcdf89cc
@ -1,3 +1,4 @@
|
||||
|
||||
/*
|
||||
* qca_securelayer.h - Qt Cryptographic Architecture
|
||||
* Copyright (C) 2003-2007 Justin Karneges <justin@affinix.com>
|
||||
@ -41,7 +42,7 @@ namespace QCA {
|
||||
/**
|
||||
Specify the lower-bound for acceptable TLS/SASL security layers
|
||||
|
||||
For TLS, the intepretation of these levels is:
|
||||
For TLS, the interpretation of these levels is:
|
||||
- Any cipher suite that provides non-authenticated communications
|
||||
(usually anonymous Diffie-Hellman) is SL_Integrity.
|
||||
- Any cipher suite that is limited to 40 bits (export-version
|
||||
@ -339,7 +340,7 @@ public:
|
||||
/**
|
||||
Constructor for Transport Layer Security connection.
|
||||
|
||||
This constructor can be used for both normal TLS (set mode to TLS::Stream)
|
||||
This constructor can be used for both normal %TLS (set mode to TLS::Stream)
|
||||
or DTLS (set mode to TLS::Datagram).
|
||||
|
||||
\param mode the connection Mode
|
||||
@ -475,7 +476,7 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
void setIssuerList(const QList<CertificateInfoOrdered> &issuers);
|
||||
|
||||
/**
|
||||
Resume a TLS session using the given session object
|
||||
Resume a %TLS session using the given session object
|
||||
*/
|
||||
void setSession(const TLSSession &session);
|
||||
|
||||
@ -518,7 +519,7 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
QString hostName() const;
|
||||
|
||||
/**
|
||||
Start the TLS/SSL connection as a client
|
||||
Start the %TLS/SSL connection as a client
|
||||
|
||||
Typically, you'll want to perform RFC 2818 validation on the
|
||||
server's certificate, based on the hostname you're intending
|
||||
@ -539,18 +540,18 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
void startClient(const QString &host = QString());
|
||||
|
||||
/**
|
||||
Start the TLS/SSL connection as a server.
|
||||
Start the %TLS/SSL connection as a server.
|
||||
*/
|
||||
void startServer();
|
||||
|
||||
/**
|
||||
Resumes TLS processing.
|
||||
Resumes %TLS processing.
|
||||
|
||||
Call this function after hostNameReceived(), certificateRequested()
|
||||
peerCertificateAvailable() or handshaken() is emitted. By
|
||||
requiring this function to be called in order to proceed,
|
||||
applications are given a chance to perform user interaction between
|
||||
steps in the TLS process.
|
||||
steps in the %TLS process.
|
||||
*/
|
||||
void continueAfterStep();
|
||||
|
||||
@ -603,7 +604,7 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
int cipherMaxBits() const;
|
||||
|
||||
/**
|
||||
The session object of the TLS connection, which can be used
|
||||
The session object of the %TLS connection, which can be used
|
||||
for resuming.
|
||||
*/
|
||||
TLSSession session() const;
|
||||
@ -616,13 +617,13 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
Error errorCode() const;
|
||||
|
||||
/**
|
||||
After the SSL/TLS handshake is complete, this
|
||||
After the SSL/%TLS handshake is complete, this
|
||||
method allows you to determine if the other end
|
||||
of the connection (if the application is a client,
|
||||
this is the server; if the application is a server,
|
||||
this is the client) has a valid identity.
|
||||
|
||||
Note that the security of TLS/SSL depends on
|
||||
Note that the security of %TLS/SSL depends on
|
||||
checking this. It is not enough to check that the
|
||||
certificate is valid - you must check that the
|
||||
certificate is valid for the entity that you are
|
||||
@ -635,7 +636,7 @@ foreach(const CertificateInfoOrdered &info, tls->issuerList())
|
||||
IdentityResult peerIdentityResult() const;
|
||||
|
||||
/**
|
||||
After the SSL/TLS handshake is valid, this method
|
||||
After the SSL/%TLS handshake is valid, this method
|
||||
allows you to check if the received certificate
|
||||
from the other end is valid. As noted in
|
||||
peerIdentityResult(), you also need to check that
|
||||
@ -711,7 +712,7 @@ Q_SIGNALS:
|
||||
Emitted if a host name is set by the client. At
|
||||
this time, the server can inspect the hostName().
|
||||
|
||||
You must call continueAfterStep() in order for TLS
|
||||
You must call continueAfterStep() in order for %TLS
|
||||
processing to resume after this signal is emitted.
|
||||
|
||||
This signal is only emitted in server mode.
|
||||
@ -724,7 +725,7 @@ Q_SIGNALS:
|
||||
Emitted when the server requests a certificate. At
|
||||
this time, the client can inspect the issuerList().
|
||||
|
||||
You must call continueAfterStep() in order for TLS
|
||||
You must call continueAfterStep() in order for %TLS
|
||||
processing to resume after this signal is emitted.
|
||||
|
||||
This signal is only emitted in client mode.
|
||||
@ -738,7 +739,7 @@ Q_SIGNALS:
|
||||
At this time, you may inspect peerIdentityResult(),
|
||||
peerCertificateValidity(), and peerCertificateChain().
|
||||
|
||||
You must call continueAfterStep() in order for TLS
|
||||
You must call continueAfterStep() in order for %TLS
|
||||
processing to resume after this signal is emitted.
|
||||
|
||||
\sa continueAfterStep
|
||||
@ -747,10 +748,10 @@ Q_SIGNALS:
|
||||
|
||||
/**
|
||||
Emitted when the protocol handshake is complete. At
|
||||
this time, all available information about the TLS
|
||||
this time, all available information about the %TLS
|
||||
session can be inspected.
|
||||
|
||||
You must call continueAfterStep() in order for TLS
|
||||
You must call continueAfterStep() in order for %TLS
|
||||
processing to resume after this signal is emitted.
|
||||
|
||||
\sa continueAfterStep
|
||||
@ -814,11 +815,11 @@ class QCA_EXPORT SASL : public SecureLayer, public Algorithm
|
||||
Q_OBJECT
|
||||
public:
|
||||
/**
|
||||
Possible errors that may occur when using SASL
|
||||
Possible errors that may occur when using %SASL
|
||||
*/
|
||||
enum Error
|
||||
{
|
||||
ErrorInit, ///< problem starting up SASL
|
||||
ErrorInit, ///< problem starting up %SASL
|
||||
ErrorHandshake, ///< problem during the authentication process
|
||||
ErrorCrypt ///< problem at anytime after
|
||||
};
|
||||
@ -877,9 +878,9 @@ public:
|
||||
/**
|
||||
\class Params qca_securelayer.h QtCrypto
|
||||
|
||||
Parameter flags for the SASL authentication
|
||||
Parameter flags for the %SASL authentication
|
||||
|
||||
This is used to indicate which parameters are needed by SASL
|
||||
This is used to indicate which parameters are needed by %SASL
|
||||
in order to complete the authentication process.
|
||||
|
||||
\ingroup UserAPI
|
||||
@ -945,7 +946,7 @@ public:
|
||||
/**
|
||||
Standard constructor
|
||||
|
||||
\param parent the parent object for this SASL connection
|
||||
\param parent the parent object for this %SASL connection
|
||||
\param provider if specified, the provider to use. If not
|
||||
specified, or specified as empty, then any provider is
|
||||
acceptable.
|
||||
@ -954,14 +955,14 @@ public:
|
||||
~SASL();
|
||||
|
||||
/**
|
||||
Reset the SASL mechanism
|
||||
Reset the %SASL mechanism
|
||||
*/
|
||||
void reset();
|
||||
|
||||
/**
|
||||
Specify connection constraints
|
||||
|
||||
SASL supports a range of authentication requirements, and
|
||||
%SASL supports a range of authentication requirements, and
|
||||
a range of security levels. This method allows you to
|
||||
specify the requirements for your connection.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user